# Visualization
TKV2d
AIS2D

# AIS2D_GlobalStatus Class Reference

Stores information about objects in graphic context:
- Status Of Display : in the main viewer
in the collector
fully Erased
- Displayed Modes
- Active Selection Modes
- is the Interactive Object Current ?
- Layer Index
.

`#include <AIS2D_GlobalStatus.hxx>`

## Public Member Functions

Standard_EXPORT | AIS2D_GlobalStatus ()
| Initialize GlobalStatus the default properties .
Standard_EXPORT | 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> .
Standard_EXPORT void | AddDisplayMode (const Standard_Integer aMode)
| Adds the display mode <amode> to the list of display modes .
Standard_EXPORT void | RemoveDisplayMode (const Standard_Integer aMode)
| Removes the display mode <amode> from the list of display modes .
Standard_EXPORT Standard_Boolean | IsDModeIn (const Standard_Integer aMode) const
| Returns True if the list of display modes contains the display mode <amode> .
Standard_EXPORT void | AddSelectionMode (const Standard_Integer aMode)
| Adds the selection mode <amode> to the list of selection modes .
Standard_EXPORT void | RemoveSelectionMode (const Standard_Integer aMode)
| Removes the selection mode <amode> from the list of selection modes .
Standard_EXPORT void | ClearSelectionModes ()
| Removes all selection modes from the list of selection modes .
Standard_EXPORT 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 .
Standard_EXPORT const | Handle (Standard_Type)&DynamicType() const

## Private Attributes

AIS2D_DisplayStatus | myStatus
TColStd_ListOfInteger | myDispModes
TColStd_ListOfInteger | mySelModes
Standard_Integer | myLayerIndex
Standard_Boolean | myIsHighl
Quantity_NameOfColor | myHiCol
Standard_Boolean | mySubInt

## Constructor & Destructor Documentation

Standard_EXPORT AIS2D_GlobalStatus::AIS2D_GlobalStatus | ( |  | ) |

Standard_EXPORT 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

Standard_EXPORT void AIS2D_GlobalStatus::AddDisplayMode | ( | const Standard_Integer | aMode | ) |

Standard_EXPORT void AIS2D_GlobalStatus::AddSelectionMode | ( | const Standard_Integer | aMode | ) |

Standard_EXPORT void AIS2D_GlobalStatus::ClearSelectionModes | ( |  | ) |

AIS2D_PToListOfInt AIS2D_GlobalStatus::DisplayedModes | ( |  | ) | `[inline]`

AIS2D_DisplayStatus AIS2D_GlobalStatus::GraphicStatus | ( |  | ) | const`[inline]`

Standard_EXPORT const AIS2D_GlobalStatus::Handle | ( | Standard_Type |  | ) | const

Quantity_NameOfColor AIS2D_GlobalStatus::HighlightColor | ( |  | ) | const`[inline]`

Standard_EXPORT Standard_Boolean AIS2D_GlobalStatus::IsDModeIn | ( | const Standard_Integer | aMode | ) | const

Standard_Boolean AIS2D_GlobalStatus::IsHighlight | ( |  | ) | const`[inline]`

Standard_EXPORT Standard_Boolean AIS2D_GlobalStatus::IsSModeIn | ( | const Standard_Integer | aMode | ) | const

Standard_Boolean AIS2D_GlobalStatus::IsSubIntensityOn | ( |  | ) | const`[inline]`

Standard_EXPORT void AIS2D_GlobalStatus::RemoveDisplayMode | ( | const Standard_Integer | aMode | ) |

Standard_EXPORT void AIS2D_GlobalStatus::RemoveSelectionMode | ( | const Standard_Integer | aMode | ) |

AIS2D_PToListOfInt AIS2D_GlobalStatus::SelectionModes | ( |  | ) | `[inline]`

void AIS2D_GlobalStatus::SetGraphicStatus | ( | const AIS2D_DisplayStatus | aStat | ) | `[inline]`

void AIS2D_GlobalStatus::SetHighlightColor | ( | const Quantity_NameOfColor | aHiCol | ) | `[inline]`

void AIS2D_GlobalStatus::SetHighlightStatus | ( | const Standard_Boolean | aStat | ) | `[inline]`

void AIS2D_GlobalStatus::SetLayerIndex | ( | const Standard_Integer | anIndex | ) | `[inline]`

void AIS2D_GlobalStatus::SubIntensityOff | ( |  | ) | `[inline]`

void AIS2D_GlobalStatus::SubIntensityOn | ( |  | ) | `[inline]`

## Field Documentation

TColStd_ListOfInteger AIS2D_GlobalStatus::myDispModes `[private]`

Quantity_NameOfColor AIS2D_GlobalStatus::myHiCol `[private]`

Standard_Boolean AIS2D_GlobalStatus::myIsHighl `[private]`

Standard_Integer AIS2D_GlobalStatus::myLayerIndex `[private]`

TColStd_ListOfInteger AIS2D_GlobalStatus::mySelModes `[private]`

AIS2D_DisplayStatus AIS2D_GlobalStatus::myStatus `[private]`

Standard_Boolean AIS2D_GlobalStatus::mySubInt `[private]`

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

- AIS2D_GlobalStatus.hxx
- AIS2D_GlobalStatus.lxx