|
| | XCAFDoc_ColorTool () |
| |
| TDF_Label | BaseLabel () const |
| | returns the label under which colors are stored
|
| |
| const Handle< XCAFDoc_ShapeTool > & | ShapeTool () |
| | Returns internal XCAFDoc_ShapeTool tool.
|
| |
| Standard_Boolean | IsColor (const TDF_Label &lab) const |
| | Returns True if label belongs to a colortable and is a color definition.
|
| |
| Standard_Boolean | FindColor (const Quantity_Color &col, TDF_Label &lab) const |
| | Finds a color definition in a colortable and returns its label if found Returns False if color is not found in colortable.
|
| |
| Standard_Boolean | FindColor (const Quantity_ColorRGBA &col, TDF_Label &lab) const |
| | Finds a color definition in a colortable and returns its label if found Returns False if color is not found in colortable.
|
| |
| TDF_Label | FindColor (const Quantity_Color &col) const |
| | Finds a color definition in a colortable and returns its label if found (or Null label else)
|
| |
| TDF_Label | FindColor (const Quantity_ColorRGBA &col) const |
| | Finds a color definition in a colortable and returns its label if found (or Null label else)
|
| |
| TDF_Label | AddColor (const Quantity_Color &col) const |
| | Adds a color definition to a colortable and returns its label (returns existing label if the same color is already defined)
|
| |
| TDF_Label | AddColor (const Quantity_ColorRGBA &col) const |
| | Adds a color definition to a colortable and returns its label (returns existing label if the same color is already defined)
|
| |
| void | RemoveColor (const TDF_Label &lab) const |
| | Removes color from the colortable.
|
| |
| void | GetColors (TDF_LabelSequence &Labels) const |
| | Returns a sequence of colors currently stored in the colortable.
|
| |
| void | SetColor (const TDF_Label &L, const TDF_Label &colorL, const XCAFDoc_ColorType type) const |
| | Sets a link with GUID defined by <type> (see XCAFDoc::ColorRefGUID()) from label <L> to color defined by <colorL>. Color of shape is defined following way in dependance with type of color. If type of color is XCAFDoc_ColorGen - then this color defines default color for surfaces and curves. If for shape color with types XCAFDoc_ColorSurf or XCAFDoc_ColorCurv is specified then such color overrides generic color.
|
| |
| void | SetColor (const TDF_Label &L, const Quantity_Color &Color, const XCAFDoc_ColorType type) const |
| | Sets a link with GUID defined by <type> (see XCAFDoc::ColorRefGUID()) from label <L> to color <Color> in the colortable Adds a color as necessary.
|
| |
| void | SetColor (const TDF_Label &L, const Quantity_ColorRGBA &Color, const XCAFDoc_ColorType type) const |
| | Sets a link with GUID defined by <type> (see XCAFDoc::ColorRefGUID()) from label <L> to color <Color> in the colortable Adds a color as necessary.
|
| |
| void | UnSetColor (const TDF_Label &L, const XCAFDoc_ColorType type) const |
| | Removes a link with GUID defined by <type> (see XCAFDoc::ColorRefGUID()) from label <L> to color.
|
| |
| Standard_Boolean | IsSet (const TDF_Label &L, const XCAFDoc_ColorType type) const |
| | Returns True if label <L> has a color assignment of the type <type>
|
| |
| Standard_Boolean | SetColor (const TopoDS_Shape &S, const TDF_Label &colorL, const XCAFDoc_ColorType type) |
| | Sets a link with GUID defined by <type> (see XCAFDoc::ColorRefGUID()) from label <L> to color defined by <colorL> Returns False if cannot find a label for shape S.
|
| |
| Standard_Boolean | SetColor (const TopoDS_Shape &S, const Quantity_Color &Color, const XCAFDoc_ColorType type) |
| | Sets a link with GUID defined by <type> (see XCAFDoc::ColorRefGUID()) from label <L> to color <Color> in the colortable Adds a color as necessary Returns False if cannot find a label for shape S.
|
| |
| Standard_Boolean | SetColor (const TopoDS_Shape &S, const Quantity_ColorRGBA &Color, const XCAFDoc_ColorType type) |
| | Sets a link with GUID defined by <type> (see XCAFDoc::ColorRefGUID()) from label <L> to color <Color> in the colortable Adds a color as necessary Returns False if cannot find a label for shape S.
|
| |
| Standard_Boolean | UnSetColor (const TopoDS_Shape &S, const XCAFDoc_ColorType type) |
| | Removes a link with GUID defined by <type> (see XCAFDoc::ColorRefGUID()) from label <L> to color Returns True if such link existed.
|
| |
| Standard_Boolean | IsSet (const TopoDS_Shape &S, const XCAFDoc_ColorType type) |
| | Returns True if label <L> has a color assignment of the type <type>
|
| |
| Standard_Boolean | GetColor (const TopoDS_Shape &S, const XCAFDoc_ColorType type, TDF_Label &colorL) |
| | Returns label with color assigned to <L> as <type> Returns False if no such color is assigned.
|
| |
| Standard_Boolean | GetColor (const TopoDS_Shape &S, const XCAFDoc_ColorType type, Quantity_Color &color) |
| | Returns color assigned to <L> as <type> Returns False if no such color is assigned.
|
| |
| Standard_Boolean | GetColor (const TopoDS_Shape &S, const XCAFDoc_ColorType type, Quantity_ColorRGBA &color) |
| | Returns color assigned to <L> as <type> Returns False if no such color is assigned.
|
| |
| void | SetVisibility (const TDF_Label &shapeLabel, const Standard_Boolean isvisible=Standard_True) |
| | Set the visibility of object on label. Do nothing if there no any object. Set UAttribute with corresponding GUID.
|
| |
| Standard_Boolean | IsColorByLayer (const TDF_Label &L) const |
| | Return TRUE if object color defined by its Layer, FALSE if not.
|
| |
| void | SetColorByLayer (const TDF_Label &shapeLabel, const Standard_Boolean isColorByLayer=Standard_False) |
| | Set the Color defined by Layer flag on label. Do nothing if there no any object. Set UAttribute with corresponding GUID.
|
| |
| Standard_Boolean | SetInstanceColor (const TopoDS_Shape &theShape, const XCAFDoc_ColorType type, const Quantity_Color &color, const Standard_Boolean isCreateSHUO=Standard_True) |
| | Sets the color of component that styled with SHUO structure Returns FALSE if no sush component found NOTE: create SHUO structeure if it is necessary and if <isCreateSHUO>
|
| |
| Standard_Boolean | SetInstanceColor (const TopoDS_Shape &theShape, const XCAFDoc_ColorType type, const Quantity_ColorRGBA &color, const Standard_Boolean isCreateSHUO=Standard_True) |
| | Sets the color of component that styled with SHUO structure Returns FALSE if no sush component found NOTE: create SHUO structeure if it is necessary and if <isCreateSHUO>
|
| |
| Standard_Boolean | GetInstanceColor (const TopoDS_Shape &theShape, const XCAFDoc_ColorType type, Quantity_Color &color) |
| | Gets the color of component that styled with SHUO structure Returns FALSE if no sush component or color type.
|
| |
| Standard_Boolean | GetInstanceColor (const TopoDS_Shape &theShape, const XCAFDoc_ColorType type, Quantity_ColorRGBA &color) |
| | Gets the color of component that styled with SHUO structure Returns FALSE if no sush component or color type.
|
| |
| Standard_Boolean | IsInstanceVisible (const TopoDS_Shape &theShape) |
| | Gets the visibility status of component that styled with SHUO structure Returns FALSE if no sush component.
|
| |
| Standard_Boolean | ReverseChainsOfTreeNodes () |
| | Reverses order in chains of TreeNodes (from Last to First) under each Color Label since we became to use function ::Prepend() instead of ::Append() in method SetColor() for acceleration.
|
| |
| const Standard_GUID & | ID () const override |
| | Returns the ID of the attribute.
|
| |
| virtual void | DumpJson (Standard_OStream &theOStream, Standard_Integer theDepth=-1) const override |
| | Dumps the content of me into the stream.
|
| |
| void | Restore (const Handle< TDF_Attribute > &) override |
| | Restores the backuped contents from <anAttribute> into this one. It is used when aborting a transaction.
|
| |
| void | Paste (const Handle< TDF_Attribute > &, const Handle< TDF_RelocationTable > &) const override |
| | This method is different from the "Copy" one, because it is used when copying an attribute from a source structure into a target structure. This method may paste the contents of <me> into <intoAttribute>.
|
| |
| virtual void | SetID (const Standard_GUID &) |
| | Sets specific ID of the attribute (supports several attributes of one type at the same label feature).
|
| |
| virtual void | SetID () |
| | Sets default ID defined in nested class (to be used for attributes having User ID feature).
|
| |
| const TDF_Label | Label () const |
| | Returns the label to which the attribute is attached. If the label is not included in a DF, the label is null. See Label. Warning If the label is not included in a data framework, it is null. This function should not be redefined inline.
|
| |
| Standard_Integer | Transaction () const |
| | Returns the transaction index in which the attribute has been created or modified.
|
| |
| Standard_Integer | UntilTransaction () const |
| | Returns the upper transaction index until which the attribute is/was valid. This number may vary. A removed attribute validity range is reduced to its transaction index.
|
| |
| Standard_Boolean | IsValid () const |
| | Returns true if the attribute is valid; i.e. not a backuped or removed one.
|
| |
| Standard_Boolean | IsNew () const |
| | Returns true if the attribute has no backup.
|
| |
| Standard_Boolean | IsForgotten () const |
| | Returns true if the attribute forgotten status is set.
|
| |
| Standard_Boolean | IsAttribute (const Standard_GUID &anID) const |
| | Returns true if it exists an associated attribute of <me> with <anID> as ID.
|
| |
| Standard_Boolean | FindAttribute (const Standard_GUID &anID, Handle< TDF_Attribute > &anAttribute) const |
| | Finds an associated attribute of <me>, according to <anID>. the returned <anAttribute> is a valid one. The method returns True if found, False otherwise. A removed attribute cannot be found using this method.
|
| |
| template<class T > |
| Standard_Boolean | FindAttribute (const Standard_GUID &theID, Handle< T > &theAttr) const |
| | Safe variant for arbitrary type of argument.
|
| |
| void | AddAttribute (const Handle< TDF_Attribute > &other) const |
| | Adds an Attribute <other> to the label of <me>.Raises if there is already one of the same GUID fhan <other>.
|
| |
| Standard_Boolean | ForgetAttribute (const Standard_GUID &aguid) const |
| | Forgets the Attribute of GUID <aguid> associated to the label of <me>. Be careful that if <me> is the attribute of <guid>, <me> will have a null label after this call. If the attribute doesn't exist returns False. Otherwise returns True.
|
| |
| void | ForgetAllAttributes (const Standard_Boolean clearChildren=Standard_True) const |
| | Forgets all the attributes attached to the label of <me>. Does it on the sub-labels if <clearChildren> is set to true. Of course, this method is compatible with Transaction & Delta mechanisms. Be careful that if <me> will have a null label after this call.
|
| |
| virtual void | AfterAddition () |
| | Something to do after adding an Attribute to a label.
|
| |
| virtual void | BeforeRemoval () |
| | Something to do before removing an Attribute from a label.
|
| |
| virtual void | BeforeForget () |
| | Something to do before forgetting an Attribute to a label.
|
| |
| virtual void | AfterResume () |
| | Something to do after resuming an Attribute from a label.
|
| |
| virtual Standard_Boolean | AfterRetrieval (const Standard_Boolean forceIt=Standard_False) |
| | Something to do AFTER creation of an attribute by persistent-transient translation. The returned status says if AfterUndo has been performed (true) or if this callback must be called once again further (false). If <forceIt> is set to true, the method MUST perform and return true. Does nothing by default and returns true.
|
| |
| virtual Standard_Boolean | BeforeUndo (const Handle< TDF_AttributeDelta > &anAttDelta, const Standard_Boolean forceIt=Standard_False) |
| | Something to do before applying <anAttDelta>. The returned status says if AfterUndo has been performed (true) or if this callback must be called once again further (false). If <forceIt> is set to true, the method MUST perform and return true. Does nothing by default and returns true.
|
| |
| virtual Standard_Boolean | AfterUndo (const Handle< TDF_AttributeDelta > &anAttDelta, const Standard_Boolean forceIt=Standard_False) |
| | Something to do after applying <anAttDelta>. The returned status says if AfterUndo has been performed (true) or if this callback must be called once again further (false). If <forceIt> is set to true, the method MUST perform and return true. Does nothing by default and returns true.
|
| |
| virtual void | BeforeCommitTransaction () |
| | A callback. By default does nothing. It is called by TDF_Data::CommitTransaction() method.
|
| |
| void | Backup () |
| | Backups the attribute. The backuped attribute is flagged "Backuped" and not "Valid".
|
| |
| Standard_Boolean | IsBackuped () const |
| | Returns true if the attribute backup status is set. This status is set/unset by the Backup() method.
|
| |
| virtual Handle< TDF_Attribute > | BackupCopy () const |
| | Copies the attribute contents into a new other attribute. It is used by Backup().
|
| |
| virtual Handle< TDF_DeltaOnAddition > | DeltaOnAddition () const |
| | Makes an AttributeDelta because <me> appeared. The only known use of a redefinition of this method is to return a null handle (no delta).
|
| |
| virtual Handle< TDF_DeltaOnForget > | DeltaOnForget () const |
| | Makes an AttributeDelta because <me> has been forgotten.
|
| |
| virtual Handle< TDF_DeltaOnResume > | DeltaOnResume () const |
| | Makes an AttributeDelta because <me> has been resumed.
|
| |
| virtual Handle< TDF_DeltaOnModification > | DeltaOnModification (const Handle< TDF_Attribute > &anOldAttribute) const |
| | Makes a DeltaOnModification between <me> and.
|
| |
| virtual void | DeltaOnModification (const Handle< TDF_DeltaOnModification > &aDelta) |
| | Applies a DeltaOnModification to <me>.
|
| |
| virtual Handle< TDF_DeltaOnRemoval > | DeltaOnRemoval () const |
| | Makes a DeltaOnRemoval on <me> because <me> has disappeared from the DS.
|
| |
| virtual Handle< TDF_Attribute > | NewEmpty () const =0 |
| | Returns an new empty attribute from the good end type. It is used by the copy algorithm.
|
| |
| virtual void | References (const Handle< TDF_DataSet > &aDataSet) const |
| | Adds the first level referenced attributes and labels to <aDataSet>.
|
| |
| virtual Standard_OStream & | Dump (Standard_OStream &anOS) const |
| | Dumps the minimum information about <me> on <aStream>.
|
| |
| Standard_OStream & | operator<< (Standard_OStream &anOS) const |
| |
| virtual void | ExtendedDump (Standard_OStream &anOS, const TDF_IDFilter &aFilter, TDF_AttributeIndexedMap &aMap) const |
| | Dumps the attribute content on <aStream>, using <aMap> like this: if an attribute is not in the map, first put add it to the map and then dump it. Use the map rank instead of dumping each attribute field.
|
| |
| void | Forget (const Standard_Integer aTransaction) |
| | Forgets the attribute. <aTransaction> is the current transaction in which the forget is done. A forgotten attribute is also flagged not "Valid".
|
| |
 Public Member Functions inherited from Standard_Transient |
