AIS2D_GlobalStatus Class Reference

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

#include <AIS2D_GlobalStatus.hxx>

Inheritance diagram for AIS2D_GlobalStatus:

Public Member Functions
	AIS2D_GlobalStatus ()
	Initialize GlobalStatus the default properties
	AIS2D_GlobalStatus (const AIS2D_DisplayStatus aStat, const Standard_Integer aDMode, const Standard_Integer aSMode, const Standard_Boolean isHighlight=Standard_False, const Quantity_NameOfColor aHighlCol=Quantity_NOC_WHITE, const Standard_Integer aLayerIndex=0)
	Initialize GlobalStatus the concrete properties
void	SetGraphicStatus (const AIS2D_DisplayStatus aStat)
	Sets the graphic status <aStat>
void	AddDisplayMode (const Standard_Integer aMode)
	Adds the display mode <aMode> to the list of display modes
void	RemoveDisplayMode (const Standard_Integer aMode)
	Removes the display mode <aMode> from the list of display modes
Standard_Boolean	IsDModeIn (const Standard_Integer aMode) const
	Returns True if the list of display modes contains the display mode <aMode>
void	AddSelectionMode (const Standard_Integer aMode)
	Adds the selection mode <aMode> to the list of selection modes
void	RemoveSelectionMode (const Standard_Integer aMode)
	Removes the selection mode <aMode> from the list of selection modes
void	ClearSelectionModes ()
	Removes all selection modes from the list of selection modes
Standard_Boolean	IsSModeIn (const Standard_Integer aMode) const
	Returns True if the list of selection modes contains the selection mode <aMode>
void	SetLayerIndex (const Standard_Integer anIndex)
	Sets the layer index <anIndex>
void	SetHighlightStatus (const Standard_Boolean aStat)
	Sets the highlight status
void	SetHighlightColor (const Quantity_NameOfColor aHiCol)
	Sets the color of highight
Standard_Boolean	IsSubIntensityOn () const
	Return True if SubIntensity is on
void	SubIntensityOn ()
	Sets the SubIntensity
void	SubIntensityOff ()
	Unsets the SubIntensity
AIS2D_DisplayStatus	GraphicStatus () const
	Indicates the display status
AIS2D_PToListOfInt	DisplayedModes ()
	keeps the information of displayed modes in the main viewer. (The convention is that the object is displayed with the mode 0 in the collector...)
AIS2D_PToListOfInt	SelectionModes ()
	keeps the active selection modes of the object in the main viewer. (The convention is that the active selection mode for an object in the collector is the mode 0).
Standard_Boolean	IsHighlight () const
	Returns True if highlight is on
Quantity_NameOfColor	HighlightColor () const
	Returns the color of highlight

---

Detailed Description

• Status Of Display : in the main viewer
  in the collector
  fully Erased
  
• Displayed Modes
  
• Active Selection Modes
  
• is the Interactive Object Current ?
  
• Layer Index
  

---

Constructor & Destructor Documentation

AIS2D_GlobalStatus::AIS2D_GlobalStatus

(

)

AIS2D_GlobalStatus::AIS2D_GlobalStatus	(	const AIS2D_DisplayStatus	aStat,
		const Standard_Integer	aDMode,
		const Standard_Integer	aSMode,
		const Standard_Boolean	isHighlight = Standard_False,
		const Quantity_NameOfColor	aHighlCol = Quantity_NOC_WHITE,
		const Standard_Integer	aLayerIndex = 0
	)

---

Member Function Documentation

void AIS2D_GlobalStatus::AddDisplayMode

(

const Standard_Integer

aMode

)

void AIS2D_GlobalStatus::AddSelectionMode

(

const Standard_Integer

aMode

)

void AIS2D_GlobalStatus::ClearSelectionModes

(

)

AIS2D_PToListOfInt AIS2D_GlobalStatus::DisplayedModes

(

)

AIS2D_DisplayStatus AIS2D_GlobalStatus::GraphicStatus

(

)

const

Quantity_NameOfColor AIS2D_GlobalStatus::HighlightColor

(

)

const

Standard_Boolean AIS2D_GlobalStatus::IsDModeIn

(

const Standard_Integer

aMode

)

const

Standard_Boolean AIS2D_GlobalStatus::IsHighlight

(

)

const

Standard_Boolean AIS2D_GlobalStatus::IsSModeIn

(

const Standard_Integer

aMode

)

const

Standard_Boolean AIS2D_GlobalStatus::IsSubIntensityOn

(

)

const

void AIS2D_GlobalStatus::RemoveDisplayMode

(

const Standard_Integer

aMode

)

void AIS2D_GlobalStatus::RemoveSelectionMode

(

const Standard_Integer

aMode

)

AIS2D_PToListOfInt AIS2D_GlobalStatus::SelectionModes

(

)

void AIS2D_GlobalStatus::SetGraphicStatus

(

const AIS2D_DisplayStatus

aStat

)

void AIS2D_GlobalStatus::SetHighlightColor

(

const Quantity_NameOfColor

aHiCol

)

void AIS2D_GlobalStatus::SetHighlightStatus

(

const Standard_Boolean

aStat

)

void AIS2D_GlobalStatus::SetLayerIndex

(

const Standard_Integer

anIndex

)

void AIS2D_GlobalStatus::SubIntensityOff

(

)

void AIS2D_GlobalStatus::SubIntensityOn

(

)

---

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

• AIS2D_GlobalStatus.hxx