Open CASCADE Technology  7.7.0.dev
Public Member Functions | Static Public Member Functions

XCAFDoc_ColorTool Class Reference

Provides tools to store and retrieve attributes (colors) of TopoDS_Shape in and from TDocStd_Document A Document is intended to hold different attributes of ONE shape and it's sub-shapes Provide tools for management of Colors section of document. More...

#include <XCAFDoc_ColorTool.hxx>

Inheritance diagram for XCAFDoc_ColorTool:
Inheritance graph
[legend]

Public Member Functions

 XCAFDoc_ColorTool ()
 
TDF_Label BaseLabel () const
 returns the label under which colors are stored More...
 
const Handle< XCAFDoc_ShapeTool > & ShapeTool ()
 Returns internal XCAFDoc_ShapeTool tool. More...
 
Standard_Boolean IsColor (const TDF_Label &lab) const
 Returns True if label belongs to a colortable and is a color definition. More...
 
Standard_Boolean GetColor (const TDF_Label &lab, Quantity_Color &col) const
 Returns color defined by label lab Returns False if the label is not in colortable or does not define a color. More...
 
Standard_Boolean GetColor (const TDF_Label &lab, Quantity_ColorRGBA &col) const
 Returns color defined by label lab Returns False if the label is not in colortable or does not define a color. More...
 
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. More...
 
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. More...
 
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) More...
 
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) More...
 
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) More...
 
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) More...
 
void RemoveColor (const TDF_Label &lab) const
 Removes color from the colortable. More...
 
void GetColors (TDF_LabelSequence &Labels) const
 Returns a sequence of colors currently stored in the colortable. More...
 
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. More...
 
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. More...
 
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. More...
 
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. More...
 
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> More...
 
Standard_Boolean GetColor (const TDF_Label &L, const XCAFDoc_ColorType type, Quantity_Color &color)
 Returns color assigned to <L> as <type> Returns False if no such color is assigned. More...
 
Standard_Boolean GetColor (const TDF_Label &L, const XCAFDoc_ColorType type, Quantity_ColorRGBA &color)
 Returns color assigned to <L> as <type> Returns False if no such color is assigned. More...
 
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. More...
 
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. More...
 
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. More...
 
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. More...
 
Standard_Boolean IsSet (const TopoDS_Shape &S, const XCAFDoc_ColorType type)
 Returns True if label <L> has a color assignment of the type <type> More...
 
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. More...
 
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. More...
 
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. More...
 
Standard_Boolean IsVisible (const TDF_Label &L) const
 Return TRUE if object on this label is visible, FALSE if invisible. More...
 
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. More...
 
Standard_Boolean IsColorByLayer (const TDF_Label &L) const
 Return TRUE if object color defined by its Layer, FALSE if not. More...
 
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. More...
 
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> More...
 
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> More...
 
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. More...
 
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. More...
 
Standard_Boolean IsInstanceVisible (const TopoDS_Shape &theShape)
 Gets the visibility status of component that styled with SHUO structure Returns FALSE if no sush component. More...
 
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. More...
 
const Standard_GUIDID () const override
 Returns the ID of the attribute. More...
 
virtual void DumpJson (Standard_OStream &theOStream, Standard_Integer theDepth=-1) const override
 Dumps the content of me into the stream. More...
 
- Public Member Functions inherited from TDataStd_GenericEmpty
void Restore (const Handle< TDF_Attribute > &) override
 Restores the backuped contents from <anAttribute> into this one. It is used when aborting a transaction. More...
 
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>. More...
 
- Public Member Functions inherited from TDF_Attribute
virtual void SetID (const Standard_GUID &)
 Sets specific ID of the attribute (supports several attributes of one type at the same label feature). More...
 
virtual void SetID ()
 Sets default ID defined in nested class (to be used for attributes having User ID feature). More...
 
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. More...
 
Standard_Integer Transaction () const
 Returns the transaction index in which the attribute has been created or modified. More...
 
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. More...
 
Standard_Boolean IsValid () const
 Returns true if the attribute is valid; i.e. not a backuped or removed one. More...
 
Standard_Boolean IsNew () const
 Returns true if the attribute has no backup. More...
 
Standard_Boolean IsForgotten () const
 Returns true if the attribute forgotten status is set. More...
 
