Open CASCADE Technology  7.4.1.dev
TDataXtd_Presentation Class Reference

Attribute containing parameters of presentation of the shape, e.g. the shape attached to the same label and displayed using TPrsStd tools (see TPrsStd_AISPresentation). More...

#include <TDataXtd_Presentation.hxx>

Inheritance diagram for TDataXtd_Presentation:
Inheritance graph
[legend]

Attribute mechanics

 TDataXtd_Presentation ()
 Empty constructor. More...
 
const Standard_GUIDID () const override
 Returns the ID of the attribute. More...
 
virtual void Restore (const Handle< TDF_Attribute > &anAttribute) override
 Restores the contents from <anAttribute> into this one. It is used when aborting a transaction. More...
 
virtual Handle< TDF_AttributeNewEmpty () const override
 Returns an new empty attribute from the good end type. It is used by the copy algorithm. More...
 
virtual void Paste (const Handle< TDF_Attribute > &intoAttribute, const Handle< TDF_RelocationTable > &aRelocTationable) 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 pastes the current attribute to the label corresponding to the insertor. The pasted attribute may be a brand new one or a new version of the previous one. More...
 
Handle< TDF_AttributeBackupCopy () const override
 Empty constructor. More...
 
static Handle< TDataXtd_PresentationSet (const TDF_Label &theLabel, const Standard_GUID &theDriverId)
 Create if not found the TDataXtd_Presentation attribute and set its driver GUID. More...
 
static void Unset (const TDF_Label &theLabel)
 Remove attribute of this type from the label. More...
 
static const Standard_GUIDGetID ()
 Returns the ID of the attribute. More...
 

Access to data

Standard_GUID GetDriverGUID () const
 Returns the GUID of the driver managing display of associated AIS object. More...
 
void SetDriverGUID (const Standard_GUID &theGUID)
 Sets the GUID of the driver managing display of associated AIS object. More...
 
Standard_Boolean IsDisplayed () const
 Returns the GUID of the driver managing display of associated AIS object. More...
 
Standard_Boolean HasOwnMaterial () const
 Returns the GUID of the driver managing display of associated AIS object. More...
 
Standard_Boolean HasOwnTransparency () const
 Returns the GUID of the driver managing display of associated AIS object. More...
 
Standard_Boolean HasOwnColor () const
 Returns the GUID of the driver managing display of associated AIS object. More...
 
Standard_Boolean HasOwnWidth () const
 Returns the GUID of the driver managing display of associated AIS object. More...
 
Standard_Boolean HasOwnMode () const
 Returns the GUID of the driver managing display of associated AIS object. More...
 
Standard_Boolean HasOwnSelectionMode () const
 Returns the GUID of the driver managing display of associated AIS object. More...
 
void SetDisplayed (const Standard_Boolean theIsDisplayed)
 Returns the GUID of the driver managing display of associated AIS object. More...
 
void SetMaterialIndex (const Standard_Integer theMaterialIndex)
 Returns the GUID of the driver managing display of associated AIS object. More...
 
void SetTransparency (const Standard_Real theValue)
 Returns the GUID of the driver managing display of associated AIS object. More...
 
void SetColor (const Quantity_NameOfColor theColor)
 Returns the GUID of the driver managing display of associated AIS object. More...
 
void SetWidth (const Standard_Real theWidth)
 Returns the GUID of the driver managing display of associated AIS object. More...
 
void SetMode (const Standard_Integer theMode)
 Returns the GUID of the driver managing display of associated AIS object. More...
 
Standard_Integer GetNbSelectionModes () const
 Returns the number of selection modes of the attribute. It starts with 1 .. GetNbSelectionModes(). More...
 
void SetSelectionMode (const Standard_Integer theSelectionMode, const Standard_Boolean theTransaction=Standard_True)
 Sets selection mode. If "theTransaction" flag is OFF, modification of the attribute doesn't influence the transaction mechanism (the attribute doesn't participate in undo/redo because of this modification). Certainly, if any other data of the attribute is modified (display mode, color, ...), the attribute will be included into undo/redo. More...
 
void AddSelectionMode (const Standard_Integer theSelectionMode, const Standard_Boolean theTransaction=Standard_True)
 Returns the GUID of the driver managing display of associated AIS object. More...
 
Standard_Integer MaterialIndex () const
 Returns the GUID of the driver managing display of associated AIS object. More...
 
Standard_Real Transparency () const
 Returns the GUID of the driver managing display of associated AIS object. More...
 
Quantity_NameOfColor Color () const
 Returns the GUID of the driver managing display of associated AIS object. More...
 
