0023024: Update headers of OCCT files
[occt.git] / src / AIS2D / AIS2D_LocalStatus.cdl
CommitLineData
b311480e 1-- Created by: Tanya COOL
2-- Copyright (c) 2000-2012 OPEN CASCADE SAS
3--
4-- The content of this file is subject to the Open CASCADE Technology Public
5-- License Version 6.5 (the "License"). You may not use the content of this file
6-- except in compliance with the License. Please obtain a copy of the License
7-- at http://www.opencascade.org and read it completely before using this file.
8--
9-- The Initial Developer of the Original Code is Open CASCADE S.A.S., having its
10-- main offices at: 1, place des Freres Montgolfier, 78280 Guyancourt, France.
11--
12-- The Original Code and all software distributed under the License is
13-- distributed on an "AS IS" basis, without warranty of any kind, and the
14-- Initial Developer hereby disclaims all such warranties, including without
15-- limitation, any warranties of merchantability, fitness for a particular
16-- purpose or non-infringement. Please see the License for the specific terms
17-- and conditions governing the rights and limitations under the License.
18
7fd59977 19
20private class LocalStatus from AIS2D inherits TShared from MMgt
21
22 ---Purpose: Stored Info about temporary objects.
23
24uses
25
26 ListOfInteger from TColStd,
27 NameOfColor from Quantity,
28 PToListOfInt from AIS2D,
29 TypeOfDetection from AIS2D
30is
31
32 Create( isTemporary : Boolean from Standard = Standard_True;
33 Decompose : Boolean from Standard = Standard_False;
34 DMode : Integer from Standard = -1;
35 SMode : Integer from Standard = -1;
36 HMode : TypeOfDetection from AIS2D = AIS2D_TOD_PRIMITIVE;
37 SubIntensity : Boolean from Standard = 0;
38 HighlCol : NameOfColor from Quantity = Quantity_NOC_WHITE )
39 returns mutable LocalStatus from AIS2D;
40 ---Purpose: Initializes the default Local Status
41
42 Decomposed( me ) returns Boolean from Standard;
43 ---C++: inline
44 ---Level: Internal
45 ---Purpose:
46
47 IsTemporary( me ) returns Boolean from Standard;
48 ---C++: inline
49 ---Level: Internal
50 ---Purpose:
51
52 DisplayMode( me ) returns Integer from Standard;
53 ---C++: inline
54 ---Level: Internal
55 ---Purpose:
56
57 SelectionModes( me: mutable ) returns PToListOfInt from AIS2D;
58 ---C++: inline
59 ---Level: Internal
60 ---Purpose:
61
62 IsActivated( me; aSelMode: Integer from Standard ) returns Boolean from Standard;
63 ---Level: Internal
64 ---Purpose:
65
66 HighlightMode( me ) returns TypeOfDetection from AIS2D;
67 ---C++: inline
68 ---Level: Internal
69 ---Purpose:
70
71 IsSubIntensityOn( me ) returns Boolean from Standard;
72 ---C++: inline
73 ---Level: Internal
74 ---Purpose:
75
76 HighlightColor( me ) returns NameOfColor from Quantity;
77 ---C++: inline
78 ---Level: Internal
79 ---Purpose:
80
81 IsFirstDisplay( me ) returns Boolean from Standard;
82 ---C++: inline
83 ---Level: Internal
84 ---Purpose:
85
86 SetDecomposition( me:mutable; aStatus: Boolean from Standard);
87 ---C++: inline
88 ---Level: Internal
89 ---Purpose:
90
91 SetTemporary( me:mutable; aStatus: Boolean from Standard);
92 ---C++: inline
93 ---Level: Internal
94 ---Purpose:
95
96 SetDisplayMode( me:mutable; aMode: Integer from Standard);
97 ---C++: inline
98 ---Level: Internal
99 ---Purpose:
100
101 SetFirstDisplay( me:mutable; aStatus: Boolean from Standard) ;
102 ---C++: inline
103 ---Level: Internal
104 ---Purpose:
105
106 AddSelectionMode( me:mutable; aMode: Integer from Standard );
107 ---Level: Internal
108 ---Purpose:
109
110 RemoveSelectionMode( me:mutable; aMode: Integer from Standard );
111 ---Level: Internal
112 ---Purpose:
113
114 ClearSelectionModes( me:mutable );
115 ---Level: Internal
116 ---Purpose:
117
118 IsSelModeIn( me; aMode: Integer from Standard ) returns Boolean from Standard;
119 ---Level: Internal
120 ---Purpose:
121
122 SetHighlightMode( me: mutable; aMode: TypeOfDetection from AIS2D );
123 ---C++: inline
124 ---Level: Internal
125 ---Purpose:
126
127 SetHighlightColor( me: mutable; aHiCol: NameOfColor from Quantity );
128 ---C++: inline
129 ---Level: Internal
130 ---Purpose:
131
132 SubIntensityOn( me:mutable );
133 ---C++: inline
134 ---Level: Internal
135 ---Purpose:
136
137 SubIntensityOff( me:mutable );
138 ---Level: Internal
139 ---Purpose:
140
141 SetPreviousState( me:mutable; aStatus: Transient from Standard );
142 ---Level: Internal
143 ---Purpose:
144
145 PreviousState( me ) returns any Transient from Standard;
146 ---C++: inline
147 ---Level: Internal
148 ---Purpose:
149
150fields
151
152 myDecomposition : Boolean from Standard;
153 myIsTemporary : Boolean from Standard;
154 myDMode : Integer from Standard;
155 myFirstDisplay : Boolean from Standard;
156 myHMode : TypeOfDetection from AIS2D;
157 mySModes : ListOfInteger from TColStd;
158 mySubIntensity : Boolean from Standard;
159 myHighlCol : NameOfColor from Quantity;
160 myPrevState : Transient from Standard;
161
162end LocalStatus;