SHAPER  9.12.0
SketchPlugin_Sketch Class Reference

Feature for creation of the new part in PartSet. More...

Inheritance diagram for SketchPlugin_Sketch:
Inheritance graph

Public Member Functions

virtual const std::string & getKind ()
 Returns the kind of a feature. More...
 
virtual void execute ()
 Creates a new part document if needed. More...
 
virtual void initAttributes ()
 Request for initialization of data model of the feature: adding all attributes. More...
 
std::shared_ptr< GeomAPI_Pntto3D (const double theX, const double theY) const
 Converts a 2D sketch space point into point in 3D space. More...
 
std::shared_ptr< GeomAPI_Pnt2dto2D (const std::shared_ptr< GeomAPI_Pnt > &thePnt) const
 Returns the point projected into the sketch plane. More...
 
virtual bool isInHistory ()
 Returns true if this feature must be displayed in the history (top level of Part tree) More...
 
 SketchPlugin_Sketch ()
 Use plugin manager for features creation. More...
 
std::shared_ptr< GeomAPI_Plnplane () const
 Returns the basis plane for the sketch. More...
 
std::shared_ptr< GeomAPI_Ax3coordinatePlane () const
 Returns currently defined plane as an object of Ax3. More...
 
bool isPlaneSet () const
 Checks whether the plane is set in the sketch. More...
 
virtual std::shared_ptr< ModelAPI_FeatureaddFeature (std::string theID)
 appends a feature to the sketch sub-elements container More...
 
virtual void removeFeature (std::shared_ptr< ModelAPI_Feature > theFeature)
 Just to synchronise the container of sub-features. More...
 
virtual int numberOfSubs (bool forTree=false) const
 Returns the number of sub-elements. More...
 
virtual std::shared_ptr< ModelAPI_FeaturesubFeature (const int theIndex, bool forTree=false)
 Returns the sub-feature by zero-base index. More...
 
virtual int subFeatureId (const int theIndex) const
 Returns the sub-feature unique identifier in this composite feature by index. More...
 
virtual bool isSub (ObjectPtr theObject) const
 Returns true if feature or reuslt belong to this composite feature as subs. More...
 
virtual void attributeChanged (const std::string &theID)
 Called on change of any argument-attribute of this object. More...
 
virtual bool customAction (const std::string &theActionId)
 Performs some custom feature specific functionality (normally called by some GUI button) More...
 
virtual void erase ()
 in addition removes all subs More...
 
virtual std::shared_ptr< ModelAPI_Documentdocument () const
 Returns document this feature belongs to. More...
 
std::shared_ptr< ModelAPI_AttributeDocRefdocument (const std::string &theID)
 Returns the document reference attribute. More...
 
virtual std::string groupName ()
 Returns the group identifier of this result. More...
 
virtual bool compute (const std::string &)
 Computes the attribute value on the base of other attributes if the value can be computed. More...
 
virtual MODELAPI_EXPORT void setError (const std::string &theError, bool isSend=true, bool isTranslate=true)
 Registers error during the execution, causes the ExecutionFailed state. More...
 
virtual std::string error () const
 Returns error, arose during the execution. More...
 
MODELAPI_EXPORT const std::list< std::shared_ptr< ModelAPI_Result > > & results ()
 returns the current results of the feature More...
 
MODELAPI_EXPORT std::shared_ptr< ModelAPI_ResultfirstResult () const
 returns the first result in the list or NULL reference More...
 
MODELAPI_EXPORT std::shared_ptr< ModelAPI_ResultlastResult ()
 returns the last result in the list or NULL reference More...
 
MODELAPI_EXPORT void setResult (const std::shared_ptr< ModelAPI_Result > &theResult)
 sets the alone result More...
 
MODELAPI_EXPORT void setResult (const std::shared_ptr< ModelAPI_Result > &theResult, const int theIndex)
 sets the result by index (zero based), results before this must be set before More...
 
MODELAPI_EXPORT void removeResults (const int theSinceIndex, const bool theForever=true, const bool theFlush=true)
 removes all results starting from the given index (zero-based) More...
 
MODELAPI_EXPORT void eraseResults (const bool theForever=true)
 removes all results from the feature More...
 
