Open CASCADE Technology  7.3.1.dev
Public Member Functions
AIS_GlobalStatus Class Reference

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

#include <AIS_GlobalStatus.hxx>

Inheritance diagram for AIS_GlobalStatus:
Inheritance graph
[legend]

Public Member Functions

 AIS_GlobalStatus ()
 
 AIS_GlobalStatus (const AIS_DisplayStatus aStat, const Standard_Integer aDispMode, const Standard_Integer aSelMode, const Standard_Boolean ishilighted=Standard_False, const Standard_Integer aLayerIndex=0)
 
void SetGraphicStatus (const AIS_DisplayStatus theStatus)
 
void AddSelectionMode (const Standard_Integer theMode)
 
void SetDisplayMode (const Standard_Integer theMode)
 Sets display mode. More...
 
Standard_Integer DisplayMode () const
 Returns the display mode. More...
 
void SetLayerIndex (const Standard_Integer theIndex)
 
void SetHilightStatus (const Standard_Boolean theStatus)
 
void SetHilightStyle (const Handle< Prs3d_Drawer > &theStyle)
 Changes applied highlight style for a particular object. More...
 
const Handle< Prs3d_Drawer > & HilightStyle () const
 Returns applied highlight style for a particular object. More...
 
Standard_Boolean IsSubIntensityOn () const
 
void SubIntensityOn ()
 
void SubIntensityOff ()
 
void RemoveSelectionMode (const Standard_Integer aMode)
 
void ClearSelectionModes ()
 
AIS_DisplayStatus GraphicStatus () const
 
const TColStd_ListOfIntegerSelectionModes () const
 keeps the active selection modes of the object in the main viewer. More...
 
Standard_Boolean IsHilighted () const
 
Standard_Boolean IsSModeIn (const Standard_Integer aMode) const
 
Standard_Integer GetLayerIndex () const
 Returns layer index. 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...
 

Additional Inherited Members

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

Detailed Description

Stores information about objects in graphic context:

Constructor & Destructor Documentation

◆ AIS_GlobalStatus() [1/2]

AIS_GlobalStatus::AIS_GlobalStatus ( )

◆ AIS_GlobalStatus() [2/2]

AIS_GlobalStatus::AIS_GlobalStatus ( const AIS_DisplayStatus  aStat,
const Standard_Integer  aDispMode,
const Standard_Integer  aSelMode,
const Standard_Boolean  ishilighted = Standard_False,
const Standard_Integer  aLayerIndex = 0 
)

Member Function Documentation

◆ AddSelectionMode()

void AIS_GlobalStatus::AddSelectionMode ( const Standard_Integer  theMode)
inline

◆ ClearSelectionModes()

void AIS_GlobalStatus::ClearSelectionModes ( )

◆ DisplayMode()

Standard_Integer AIS_GlobalStatus::DisplayMode ( ) const
inline

Returns the display mode.

◆ GetLayerIndex()

Standard_Integer AIS_GlobalStatus::GetLayerIndex ( ) const
inline

Returns layer index.

◆ GraphicStatus()

AIS_DisplayStatus AIS_GlobalStatus::GraphicStatus ( ) const
inline

◆ 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

◆ IsSModeIn()

Standard_Boolean AIS_GlobalStatus::IsSModeIn ( const Standard_Integer  aMode) const

◆ IsSubIntensityOn()

Standard_Boolean AIS_GlobalStatus::IsSubIntensityOn ( ) const
inline

◆ RemoveSelectionMode()

void AIS_GlobalStatus::RemoveSelectionMode ( const Standard_Integer  aMode)

◆ SelectionModes()

const TColStd_ListOfInteger& AIS_GlobalStatus::SelectionModes ( ) const
inline

keeps the active selection modes of the object in the main viewer.

◆ SetDisplayMode()

void AIS_GlobalStatus::SetDisplayMode ( const Standard_Integer  theMode)
inline

Sets display mode.

◆ SetGraphicStatus()

void AIS_GlobalStatus::SetGraphicStatus ( const AIS_DisplayStatus  theStatus)
inline

◆ SetHilightStatus()

void AIS_GlobalStatus::SetHilightStatus ( const Standard_Boolean  theStatus)
inline

◆ SetHilightStyle()

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

Changes applied highlight style for a particular object.

◆ SetLayerIndex()

void AIS_GlobalStatus::SetLayerIndex ( const Standard_Integer  theIndex)
inline

◆ SubIntensityOff()

void AIS_GlobalStatus::SubIntensityOff ( )
inline

◆ SubIntensityOn()

void AIS_GlobalStatus::SubIntensityOn ( )
inline

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