SHAPER  9.12.0
ModelAPI_Folder Class Reference

Folder feature (groups the features). More...

Inheritance diagram for ModelAPI_Folder:
Inheritance graph

Public Member Functions

virtual MODELAPI_EXPORT ~ModelAPI_Folder ()
 To virtually destroy the fields of successors. More...
 
virtual std::string groupName ()
 Returns the group identifier of this result. More...
 
virtual MODELAPI_EXPORT void initAttributes ()
 Request for initialization of data model of the object: adding all attributes. More...
 
virtual MODELAPI_EXPORT void execute ()
 Computes or recomputes the results. More...
 
virtual bool isDisabled ()
 Returns the feature is disabled or not. More...
 
std::wstring name ()
 Returns the name stored in the attribute. More...
 
std::shared_ptr< ModelAPI_AttributeReferencereference (const std::string &theID)
 Returns the reference attribute by the identifier. More...
 
MODELAPI_EXPORT std::shared_ptr< ModelAPI_FeaturelastVisibleFeature ()
 Returns the last visible feature in the folder, passing through invisible, that may appear as the last ones. 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_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 std::shared_ptr< ModelAPI_Documentdocument () const
 Returns document this feature belongs to. 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...
 
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 ()
 Folder feature ID. More...
 
static std::string group ()
 Returns the group identifier of all features. More...
 
static const std::string & FIRST_FEATURE_ID ()
 Attribute referring first feature in the folder. More...
 
static const std::string & LAST_FEATURE_ID ()
 Attribute referring last feature in the folder. 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...
 
virtual void erase ()
 removes all fields from this feature More...
 

Detailed Description

Folder feature (groups the features).

Constructor & Destructor Documentation

◆ ~ModelAPI_Folder()

ModelAPI_Folder::~ModelAPI_Folder ( )
virtual

To virtually destroy the fields of successors.

Member Function Documentation

◆ ID()

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

Folder feature ID.

◆ group()

static std::string ModelAPI_Folder::group ( )
inlinestatic

Returns the group identifier of all features.

◆ groupName()

virtual std::string ModelAPI_Folder::groupName ( )
inlinevirtual

Returns the group identifier of this result.

Implements ModelAPI_Object.

◆ FIRST_FEATURE_ID()

static const std::string& ModelAPI_Folder::FIRST_FEATURE_ID ( )
inlinestatic

Attribute referring first feature in the folder.

◆ LAST_FEATURE_ID()

static const std::string& ModelAPI_Folder::LAST_FEATURE_ID ( )
inlinestatic

Attribute referring last feature in the folder.

◆ initAttributes()

void ModelAPI_Folder::initAttributes ( )
virtual

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

Implements ModelAPI_Object.

◆ execute()

void ModelAPI_Folder::execute ( )
virtual

Computes or recomputes the results.

◆ isDisabled()

virtual bool ModelAPI_Folder::isDisabled ( )
inlinevirtual

Returns the feature is disabled or not.

Implements ModelAPI_Object.

◆ name()

std::wstring ModelAPI_Folder::name ( )
inline

Returns the name stored in the attribute.

◆ reference()

std::shared_ptr<ModelAPI_AttributeReference> ModelAPI_Folder::reference ( const std::string &  theID)
inline

Returns the reference attribute by the identifier.

◆ lastVisibleFeature()

std::shared_ptr< ModelAPI_Feature > ModelAPI_Folder::lastVisibleFeature ( )

Returns the last visible feature in the folder, passing through invisible, that may appear as the last ones.

◆ init()

void ModelAPI_Folder::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

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

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

◆ colorConfigInfo()

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

◆ attributeChanged()

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

◆ 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

◆ emptyFunction()

virtual void ModelAPI_Entity::emptyFunction ( ) const
inlinevirtualinherited

Empty function which is added for virtualiation of the interface.