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
|
-- File: Graphic2d_ImageFile.cdl
-- Created: 21 Novembre 1994
-- Author: CAL
--
-- Modified: TCL G002A, 28-11-00, new section "inquire methods"
---Copyright: Matra Datavision 1994
class ImageFile from Graphic2d inherits Primitive from Graphic2d
---Version:
---Purpose: The primitive ImageFile
---Keywords: Primitive, ImageFile
---Warning:
---References:
uses
File from OSD,
AsciiString from TCollection,
Drawer from Graphic2d,
GraphicObject from Graphic2d,
Factor from Quantity,
Length from Quantity,
CardinalPoints from Aspect,
FStream from Aspect,
IFStream from Aspect
raises
ImageDefinitionError from Graphic2d
is
-------------------------
-- Category: Constructors
-------------------------
Create (aGraphicObject: GraphicObject from Graphic2d;
aFile: in out File from OSD;
X, Y: Length from Quantity;
adx: Length from Quantity = 0.0;
ady: Length from Quantity = 0.0;
aTypeOfPlacement: CardinalPoints
from Aspect = Aspect_CP_Center;
aScale: Factor from Quantity = 1.0)
returns mutable ImageFile from Graphic2d
---Level: Public
---Purpose: Defines an image with its center location;
-- <X>, <Y> defines the position in the space model.
-- <adx>, <ady> defines an offset in the device space.
-- <ascale> defines a scale factor applied to the
-- original size of the image.
-- The image will be placed at this offset
-- according to the type of placement.
--
-- CardinalPoints values :
-- - CP_North
-- - CP_NorthEast
-- - CP_East
-- - CP_SouthEast
-- - CP_South
-- - CP_SouthWest
-- - CP_West
-- - CP_NorthWest
-- - CP_Center
raises ImageDefinitionError;
---Trigger:
-- If the file don't exist or has a null size.
---Category: Constructors
--------------------------
-- Category: Draw and Pick
--------------------------
Draw (me : mutable; aDrawer: Drawer from Graphic2d)
is static protected;
---Level: Internal
---Purpose: Draws the image at the required center location
-- defined by the SetCenter method.
---Category: Draw and Pick
Pick (me : mutable;
X, Y: ShortReal from Standard;
aPrecision: ShortReal from Standard;
aDrawer: Drawer from Graphic2d)
returns Boolean from Standard
is static protected;
---Purpose: Returns Standard_True if the image <me> is picked,
-- Standard_False if not.
---Category: Draw and Pick
---------------------------------------------------
-- Category: Methods to modify the class definition
---------------------------------------------------
SetCenter (me: mutable;
X, Y: Length from Quantity)
is static;
---Level: Public
---Purpose: Modifies the center location of the image <me>.
---Category: Methods to modify the class definition
SetOffset (me: mutable;
dx, dy: Length from Quantity)
is static;
---Level: Public
---Purpose: Modifies the offset of the image <me>.
---Category: Methods to modify the class definition
SetPlacement (me: mutable; aPlacement: CardinalPoints from Aspect)
is static;
---Level: Public
---Purpose: Modifies the type of placement of the image <me>.
--
-- CardinalPoints values :
-- - CP_North
-- - CP_NorthEast
-- - CP_East
-- - CP_SouthEast
-- - CP_South
-- - CP_SouthWest
-- - CP_West
-- - CP_NorthWest
-- - CP_Center
---Category: Methods to modify the class definition
Translate (me: mutable;
DX, DY: Length from Quantity)
is static;
---Level: Public
---Purpose: Modifies the center location of the image <me>
-- by translating it.
---Category: Methods to modify the class definition
SetScale (me: mutable; aScale: Factor from Quantity) is static;
---Level: Public
---Purpose: Changes the scale factor of the image.
---Category: Methods to modify the class definition
SetZoomable (me: mutable; aFlag: Boolean from Standard = Standard_False)
is static;
---Level: Public
---Purpose: The image <me> follows the scale factor of the view
-- if the flag is Standard_True.
---Category: Zoom management
Clear (me: mutable) is static;
---Level: Public
---Purpose: Clear the reference to this imagefile if something
-- inside have changed,Forced the reload of this at Draw()
-- time.
---Category: Methods to modify the class definition
----------------------------
-- Category: Zoom management
----------------------------
Scale (me)
returns Factor from Quantity;
---Level: Internal
---Purpose: Returns the original scale factor applied to
-- the image <me>.
---Category: Zoom management
IsZoomable (me)
returns Boolean from Standard is static;
---Level: Internal
---Purpose: Returns Standard_True if the image <me> follows
-- the scale factor of the view.
---Category: Zoom management
----------------------------
-- Category: Inquire methods
----------------------------
Position( me; X, Y: out Length from Quantity );
---Level: Public
---Purpose: returns the position in the space model
Offset( me; aX, aY: out Length from Quantity );
---Level: Public
---Purpose: returns the offset in the device space
Placement( me ) returns CardinalPoints from Aspect;
---Level: Public
---Purpose: returns the type of placement
ImageFile( me ) returns File from OSD;
---Level: Public
---Purpose: returns the image file
Values (myclass;
aFile: in out File from OSD;
aWidth, aHeight: out Integer from Standard;
aDepth: out Integer from Standard)
returns Boolean from Standard;
---Level: Internal
---Purpose: Returns Standard_True, the Image pixel size
-- and the Image planes depth, if the image file :
-- - is not open
-- - exists
-- - have the extension .xwd
-- NOTE that only XWD image file type are recognized.
---Category: Inquire methods
----------------------------
-- Category: Private methods
----------------------------
ComputeCenterAndSize (me : mutable;
aDrawer: Drawer from Graphic2d;
cx, cy, width, height: out ShortReal from Standard)
returns Boolean from Standard is static private;
---Level: Internal
---Purpose: Evaluates the center of the image in the device space.
-- Called by the methods :
-- - Graphic2d_ImageFile::Draw
-- - Graphic2d_ImageFile::Pick
-- - Graphic2d_ImageFile::FillAndDraw
--Returns FALSE if the size cann't gbe evaluated.
---Category: Private methods
SwapLong (myclass;
anAddress: Address from Standard;
aNumOfBytes: Integer from Standard);
---Level: Internal
---Purpose: Swaps long ints
---Category: Private methods
----------------------------------------------------------------------
Save( me; aFStream: in out FStream from Aspect ) is virtual;
-- Retrieve( me; aIFStream: in out IFStream from AIS2D ) is virtual;
fields
myFile: File from OSD;
myFileName: AsciiString from TCollection;
myX, myY: ShortReal from Standard;
mydx, mydy: ShortReal from Standard;
myWidth, myHeight: Integer from Standard;
myPlacement: CardinalPoints from Aspect;
myIsZoomable: Boolean from Standard;
myScale: ShortReal from Standard;
myIsModified: Boolean from Standard;
end ImageFile from Graphic2d;
|