| | Standard_Transient () |
| | Empty constructor.
|
| |
| | Standard_Transient (const Standard_Transient &) |
| | Copy constructor – does nothing.
|
| |
| Standard_Transient & | operator= (const Standard_Transient &) |
| | Assignment operator, needed to avoid copying reference counter.
|
| |
| virtual | ~Standard_Transient () |
| | Destructor must be virtual.
|
| |
| virtual const opencascade::handle< Standard_Type > & | DynamicType () const |
| | Returns a type descriptor about this object.
|
| |
| Standard_Boolean | IsInstance (const opencascade::handle< Standard_Type > &theType) const |
| | Returns a true value if this is an instance of Type.
|
| |
| Standard_Boolean | IsInstance (const Standard_CString theTypeName) const |
| | Returns a true value if this is an instance of TypeName.
|
| |
| Standard_Boolean | IsKind (const opencascade::handle< Standard_Type > &theType) const |
| | Returns true if this is an instance of Type or an instance of any class that inherits from Type. Note that multiple inheritance is not supported by OCCT RTTI mechanism.
|
| |
| Standard_Boolean | IsKind (const Standard_CString theTypeName) const |
| | Returns true if this is an instance of TypeName or an instance of any class that inherits from TypeName. Note that multiple inheritance is not supported by OCCT RTTI mechanism.
|
| |
| Standard_Transient * | This () const |
| | Returns non-const pointer to this object (like const_cast). For protection against creating handle to objects allocated in stack or call from constructor, it will raise exception Standard_ProgramError if reference counter is zero.
|
| |
| Standard_Integer | GetRefCount () const noexcept |
| | Get the reference counter of this object.
|
| |
| void | IncrementRefCounter () noexcept |
| | Increments the reference counter of this object.
|
| |
| Standard_Integer | DecrementRefCounter () noexcept |
| | Decrements the reference counter of this object; returns the decremented value.
|
| |
| virtual void | Delete () const |
| | Memory deallocator for transient classes.
|
| |
