ModelAPI_Result Class Reference

The result of a feature. More...

Inheritance diagram for ModelAPI_Result:

Public Member Functions
virtual bool	isConcealed ()
	Returns true if the result is concealed from the data tree (referenced by other objects) More...
virtual void	setIsConcealed (const bool theValue, const bool theForced=false)
	Sets the result as concealed in the data tree (referenced by other objects) More...
virtual bool	setDisabled (std::shared_ptr< ModelAPI_Result > theThis, const bool theFlag)
	Enables/disables the result. More...
virtual bool	isDisabled ()
	Returns the result is disabled or not. More...
virtual void	initAttributes ()
	Request for initialization of data model of the result: adding all attributes. More...
virtual	~ModelAPI_Result ()
	To virtually destroy the fields of successors. More...
virtual std::shared_ptr< GeomAPI_Shape >	shape ()
	Returns the shape-result produced by this feature (or null if no shapes) More...
virtual void	attributeChanged (const std::string &theID)
	On change of attribute of the result update presentation of this result: for the current moment there are only presentation attributes assigned to results. More...
virtual bool	isInHistory ()
	By default object is displayed in the object browser. More...
virtual void	setInHistory (const std::shared_ptr< ModelAPI_Object > theObject, const bool theFlag)
	Makes object presented or not in the history of the created objects. More...
virtual std::shared_ptr< ModelAPI_Data >	data () const
	Returns the data manager of this object: attributes. More...
virtual bool	isSame (const std::shared_ptr< ModelAPI_Object > &theObject)
	Returns true if object refers to the same data model instance. More...
virtual std::shared_ptr< ModelAPI_Document >	document () const
	Returns document this feature belongs to. More...
virtual std::string	groupName ()=0
	Returns the group identifier of this object. More...
virtual void	colorConfigInfo (std::string &, std::string &, std::string &)
	Returns the parameters of color definition in the resources config manager. More...
virtual bool	isDisplayed ()
	Returns true if object must be displayed in the viewer: flag is stored in the data model, so on undo/redo, open/save or recreation of object by history-playing it keeps the original state in the current transaction. More...
virtual void	setDisplayed (const bool theDisplay)
	Sets the displayed/hidden state of the object. More...
virtual bool	hasTexture ()
virtual void	emptyFunction () const
	Empty function which is added for virtualiation of the interface. More...

Static Public Member Functions
static const std::string &	COLOR_ID ()
	Reference to the color of the result. More...
static const std::string &	DEFLECTION_ID ()
	Reference to the deflection of the result. More...
static const std::string &	TRANSPARENCY_ID ()
	Reference to the transparency of the result. More...
static const std::string &	ISO_LINES_ID ()
	Reference to the transparency of the result. More...
static const std::string &	SHOW_ISO_LINES_ID ()
	Reference to the transparency of the result. More...
static const std::string &	SHOW_EDGES_DIRECTION_ID ()
	Reference to the transparency of the result. More...
static const std::string &	BRING_TO_FRONT_ID ()
	Reference to the BringToFront flag of the result. More...

Protected Member Functions
virtual void	init ()
	This method is called just after creation of the object: it must initialize all fields, normally initialized in the constructor. More...
virtual void	setData (std::shared_ptr< ModelAPI_Data > theData)
	Sets the data manager of an object (document does) More...
virtual void	setDoc (std::shared_ptr< ModelAPI_Document > theDoc)
	Sets the data manager of an object (document does) More...
virtual void	erase ()
	removes all fields from this feature More...

Protected Attributes
bool	myIsDisabled
	the result is disabled: removed for the user, but keeps the general info More...

Friends
class	Model_Objects

Detailed Description

The result of a feature.

A generic class that .

Constructor & Destructor Documentation

~ModelAPI_Result()

ModelAPI_Result::~ModelAPI_Result ( )

virtual

To virtually destroy the fields of successors.

