Open CASCADE Technology  7.5.0.beta
Public Member Functions | Static Public Member Functions | Protected Member Functions
TPrsStd_AISPresentation Class Reference

An attribute to associate an AIS_InteractiveObject to a label in an AIS viewer. This attribute works in collaboration with TPrsStd_AISViewer. Note that all the Set... and Unset... attribute methods as well as the query methods for visualization attributes and the HasOwn... test methods are shortcuts to the respective AIS_InteractiveObject settings. More...

#include <TPrsStd_AISPresentation.hxx>

Inheritance diagram for TPrsStd_AISPresentation:
Inheritance graph
[legend]

Public Member Functions

 TPrsStd_AISPresentation ()
 
void SetDisplayed (const Standard_Boolean B)
 
void Display (const Standard_Boolean update=Standard_False)
 Display presentation of object in AIS viewer. If <update> = True then AISObject is recomputed and all the visualization settings are applied. More...
 
void Erase (const Standard_Boolean remove=Standard_False)
 Removes the presentation of this AIS presentation attribute from the TPrsStd_AISViewer. If remove is true, this AIS presentation attribute is removed from the interactive context. More...
 
void Update ()
 Recompute presentation of object and apply the visualization settings. More...
 
Standard_GUID GetDriverGUID () const
 
void SetDriverGUID (const Standard_GUID &guid)
 
Standard_Boolean IsDisplayed () const
 Returns true if this AIS presentation attribute is displayed. More...
 
Handle< AIS_InteractiveObjectGetAIS () const
 Returns AIS_InteractiveObject stored in the presentation attribute. More...
 
Graphic3d_NameOfMaterial Material () const
 Returns the material setting for this presentation attribute. More...
 
void SetMaterial (const Graphic3d_NameOfMaterial aName)
 Sets the material aName for this presentation attribute. More...
 
Standard_Boolean HasOwnMaterial () const
 Returns true if this presentation attribute already has a material setting. More...
 
void UnsetMaterial ()
 Removes the material setting from this presentation attribute. More...
 
void SetTransparency (const Standard_Real aValue=0.6)
 Sets the transparency value aValue for this presentation attribute. This value is 0.6 by default. More...
 
Standard_Real Transparency () const
 
Standard_Boolean HasOwnTransparency () const
 Returns true if this presentation attribute already has a transparency setting. More...
 
void UnsetTransparency ()
 Removes the transparency setting from this presentation attribute. More...
 
Quantity_NameOfColor Color () const
 
void SetColor (const Quantity_NameOfColor aColor)
 Sets the color aColor for this presentation attribute. More...
 
Standard_Boolean HasOwnColor () const
 Returns true if this presentation attribute already has a color setting. More...
 
void UnsetColor ()
 Removes the color setting from this presentation attribute. More...
 
Standard_Real Width () const
 
void SetWidth (const Standard_Real aWidth)
 Sets the width aWidth for this presentation attribute. More...
 
Standard_Boolean HasOwnWidth () const
 Returns true if this presentation attribute already has a width setting. More...
 
void UnsetWidth ()
 Removes the width setting from this presentation attribute. More...
 
Standard_Integer Mode () const
 
void SetMode (const Standard_Integer theMode)
 
Standard_Boolean HasOwnMode () const
 
void UnsetMode ()
 
Standard_Integer GetNbSelectionModes () const
 Returns selection mode(s) of the attribute. It starts with 1 .. GetNbSelectionModes(). More...
 
Standard_Integer SelectionMode (const int index=1) const
 
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)
 
Standard_Boolean HasOwnSelectionMode () const
 
void UnsetSelectionMode ()
 Clears all selection modes of the attribute. More...
 
const Standard_GUIDID () const override
 Returns the ID of the attribute. More...
 
Handle< TDF_AttributeNewEmpty () const override
 Returns an new empty attribute from the good end type. It is used by the copy algorithm. More...
 
void Restore (const Handle< TDF_Attribute > &with) override
 Restores the backuped contents from <anAttribute> into this one. It is used when aborting a transaction. More...
 
void Paste (const Handle< TDF_Attribute > &into, const Handle< TDF_RelocationTable > &RT) 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...
 
virtual Handle< TDF_AttributeBackupCopy () const override
 Copies the attribute contents into a new other attribute. It is used by Backup(). More...
 
virtual void AfterAddition () override
 Something to do after adding an Attribute to a label. More...
 
virtual void BeforeRemoval () override
 Something to do before removing an Attribute from a label. More...
 
virtual void BeforeForget () override
 Something to do before forgetting an Attribute to a label. More...
 
virtual void AfterResume () override
 Something to do after resuming an Attribute from a label. More...
 
virtual Standard_Boolean BeforeUndo (const Handle< TDF_AttributeDelta > &anAttDelta, const Standard_Boolean forceIt=Standard_False) override
 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) override
 update AIS viewer according to delta 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 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 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

static const Standard_GUIDGetID ()
 Returns the GUID for TPrsStd_AISPresentation attributes. More...
 
