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
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
|
-- File: Aspect_ColorScale.cdl
-- Created: 22/06/2004
-- Author: STV
--
---Copyright: Open Cascade 2004
--
deferred class ColorScale from Aspect inherits TShared from MMgt
uses
TypeOfColorScaleData from Aspect,
TypeOfColorScalePosition from Aspect,
ColorMap from Aspect,
SequenceOfColor from Aspect,
View from Viewer,
Color from Quantity,
AsciiString from TCollection,
ExtendedString from TCollection,
SequenceOfExtendedString from TColStd
is
---Category: Public
FindColor( me; Value : Real from Standard;
Color : in out Color from Quantity ) returns Boolean from Standard;
---Purpose: Calculate color according passed value; returns true if value is in range or false, if isn't
FindColor( myclass; Value : Real from Standard;
Min, Max : Real from Standard;
ColorsCount : Integer from Standard;
Color : in out Color from Quantity ) returns Boolean from Standard;
GetMin(me)
returns Real from Standard;
---Purpose: Returns minimal value of color scale;
GetMax(me)
returns Real from Standard;
---Purpose: Returns maximal value of color scale;
GetRange(me; aMin : in out Real from Standard;
aMax : in out Real from Standard);
---Purpose: Returns minimal and maximal values of color scale;
GetLabelType(me)
returns TypeOfColorScaleData from Aspect;
---Purpose: Returns the type of labels;
--- Aspect_TOCSD_AUTO - labels as boundary values for intervals
--- Aspect_TOCSD_USER - user specified label is used
GetColorType(me)
returns TypeOfColorScaleData from Aspect;
---Purpose: Returns the type of colors;
--- Aspect_TOCSD_AUTO - value between Red and Blue
--- Aspect_TOCSD_USER - user specified color from color map
GetNumberOfIntervals(me)
returns Integer from Standard;
---Purpose: Returns the number of color scale intervals;
GetTitle(me)
returns ExtendedString from TCollection;
---Purpose: Returns the color scale title string;
GetFormat(me)
returns AsciiString from TCollection;
---Purpose: Returns the format for numbers.
-- The same like format for function printf().
-- Used if GetLabelType() is TOCSD_AUTO;
GetLabel(me; anIndex : Integer from Standard)
returns ExtendedString from TCollection;
---Purpose: Returns the user specified label with index <anIndex>.
-- Returns empty string if label not defined.
GetColor(me; anIndex : Integer from Standard)
returns Color from Quantity;
---Purpose: Returns the user specified color from color map with index <anIndex>.
-- Returns default color if index out of range in color map.
GetLabels(me; aLabels : in out SequenceOfExtendedString from TColStd);
---Purpose: Returns the user specified labels.
GetColors(me; aColors : in out SequenceOfColor from Aspect);
---Purpose: Returns the user specified colors.
GetLabelPosition(me)
returns TypeOfColorScalePosition from Aspect;
---Purpose: Returns the position of labels concerning color filled rectangles.
GetTitlePosition(me)
returns TypeOfColorScalePosition from Aspect;
---Purpose: Returns the position of color scale title.
IsReversed(me)
returns Boolean from Standard;
---Purpose: Returns true if the labels and colors used in reversed order.
IsLabelAtBorder(me)
returns Boolean from Standard;
---Purpose: Returns true if the labels placed at border of color filled rectangles.
SetMin(me : mutable; aMin : Real from Standard);
---Purpose: Sets the minimal value of color scale.
SetMax(me : mutable; aMax : Real from Standard);
---Purpose: Sets the maximal value of color scale.
SetRange(me : mutable; aMin : Real from Standard;
aMax : Real from Standard);
---Purpose: Sets the minimal and maximal value of color scale.
SetLabelType(me : mutable; aType : TypeOfColorScaleData from Aspect);
---Purpose: Sets the type of labels.
-- Aspect_TOCSD_AUTO - labels as boundary values for intervals
-- Aspect_TOCSD_USER - user specified label is used
SetColorType(me : mutable; aType : TypeOfColorScaleData from Aspect);
---Purpose: Sets the type of colors.
-- Aspect_TOCSD_AUTO - value between Red and Blue
-- Aspect_TOCSD_USER - user specified color from color map
SetNumberOfIntervals(me : mutable; aNum : Integer from Standard);
---Purpose: Sets the number of color scale intervals.
SetTitle(me : mutable; aTitle : ExtendedString from TCollection);
---Purpose: Sets the color scale title string.
SetFormat(me : mutable; aFormat : AsciiString from TCollection);
---Purpose: Sets the color scale auto label format specification.
SetLabel(me : mutable; aLabel : ExtendedString from TCollection;
anIndex : Integer from Standard = -1);
---Purpose: Sets the color scale label at index. Index started from 1.
SetColor(me : mutable; aColor : Color from Quantity;
anIndex : Integer from Standard = -1);
---Purpose: Sets the color scale color at index. Index started from 1.
SetLabels(me : mutable; aSeq : SequenceOfExtendedString from TColStd);
---Purpose: Sets the color scale labels.
SetColors(me : mutable; aMap : ColorMap from Aspect);
---Purpose: Sets the color scale colors.
SetColors(me : mutable; aSeq : SequenceOfColor from Aspect);
---Purpose: Sets the color scale colors.
SetLabelPosition(me : mutable; aPos : TypeOfColorScalePosition from Aspect);
---Purpose: Sets the color scale labels position concerning color filled rectangles.
SetTitlePosition(me : mutable; aPos : TypeOfColorScalePosition from Aspect);
---Purpose: Sets the color scale title position.
SetReversed(me : mutable; aReverse : Boolean from Standard);
---Purpose: Sets true if the labels and colors used in reversed order.
SetLabelAtBorder(me : mutable; anOn : Boolean from Standard);
---Purpose: Sets true if the labels placed at border of color filled rectangles.
--- Size and position management
--- Size and position are values relative to view size (between 0 and 1)
GetSize(me; aWidth : in out Real from Standard;
aHeight : in out Real from Standard);
---Purpose: Returns the size of color scale.
GetWidth(me)
returns Real from Standard;
---Purpose: Returns the width of color scale.
GetHeight(me)
returns Real from Standard;
---Purpose: Returns the height of color scale.
SetSize(me : mutable; aWidth : Real from Standard;
aHeight : Real from Standard);
---Purpose: Sets the size of color scale.
SetWidth(me : mutable; aWidth : Real from Standard);
---Purpose: Sets the width of color scale.
SetHeight(me : mutable; aHeight : Real from Standard);
---Purpose: Sets the height of color scale.
GetPosition(me; aX : in out Real from Standard;
aY : in out Real from Standard);
---Purpose: Returns the position of color scale.
GetXPosition(me)
returns Real from Standard;
---Purpose: Returns the X position of color scale.
GetYPosition(me)
returns Real from Standard;
---Purpose: Returns the height of color scale.
SetPosition(me : mutable; aX : Real from Standard;
aY : Real from Standard);
---Purpose: Sets the position of color scale.
SetXPosition(me : mutable; aX : Real from Standard);
---Purpose: Sets the X position of color scale.
SetYPosition(me : mutable; aY : Real from Standard);
---Purpose: Sets the Y position of color scale.
GetTextHeight(me)
returns Integer from Standard;
SetTextHeight(me: mutable; aHeigh : Integer from Standard);
---Category: Protected
Initialize
returns ColorScale from Aspect
is protected;
SizeHint(me; aWidth : in out Integer from Standard;
aHeight : in out Integer from Standard)
is protected;
UpdateColorScale(me : mutable)
is virtual protected;
DrawScale(me : mutable; aBgColor : Color from Quantity;
X, Y, W, H : Integer from Standard)
is protected;
BeginPaint(me : mutable)
returns Boolean from Standard
is virtual protected;
EndPaint(me : mutable)
returns Boolean from Standard
is virtual protected;
PaintRect(me : mutable; X, Y, W, H : Integer from Standard;
aColor : Color from Quantity;
aFilled : Boolean from Standard = Standard_False)
is deferred;
PaintText(me : mutable; aText : ExtendedString from TCollection;
X, Y : Integer from Standard;
aColor : Color from Quantity)
is deferred;
TextWidth(me; aText : ExtendedString from TCollection)
returns Integer from Standard
is deferred;
TextHeight(me; aText : ExtendedString from TCollection)
returns Integer from Standard
is deferred;
---Category: Private
Format(me)
returns AsciiString from TCollection
is private;
GetCurrentLabel(me; anIndex : Integer from Standard)
returns ExtendedString from TCollection
is private;
GetCurrentColor(me; anIndex : Integer from Standard)
returns Color from Quantity
is private;
GetNumber(me; anIndex : Integer from Standard)
returns Real from Standard
is private;
HueFromValue(myclass; aValue : Integer from Standard;
aMin : Integer from Standard;
aMax : Integer from Standard)
returns Integer from Standard
is private;
fields
myMin, myMax : Real from Standard;
myTitle : ExtendedString from TCollection;
myFormat : AsciiString from TCollection;
myInterval : Integer from Standard;
myColorType : TypeOfColorScaleData from Aspect;
myLabelType : TypeOfColorScaleData from Aspect;
myAtBorder : Boolean from Standard;
myReversed : Boolean from Standard;
myColors : SequenceOfColor from Aspect;
myLabels : SequenceOfExtendedString from TColStd;
myLabelPos : TypeOfColorScalePosition from Aspect;
myTitlePos : TypeOfColorScalePosition from Aspect;
myXPos, myYPos : Real from Standard;
myWidth, myHeight : Real from Standard;
myTextHeight : Integer from Standard;
end ColorScale;
|