Member Function Documentation

COLOR_ID()

static const std::string& ModelAPI_Result::COLOR_ID ( )

inlinestatic

Reference to the color of the result.

The integer array is used. It contains three values for red, green and blue values. The values are in [0, 255] range

DEFLECTION_ID()

static const std::string& ModelAPI_Result::DEFLECTION_ID ( )

inlinestatic

Reference to the deflection of the result.

The double value is used. The value is in [0, 1] range

TRANSPARENCY_ID()

static const std::string& ModelAPI_Result::TRANSPARENCY_ID ( )

inlinestatic

Reference to the transparency of the result.

The double value is used. The value is in [0, 1] range

ISO_LINES_ID()

static const std::string& ModelAPI_Result::ISO_LINES_ID ( )

inlinestatic

Reference to the transparency of the result.

The double value is used. The value is in [0, 1] range

SHOW_ISO_LINES_ID()

static const std::string& ModelAPI_Result::SHOW_ISO_LINES_ID ( )

inlinestatic

Reference to the transparency of the result.

The double value is used. The value is in [0, 1] range

SHOW_EDGES_DIRECTION_ID()

static const std::string& ModelAPI_Result::SHOW_EDGES_DIRECTION_ID ( )

inlinestatic

Reference to the transparency of the result.

The double value is used. The value is in [0, 1] range

BRING_TO_FRONT_ID()

static const std::string& ModelAPI_Result::BRING_TO_FRONT_ID ( )

inlinestatic

Reference to the BringToFront flag of the result.

The bool value is used.

isConcealed()

bool ModelAPI_Result::isConcealed ( )

virtual

Returns true if the result is concealed from the data tree (referenced by other objects)

Reimplemented in Model_ResultBody.

setIsConcealed()

void ModelAPI_Result::setIsConcealed ( const bool  theValue, const bool  theForced = false  )

virtual

Sets the result as concealed in the data tree (referenced by other objects)

Reimplemented in Model_ResultConstruction, and Model_ResultBody.

setDisabled()

bool ModelAPI_Result::setDisabled ( std::shared_ptr< ModelAPI_Result >  theThis, const bool  theFlag  )

virtual

Enables/disables the result.

The disabled result does not participate in any calculation and visualization: like it was removed. But it keeps the general parameters: colors, visibility, etc.

Parameters

theThis	pointer to this object, needed to generate all events if it is necessary
theFlag	makes disabled if it is true

Returns

true if state is really changed

Reimplemented in Model_ResultPart, and Model_ResultBody.

isDisabled()

bool ModelAPI_Result::isDisabled ( )

virtual

Returns the result is disabled or not.

Implements ModelAPI_Object.

initAttributes()

void ModelAPI_Result::initAttributes ( )

virtual

Request for initialization of data model of the result: adding all attributes.

Implements ModelAPI_Object.

Reimplemented in ModelAPI_ResultParameter, Model_ResultPart, Model_ResultParameter, and Model_ResultBody.

shape()

std::shared_ptr< GeomAPI_Shape > ModelAPI_Result::shape ( )

virtual

Returns the shape-result produced by this feature (or null if no shapes)

Reimplemented in ModelAPI_ResultBody, Model_ResultPart, Model_ResultGroup, Model_ResultField, and Model_ResultConstruction.

attributeChanged()

void ModelAPI_Result::attributeChanged ( const std::string &  theID )

virtual

On change of attribute of the result update presentation of this result: for the current moment there are only presentation attributes assigned to results.

Reimplemented from ModelAPI_Object.

init()

void ModelAPI_Result::init ( )

protectedvirtual

This method is called just after creation of the object: it must initialize all fields, normally initialized in the constructor.

Implements ModelAPI_Object.

isInHistory()

bool ModelAPI_Object::isInHistory ( )

virtualinherited

By default object is displayed in the object browser.