Standard_Real Width () const
 Returns the GUID of the driver managing display of associated AIS object. More...
 
Standard_Integer Mode () const
 Returns the GUID of the driver managing display of associated AIS object. More...
 
Standard_Integer SelectionMode (const int index=1) const
 Returns the GUID of the driver managing display of associated AIS object. More...
 
void UnsetMaterial ()
 Returns the GUID of the driver managing display of associated AIS object. More...
 
void UnsetTransparency ()
 Returns the GUID of the driver managing display of associated AIS object. More...
 
void UnsetColor ()
 Returns the GUID of the driver managing display of associated AIS object. More...
 
void UnsetWidth ()
 Returns the GUID of the driver managing display of associated AIS object. More...
 
void UnsetMode ()
 Returns the GUID of the driver managing display of associated AIS object. More...
 
void UnsetSelectionMode ()
 Returns the GUID of the driver managing display of associated AIS object. More...
 

Additional Inherited Members

- Public Types inherited from Standard_Transient
typedef void base_type
 Returns a type descriptor about this object. 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 carefull 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 mecanisms. Be carefull 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_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 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...
 
virtual void DumpJson (Standard_OStream &theOStream, Standard_Integer theDepth=-1) const
 Dumps the content of me into the stream. 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 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...
 
- Protected Member Functions inherited from TDF_Attribute
 TDF_Attribute ()
 Initializes fields. More...
 

Detailed Description

Attribute containing parameters of presentation of the shape, e.g. the shape attached to the same label and displayed using TPrsStd tools (see TPrsStd_AISPresentation).

Constructor & Destructor Documentation

◆ TDataXtd_Presentation()

TDataXtd_Presentation::TDataXtd_Presentation ( )

Empty constructor.

Member Function Documentation

◆ AddSelectionMode()

void TDataXtd_Presentation::AddSelectionMode ( const Standard_Integer  theSelectionMode,
const Standard_Boolean  theTransaction = Standard_True 
)

Returns the GUID of the driver managing display of associated AIS object.

◆ BackupCopy()

Handle< TDF_Attribute > TDataXtd_Presentation::BackupCopy ( ) const
overridevirtual

Empty constructor.

Reimplemented from TDF_Attribute.

◆ Color()

Quantity_NameOfColor TDataXtd_Presentation::Color ( ) const

Returns the GUID of the driver managing display of associated AIS object.

◆ GetDriverGUID()

Standard_GUID TDataXtd_Presentation::GetDriverGUID ( ) const

Returns the GUID of the driver managing display of associated AIS object.

◆ GetID()

static const Standard_GUID& TDataXtd_Presentation::GetID ( )
static

Returns the ID of the attribute.

◆ GetNbSelectionModes()

Standard_Integer TDataXtd_Presentation::GetNbSelectionModes ( ) const

Returns the number of selection modes of the attribute. It starts with 1 .. GetNbSelectionModes().

◆ HasOwnColor()

Standard_Boolean TDataXtd_Presentation::HasOwnColor ( ) const

Returns the GUID of the driver managing display of associated AIS object.

◆ HasOwnMaterial()

Standard_Boolean TDataXtd_Presentation::HasOwnMaterial ( ) const

Returns the GUID of the driver managing display of associated AIS object.

◆ HasOwnMode()

Standard_Boolean TDataXtd_Presentation::HasOwnMode ( ) const

Returns the GUID of the driver managing display of associated AIS object.

◆ HasOwnSelectionMode()

Standard_Boolean TDataXtd_Presentation::HasOwnSelectionMode ( ) const

Returns the GUID of the driver managing display of associated AIS object.

◆ HasOwnTransparency()

Standard_Boolean TDataXtd_Presentation::HasOwnTransparency ( ) const

Returns the GUID of the driver managing display of associated AIS object.

◆ HasOwnWidth()

Standard_Boolean TDataXtd_Presentation::HasOwnWidth ( ) const

Returns the GUID of the driver managing display of associated AIS object.

◆ ID()

const Standard_GUID& TDataXtd_Presentation::ID ( ) const
overridevirtual

Returns the ID of the attribute.

Implements TDF_Attribute.

◆ IsDisplayed()

Standard_Boolean TDataXtd_Presentation::IsDisplayed ( ) const

Returns the GUID of the driver managing display of associated AIS object.

◆ MaterialIndex()

Standard_Integer TDataXtd_Presentation::MaterialIndex ( ) const

Returns the GUID of the driver managing display of associated AIS object.

