blob: ca1ebfd8c4347518742ffe3db7165cbd1a844d89 (
plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
|
-- File: XCAFDoc_ColorTool.cdl
-- Created: Thu May 11 10:05:27 2000
-- Author: Edward AGAPOV
-- <det@strelox.nnov.matra-dtv.fr>
---Copyright: Matra Datavision 2000
class ColorTool from XCAFDoc inherits Attribute from TDF
---Purpose: Provides tools to store and retrieve attributes (colors)
-- of TopoDS_Shape in and from TDocStd_Document
-- A Document is intended to hold different
-- attributes of ONE shape and it's sub-shapes
uses
Color from Quantity,
Shape from TopoDS,
Label from TDF,
LabelSequence from TDF,
Document from TDocStd,
ColorType from XCAFDoc,
ShapeTool from XCAFDoc,
RelocationTable from TDF
is
Create returns ColorTool from XCAFDoc;
Set (myclass; L : Label from TDF) returns ColorTool from XCAFDoc;
---Purpose: Creates (if not exist) ColorTool.
GetID (myclass)
---C++: return const &
returns GUID from Standard;
---API: General structure
BaseLabel(me) returns Label from TDF;
---Purpose: returns the label under which colors are stored
ShapeTool (me: mutable) returns ShapeTool from XCAFDoc;
---Purpose: Returns internal XCAFDoc_ShapeTool tool
---C++: return const &
---API: Color table management
IsColor (me; lab: Label from TDF) returns Boolean;
---Purpose: Returns True if label belongs to a colortable and
-- is a color definition
GetColor (me; lab: Label from TDF; col: out Color from Quantity)
returns Boolean;
---Purpose: Returns color defined by label lab
-- Returns False if the label is not in colortable
-- or does not define a color
FindColor (me; col: Color from Quantity; lab: out Label from TDF)
returns Boolean;
---Purpose: Finds a color definition in a colortable and returns
-- its label if found
-- Returns False if color is not found in colortable
FindColor (me; col: Color from Quantity) returns Label from TDF;
---Purpose: Finds a color definition in a colortable and returns
-- its label if found (or Null label else)
AddColor (me; col: Color from Quantity) returns Label from TDF;
---Purpose: Adds a color definition to a colortable and returns
-- its label (returns existing label if the same color
-- is already defined)
RemoveColor (me; lab: Label from TDF);
---Purpose: Removes color from the colortable
GetColors (me; Labels: out LabelSequence from TDF);
---Purpose: Returns a sequence of colors currently stored
-- in the colortable
---API: Assignment of colors to labels
SetColor (me; L: Label from TDF;
colorL: Label from TDF;
type : ColorType from XCAFDoc);
---Purpose: Sets a link with GUID defined by <type> (see
-- XCAFDoc::ColorRefGUID()) from label <L> to color
-- defined by <colorL>
SetColor (me; L: Label from TDF;
Color: Color from Quantity;
type : ColorType from XCAFDoc);
---Purpose: Sets a link with GUID defined by <type> (see
-- XCAFDoc::ColorRefGUID()) from label <L> to color <Color>
-- in the colortable
-- Adds a color as necessary
UnSetColor (me; L: Label from TDF;
type : ColorType from XCAFDoc);
---Purpose: Removes a link with GUID defined by <type> (see
-- XCAFDoc::ColorRefGUID()) from label <L> to color
IsSet (me; L: Label from TDF;
type : ColorType from XCAFDoc) returns Boolean;
---Purpose: Returns True if label <L> has a color assignment
-- of the type <type>
GetColor (me: mutable; L: Label from TDF;
type : ColorType from XCAFDoc;
colorL: out Label from TDF) returns Boolean;
---Purpose: Returns label with color assigned to <L> as <type>
-- Returns False if no such color is assigned
GetColor (me: mutable; L: Label from TDF;
type : ColorType from XCAFDoc;
color: out Color from Quantity) returns Boolean;
---Purpose: Returns color assigned to <L> as <type>
-- Returns False if no such color is assigned
---API: Assignment of colors to shapes in Shapes section
SetColor (me: mutable; S: Shape from TopoDS;
colorL: Label from TDF;
type : ColorType from XCAFDoc) returns Boolean;
---Purpose: Sets a link with GUID defined by <type> (see
-- XCAFDoc::ColorRefGUID()) from label <L> to color
-- defined by <colorL>
-- Returns False if cannot find a label for shape S
SetColor (me: mutable; S: Shape from TopoDS;
Color: Color from Quantity;
type : ColorType from XCAFDoc) returns Boolean;
---Purpose: Sets a link with GUID defined by <type> (see
-- XCAFDoc::ColorRefGUID()) from label <L> to color <Color>
-- in the colortable
-- Adds a color as necessary
-- Returns False if cannot find a label for shape S
UnSetColor (me: mutable; S: Shape from TopoDS;
type : ColorType from XCAFDoc) returns Boolean;
---Purpose: Removes a link with GUID defined by <type> (see
-- XCAFDoc::ColorRefGUID()) from label <L> to color
-- Returns True if such link existed
IsSet (me: mutable; S: Shape from TopoDS;
type : ColorType from XCAFDoc) returns Boolean;
---Purpose: Returns True if label <L> has a color assignment
-- of the type <type>
GetColor (me: mutable; S: Shape from TopoDS;
type : ColorType from XCAFDoc;
colorL: out Label from TDF) returns Boolean;
---Purpose: Returns label with color assigned to <L> as <type>
-- Returns False if no such color is assigned
GetColor (me: mutable; S: Shape from TopoDS;
type : ColorType from XCAFDoc;
color: out Color from Quantity) returns Boolean;
---Purpose: Returns color assigned to <L> as <type>
-- Returns False if no such color is assigned
IsVisible (me; L: Label from TDF)
---Purpose: Return TRUE if object on this label is visible, FALSE if invisible.
returns Boolean;
SetVisibility (me: mutable; shapeLabel: Label from TDF;
isvisible: Boolean = Standard_True);
---Purpose: Set the visibility of object on label. Do nothing if there no any object.
-- Set UAttribute with corresponding GUID.
SetInstanceColor (me: mutable; theShape : Shape from TopoDS;
type : ColorType from XCAFDoc;
color: Color from Quantity;
isCreateSHUO : Boolean = Standard_True)
returns Boolean;
---Purpose: Sets the color of component that styled with SHUO structure
-- Returns FALSE if no sush component found
-- NOTE: create SHUO structeure if it is necessary and if <isCreateSHUO>
GetInstanceColor (me: mutable; theShape : Shape from TopoDS;
type : ColorType from XCAFDoc;
color: out Color from Quantity)
returns Boolean;
---Purpose: Gets the color of component that styled with SHUO structure
-- Returns FALSE if no sush component or color type
IsInstanceVisible (me: mutable; theShape : Shape from TopoDS)
returns Boolean;
---Purpose: Gets the visibility status of component that styled with SHUO structure
-- Returns FALSE if no sush component
ReverseChainsOfTreeNodes(me: mutable) returns Boolean; -- skl 11.11.2003
---Purpose: Reverses order in chains of TreeNodes (from Last to First) under
-- each Color Label since we became to use function ::Prepend()
-- instead of ::Append() in method SetColor() for acceleration
---Category: TDF_Attribute methods
-- =====================
ID (me)
---C++: return const &
returns GUID from Standard;
Restore (me: mutable; with : Attribute from TDF);
NewEmpty (me)
returns mutable Attribute from TDF;
Paste (me; into : mutable Attribute from TDF;
RT : mutable RelocationTable from TDF);
fields
myShapeTool: ShapeTool from XCAFDoc;
end ColorTool;
|