MODELAPI_EXPORT void eraseResultFromList (const std::shared_ptr< ModelAPI_Result > &theResult)
 removes the result from the list of feature (not doing in disabled): normally this method is not used from features. More...
 
virtual bool isPersistentResult ()
 Returns true if result is persistent (stored in document) and on undo-redo, save-open it is not needed to recompute it. More...
 
virtual bool isAction ()
 Returns true if this feature must not be created: this is just an action that is not stored in the features history and data model (like "delete part"). More...
 
virtual MODELAPI_EXPORT bool isMacro () const
 Returns true if this feature is used as macro: creates other features and then removed. More...
 
virtual MODELAPI_EXPORT bool isPreviewNeeded () const
 Returns true if preview update during the edition needed. More...
 
virtual MODELAPI_EXPORT const std::string & documentToAdd ()
 Must return document where the new feature must be added to By default it is empty: it is added to the document this method is called to. More...
 
virtual MODELAPI_EXPORT bool setDisabled (const bool theFlag)
 Enables/disables the feature. More...
 
virtual MODELAPI_EXPORT bool isDisabled ()
 Returns the feature is disabled or not. More...
 
virtual MODELAPI_EXPORT bool setStable (const bool theFlag)
 Set the stable feature flag. More...
 
virtual MODELAPI_EXPORT bool isStable ()
 Returns the feature is stable or not. More...
 
virtual MODELAPI_EXPORT bool isEditable ()
 Returns the feature is editable or not. Most of features are editable. More...
 
std::wstring name ()
 Returns the name stored in the attribute. More...
 
std::shared_ptr< ModelAPI_AttributeBooleanboolean (const std::string &theID)
 Returns the Boolean attribute by the identifier. More...
 
std::shared_ptr< ModelAPI_AttributeDoublereal (const std::string &theID)
 Returns the real attribute by the identifier. More...
 
std::shared_ptr< ModelAPI_AttributeIntegerinteger (const std::string &theID)
 Returns the integer attribute by the identifier. More...
 
std::shared_ptr< ModelAPI_AttributeIntArrayintArray (const std::string &theID)
 Returns the integer array attribute by the identifier. More...
 
std::shared_ptr< ModelAPI_AttributeRefAttrrefattr (const std::string &theID)
 Returns the reference attribute by the identifier. More...
 
std::shared_ptr< ModelAPI_AttributeRefAttrListrefattrlist (const std::string &theID)
 Returns the refattrlist attribute by the identifier. More...
 
std::shared_ptr< ModelAPI_AttributeReferencereference (const std::string &theID)
 Returns the reference attribute by the identifier. More...
 
std::shared_ptr< ModelAPI_AttributeRefListreflist (const std::string &theID)
 Returns the list of references attribute by the identifier. More...
 
std::shared_ptr< ModelAPI_AttributeSelectionselection (const std::string &theID)
 Returns the shape selection attribute by the identifier. More...
 
std::shared_ptr< ModelAPI_AttributeSelectionListselectionList (const std::string &theID)
 Returns the list of shape selections attribute by the identifier. More...
 
std::shared_ptr< ModelAPI_AttributeStringstring (const std::string &theID)
 Returns the string attribute by the identifier. More...
 
std::shared_ptr< ModelAPI_AttributeStringArraystringArray (const std::string &theID)
 Returns the string array attribute by the identifier. More...
 
std::shared_ptr< ModelAPI_AttributeTablestables (const std::string &theID)
 Returns the tables attribute by the identifier. More...
 
std::shared_ptr< ModelAPI_Attributeattribute (const std::string &theID)
 Returns the attribute by the identifier. 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_Datadata () 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 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 & ID ()
 Sketch feature kind. More...
 
static const std::string & ORIGIN_ID ()
 Origin point of the sketcher in 3D space. More...
 
static const std::string & DIRX_ID ()
 Vector X inside of the sketch plane. More...
 
static const std::string & NORM_ID ()
 Vector Z, normal to the sketch plane. More...
 
static const std::string & FEATURES_ID ()
 All features of this sketch (list of references) More...
 
static const std::string & SOLVER_ERROR ()
 Sketch solver error. More...
 
static const std::string & SOLVER_DOF ()
 Sketch solver error. More...
 
static const std::string & ACTION_REMOVE_EXTERNAL ()
 Action ID to remove links to external entities while changing the sketch plane. More...
 