Reimplemented in SketchPlugin_Sketch, SketchPlugin_Feature, ParametersPlugin_ParametersMgr, ParametersPlugin_Parameter, Model_ResultConstruction, FiltersPlugin_Selection, FeaturesPlugin_RemoveResults, ExchangePlugin_ExportPart, and ExchangePlugin_ExportFeature.

setInHistory()

void ModelAPI_Object::setInHistory ( const std::shared_ptr< ModelAPI_Object >  theObject, const bool  theFlag  )

virtualinherited

Makes object presented or not in the history of the created objects.

Parameters

theObject	is shared pointer to "this"
theFlag	is boolean value: to add or remove from the history

data()

std::shared_ptr< ModelAPI_Data > ModelAPI_Object::data ( ) const

virtualinherited

Returns the data manager of this object: attributes.

isSame()

bool ModelAPI_Object::isSame ( const std::shared_ptr< ModelAPI_Object > &  theObject )

virtualinherited

Returns true if object refers to the same data model instance.

document()

std::shared_ptr< ModelAPI_Document > ModelAPI_Object::document ( ) const

virtualinherited

Returns document this feature belongs to.

Reimplemented in ModelAPI_Feature, and Model_ResultField::Model_FieldStep.

groupName()

virtual std::string ModelAPI_Object::groupName ( )

pure virtualinherited

Returns the group identifier of this object.

Implemented in ModelAPI_ResultPart, ModelAPI_ResultParameter, ModelAPI_ResultGroup, ModelAPI_ResultField, ModelAPI_ResultField::ModelAPI_FieldStep, ModelAPI_ResultConstruction, ModelAPI_ResultBody, ModelAPI_Folder, and ModelAPI_Feature.

colorConfigInfo()

virtual void ModelAPI_Object::colorConfigInfo ( std::string &  , std::string &  , std::string &    )

inlinevirtualinherited

Returns the parameters of color definition in the resources config manager.

Reimplemented in SketchPlugin_ConstraintRadius, SketchPlugin_ConstraintLength, SketchPlugin_ConstraintDistance, SketchPlugin_ConstraintAngle, Model_ResultPart, Model_ResultGroup, Model_ResultField, Model_ResultConstruction, and Model_ResultBody.

isDisplayed()

bool ModelAPI_Object::isDisplayed ( )

virtualinherited

Returns true if object must be displayed in the viewer: flag is stored in the data model, so on undo/redo, open/save or recreation of object by history-playing it keeps the original state in the current transaction.

Reimplemented in ModelAPI_ResultField::ModelAPI_FieldStep.

setDisplayed()

void ModelAPI_Object::setDisplayed ( const bool  theDisplay )

virtualinherited

Sets the displayed/hidden state of the object.

If it is changed, sends the "redisplay" signal.

Reimplemented in ModelAPI_ResultField, ModelAPI_ResultField::ModelAPI_FieldStep, and ModelAPI_ResultBody.

setData()

void ModelAPI_Object::setData ( std::shared_ptr< ModelAPI_Data >  theData )

protectedvirtualinherited

Sets the data manager of an object (document does)

setDoc()

void ModelAPI_Object::setDoc ( std::shared_ptr< ModelAPI_Document >  theDoc )

protectedvirtualinherited

Sets the data manager of an object (document does)

erase()

void ModelAPI_Object::erase ( )

protectedvirtualinherited

removes all fields from this feature

Reimplemented in SketchPlugin_MultiTranslation, SketchPlugin_MultiRotation, SketchPlugin_ConstraintMirror, PartSetPlugin_Part, ModelAPI_Feature, and ModelAPI_CompositeFeature.

emptyFunction()

virtual void ModelAPI_Entity::emptyFunction ( ) const

inlinevirtualinherited

Empty function which is added for virtualiation of the interface.

Field Documentation

myIsDisabled

bool ModelAPI_Result::myIsDisabled

protected

the result is disabled: removed for the user, but keeps the general info