SHAPER
9.12.0
|
Attribute that contains list of references to the sub-shapes with possibility to manage them. More...
Public Member Functions | |
virtual void | append (const ObjectPtr &theContext, const std::shared_ptr< GeomAPI_Shape > &theSubShape, const bool theTemporarily=false)=0 |
Adds the new reference to the end of the list. More... | |
virtual void | append (const std::wstring &theNamingName, const std::string &theType="")=0 |
Adds the new reference to the end of the list by the naming name of the selected shape The type of shape is taken from the current selection type if the given is empty. More... | |
virtual void | append (const std::shared_ptr< GeomAPI_Pnt > &thePoint, const std::string &theType)=0 |
Adds the new reference to the end of the list by inner point on the selected shape. More... | |
virtual void | append (const std::string &theType, const std::wstring &theContextName, const int theIndex)=0 |
Adds the new reference to the end of the list by weak naming index. More... | |
virtual void | copyTo (std::shared_ptr< ModelAPI_AttributeSelectionList > theTarget) const =0 |
Copy the selection list to the destination attribute. More... | |
virtual void | removeTemporaryValues ()=0 |
Reset temporary stored values. More... | |
virtual void | removeLast ()=0 |
Removes the last element in the list. More... | |
virtual void | remove (const std::set< int > &theIndices)=0 |
Removes the elements from the list. More... | |
virtual int | size ()=0 |
Returns the number of selection attributes in the list. More... | |
virtual bool | isInList (const ObjectPtr &theContext, const std::shared_ptr< GeomAPI_Shape > &theSubShape, const bool theTemporarily=false)=0 |
Returns true if the object with the shape are in list. More... | |
virtual const std::string | selectionType () const =0 |
The type of all elements selection. More... | |
virtual void | setSelectionType (const std::string &theType)=0 |
Sets the type of all elements selection. More... | |
virtual std::shared_ptr< ModelAPI_AttributeSelection > | value (const int theIndex)=0 |
Returns the attribute selection by the index (zero based) More... | |
virtual void | clear ()=0 |
Removes all attributes of the list. More... | |
virtual void | cashValues (const bool theEnabled)=0 |
Starts or stops cashing of the values in the attribute (the cash may become invalid on modification of the attribute or sub-elements, so the cash must be enabled only during non-modification operations with this attribute) More... | |
virtual void | setGeometricalSelection (const bool theIsGeometricalSelection)=0 |
virtual bool | isGeometricalSelection () const =0 |
Returns true if is geometrical selection. More... | |
virtual std::string | attributeType () |
Returns the type of this class of attributes, not static method. More... | |
virtual | ~ModelAPI_AttributeSelectionList () |
To virtually destroy the fields of successors. More... | |
virtual FiltersFeaturePtr | filters () const =0 |
Returns a selection filters feature if it is defined for this selection list. More... | |
virtual void | setFilters (FiltersFeaturePtr theFeature)=0 |
Sets a selection filters feature if it is defined for this selection list. More... | |
virtual const bool | isWholeResultAllowed () const |
Returns true if the whole result selection corresponds to selection of all sub-shapes. More... | |
virtual void | setWholeResultAllowed (const bool theFlag) |
Sets whether the whole result selection corresponds to selection of all sub-shapes. More... | |
virtual const bool | isMakeCopy () const |
Returns true if a copy features must be used in update in history. More... | |
virtual void | setMakeCopy (const bool theFlag) |
Sets true if a copy features must be used in update in history. More... | |
virtual void | setObject (const std::shared_ptr< ModelAPI_Object > &theObject) |
Sets the owner of this attribute. More... | |
const std::shared_ptr< ModelAPI_Object > & | owner () const |
Returns the owner of this attribute. More... | |
virtual bool | isInitialized () |
Returns true if attribute was initialized by some value. More... | |
void | setInitialized () |
Makes attribute initialized. More... | |
bool | blockSetInitialized (const bool theBlock) |
Blocks sending "attribute updated" if theBlock is true. More... | |
void | setIsArgument (const bool theFlag) |
Set this attribute is argument for result (change of this attribute requires update of result). More... | |
bool | isArgument () |
Returns true if attribute causes the result change. More... | |
bool | setImmutable (const bool theFlag) |
Immutable argument can not be changed programmatically (e.g. More... | |
bool | isImmutable () |
Returns true if can not be changed programmatically. More... | |
const std::string & | id () const |
ID of the attribute in Data. More... | |
virtual void | reset () |
Resets attribute to deafult state. More... | |
Static Public Member Functions | |
static std::string | typeId () |
Returns the type of this class of attributes. More... | |
Protected Member Functions | |
ModelAPI_AttributeSelectionList () | |
Default constructor. More... | |
virtual void | setID (const std::string theID) |
Sets the ID of the attribute in Data (called from Data) More... | |
virtual void | reinit () |
Reinitializes the internal state of the attribute (may be needed on undo/redo, abort, etc) More... | |
Protected Attributes | |
bool | myIsInitialized |
is some value assigned to this attribute More... | |
bool | mySetInitializedBlocked |
is initialized blocked More... | |
bool | myIsArgument |
is this attribute used as an argument for execution More... | |
bool | myIsImmutable |
is this attribute can be changed programmatically (e.g. by constraint) More... | |
Attribute that contains list of references to the sub-shapes with possibility to manage them.
|
virtual |
To virtually destroy the fields of successors.
|
inlineprotected |
Default constructor.
|
pure virtual |
Adds the new reference to the end of the list.
theContext | object where the sub-shape was selected |
theSubShape | selected sub-shape (if null, the whole context is selected) |
theTemporarily | if it is true, do not store and name the added in the data framework (used to remove immediately, without the following updates) |
Implemented in Model_AttributeSelectionList.
|
pure virtual |
Adds the new reference to the end of the list by the naming name of the selected shape The type of shape is taken from the current selection type if the given is empty.
Implemented in Model_AttributeSelectionList.
|
pure virtual |
Adds the new reference to the end of the list by inner point on the selected shape.
Implemented in Model_AttributeSelectionList.
|
pure virtual |
Adds the new reference to the end of the list by weak naming index.
Implemented in Model_AttributeSelectionList.
|
pure virtual |
Copy the selection list to the destination attribute.
Implemented in Model_AttributeSelectionList.
|
pure virtual |
Reset temporary stored values.
Implemented in Model_AttributeSelectionList.
|
pure virtual |
Removes the last element in the list.
Implemented in Model_AttributeSelectionList.
|
pure virtual |
Removes the elements from the list.
theIndices | a list of indices of elements to be removed |
Implemented in Model_AttributeSelectionList.
|
pure virtual |
Returns the number of selection attributes in the list.
Implemented in Model_AttributeSelectionList.
|
pure virtual |
Returns true if the object with the shape are in list.
theContext | object where the sub-shape was selected |
theSubShape | selected sub-shape (if null, the whole context is selected) |
theTemporarily | if it is true, it checks also the temporary added item |
Implemented in Model_AttributeSelectionList.
|
pure virtual |
The type of all elements selection.
Implemented in Model_AttributeSelectionList.
|
pure virtual |
Sets the type of all elements selection.
theType | the index of the enumeration of the type of shape |
Implemented in Model_AttributeSelectionList.
|
pure virtual |
Returns the attribute selection by the index (zero based)
Implemented in Model_AttributeSelectionList.
|
pure virtual |
Removes all attributes of the list.
Implemented in Model_AttributeSelectionList.
|
pure virtual |
Starts or stops cashing of the values in the attribute (the cash may become invalid on modification of the attribute or sub-elements, so the cash must be enabled only during non-modification operations with this attribute)
Implemented in Model_AttributeSelectionList.
|
pure virtual |
Returns true if is geometrical selection.
Implemented in Model_AttributeSelectionList.
|
inlinestatic |
Returns the type of this class of attributes.
|
virtual |
Returns the type of this class of attributes, not static method.
Implements ModelAPI_Attribute.
|
pure virtual |
Returns a selection filters feature if it is defined for this selection list.
Implemented in Model_AttributeSelectionList.
|
pure virtual |
Sets a selection filters feature if it is defined for this selection list.
Implemented in Model_AttributeSelectionList.
|
inlinevirtual |
Returns true if the whole result selection corresponds to selection of all sub-shapes.
|
inlinevirtual |
Sets whether the whole result selection corresponds to selection of all sub-shapes.
|
inlinevirtual |
Returns true if a copy features must be used in update in history.
|
inlinevirtual |
Sets true if a copy features must be used in update in history.
|
virtualinherited |
Sets the owner of this attribute.
Reimplemented in Model_AttributeSelection, and Model_AttributeReference.
|
inherited |
Returns the owner of this attribute.
|
virtualinherited |
Returns true if attribute was initialized by some value.
Reimplemented in Model_AttributeSelectionList, Model_AttributeSelection, Model_AttributeRefList, Model_AttributeReference, Model_AttributeRefAttrList, Model_AttributeRefAttr, and GeomData_Dir.
|
inherited |
Makes attribute initialized.
|
inherited |
Blocks sending "attribute updated" if theBlock is true.
theBlock | a block value |
|
inherited |
Set this attribute is argument for result (change of this attribute requires update of result).
By default it is true.
|
inherited |
Returns true if attribute causes the result change.
|
inherited |
Immutable argument can not be changed programmatically (e.g.
by constraint) By default it is false. Returns the previous state of the attribute's immutability.
|
inherited |
Returns true if can not be changed programmatically.
|
inherited |
ID of the attribute in Data.
|
virtualinherited |
Resets attribute to deafult state.
Reimplemented in Model_AttributeSelection, Model_AttributeDouble, GeomData_Point2D, and GeomData_Dir.
|
protectedvirtualinherited |
Sets the ID of the attribute in Data (called from Data)
Reimplemented in Model_AttributeSelection.
|
protectedvirtualinherited |
Reinitializes the internal state of the attribute (may be needed on undo/redo, abort, etc)
Reimplemented in Model_AttributeTables, Model_AttributeString, Model_AttributeSelectionList, Model_AttributeRefList, Model_AttributeReference, Model_AttributeRefAttrList, Model_AttributeRefAttr, Model_AttributeInteger, Model_AttributeIntArray, Model_AttributeImage, Model_AttributeDoubleArray, Model_AttributeDouble, Model_AttributeDocRef, Model_AttributeBoolean, GeomData_Point2DArray, GeomData_Point2D, GeomData_Point, and GeomData_Dir.
|
protectedinherited |
is some value assigned to this attribute
|
protectedinherited |
is initialized blocked
|
protectedinherited |
is this attribute used as an argument for execution
|
protectedinherited |
is this attribute can be changed programmatically (e.g. by constraint)