SHAPER
9.12.0
|
Represents any object in the data model and in the object browser. More...
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 |
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".
ModelAPI_Object::ModelAPI_Object | ( | ) |
Initializes the default states of the object.
|
virtual |
To use virtuality for destructors.
|
virtual |
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.
|
virtual |
Makes object presented or not in the history of the created objects.
theObject | is shared pointer to "this" |
theFlag | is boolean value: to add or remove from the history |
|
virtual |
Returns the data manager of this object: attributes.
|
virtual |
Returns true if object refers to the same data model instance.
|
virtual |
Returns document this feature belongs to.
Reimplemented in ModelAPI_Feature, and Model_ResultField::Model_FieldStep.
|
pure virtual |
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.
|
pure virtual |
Request for initialization of data model of the object: adding all attributes.
Implemented in ModelAPI_ResultParameter, FiltersPlugin_Selection, SketchPlugin_Trim, SketchPlugin_Split, SketchPlugin_SketchEntity, SketchPlugin_SketchDrawer, SketchPlugin_SketchCopy, SketchPlugin_Sketch, SketchPlugin_Offset, SketchPlugin_MultiTranslation, SketchPlugin_MultiRotation, SketchPlugin_MacroEllipticArc, SketchPlugin_MacroEllipse, SketchPlugin_MacroCircle, SketchPlugin_MacroBSpline, SketchPlugin_MacroArc, SketchPlugin_Line, SketchPlugin_Fillet, SketchPlugin_ConstraintVertical, SketchPlugin_ConstraintTangent, SketchPlugin_ConstraintRigid, SketchPlugin_ConstraintRadius, SketchPlugin_ConstraintPerpendicular, SketchPlugin_ConstraintParallel, SketchPlugin_ConstraintMirror, SketchPlugin_ConstraintMiddle, SketchPlugin_ConstraintLength, SketchPlugin_ConstraintHorizontal, SketchPlugin_ConstraintEqual, SketchPlugin_ConstraintDistanceAlongDir, SketchPlugin_ConstraintDistance, SketchPlugin_ConstraintCollinear, SketchPlugin_ConstraintCoincidenceInternal, SketchPlugin_ConstraintCoincidence, SketchPlugin_ConstraintAngle, SamplePanelPlugin_Feature, PrimitivesPlugin_Tube, PrimitivesPlugin_Torus, PrimitivesPlugin_Sphere, PrimitivesPlugin_Cylinder, PrimitivesPlugin_Cone, PrimitivesPlugin_Box, PartSetPlugin_Remove, PartSetPlugin_Part, PartSetPlugin_Duplicate, ParametersPlugin_ParametersMgr, ParametersPlugin_Parameter, ModelAPI_ResultField::ModelAPI_FieldStep, ModelAPI_Result, ModelAPI_Folder, Model_ResultPart, Model_ResultParameter, Model_ResultBody, Model_SelectionInPartFeature, GDMLPlugin_Ellipsoid, GDMLPlugin_ConeSegment, FeaturesPlugin_Union, FeaturesPlugin_Translation, FeaturesPlugin_Symmetry, FeaturesPlugin_SharedFaces, FeaturesPlugin_Sewing, FeaturesPlugin_Scale, FeaturesPlugin_Rotation, FeaturesPlugin_RevolutionBoolean, FeaturesPlugin_Revolution, FeaturesPlugin_RemoveSubShapes, FeaturesPlugin_RemoveResults, FeaturesPlugin_Recover, FeaturesPlugin_PointCoordinates, FeaturesPlugin_PointCloudOnFace, FeaturesPlugin_Placement, FeaturesPlugin_Pipe, FeaturesPlugin_Partition, FeaturesPlugin_NormalToFace, FeaturesPlugin_MultiTranslation, FeaturesPlugin_MultiRotation, FeaturesPlugin_Measurement, FeaturesPlugin_Loft, FeaturesPlugin_LimitTolerance, FeaturesPlugin_Intersection, FeaturesPlugin_InspectNormalToFace, FeaturesPlugin_InspectBoundingBox, FeaturesPlugin_ImportResult, FeaturesPlugin_GroupSharedFaces, FeaturesPlugin_GlueFaces, FeaturesPlugin_GeometryCalculation, FeaturesPlugin_FusionFaces, FeaturesPlugin_Fillet1D, FeaturesPlugin_Fillet, FeaturesPlugin_ExtrusionBoolean, FeaturesPlugin_Extrusion, FeaturesPlugin_Defeaturing, FeaturesPlugin_Copy, FeaturesPlugin_Chamfer, FeaturesPlugin_BoundingBox, FeaturesPlugin_BooleanSmash, FeaturesPlugin_BooleanFuse, FeaturesPlugin_BooleanFill, FeaturesPlugin_BooleanCut, FeaturesPlugin_BooleanCommon, FeaturesPlugin_Boolean, ExchangePlugin_ImportPart, ExchangePlugin_ImportFeature, ExchangePlugin_ImportFeatureBase, ExchangePlugin_Import, ExchangePlugin_ImportBase, ExchangePlugin_ExportPart, ExchangePlugin_ExportFeature, ExchangePlugin_Dump, ConstructionPlugin_Point, ConstructionPlugin_Plane, ConstructionPlugin_Axis, CollectionPlugin_GroupSubstraction, CollectionPlugin_GroupMerge, CollectionPlugin_GroupIntersection, CollectionPlugin_Group, CollectionPlugin_Field, BuildPlugin_Wire, BuildPlugin_Vertex, BuildPlugin_SubShapes, BuildPlugin_Solid, BuildPlugin_Shell, BuildPlugin_Polyline, BuildPlugin_Interpolation, BuildPlugin_Filling, BuildPlugin_Face, BuildPlugin_Edge, BuildPlugin_CompSolid, and BuildPlugin_Compound.
|
pure virtual |
Returns the feature is disabled or not.
Implemented in ModelAPI_ResultField::ModelAPI_FieldStep, ModelAPI_Result, ModelAPI_Folder, and ModelAPI_Feature.
|
inlinevirtual |
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.
|
virtual |
Called on change of any argument-attribute of this object.
theID | identifier of changed attribute |
Reimplemented in ExchangePlugin_ImportBase, ExchangePlugin_Import_Image, ExchangePlugin_Import, SketchPlugin_Sketch, SketchPlugin_Projection, SketchPlugin_Point, SketchPlugin_Offset, SketchPlugin_MultiTranslation, SketchPlugin_MultiRotation, SketchPlugin_MacroEllipticArc, SketchPlugin_MacroEllipse, SketchPlugin_MacroCircle, SketchPlugin_MacroArc, SketchPlugin_Line, SketchPlugin_IntersectionPoint, SketchPlugin_EllipticArc, SketchPlugin_Ellipse, SketchPlugin_ConstraintRadius, SketchPlugin_ConstraintMirror, SketchPlugin_ConstraintMiddle, SketchPlugin_ConstraintLength, SketchPlugin_ConstraintDistanceAlongDir, SketchPlugin_ConstraintDistance, SketchPlugin_ConstraintAngle, SketchPlugin_Circle, SketchPlugin_BSplineBase, SketchPlugin_BSpline, SketchPlugin_Arc, ParametersPlugin_Parameter, ModelAPI_Result, FeaturesPlugin_SharedFaces, FeaturesPlugin_RemoveSubShapes, FeaturesPlugin_Recover, FeaturesPlugin_PointCoordinates, FeaturesPlugin_PointCloudOnFace, FeaturesPlugin_NormalToFace, FeaturesPlugin_Measurement, FeaturesPlugin_InspectNormalToFace, FeaturesPlugin_InspectBoundingBox, FeaturesPlugin_GroupSharedFaces, FeaturesPlugin_GeometryCalculation, FeaturesPlugin_Fillet1D, FeaturesPlugin_BoundingBox, ExchangePlugin_ImportPart, ExchangePlugin_ExportFeature, BuildPlugin_SubShapes, BuildPlugin_Interpolation, and BuildPlugin_Filling.
|
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.
|
virtual |
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.
|
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_ResultField::ModelAPI_FieldStep, ModelAPI_Result, ModelAPI_Folder, and ModelAPI_Feature.
|
protectedvirtual |
Sets the data manager of an object (document does)
|
protectedvirtual |
Sets the data manager of an object (document does)
|
protectedvirtual |
removes all fields from this feature
Reimplemented in SketchPlugin_MultiTranslation, SketchPlugin_MultiRotation, SketchPlugin_ConstraintMirror, PartSetPlugin_Part, ModelAPI_Feature, and ModelAPI_CompositeFeature.
|
inlinevirtualinherited |
Empty function which is added for virtualiation of the interface.