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:

[legend]

Public Member Functions
	TPrsStd_AISPresentation ()
void	SetDisplayed (const bool B)
void	Display (const bool update=false)
	Display presentation of object in AIS viewer. If <update> = True then AISObject is recomputed and all the visualization settings are applied.
void	Erase (const bool remove=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.
void	Update ()
	Recompute presentation of object and apply the visualization settings.
Standard_GUID	GetDriverGUID () const
void	SetDriverGUID (const Standard_GUID &guid)
bool	IsDisplayed () const
	Returns true if this AIS presentation attribute is displayed.
occ::handle< AIS_InteractiveObject >	GetAIS () const
	Returns AIS_InteractiveObject stored in the presentation attribute.
Graphic3d_NameOfMaterial	Material () const
	Returns the material setting for this presentation attribute.
void	SetMaterial (const Graphic3d_NameOfMaterial aName)
	Sets the material aName for this presentation attribute.
bool	HasOwnMaterial () const
	Returns true if this presentation attribute already has a material setting.
void	UnsetMaterial ()
	Removes the material setting from this presentation attribute.
void	SetTransparency (const double aValue=0.6)
	Sets the transparency value aValue for this presentation attribute. This value is 0.6 by default.
double	Transparency () const
bool	HasOwnTransparency () const
	Returns true if this presentation attribute already has a transparency setting.
void	UnsetTransparency ()
	Removes the transparency setting from this presentation attribute.
Quantity_NameOfColor	Color () const
void	SetColor (const Quantity_NameOfColor aColor)
	Sets the color aColor for this presentation attribute.
bool	HasOwnColor () const
	Returns true if this presentation attribute already has a color setting.
void	UnsetColor ()
	Removes the color setting from this presentation attribute.
double	Width () const
void	SetWidth (const double aWidth)
	Sets the width aWidth for this presentation attribute.
bool	HasOwnWidth () const
	Returns true if this presentation attribute already has a width setting.
void	UnsetWidth ()
	Removes the width setting from this presentation attribute.
int	Mode () const
void	SetMode (const int theMode)
bool	HasOwnMode () const
void	UnsetMode ()
int	GetNbSelectionModes () const
	Returns selection mode(s) of the attribute. It starts with 1 .. GetNbSelectionModes().
int	SelectionMode (const int indexindex=1) const
void	SetSelectionMode (const int theSelectionMode, const bool theTransaction=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.
void	AddSelectionMode (const int theSelectionMode, const bool theTransaction=true)
bool	HasOwnSelectionMode () const
void	UnsetSelectionMode ()
	Clears all selection modes of the attribute.
const Standard_GUID &	ID () const override
	Returns the ID of the attribute.
occ::handle< TDF_Attribute >	NewEmpty () const override
	Returns an new empty attribute from the good end type. It is used by the copy algorithm.
void	Restore (const occ::handle< TDF_Attribute > &with) override
	Restores the backuped contents from <anAttribute> into this one. It is used when aborting a transaction.
void	Paste (const occ::handle< TDF_Attribute > &into, const occ::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>.
occ::handle< TDF_Attribute >	BackupCopy () const override
	Copies the attribute contents into a new other attribute. It is used by Backup().
void	AfterAddition () override
	Something to do after adding an Attribute to a label.
void	BeforeRemoval () override
	Something to do before removing an Attribute from a label.
void	BeforeForget () override
	Something to do before forgetting an Attribute to a label.
void	AfterResume () override
	Something to do after resuming an Attribute from a label.
bool	BeforeUndo (const occ::handle< TDF_AttributeDelta > &anAttDelta, const bool forceIt=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.
bool	AfterUndo (const occ::handle< TDF_AttributeDelta > &anAttDelta, const bool forceIt=false) override
	update AIS viewer according to delta
void	DumpJson (Standard_OStream &theOStream, int theDepth=-1) const override
	Dumps the content of me into the stream.
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).
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.
int	Transaction () const
	Returns the transaction index in which the attribute has been created or modified.
int	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.
bool	IsValid () const
	Returns true if the attribute is valid; i.e. not a backuped or removed one.
bool	IsNew () const
	Returns true if the attribute has no backup.
bool	IsForgotten () const
	Returns true if the attribute forgotten status is set.
bool	IsAttribute (const Standard_GUID &anID) const
	Returns true if it exists an associated attribute of <me> with <anID> as ID.
bool	FindAttribute (const Standard_GUID &anID, occ::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>
bool	FindAttribute (const Standard_GUID &theID, occ::handle< T > &theAttr) const
	Safe variant for arbitrary type of argument.
void	AddAttribute (const occ::handle< TDF_Attribute > &other) const
	Adds an Attribute <other> to the label of <me>. Raises if there is already one of the same GUID than <other>.
bool	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 bool clearChildren=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 bool	AfterRetrieval (const bool forceIt=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 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".
bool	IsBackuped () const
	Returns true if the attribute backup status is set. This status is set/unset by the Backup() method.
virtual occ::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 occ::handle< TDF_DeltaOnForget >	DeltaOnForget () const
	Makes an AttributeDelta because <me> has been forgotten.
virtual occ::handle< TDF_DeltaOnResume >	DeltaOnResume () const
	Makes an AttributeDelta because <me> has been resumed.
virtual occ::handle< TDF_DeltaOnModification >	DeltaOnModification (const occ::handle< TDF_Attribute > &anOldAttribute) const
	Makes a DeltaOnModification between <me> and.
virtual void	DeltaOnModification (const occ::handle< TDF_DeltaOnModification > &aDelta)
	Applies a DeltaOnModification to <me>.
virtual occ::handle< TDF_DeltaOnRemoval >	DeltaOnRemoval () const
	Makes a DeltaOnRemoval on <me> because <me> has disappeared from the DS.
virtual void	References (const occ::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, NCollection_IndexedMap< occ::handle< TDF_Attribute > > &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 int 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 ()=default
	Destructor must be virtual.
virtual const opencascade::handle< Standard_Type > &	DynamicType () const
	Returns a type descriptor about this object.
bool	IsInstance (const opencascade::handle< Standard_Type > &theType) const
	Returns a true value if this is an instance of Type.
bool	IsInstance (const char *const theTypeName) const
	Returns a true value if this is an instance of TypeName.
bool	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.
bool	IsKind (const char *const 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.
int	GetRefCount () const noexcept
	Get the reference counter of this object.
void	IncrementRefCounter () noexcept
	Increments the reference counter of this object. Uses relaxed memory ordering since incrementing only requires atomicity, not synchronization with other memory operations.
int	DecrementRefCounter () noexcept
	Decrements the reference counter of this object; returns the decremented value. Uses release ordering for the decrement to ensure all writes to the object are visible before the count reaches zero. An acquire fence is added only when the count reaches zero, ensuring proper synchronization before deletion. This is more efficient than using acq_rel for every decrement.
virtual void	Delete () const
	Memory deallocator for transient classes.

Static Public Member Functions
static const Standard_GUID &	GetID ()
	Returns the GUID for TPrsStd_AISPresentation attributes.
static occ::handle< TPrsStd_AISPresentation >	Set (const TDF_Label &L, const Standard_GUID &driver)
	Creates or retrieves the presentation attribute on the label L, and sets the GUID driver.
static void	Unset (const TDF_Label &L)
	Delete (if exist) the presentation attribute associated to the label <L>.
static occ::handle< TPrsStd_AISPresentation >	Set (const occ::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.
static constexpr const char *	get_type_name ()
	Returns a type descriptor about this object.
static const opencascade::handle< Standard_Type > &	get_type_descriptor ()
	Returns type descriptor of Standard_Transient class.

Protected Member Functions
virtual occ::handle< TDataXtd_Presentation >	getData () const
	Returns attribute storing presentation data.
Protected Member Functions inherited from TDF_Attribute
	TDF_Attribute ()
	Initializes fields.

Additional Inherited Members
typedef void	base_type
	Returns a type descriptor about this object.

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 int	theSelectionMode,
		const bool	theTransaction = true )

◆ AfterAddition()

void TPrsStd_AISPresentation::AfterAddition ( )

overridevirtual

Something to do after adding an Attribute to a label.

Reimplemented from TDF_Attribute.

◆ AfterResume()

void TPrsStd_AISPresentation::AfterResume ( )

overridevirtual

Something to do after resuming an Attribute from a label.

Reimplemented from TDF_Attribute.

◆ AfterUndo()

bool TPrsStd_AISPresentation::AfterUndo	(	const occ::handle< TDF_AttributeDelta > &	anAttDelta,
		const bool	forceIt = false )

overridevirtual

update AIS viewer according to delta

Reimplemented from TDF_Attribute.

◆ BackupCopy()

occ::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()

void TPrsStd_AISPresentation::BeforeForget ( )

overridevirtual

Something to do before forgetting an Attribute to a label.

Reimplemented from TDF_Attribute.

◆ BeforeRemoval()

void TPrsStd_AISPresentation::BeforeRemoval ( )

overridevirtual

Something to do before removing an Attribute from a label.

Reimplemented from TDF_Attribute.

◆ BeforeUndo()

bool TPrsStd_AISPresentation::BeforeUndo	(	const occ::handle< TDF_AttributeDelta > &	anAttDelta,
		const bool	forceIt = 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 bool update = false )

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

◆ DumpJson()

void TPrsStd_AISPresentation::DumpJson	(	Standard_OStream &	theOStream,
		int	theDepth = -1 ) const

overridevirtual

Dumps the content of me into the stream.

Reimplemented from TDF_Attribute.

◆ Erase()

void TPrsStd_AISPresentation::Erase ( const bool remove = 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()

occ::handle< AIS_InteractiveObject > TPrsStd_AISPresentation::GetAIS ( ) const

Returns AIS_InteractiveObject stored in the presentation attribute.

◆ getData()

virtual occ::handle< TDataXtd_Presentation > TPrsStd_AISPresentation::getData ( ) const

protectedvirtual

Returns attribute storing presentation data.

◆ GetDriverGUID()

Standard_GUID TPrsStd_AISPresentation::GetDriverGUID ( ) const

◆ GetID()

const Standard_GUID & TPrsStd_AISPresentation::GetID ( )

static

Returns the GUID for TPrsStd_AISPresentation attributes.

◆ GetNbSelectionModes()

int TPrsStd_AISPresentation::GetNbSelectionModes ( ) const

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

◆ HasOwnColor()

bool TPrsStd_AISPresentation::HasOwnColor ( ) const

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

◆ HasOwnMaterial()

bool TPrsStd_AISPresentation::HasOwnMaterial ( ) const

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

◆ HasOwnMode()

bool TPrsStd_AISPresentation::HasOwnMode ( ) const

◆ HasOwnSelectionMode()

bool TPrsStd_AISPresentation::HasOwnSelectionMode ( ) const

◆ HasOwnTransparency()

bool TPrsStd_AISPresentation::HasOwnTransparency ( ) const

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

◆ HasOwnWidth()

bool 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()

bool 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()

int TPrsStd_AISPresentation::Mode ( ) const

◆ NewEmpty()

occ::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 occ::handle< TDF_Attribute > &	intoAttribute,
		const occ::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 occ::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()

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

◆ Set() [1/2]

occ::handle< TPrsStd_AISPresentation > TPrsStd_AISPresentation::Set ( const occ::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.

◆ Set() [2/2]

occ::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.

◆ SetColor()

void TPrsStd_AISPresentation::SetColor ( const Quantity_NameOfColor aColor )

Sets the color aColor for this presentation attribute.

◆ SetDisplayed()

void TPrsStd_AISPresentation::SetDisplayed ( const bool 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 int theMode )

◆ SetSelectionMode()

void TPrsStd_AISPresentation::SetSelectionMode	(	const int	theSelectionMode,
		const bool	theTransaction = 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 double 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 double aWidth )

Sets the width aWidth for this presentation attribute.

◆ Transparency()

double TPrsStd_AISPresentation::Transparency ( ) const

◆ Unset()

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()

double TPrsStd_AISPresentation::Width ( ) const

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

TPrsStd_AISPresentation.hxx

Public Member Functions

Static Public Member Functions

Protected Member Functions

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ TPrsStd_AISPresentation()

Member Function Documentation

◆ AddSelectionMode()

◆ AfterAddition()

◆ AfterResume()

◆ AfterUndo()

◆ BackupCopy()

◆ BeforeForget()

◆ BeforeRemoval()

◆ BeforeUndo()

◆ Color()

◆ Display()

◆ DumpJson()

◆ Erase()

◆ GetAIS()

◆ getData()

◆ GetDriverGUID()

◆ GetID()

◆ GetNbSelectionModes()

◆ HasOwnColor()

◆ HasOwnMaterial()

◆ HasOwnMode()

◆ HasOwnSelectionMode()

◆ HasOwnTransparency()

◆ HasOwnWidth()

◆ ID()

◆ IsDisplayed()

◆ Material()

◆ Mode()

◆ NewEmpty()

◆ Paste()

◆ Restore()

◆ SelectionMode()

◆ Set() [1/2]

◆ Set() [2/2]

◆ SetColor()

◆ SetDisplayed()

◆ SetDriverGUID()

◆ SetMaterial()

◆ SetMode()

◆ SetSelectionMode()

◆ SetTransparency()

◆ SetWidth()

◆ Transparency()

◆ Unset()

◆ UnsetColor()

◆ UnsetMaterial()

◆ UnsetMode()

◆ UnsetSelectionMode()

◆ UnsetTransparency()

◆ UnsetWidth()

◆ Update()

◆ Width()