◆ Mode()

Standard_Integer TDataXtd_Presentation::Mode ( ) const

Returns the GUID of the driver managing display of associated AIS object.

◆ NewEmpty()

virtual Handle< TDF_Attribute > TDataXtd_Presentation::NewEmpty ( ) const
overridevirtual

Returns an new empty attribute from the good end type. It is used by the copy algorithm.

Implements TDF_Attribute.

◆ Paste()

virtual void TDataXtd_Presentation::Paste ( const Handle< TDF_Attribute > &  intoAttribute,
const Handle< TDF_RelocationTable > &  aRelocTationable 
) const
overridevirtual

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 pastes the current attribute to the label corresponding to the insertor. The pasted attribute may be a brand new one or a new version of the previous one.

Implements TDF_Attribute.

◆ Restore()

virtual void TDataXtd_Presentation::Restore ( const Handle< TDF_Attribute > &  anAttribute)
overridevirtual

Restores the contents from <anAttribute> into this one. It is used when aborting a transaction.

Implements TDF_Attribute.

◆ SelectionMode()

Standard_Integer TDataXtd_Presentation::SelectionMode ( const int  index = 1) const

Returns the GUID of the driver managing display of associated AIS object.

◆ Set()

static Handle< TDataXtd_Presentation > TDataXtd_Presentation::Set ( const TDF_Label theLabel,
const Standard_GUID theDriverId 
)
static

Create if not found the TDataXtd_Presentation attribute and set its driver GUID.

◆ SetColor()

void TDataXtd_Presentation::SetColor ( const Quantity_NameOfColor  theColor)

Returns the GUID of the driver managing display of associated AIS object.

◆ SetDisplayed()

void TDataXtd_Presentation::SetDisplayed ( const Standard_Boolean  theIsDisplayed)

Returns the GUID of the driver managing display of associated AIS object.

◆ SetDriverGUID()

void TDataXtd_Presentation::SetDriverGUID ( const Standard_GUID theGUID)

Sets the GUID of the driver managing display of associated AIS object.

◆ SetMaterialIndex()

void TDataXtd_Presentation::SetMaterialIndex ( const Standard_Integer  theMaterialIndex)

Returns the GUID of the driver managing display of associated AIS object.

◆ SetMode()

void TDataXtd_Presentation::SetMode ( const Standard_Integer  theMode)

Returns the GUID of the driver managing display of associated AIS object.

◆ SetSelectionMode()

void TDataXtd_Presentation::SetSelectionMode ( const Standard_Integer  theSelectionMode,
const Standard_Boolean  theTransaction = Standard_True 
)

Sets selection mode. If "theTransaction" flag is OFF, modification of the attribute doesn't influence the transaction mechanism (the attribute doesn't participate in undo/redo because of this modification). Certainly, if any other data of the attribute is modified (display mode, color, ...), the attribute will be included into undo/redo.

◆ SetTransparency()

void TDataXtd_Presentation::SetTransparency ( const Standard_Real  theValue)

Returns the GUID of the driver managing display of associated AIS object.

◆ SetWidth()

void TDataXtd_Presentation::SetWidth ( const Standard_Real  theWidth)

Returns the GUID of the driver managing display of associated AIS object.

◆ Transparency()

Standard_Real TDataXtd_Presentation::Transparency ( ) const

Returns the GUID of the driver managing display of associated AIS object.

◆ Unset()

static void TDataXtd_Presentation::Unset ( const TDF_Label theLabel)
static

Remove attribute of this type from the label.

◆ UnsetColor()

void TDataXtd_Presentation::UnsetColor ( )

Returns the GUID of the driver managing display of associated AIS object.

◆ UnsetMaterial()

void TDataXtd_Presentation::UnsetMaterial ( )

Returns the GUID of the driver managing display of associated AIS object.

◆ UnsetMode()

void TDataXtd_Presentation::UnsetMode ( )

Returns the GUID of the driver managing display of associated AIS object.

◆ UnsetSelectionMode()

void TDataXtd_Presentation::UnsetSelectionMode ( )

Returns the GUID of the driver managing display of associated AIS object.

◆ UnsetTransparency()

void TDataXtd_Presentation::UnsetTransparency ( )

Returns the GUID of the driver managing display of associated AIS object.

◆ UnsetWidth()

void TDataXtd_Presentation::UnsetWidth ( )

Returns the GUID of the driver managing display of associated AIS object.

◆ Width()

Standard_Real TDataXtd_Presentation::Width ( ) const

Returns the GUID of the driver managing display of associated AIS object.


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