0024343: AIS_DisplayStatus - outdated description
[occt.git] / src / AIS / AIS_GlobalStatus.cdl
CommitLineData
b311480e 1-- Created on: 1997-01-24
2-- Created by: Robert COUBLANC
3-- Copyright (c) 1997-1999 Matra Datavision
4-- Copyright (c) 1999-2012 OPEN CASCADE SAS
5--
6-- The content of this file is subject to the Open CASCADE Technology Public
7-- License Version 6.5 (the "License"). You may not use the content of this file
8-- except in compliance with the License. Please obtain a copy of the License
9-- at http://www.opencascade.org and read it completely before using this file.
10--
11-- The Initial Developer of the Original Code is Open CASCADE S.A.S., having its
12-- main offices at: 1, place des Freres Montgolfier, 78280 Guyancourt, France.
13--
14-- The Original Code and all software distributed under the License is
15-- distributed on an "AS IS" basis, without warranty of any kind, and the
16-- Initial Developer hereby disclaims all such warranties, including without
17-- limitation, any warranties of merchantability, fitness for a particular
18-- purpose or non-infringement. Please see the License for the specific terms
19-- and conditions governing the rights and limitations under the License.
20
7fd59977 21
22
23private class GlobalStatus from AIS inherits TShared from MMgt
24
25 ---Purpose: Stores information about objects in graphic context:
26 -- - Status Of Display : in the main viewer
ed8cad74 27 -- hidden in the main viewer
7fd59977 28 -- - Displayed Modes
29 -- - Active Selection Modes
30 -- - is the Interactive Object Current ?
31 -- - Layer Index
32
33uses
34 ListOfInteger from TColStd,
35 DisplayStatus from AIS,
36 NameOfColor from Quantity
37
38is
39
40 Create returns mutable GlobalStatus from AIS;
41
42 Create (aStat : DisplayStatus from AIS;
43 aDispMode,aSelMode: Integer from Standard;
44 ishilighted : Boolean from Standard=Standard_False;
45 TheHiCol : NameOfColor from Quantity = Quantity_NOC_WHITE;
46 aLayerIndex : Integer from Standard = 0)
47 returns mutable GlobalStatus from AIS;
48
49 ---Category: Modifications.
50
51 SetGraphicStatus(me:mutable; aStat : DisplayStatus from AIS);
52 ---C++: inline
53 AddDisplayMode(me:mutable; aMode: Integer from Standard);
54 ---C++: inline
55 AddSelectionMode(me:mutable; aMode : Integer from Standard);
56 ---C++: inline
57 SetLayerIndex (me: mutable ; AnIndex : Integer from Standard);
58 ---C++: inline
59 SetHilightStatus (me: mutable; aStat:Boolean from Standard);
60 ---C++: inline
61 SetHilightColor(me:mutable;aHiCol : NameOfColor from Quantity);
62 ---C++: inline
63
64
65
66 IsSubIntensityOn(me) returns Boolean from Standard;
67 ---C++: inline
68 SubIntensityOn (me: mutable);
69 ---C++: inline
70 SubIntensityOff (me: mutable);
71 ---C++: inline
72
73
74
75 RemoveDisplayMode(me:mutable; aMode : Integer from Standard);
76
77 RemoveSelectionMode(me:mutable; aMode : Integer from Standard);
78 ClearSelectionModes(me:mutable);
79
80
81 ---Category: Information.
82
83
84 GraphicStatus(me) returns DisplayStatus from AIS;
85 ---C++: inline
86
87 DisplayedModes(me) returns ListOfInteger from TColStd;
88 ---C++: return const &
89 ---C++: inline
90 ---Purpose: keeps the information of displayed modes in the
91 -- main viewer.
ed8cad74 92
7fd59977 93 SelectionModes(me) returns ListOfInteger from TColStd;
94 ---C++: return const &
95 ---C++: inline
96 ---Purpose: keeps the active selection modes of the object
97 -- in the main viewer.
7fd59977 98
99 IsHilighted(me) returns Boolean from Standard;
100 ---C++: inline
101
102 HilightColor(me) returns NameOfColor from Quantity;
103 ---C++: inline
104
105 IsDModeIn(me; aMode : Integer from Standard) returns Boolean from Standard;
106
107 IsSModeIn(me; aMode : Integer from Standard) returns Boolean from Standard;
108
109
110fields
111
112 myStatus : DisplayStatus from AIS;
113 myDispModes : ListOfInteger from TColStd;
114 mySelModes : ListOfInteger from TColStd;
115 myLayerIndex : Integer from Standard;
116 myIsHilit : Boolean from Standard;
117 myHiCol : NameOfColor from Quantity;
118 mySubInt : Boolean;
119end GlobalStatus;