static void createPoint2DResult (ModelAPI_Feature *theFeature, SketchPlugin_Sketch *theSketch, const std::string &theAttributeID, const int theIndex)
 Create a result for the point in the attribute if the attribute is initialized. More...
 
static void createLine2DResult (ModelAPI_Feature *theFeature, SketchPlugin_Sketch *theSketch, const std::string &theStartAttrID, const std::string &theEndAttrID, const int theIndex=0)
 Create a result for the segment given by a pair of attributes. More...
 
static FeaturePtr addUniqueNamedCopiedFeature (FeaturePtr theFeature, SketchPlugin_Sketch *theSketch, const bool theIsCopy=false)
 Add new feature and fill the data of the feature by the data of the parameter feature. More...
 
static std::shared_ptr< GeomAPI_Ax3plane (SketchPlugin_Sketch *theSketch)
 Creates a plane of the sketch. More...
 
static std::string group ()
 Returns the group identifier of all features. More...
 
static MODELAPI_EXPORT std::shared_ptr< ModelAPI_Featurefeature (ObjectPtr theObject)
 Returns the feature by the object (result). More...
 

Protected Member Functions

virtual MODELAPI_EXPORT 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...
 

Detailed Description

Feature for creation of the new part in PartSet.

Constructor & Destructor Documentation

◆ SketchPlugin_Sketch()

SketchPlugin_Sketch::SketchPlugin_Sketch ( )

Use plugin manager for features creation.

Member Function Documentation

◆ ID()

static const std::string& SketchPlugin_Sketch::ID ( )
inlinestatic

Sketch feature kind.

◆ ORIGIN_ID()

static const std::string& SketchPlugin_Sketch::ORIGIN_ID ( )
inlinestatic

Origin point of the sketcher in 3D space.

◆ DIRX_ID()

static const std::string& SketchPlugin_Sketch::DIRX_ID ( )
inlinestatic

Vector X inside of the sketch plane.

◆ NORM_ID()

static const std::string& SketchPlugin_Sketch::NORM_ID ( )
inlinestatic

Vector Z, normal to the sketch plane.

◆ FEATURES_ID()

static const std::string& SketchPlugin_Sketch::FEATURES_ID ( )
inlinestatic

All features of this sketch (list of references)

◆ SOLVER_ERROR()

static const std::string& SketchPlugin_Sketch::SOLVER_ERROR ( )
inlinestatic

Sketch solver error.

◆ SOLVER_DOF()

static const std::string& SketchPlugin_Sketch::SOLVER_DOF ( )
inlinestatic

Sketch solver error.

◆ ACTION_REMOVE_EXTERNAL()

static const std::string& SketchPlugin_Sketch::ACTION_REMOVE_EXTERNAL ( )
inlinestatic

Action ID to remove links to external entities while changing the sketch plane.

◆ getKind()

virtual const std::string& SketchPlugin_Sketch::getKind ( )
inlinevirtual

Returns the kind of a feature.

Implements ModelAPI_Feature.

◆ execute()

void SketchPlugin_Sketch::execute ( )
virtual

Creates a new part document if needed.

Implements ModelAPI_Feature.

◆ initAttributes()

void SketchPlugin_Sketch::initAttributes ( )
virtual

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

Implements ModelAPI_Object.

◆ to3D()

std::shared_ptr<GeomAPI_Pnt> SketchPlugin_Sketch::to3D ( const double  theX,
const double  theY 
) const
inline

Converts a 2D sketch space point into point in 3D space.

Parameters
theXan X coordinate
theYan Y coordinate

◆ to2D()

std::shared_ptr<GeomAPI_Pnt2d> SketchPlugin_Sketch::to2D ( const std::shared_ptr< GeomAPI_Pnt > &  thePnt) const
inline

Returns the point projected into the sketch plane.

Parameters
thePnta source 3d point

◆ isInHistory()

virtual bool SketchPlugin_Sketch::isInHistory ( )
inlinevirtual

Returns true if this feature must be displayed in the history (top level of Part tree)

Reimplemented from ModelAPI_Object.

◆ plane() [1/2]

std::shared_ptr<GeomAPI_Pln> SketchPlugin_Sketch::plane ( ) const
inline

Returns the basis plane for the sketch.

◆ coordinatePlane()

