Represents any object in the data model and in the object browser. More...

#include <ModelAPI_Object.h>

Inheritance diagram for ModelAPI_Object:

Public Member Functions
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	initAttributes ()=0
	Request for initialization of data model of the object: adding all attributes. More...

virtual bool	isDisabled ()=0
	Returns the feature is disabled or not. More...

virtual void	colorConfigInfo (std::string &, std::string &, std::string &)
	Returns the parameters of color definition in the resources config manager. More...

virtual void	attributeChanged (const std::string &theID)
	Called on change of any argument-attribute of this object. More...

	ModelAPI_Object ()
	Initializes the default states of the object. More...

virtual	~ModelAPI_Object ()
	To use virtuality for destructors. 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...

Protected Member Functions
virtual void	init ()=0
	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...

Friends
class	Model_Objects

class	ModelAPI_Feature

class	Model_Document

Detailed Description

Represents any object in the data model and in the object browser.

It may be feature or result of the feature. User just may set name for it or change this name later. Generic class for Feature, Body, Parameter and other objects related to the features and their results. Contains attributes of this object in the "Data".

Constructor & Destructor Documentation

◆ ModelAPI_Object()

ModelAPI_Object::ModelAPI_Object ( )

Initializes the default states of the object.

◆ ~ModelAPI_Object()

ModelAPI_Object::~ModelAPI_Object ( )

virtual

To use virtuality for destructors.

Member Function Documentation

◆ isInHistory()

bool ModelAPI_Object::isInHistory ( )

virtual

By default object is displayed in the object browser.

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

◆ setInHistory()

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

virtual

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

virtual

Returns the data manager of this object: attributes.

◆ isSame()

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

virtual

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

◆ document()

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

virtual

Returns document this feature belongs to.

Reimplemented in Model_ResultField::Model_FieldStep, and ModelAPI_Feature.

◆ groupName()

virtual std::string ModelAPI_Object::groupName ( )

pure virtual

Returns the group identifier of this object.

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

◆ initAttributes()

virtual void ModelAPI_Object::initAttributes ( )

pure virtual

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

◆ isDisabled()

virtual bool ModelAPI_Object::isDisabled ( )

pure virtual

Returns the feature is disabled or not.

Implemented in ModelAPI_Feature, ModelAPI_Folder, ModelAPI_Result, and ModelAPI_ResultField::ModelAPI_FieldStep.

◆ colorConfigInfo()

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

inlinevirtual

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

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

◆ attributeChanged()

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

virtual

Called on change of any argument-attribute of this object.

Parameters

theID identifier of changed attribute

Reimplemented in BuildPlugin_Filling, BuildPlugin_Interpolation, BuildPlugin_SubShapes, ExchangePlugin_ExportFeature, ExchangePlugin_ImportPart, FeaturesPlugin_BoundingBox, FeaturesPlugin_Fillet1D, FeaturesPlugin_GeometryCalculation, FeaturesPlugin_GroupSharedFaces, FeaturesPlugin_InspectBoundingBox, FeaturesPlugin_InspectNormalToFace, FeaturesPlugin_Measurement, FeaturesPlugin_NormalToFace, FeaturesPlugin_PointCloudOnFace, FeaturesPlugin_PointCoordinates, FeaturesPlugin_Recover, FeaturesPlugin_RemoveSubShapes, FeaturesPlugin_SharedFaces, FeaturesPlugin_Thickness, ModelAPI_Result, ParametersPlugin_Parameter, SketchPlugin_Arc, SketchPlugin_BSpline, SketchPlugin_BSplineBase, SketchPlugin_Circle, SketchPlugin_ConstraintAngle, SketchPlugin_ConstraintDistance, SketchPlugin_ConstraintDistanceAlongDir, SketchPlugin_ConstraintLength, SketchPlugin_ConstraintMiddle, SketchPlugin_ConstraintMirror, SketchPlugin_ConstraintRadius, SketchPlugin_Ellipse, SketchPlugin_EllipticArc, SketchPlugin_IntersectionPoint, SketchPlugin_Line, SketchPlugin_MacroArc, SketchPlugin_MacroCircle, SketchPlugin_MacroEllipse, SketchPlugin_MacroEllipticArc, SketchPlugin_MultiRotation, SketchPlugin_MultiTranslation, SketchPlugin_Offset, SketchPlugin_Point, SketchPlugin_Projection, SketchPlugin_Sketch, ExchangePlugin_Import, ExchangePlugin_Import_Image, and ExchangePlugin_ImportBase.

◆ isDisplayed()

bool ModelAPI_Object::isDisplayed ( )

virtual

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 )

virtual

Sets the displayed/hidden state of the object.

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

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

◆ hasTexture()

virtual bool ModelAPI_Object::hasTexture ( )

inlinevirtual

Reimplemented in Model_ResultBody.

◆ init()

virtual void ModelAPI_Object::init ( )

protectedpure virtual

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

Implemented in ModelAPI_Feature, ModelAPI_Folder, ModelAPI_Result, and ModelAPI_ResultField::ModelAPI_FieldStep.

◆ setData()

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

protectedvirtual

Sets the data manager of an object (document does)

◆ setDoc()

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

protectedvirtual

Sets the data manager of an object (document does)

◆ erase()

void ModelAPI_Object::erase ( )

protectedvirtual

removes all fields from this feature

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

◆ emptyFunction()

virtual void ModelAPI_Entity::emptyFunction ( ) const

inlinevirtualinherited

Empty function which is added for virtualiation of the interface.

Public Member Functions

Protected Member Functions

Friends

Detailed Description

Constructor & Destructor Documentation

◆ ModelAPI_Object()

◆ ~ModelAPI_Object()

Member Function Documentation

◆ isInHistory()

◆ setInHistory()

◆ data()

◆ isSame()

◆ document()

◆ groupName()

◆ initAttributes()

◆ isDisabled()

◆ colorConfigInfo()

◆ attributeChanged()

◆ isDisplayed()

◆ setDisplayed()

◆ hasTexture()

◆ init()

◆ setData()

◆ setDoc()

◆ erase()

◆ emptyFunction()