AIS_GlobalStatus Class Reference

Stores information about objects in graphic context: More...

#include <AIS_GlobalStatus.hxx>

Inheritance diagram for AIS_GlobalStatus:

Public Member Functions
	AIS_GlobalStatus ()
	Default constructor.
int	DisplayMode () const
	Returns the display mode.
void	SetDisplayMode (const int theMode)
	Sets display mode.
bool	IsHilighted () const
	Returns TRUE if object is highlighted.
void	SetHilightStatus (const bool theStatus)
	Sets highlighted state.
void	SetHilightStyle (const occ::handle< Prs3d_Drawer > &theStyle)
	Changes applied highlight style for a particular object.
const occ::handle< Prs3d_Drawer > &	HilightStyle () const
	Returns applied highlight style for a particular object.
const NCollection_List< int > &	SelectionModes () const
	Returns active selection modes of the object.
bool	IsSModeIn (int theMode) const
	Return TRUE if selection mode was registered.
bool	AddSelectionMode (const int theMode)
	Add selection mode.
bool	RemoveSelectionMode (const int theMode)
	Remove selection mode.
void	ClearSelectionModes ()
	Remove all selection modes.
bool	IsSubIntensityOn () const
void	SetSubIntensity (bool theIsOn)
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.

Additional Inherited Members
Public Types inherited from Standard_Transient
typedef void	base_type
	Returns a type descriptor about this object.
Static Public Member Functions inherited from Standard_Transient
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.

Detailed Description

Stores information about objects in graphic context:

Constructor & Destructor Documentation

AIS_GlobalStatus()

AIS_GlobalStatus::AIS_GlobalStatus

(

)

Default constructor.

Member Function Documentation

AddSelectionMode()

bool AIS_GlobalStatus::AddSelectionMode ( const int theMode )

inline

Add selection mode.

ClearSelectionModes()

void AIS_GlobalStatus::ClearSelectionModes ( )

inline

Remove all selection modes.

DisplayMode()

int AIS_GlobalStatus::DisplayMode ( ) const

inline

Returns the display mode.

HilightStyle()

const occ::handle< Prs3d_Drawer > & AIS_GlobalStatus::HilightStyle ( ) const

inline

Returns applied highlight style for a particular object.

IsHilighted()

bool AIS_GlobalStatus::IsHilighted ( ) const

inline

Returns TRUE if object is highlighted.

IsSModeIn()

bool AIS_GlobalStatus::IsSModeIn ( int theMode ) const

inline

Return TRUE if selection mode was registered.

IsSubIntensityOn()

bool AIS_GlobalStatus::IsSubIntensityOn ( ) const

inline

RemoveSelectionMode()

bool AIS_GlobalStatus::RemoveSelectionMode ( const int theMode )

inline

Remove selection mode.

SelectionModes()

const NCollection_List< int > & AIS_GlobalStatus::SelectionModes ( ) const

inline

Returns active selection modes of the object.

SetDisplayMode()

void AIS_GlobalStatus::SetDisplayMode ( const int theMode )

inline

Sets display mode.

SetHilightStatus()

void AIS_GlobalStatus::SetHilightStatus ( const bool theStatus )

inline

Sets highlighted state.

SetHilightStyle()

void AIS_GlobalStatus::SetHilightStyle ( const occ::handle< Prs3d_Drawer > & theStyle )

inline

Changes applied highlight style for a particular object.

SetSubIntensity()

void AIS_GlobalStatus::SetSubIntensity ( bool theIsOn )

inline

---

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

• AIS_GlobalStatus.hxx