std::shared_ptr<GeomAPI_Ax3> SketchPlugin_Sketch::coordinatePlane ( ) const
inline

Returns currently defined plane as an object of Ax3.

◆ isPlaneSet()

bool SketchPlugin_Sketch::isPlaneSet ( ) const
inline

Checks whether the plane is set in the sketch.

Returns
the boolean state

◆ addFeature()

std::shared_ptr< ModelAPI_Feature > SketchPlugin_Sketch::addFeature ( std::string  theID)
virtual

appends a feature to the sketch sub-elements container

Implements ModelAPI_CompositeFeature.

◆ removeFeature()

void SketchPlugin_Sketch::removeFeature ( std::shared_ptr< ModelAPI_Feature theFeature)
virtual

Just to synchronise the container of sub-features.

Implements ModelAPI_CompositeFeature.

◆ numberOfSubs()

int SketchPlugin_Sketch::numberOfSubs ( bool  forTree = false) const
virtual

Returns the number of sub-elements.

Implements ModelAPI_CompositeFeature.

◆ subFeature()

std::shared_ptr< ModelAPI_Feature > SketchPlugin_Sketch::subFeature ( const int  theIndex,
bool  forTree = false 
)
virtual

Returns the sub-feature by zero-base index.

Implements ModelAPI_CompositeFeature.

◆ subFeatureId()

int SketchPlugin_Sketch::subFeatureId ( const int  theIndex) const
virtual

Returns the sub-feature unique identifier in this composite feature by index.

Implements ModelAPI_CompositeFeature.

◆ isSub()

bool SketchPlugin_Sketch::isSub ( ObjectPtr  theObject) const
virtual

Returns true if feature or reuslt belong to this composite feature as subs.

Implements ModelAPI_CompositeFeature.

◆ attributeChanged()

void SketchPlugin_Sketch::attributeChanged ( const std::string &  theID)
virtual

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

Parameters
theIDidentifier of changed attribute

Reimplemented from ModelAPI_Object.

◆ customAction()

bool SketchPlugin_Sketch::customAction ( const std::string &  theActionId)
virtual

Performs some custom feature specific functionality (normally called by some GUI button)

Parameters
theActionIdan action key
Returns
a boolean value about it is performed

Reimplemented from ModelAPI_Feature.

◆ createPoint2DResult()

void SketchPlugin_Sketch::createPoint2DResult ( ModelAPI_Feature theFeature,
SketchPlugin_Sketch theSketch,
const std::string &  theAttributeID,
const int  theIndex 
)
static

Create a result for the point in the attribute if the attribute is initialized.

Parameters
theFeaturea source feature
theSketcha sketch intance
theAttributeIDan attribute string
theIndexan index of the result

◆ createLine2DResult()

void SketchPlugin_Sketch::createLine2DResult ( ModelAPI_Feature theFeature,
SketchPlugin_Sketch theSketch,
const std::string &  theStartAttrID,
const std::string &  theEndAttrID,
const int  theIndex = 0 
)
static

Create a result for the segment given by a pair of attributes.

Parameters
theFeaturea source feature
theSketcha sketch intance
theStartAttrIDan attribute string
theEndAttrIDan attribute string
theIndexan index of the result

◆ addUniqueNamedCopiedFeature()

FeaturePtr SketchPlugin_Sketch::addUniqueNamedCopiedFeature ( FeaturePtr  theFeature,
SketchPlugin_Sketch theSketch,
const bool  theIsCopy = false 
)
static

Add new feature and fill the data of the feature by the data of the parameter feature.

The name of the created feature stays unique.

Parameters
theFeaturea source feature
theSketcha sketch intance
theIsCopyif true sets feature copy attribute to true.
Returns
a created feature

◆ plane() [2/2]

std::shared_ptr< GeomAPI_Ax3 > SketchPlugin_Sketch::plane ( SketchPlugin_Sketch theSketch)
static

Creates a plane of the sketch.

Parameters
theSketcha sketch intance

◆ erase()

void ModelAPI_CompositeFeature::erase ( )
virtualinherited

in addition removes all subs

Reimplemented from ModelAPI_Feature.

Reimplemented in PartSetPlugin_Part.

◆ group()

static std::string ModelAPI_Feature::group ( )
inlinestaticinherited

Returns the group identifier of all features.