Standard_Boolean IsAttribute (const Standard_GUID &anID) const
 Returns true if it exists an associated attribute of <me> with <anID> as ID. More...
 
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. More...
 
template<class T >
Standard_Boolean FindAttribute (const Standard_GUID &theID, Handle< T > &theAttr) const
 Safe variant for arbitrary type of argument. More...
 
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>. More...
 
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. More...
 
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. More...
 
virtual void AfterAddition ()
 Something to do after adding an Attribute to a label. More...
 
virtual void BeforeRemoval ()
 Something to do before removing an Attribute from a label. More...
 
virtual void BeforeForget ()
 Something to do before forgetting an Attribute to a label. More...
 
virtual void AfterResume ()
 Something to do after resuming an Attribute from a label. More...
 
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. More...
 
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. More...
 
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. More...
 
virtual void BeforeCommitTransaction ()
 A callback. By default does nothing. It is called by TDF_Data::CommitTransaction() method. More...
 
void Backup ()
 Backups the attribute. The backuped attribute is flagged "Backuped" and not "Valid". More...
 
Standard_Boolean IsBackuped () const
 Returns true if the attribute backup status is set. This status is set/unset by the Backup() method. More...
 
virtual Handle< TDF_AttributeBackupCopy () const
 Copies the attribute contents into a new other attribute. It is used by Backup(). More...
 
virtual Handle< TDF_DeltaOnAdditionDeltaOnAddition () 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). More...
 
virtual Handle< TDF_DeltaOnForgetDeltaOnForget () const
 Makes an AttributeDelta because <me> has been forgotten. More...
 
virtual Handle< TDF_DeltaOnResumeDeltaOnResume () const
 Makes an AttributeDelta because <me> has been resumed. More...
 
virtual Handle< TDF_DeltaOnModificationDeltaOnModification (const Handle< TDF_Attribute > &anOldAttribute) const
 Makes a DeltaOnModification between <me> and <anOldAttribute. More...
 
virtual void DeltaOnModification (const Handle< TDF_DeltaOnModification > &aDelta)
 Applies a DeltaOnModification to <me>. More...
 
virtual Handle< TDF_DeltaOnRemovalDeltaOnRemoval () const
 Makes a DeltaOnRemoval on <me> because <me> has disappeared from the DS. More...
 
virtual Handle< TDF_AttributeNewEmpty () const =0
 Returns an new empty attribute from the good end type. It is used by the copy algorithm. More...
 
virtual void References (const Handle< TDF_DataSet > &aDataSet) const
 Adds the first level referenced attributes and labels to <aDataSet>. More...
 
virtual Standard_OStreamDump (Standard_OStream &anOS) const
 Dumps the minimum information about <me> on <aStream>. More...
 
