Integration of OCCT 6.5.0 from SVN
[occt.git] / src / AIS / AIS_GlobalStatus.cdl
CommitLineData
7fd59977 1-- File: AIS_GlobalStatus.cdl
2-- Created: Fri Jan 24 14:34:35 1997
3-- Author: Robert COUBLANC
4-- <rob@robox.paris1.matra-dtv.fr>
5---Copyright: Matra Datavision 1997
6
7
8private class GlobalStatus from AIS inherits TShared from MMgt
9
10 ---Purpose: Stores information about objects in graphic context:
11 -- - Status Of Display : in the main viewer
12 -- in the collector
13 -- fully Erased
14 -- - Displayed Modes
15 -- - Active Selection Modes
16 -- - is the Interactive Object Current ?
17 -- - Layer Index
18
19uses
20 ListOfInteger from TColStd,
21 DisplayStatus from AIS,
22 NameOfColor from Quantity
23
24is
25
26 Create returns mutable GlobalStatus from AIS;
27
28 Create (aStat : DisplayStatus from AIS;
29 aDispMode,aSelMode: Integer from Standard;
30 ishilighted : Boolean from Standard=Standard_False;
31 TheHiCol : NameOfColor from Quantity = Quantity_NOC_WHITE;
32 aLayerIndex : Integer from Standard = 0)
33 returns mutable GlobalStatus from AIS;
34
35 ---Category: Modifications.
36
37 SetGraphicStatus(me:mutable; aStat : DisplayStatus from AIS);
38 ---C++: inline
39 AddDisplayMode(me:mutable; aMode: Integer from Standard);
40 ---C++: inline
41 AddSelectionMode(me:mutable; aMode : Integer from Standard);
42 ---C++: inline
43 SetLayerIndex (me: mutable ; AnIndex : Integer from Standard);
44 ---C++: inline
45 SetHilightStatus (me: mutable; aStat:Boolean from Standard);
46 ---C++: inline
47 SetHilightColor(me:mutable;aHiCol : NameOfColor from Quantity);
48 ---C++: inline
49
50
51
52 IsSubIntensityOn(me) returns Boolean from Standard;
53 ---C++: inline
54 SubIntensityOn (me: mutable);
55 ---C++: inline
56 SubIntensityOff (me: mutable);
57 ---C++: inline
58
59
60
61 RemoveDisplayMode(me:mutable; aMode : Integer from Standard);
62
63 RemoveSelectionMode(me:mutable; aMode : Integer from Standard);
64 ClearSelectionModes(me:mutable);
65
66
67 ---Category: Information.
68
69
70 GraphicStatus(me) returns DisplayStatus from AIS;
71 ---C++: inline
72
73 DisplayedModes(me) returns ListOfInteger from TColStd;
74 ---C++: return const &
75 ---C++: inline
76 ---Purpose: keeps the information of displayed modes in the
77 -- main viewer.
78 -- (The convention is that the object is displayed
79 -- with the mode 0 in the collector...)
80
81 SelectionModes(me) returns ListOfInteger from TColStd;
82 ---C++: return const &
83 ---C++: inline
84 ---Purpose: keeps the active selection modes of the object
85 -- in the main viewer.
86 -- (The convention is that the active selection mode
87 -- for an object in the collector is the mode 0).
88
89 IsHilighted(me) returns Boolean from Standard;
90 ---C++: inline
91
92 HilightColor(me) returns NameOfColor from Quantity;
93 ---C++: inline
94
95 IsDModeIn(me; aMode : Integer from Standard) returns Boolean from Standard;
96
97 IsSModeIn(me; aMode : Integer from Standard) returns Boolean from Standard;
98
99
100fields
101
102 myStatus : DisplayStatus from AIS;
103 myDispModes : ListOfInteger from TColStd;
104 mySelModes : ListOfInteger from TColStd;
105 myLayerIndex : Integer from Standard;
106 myIsHilit : Boolean from Standard;
107 myHiCol : NameOfColor from Quantity;
108 mySubInt : Boolean;
109end GlobalStatus;