◆ document() [1/2]

virtual std::shared_ptr<ModelAPI_Document> ModelAPI_Feature::document ( ) const
inlinevirtualinherited

Returns document this feature belongs to.

Reimplemented from ModelAPI_Object.

◆ document() [2/2]

std::shared_ptr<ModelAPI_AttributeDocRef> ModelAPI_Feature::document ( const std::string &  theID)
inlineinherited

Returns the document reference attribute.

◆ groupName()

virtual std::string ModelAPI_Feature::groupName ( )
inlinevirtualinherited

Returns the group identifier of this result.

Implements ModelAPI_Object.

◆ compute()

virtual bool ModelAPI_Feature::compute ( const std::string &  )
inlinevirtualinherited

Computes the attribute value on the base of other attributes if the value can be computed.

Parameters
theAttributeIdan attribute index to be computed
Returns
a boolean value about it is computed

Reimplemented in SketchPlugin_ConstraintRadius, SketchPlugin_ConstraintLength, and SketchPlugin_ConstraintAngle.

◆ setError()

void ModelAPI_Feature::setError ( const std::string &  theError,
bool  isSend = true,
bool  isTranslate = true 
)
virtualinherited

Registers error during the execution, causes the ExecutionFailed state.

◆ error()

virtual std::string ModelAPI_Feature::error ( ) const
inlinevirtualinherited

Returns error, arose during the execution.

◆ results()

const std::list< std::shared_ptr< ModelAPI_Result > > & ModelAPI_Feature::results ( )
inherited

returns the current results of the feature

◆ firstResult()

std::shared_ptr< ModelAPI_Result > ModelAPI_Feature::firstResult ( ) const
inherited

returns the first result in the list or NULL reference

◆ lastResult()

std::shared_ptr< ModelAPI_Result > ModelAPI_Feature::lastResult ( )
inherited

returns the last result in the list or NULL reference

◆ setResult() [1/2]

void ModelAPI_Feature::setResult ( const std::shared_ptr< ModelAPI_Result > &  theResult)
inherited

sets the alone result

◆ setResult() [2/2]

void ModelAPI_Feature::setResult ( const std::shared_ptr< ModelAPI_Result > &  theResult,
const int  theIndex 
)
inherited

sets the result by index (zero based), results before this must be set before

◆ removeResults()

void ModelAPI_Feature::removeResults ( const int  theSinceIndex,
const bool  theForever = true,
const bool  theFlush = true 
)
inherited

removes all results starting from the given index (zero-based)

Parameters
theSinceIndex- index of the deleted result and all after also will be deleted
theForever- removes results for long period (not just because of feature disabling)
theFlush- if it is false, REDISPLAY message is not flushed

◆ eraseResults()

void ModelAPI_Feature::eraseResults ( const bool  theForever = true)
inherited

removes all results from the feature

◆ eraseResultFromList()

void ModelAPI_Feature::eraseResultFromList ( const std::shared_ptr< ModelAPI_Result > &  theResult)
inherited

removes the result from the list of feature (not doing in disabled): normally this method is not used from features.

only internally

◆ isPersistentResult()

virtual bool ModelAPI_Feature::isPersistentResult ( )
inlinevirtualinherited

Returns true if result is persistent (stored in document) and on undo-redo, save-open it is not needed to recompute it.

Reimplemented in ParametersPlugin_ParametersMgr, CollectionPlugin_GroupOperation, CollectionPlugin_Group, and CollectionPlugin_Field.

◆ isAction()

virtual bool ModelAPI_Feature::isAction ( )
inlinevirtualinherited

Returns true if this feature must not be created: this is just an action that is not stored in the features history and data model (like "delete part").

Reimplemented in PartSetPlugin_Remove, and PartSetPlugin_Duplicate.

◆ isMacro()

◆ isPreviewNeeded()

◆ documentToAdd()

const std::string & ModelAPI_Feature::documentToAdd ( )
virtualinherited

Must return document where the new feature must be added to By default it is empty: it is added to the document this method is called to.

Reimplemented in PartSetPlugin_Part.

◆ setDisabled()

bool ModelAPI_Feature::setDisabled ( const bool  theFlag)
virtualinherited

Enables/disables the feature.

The disabled feature has no results and does not participate in any calculation.

Returns
true if state is really changed