static Handle< TPrsStd_AISPresentationSet (const TDF_Label &L, const Standard_GUID &driver)
 Creates or retrieves the presentation attribute on the label L, and sets the GUID driver. More...
 
static void Unset (const TDF_Label &L)
 Delete (if exist) the presentation attribute associated to the label <L>. More...
 
static Handle< TPrsStd_AISPresentationSet (const Handle< TDF_Attribute > &master)
 Creates or retrieves the AISPresentation attribute attached to master. The GUID of the driver will be the GUID of master. master is the attribute you want to display. 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

virtual Handle< TDataXtd_PresentationgetData () const
 Returns attribute storing presentation data. More...
 
- Protected Member Functions inherited from TDF_Attribute
 TDF_Attribute ()
 Initializes fields. More...
 

Additional Inherited Members

- Public Types inherited from Standard_Transient
typedef void base_type
 Returns a type descriptor about this object. More...
 

Detailed Description

An attribute to associate an AIS_InteractiveObject to a label in an AIS viewer. This attribute works in collaboration with TPrsStd_AISViewer. Note that all the Set... and Unset... attribute methods as well as the query methods for visualization attributes and the HasOwn... test methods are shortcuts to the respective AIS_InteractiveObject settings.

Constructor & Destructor Documentation

◆ TPrsStd_AISPresentation()

TPrsStd_AISPresentation::TPrsStd_AISPresentation ( )

Member Function Documentation

◆ AddSelectionMode()

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

◆ AfterAddition()

virtual void TPrsStd_AISPresentation::AfterAddition ( )
overridevirtual

Something to do after adding an Attribute to a label.

Reimplemented from TDF_Attribute.

◆ AfterResume()

virtual void TPrsStd_AISPresentation::AfterResume ( )
overridevirtual

Something to do after resuming an Attribute from a label.

Reimplemented from TDF_Attribute.

◆ AfterUndo()

virtual Standard_Boolean TPrsStd_AISPresentation::AfterUndo ( const Handle< TDF_AttributeDelta > &  anAttDelta,
const Standard_Boolean  forceIt = Standard_False 
)
overridevirtual

update AIS viewer according to delta

Reimplemented from TDF_Attribute.

◆ BackupCopy()

virtual Handle< TDF_Attribute > TPrsStd_AISPresentation::BackupCopy ( ) const
overridevirtual

Copies the attribute contents into a new other attribute. It is used by Backup().

Reimplemented from TDF_Attribute.

◆ BeforeForget()

virtual void TPrsStd_AISPresentation::BeforeForget ( )
overridevirtual

Something to do before forgetting an Attribute to a label.

Reimplemented from TDF_Attribute.

◆ BeforeRemoval()

virtual void TPrsStd_AISPresentation::BeforeRemoval ( )
overridevirtual

Something to do before removing an Attribute from a label.

Reimplemented from TDF_Attribute.

◆ BeforeUndo()

virtual Standard_Boolean TPrsStd_AISPresentation::BeforeUndo ( const Handle< TDF_AttributeDelta > &  anAttDelta,
const Standard_Boolean  forceIt = Standard_False 
)
overridevirtual

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.

Reimplemented from TDF_Attribute.

◆ Color()

Quantity_NameOfColor TPrsStd_AISPresentation::Color ( ) const

◆ Display()

void TPrsStd_AISPresentation::Display ( const Standard_Boolean  update = Standard_False)

Display presentation of object in AIS viewer. If <update> = True then AISObject is recomputed and all the visualization settings are applied.

◆ Erase()

void TPrsStd_AISPresentation::Erase ( const Standard_Boolean  remove = Standard_False)

Removes the presentation of this AIS presentation attribute from the TPrsStd_AISViewer. If remove is true, this AIS presentation attribute is removed from the interactive context.

◆ GetAIS()

Handle< AIS_InteractiveObject > TPrsStd_AISPresentation::GetAIS ( ) const

Returns AIS_InteractiveObject stored in the presentation attribute.

◆ getData()

virtual Handle< TDataXtd_Presentation > TPrsStd_AISPresentation::getData ( ) const
protectedvirtual

Returns attribute storing presentation data.

◆ GetDriverGUID()

Standard_GUID TPrsStd_AISPresentation::GetDriverGUID ( ) const

◆ GetID()

static const Standard_GUID& TPrsStd_AISPresentation::GetID ( )
static

Returns the GUID for TPrsStd_AISPresentation attributes.

◆ GetNbSelectionModes()

Standard_Integer TPrsStd_AISPresentation::GetNbSelectionModes ( ) const

Returns selection mode(s) of the attribute. It starts with 1 .. GetNbSelectionModes().

◆ HasOwnColor()

Standard_Boolean TPrsStd_AISPresentation::HasOwnColor ( ) const

Returns true if this presentation attribute already has a color setting.

◆ HasOwnMaterial()

Standard_Boolean TPrsStd_AISPresentation::HasOwnMaterial ( ) const

