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.
Standard_Integer	DisplayMode () const
	Returns the display mode.
void	SetDisplayMode (const Standard_Integer theMode)
	Sets display mode.
Standard_Boolean	IsHilighted () const
	Returns TRUE if object is highlighted.
void	SetHilightStatus (const Standard_Boolean theStatus)
	Sets highlighted state.
void	SetHilightStyle (const Handle< Prs3d_Drawer > &theStyle)
	Changes applied highlight style for a particular object.
const Handle< Prs3d_Drawer > &	HilightStyle () const
	Returns applied highlight style for a particular object.
const TColStd_ListOfInteger &	SelectionModes () const
	Returns active selection modes of the object.
Standard_Boolean	IsSModeIn (Standard_Integer theMode) const
	Return TRUE if selection mode was registered.
Standard_Boolean	AddSelectionMode (const Standard_Integer theMode)
	Add selection mode.
Standard_Boolean	RemoveSelectionMode (const Standard_Integer theMode)
	Remove selection mode.
void	ClearSelectionModes ()
	Remove all selection modes.
Standard_Boolean	IsSubIntensityOn () const
void	SetSubIntensity (Standard_Boolean 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 ()
	Destructor must be virtual.
virtual const opencascade::handle< Standard_Type > &	DynamicType () const
	Returns a type descriptor about this object.
Standard_Boolean	IsInstance (const opencascade::handle< Standard_Type > &theType) const
	Returns a true value if this is an instance of Type.
Standard_Boolean	IsInstance (const Standard_CString theTypeName) const
	Returns a true value if this is an instance of TypeName.
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.
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.
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.
Standard_Integer	GetRefCount () const noexcept
	Get the reference counter of this object.
void	IncrementRefCounter () noexcept
	Increments the reference counter of this object.
Standard_Integer	DecrementRefCounter () noexcept
	Decrements the reference counter of this object; returns the decremented value.
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()

Standard_Boolean AIS_GlobalStatus::AddSelectionMode ( const Standard_Integer theMode )

inline

Add selection mode.

ClearSelectionModes()

void AIS_GlobalStatus::ClearSelectionModes ( )

inline

Remove all selection modes.

DisplayMode()

Standard_Integer AIS_GlobalStatus::DisplayMode ( ) const

inline

Returns the display mode.

HilightStyle()

const Handle< Prs3d_Drawer > & AIS_GlobalStatus::HilightStyle ( ) const

inline

Returns applied highlight style for a particular object.

IsHilighted()

Standard_Boolean AIS_GlobalStatus::IsHilighted ( ) const

inline

Returns TRUE if object is highlighted.

IsSModeIn()

Standard_Boolean AIS_GlobalStatus::IsSModeIn ( Standard_Integer theMode ) const

inline

Return TRUE if selection mode was registered.

IsSubIntensityOn()

Standard_Boolean AIS_GlobalStatus::IsSubIntensityOn ( ) const

inline

RemoveSelectionMode()

Standard_Boolean AIS_GlobalStatus::RemoveSelectionMode ( const Standard_Integer theMode )

inline

Remove selection mode.

SelectionModes()

const TColStd_ListOfInteger & AIS_GlobalStatus::SelectionModes ( ) const

inline

Returns active selection modes of the object.

SetDisplayMode()

void AIS_GlobalStatus::SetDisplayMode ( const Standard_Integer theMode )

inline

Sets display mode.

SetHilightStatus()

void AIS_GlobalStatus::SetHilightStatus ( const Standard_Boolean theStatus )

inline

Sets highlighted state.

SetHilightStyle()

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

inline

Changes applied highlight style for a particular object.

SetSubIntensity()

void AIS_GlobalStatus::SetSubIntensity ( Standard_Boolean theIsOn )

inline

---

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

• AIS_GlobalStatus.hxx