◆ isDisabled()

bool ModelAPI_Feature::isDisabled ( )
virtualinherited

Returns the feature is disabled or not.

Implements ModelAPI_Object.

◆ feature()

FeaturePtr ModelAPI_Feature::feature ( ObjectPtr  theObject)
staticinherited

Returns the feature by the object (result).

◆ setStable()

bool ModelAPI_Feature::setStable ( const bool  theFlag)
virtualinherited

Set the stable feature flag.

If feature is currently editing then it is not stable.

Returns
true if state is really changed

◆ isStable()

bool ModelAPI_Feature::isStable ( )
virtualinherited

Returns the feature is stable or not.

◆ isEditable()

bool ModelAPI_Feature::isEditable ( )
virtualinherited

Returns the feature is editable or not. Most of features are editable.

Reimplemented in ExchangePlugin_ImportFeature.

◆ name()

std::wstring ModelAPI_Feature::name ( )
inlineinherited

Returns the name stored in the attribute.

◆ boolean()

std::shared_ptr<ModelAPI_AttributeBoolean> ModelAPI_Feature::boolean ( const std::string &  theID)
inlineinherited

Returns the Boolean attribute by the identifier.

◆ real()

std::shared_ptr<ModelAPI_AttributeDouble> ModelAPI_Feature::real ( const std::string &  theID)
inlineinherited

Returns the real attribute by the identifier.

◆ integer()

std::shared_ptr<ModelAPI_AttributeInteger> ModelAPI_Feature::integer ( const std::string &  theID)
inlineinherited

Returns the integer attribute by the identifier.

◆ intArray()

std::shared_ptr<ModelAPI_AttributeIntArray> ModelAPI_Feature::intArray ( const std::string &  theID)
inlineinherited

Returns the integer array attribute by the identifier.

◆ refattr()

std::shared_ptr<ModelAPI_AttributeRefAttr> ModelAPI_Feature::refattr ( const std::string &  theID)
inlineinherited

Returns the reference attribute by the identifier.

◆ refattrlist()

std::shared_ptr<ModelAPI_AttributeRefAttrList> ModelAPI_Feature::refattrlist ( const std::string &  theID)
inlineinherited

Returns the refattrlist attribute by the identifier.

◆ reference()

std::shared_ptr<ModelAPI_AttributeReference> ModelAPI_Feature::reference ( const std::string &  theID)
inlineinherited

Returns the reference attribute by the identifier.

◆ reflist()

std::shared_ptr<ModelAPI_AttributeRefList> ModelAPI_Feature::reflist ( const std::string &  theID)
inlineinherited

Returns the list of references attribute by the identifier.

◆ selection()

std::shared_ptr<ModelAPI_AttributeSelection> ModelAPI_Feature::selection ( const std::string &  theID)
inlineinherited

Returns the shape selection attribute by the identifier.

◆ selectionList()

std::shared_ptr<ModelAPI_AttributeSelectionList> ModelAPI_Feature::selectionList ( const std::string &  theID)
inlineinherited

Returns the list of shape selections attribute by the identifier.

◆ string()

std::shared_ptr<ModelAPI_AttributeString> ModelAPI_Feature::string ( const std::string &  theID)
inlineinherited

Returns the string attribute by the identifier.

◆ stringArray()

std::shared_ptr<ModelAPI_AttributeStringArray> ModelAPI_Feature::stringArray ( const std::string &  theID)
inlineinherited

Returns the string array attribute by the identifier.

◆ tables()

std::shared_ptr<ModelAPI_AttributeTables> ModelAPI_Feature::tables ( const std::string &  theID)
inlineinherited

Returns the tables attribute by the identifier.

◆ attribute()

std::shared_ptr<ModelAPI_Attribute> ModelAPI_Feature::attribute ( const std::string &  theID)
inlineinherited

Returns the attribute by the identifier.

◆ init()

void ModelAPI_Feature::init ( )
protectedvirtualinherited

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

Implements ModelAPI_Object.

◆ 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
theObjectis shared pointer to "this"
theFlagis 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.

◆ colorConfigInfo()

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

◆ 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)

◆ emptyFunction()

virtual void ModelAPI_Entity::emptyFunction ( ) const
inlinevirtualinherited

Empty function which is added for virtualiation of the interface.