Returns true if this presentation attribute already has a material setting.

◆ HasOwnMode()

Standard_Boolean TPrsStd_AISPresentation::HasOwnMode ( ) const

◆ HasOwnSelectionMode()

Standard_Boolean TPrsStd_AISPresentation::HasOwnSelectionMode ( ) const

◆ HasOwnTransparency()

Standard_Boolean TPrsStd_AISPresentation::HasOwnTransparency ( ) const

Returns true if this presentation attribute already has a transparency setting.

◆ HasOwnWidth()

Standard_Boolean TPrsStd_AISPresentation::HasOwnWidth ( ) const

Returns true if this presentation attribute already has a width setting.

◆ ID()

const Standard_GUID& TPrsStd_AISPresentation::ID ( ) const
overridevirtual

Returns the ID of the attribute.

Implements TDF_Attribute.

◆ IsDisplayed()

Standard_Boolean TPrsStd_AISPresentation::IsDisplayed ( ) const

Returns true if this AIS presentation attribute is displayed.

◆ Material()

Graphic3d_NameOfMaterial TPrsStd_AISPresentation::Material ( ) const

Returns the material setting for this presentation attribute.

◆ Mode()

Standard_Integer TPrsStd_AISPresentation::Mode ( ) const

◆ NewEmpty()

Handle< TDF_Attribute > TPrsStd_AISPresentation::NewEmpty ( ) const
overridevirtual

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

Implements TDF_Attribute.

◆ Paste()

void TPrsStd_AISPresentation::Paste ( const Handle< TDF_Attribute > &  intoAttribute,
const Handle< TDF_RelocationTable > &  aRelocationTable 
) 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 may paste the contents of <me> into <intoAttribute>.

The given pasted attribute can be full or empty of its contents. But don't make a NEW! Just set the contents!

It is possible to use <aRelocationTable> to get/set the relocation value of a source attribute.

Implements TDF_Attribute.

◆ Restore()

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

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

Implements TDF_Attribute.

◆ SelectionMode()

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

◆ Set() [1/2]

static Handle< TPrsStd_AISPresentation > TPrsStd_AISPresentation::Set ( const TDF_Label L,
const Standard_GUID driver 
)
static

Creates or retrieves the presentation attribute on the label L, and sets the GUID driver.

◆ Set() [2/2]

static Handle< TPrsStd_AISPresentation > TPrsStd_AISPresentation::Set ( const Handle< TDF_Attribute > &  master)
static

Creates or retrieves the AISPresentation attribute attached to master. The GUID of the driver will be the GUID of master. master is the attribute you want to display.

◆ SetColor()

void TPrsStd_AISPresentation::SetColor ( const Quantity_NameOfColor  aColor)

Sets the color aColor for this presentation attribute.

◆ SetDisplayed()

void TPrsStd_AISPresentation::SetDisplayed ( const Standard_Boolean  B)

◆ SetDriverGUID()

void TPrsStd_AISPresentation::SetDriverGUID ( const Standard_GUID guid)

◆ SetMaterial()

void TPrsStd_AISPresentation::SetMaterial ( const Graphic3d_NameOfMaterial  aName)

Sets the material aName for this presentation attribute.

◆ SetMode()

void TPrsStd_AISPresentation::SetMode ( const Standard_Integer  theMode)

◆ SetSelectionMode()

void TPrsStd_AISPresentation::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 TPrsStd_AISPresentation::SetTransparency ( const Standard_Real  aValue = 0.6)

Sets the transparency value aValue for this presentation attribute. This value is 0.6 by default.

◆ SetWidth()

void TPrsStd_AISPresentation::SetWidth ( const Standard_Real  aWidth)

Sets the width aWidth for this presentation attribute.

◆ Transparency()

Standard_Real TPrsStd_AISPresentation::Transparency ( ) const

◆ Unset()

static void TPrsStd_AISPresentation::Unset ( const TDF_Label L)
static

Delete (if exist) the presentation attribute associated to the label <L>.

◆ UnsetColor()

void TPrsStd_AISPresentation::UnsetColor ( )

Removes the color setting from this presentation attribute.

◆ UnsetMaterial()

void TPrsStd_AISPresentation::UnsetMaterial ( )

Removes the material setting from this presentation attribute.

◆ UnsetMode()

void TPrsStd_AISPresentation::UnsetMode ( )

◆ UnsetSelectionMode()

void TPrsStd_AISPresentation::UnsetSelectionMode ( )

Clears all selection modes of the attribute.

◆ UnsetTransparency()

void TPrsStd_AISPresentation::UnsetTransparency ( )

Removes the transparency setting from this presentation attribute.

◆ UnsetWidth()

void TPrsStd_AISPresentation::UnsetWidth ( )

Removes the width setting from this presentation attribute.

◆ Update()

void TPrsStd_AISPresentation::Update ( )

Recompute presentation of object and apply the visualization settings.

◆ Width()

Standard_Real TPrsStd_AISPresentation::Width ( ) const

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