Standard_OStreamoperator<< (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. More...
 
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". More...
 
- Public Member Functions inherited from Standard_Transient
 Standard_Transient ()
 Empty constructor. More...
 
 Standard_Transient (const Standard_Transient &)
 Copy constructor – does nothing. More...
 
Standard_Transientoperator= (const Standard_Transient &)
 Assignment operator, needed to avoid copying reference counter. More...
 
virtual ~Standard_Transient ()
 Destructor must be virtual. More...
 
virtual void Delete () const
 Memory deallocator for transient classes. More...
 
virtual const opencascade::handle< Standard_Type > & DynamicType () const
 Returns a type descriptor about this object. More...
 
Standard_Boolean IsInstance (const opencascade::handle< Standard_Type > &theType) const
 Returns a true value if this is an instance of Type. More...
 
Standard_Boolean IsInstance (const Standard_CString theTypeName) const
 Returns a true value if this is an instance of TypeName. More...
 
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. More...
 
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. More...
 
Standard_TransientThis () 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. More...
 
Standard_Integer GetRefCount () const
 Get the reference counter of this object. More...
 
void IncrementRefCounter () const
 Increments the reference counter of this object. More...
 
Standard_Integer DecrementRefCounter () const
 Decrements the reference counter of this object; returns the decremented value. More...
 

Static Public Member Functions

static Standard_Boolean AutoNaming ()
 Returns current auto-naming mode; TRUE by default. If TRUE then for added colors the TDataStd_Name attribute will be automatically added. This setting is global. More...
 
static void SetAutoNaming (Standard_Boolean theIsAutoNaming)
 See also AutoNaming(). More...
 
static Handle< XCAFDoc_ColorToolSet (const TDF_Label &L)
 Creates (if not exist) ColorTool. More...
 
static const Standard_GUIDGetID ()
 
static Standard_Boolean GetColor (const TDF_Label &L, const XCAFDoc_ColorType type, TDF_Label &colorL)
 Returns label with color assigned to <L> as <type> Returns False if no such color is assigned. More...
 
- Static Public Member Functions inherited from Standard_Transient
static const char * get_type_name ()
 Returns a type descriptor about this object. More...
 
static const opencascade::handle< Standard_Type > & get_type_descriptor ()
 Returns type descriptor of Standard_Transient class. More...
 

Additional Inherited Members

- Public Types inherited from Standard_Transient
typedef void base_type
 Returns a type descriptor about this object. More...
 
- Protected Member Functions inherited from TDF_Attribute
 TDF_Attribute ()
 Initializes fields. More...
 

Detailed Description

Provides tools to store and retrieve attributes (colors) of TopoDS_Shape in and from TDocStd_Document A Document is intended to hold different attributes of ONE shape and it's sub-shapes Provide tools for management of Colors section of document.

Constructor & Destructor Documentation

◆ XCAFDoc_ColorTool()

XCAFDoc_ColorTool::XCAFDoc_ColorTool ( )

Member Function Documentation

◆ AddColor() [1/2]

TDF_Label XCAFDoc_ColorTool::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)

◆ AddColor() [2/2]

TDF_Label XCAFDoc_ColorTool::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)

◆ AutoNaming()

static Standard_Boolean XCAFDoc_ColorTool::AutoNaming ( )
static

Returns current auto-naming mode; TRUE by default. If TRUE then for added colors the TDataStd_Name attribute will be automatically added. This setting is global.

◆ BaseLabel()

TDF_Label XCAFDoc_ColorTool::BaseLabel ( ) const

returns the label under which colors are stored

◆ DumpJson()

virtual void XCAFDoc_ColorTool::DumpJson ( Standard_OStream theOStream,
Standard_Integer  theDepth = -1 
) const
overridevirtual

Dumps the content of me into the stream.

Reimplemented from TDataStd_GenericEmpty.

◆ FindColor() [1/4]

TDF_Label XCAFDoc_ColorTool::FindColor ( const Quantity_Color col) const

Finds a color definition in a colortable and returns its label if found (or Null label else)

◆ FindColor() [2/4]

Standard_Boolean XCAFDoc_ColorTool::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.

◆ FindColor() [3/4]

TDF_Label XCAFDoc_ColorTool::FindColor ( const Quantity_ColorRGBA col) const

Finds a color definition in a colortable and returns its label if found (or Null label else)

◆ FindColor() [4/4]

Standard_Boolean XCAFDoc_ColorTool::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.

◆ GetColor() [1/8]

Standard_Boolean XCAFDoc_ColorTool::GetColor ( const TDF_Label L,
const XCAFDoc_ColorType  type,
Quantity_Color color 
)

Returns color assigned to <L> as <type> Returns False if no such color is assigned.

◆ GetColor() [2/8]

Standard_Boolean XCAFDoc_ColorTool::GetColor ( const TDF_Label L,
const XCAFDoc_ColorType  type,
Quantity_ColorRGBA color 
)

Returns color assigned to <L> as <type> Returns False if no such color is assigned.

◆ GetColor() [3/8]

static Standard_Boolean XCAFDoc_ColorTool::GetColor ( const TDF_Label L,
const XCAFDoc_ColorType  type,
TDF_Label colorL 
)
static

Returns label with color assigned to <L> as <type> Returns False if no such color is assigned.

◆ GetColor() [4/8]

Standard_Boolean XCAFDoc_ColorTool::GetColor ( const TDF_Label lab,
Quantity_Color col 
) const

Returns color defined by label lab Returns False if the label is not in colortable or does not define a color.

◆ GetColor() [5/8]

Standard_Boolean XCAFDoc_ColorTool::GetColor ( const TDF_Label lab,
Quantity_ColorRGBA col 
) const

Returns color defined by label lab Returns False if the label is not in colortable or does not define a color.

◆ GetColor() [6/8]

Standard_Boolean XCAFDoc_ColorTool::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.

◆ GetColor() [7/8]

Standard_Boolean XCAFDoc_ColorTool::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.

◆ GetColor() [8/8]

Standard_Boolean XCAFDoc_ColorTool::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.

◆ GetColors()

void XCAFDoc_ColorTool::GetColors ( TDF_LabelSequence Labels) const

Returns a sequence of colors currently stored in the colortable.

◆ GetID()

static const Standard_GUID& XCAFDoc_ColorTool::GetID ( )
static

◆ GetInstanceColor() [1/2]

Standard_Boolean XCAFDoc_ColorTool::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.

◆ GetInstanceColor() [2/2]

Standard_Boolean XCAFDoc_ColorTool::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.

◆ ID()

const Standard_GUID& XCAFDoc_ColorTool::ID ( ) const
overridevirtual

Returns the ID of the attribute.

Implements TDF_Attribute.

◆ IsColor()

Standard_Boolean XCAFDoc_ColorTool::IsColor ( const TDF_Label lab) const

Returns True if label belongs to a colortable and is a color definition.

◆ IsColorByLayer()

Standard_Boolean XCAFDoc_ColorTool::IsColorByLayer ( const TDF_Label L) const

Return TRUE if object color defined by its Layer, FALSE if not.

◆ IsInstanceVisible()

Standard_Boolean XCAFDoc_ColorTool::IsInstanceVisible ( const TopoDS_Shape theShape)

Gets the visibility status of component that styled with SHUO structure Returns FALSE if no sush component.

◆ IsSet() [1/2]

Standard_Boolean XCAFDoc_ColorTool::IsSet ( const TDF_Label L,
const XCAFDoc_ColorType  type 
) const

Returns True if label <L> has a color assignment of the type <type>

◆ IsSet() [2/2]

Standard_Boolean XCAFDoc_ColorTool::IsSet ( const TopoDS_Shape S,
const XCAFDoc_ColorType  type 
)

Returns True if label <L> has a color assignment of the type <type>

◆ IsVisible()

Standard_Boolean XCAFDoc_ColorTool::IsVisible ( const TDF_Label L) const

Return TRUE if object on this label is visible, FALSE if invisible.

◆ RemoveColor()

void XCAFDoc_ColorTool::RemoveColor ( const TDF_Label lab) const

Removes color from the colortable.

◆ ReverseChainsOfTreeNodes()

Standard_Boolean XCAFDoc_ColorTool::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.

◆ Set()

static Handle< XCAFDoc_ColorTool > XCAFDoc_ColorTool::Set ( const TDF_Label L)
static

Creates (if not exist) ColorTool.

◆ SetAutoNaming()

static void XCAFDoc_ColorTool::SetAutoNaming ( Standard_Boolean  theIsAutoNaming)
static

See also AutoNaming().

◆ SetColor() [1/6]

void XCAFDoc_ColorTool::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.

◆ SetColor() [2/6]

void XCAFDoc_ColorTool::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.

◆ SetColor() [3/6]

void XCAFDoc_ColorTool::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.

◆ SetColor() [4/6]

Standard_Boolean XCAFDoc_ColorTool::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.

◆ SetColor() [5/6]

Standard_Boolean XCAFDoc_ColorTool::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.

◆ SetColor() [6/6]

Standard_Boolean XCAFDoc_ColorTool::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.

◆ SetColorByLayer()

void XCAFDoc_ColorTool::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.

◆ SetInstanceColor() [1/2]

Standard_Boolean XCAFDoc_ColorTool::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>

◆ SetInstanceColor() [2/2]

Standard_Boolean XCAFDoc_ColorTool::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>

◆ SetVisibility()

void XCAFDoc_ColorTool::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.

◆ ShapeTool()

const Handle< XCAFDoc_ShapeTool >& XCAFDoc_ColorTool::ShapeTool ( )

Returns internal XCAFDoc_ShapeTool tool.

◆ UnSetColor() [1/2]

void XCAFDoc_ColorTool::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.

◆ UnSetColor() [2/2]

Standard_Boolean XCAFDoc_ColorTool::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.


The documentation for this class was generated from the following file: