0022149: Strings with Japanese characters can not be displayed in 3D viewer
[occt.git] / src / V3d / V3d_View.cdl
1 --
2 -- File:        V3d_View.cdl
3 -- Created:     Wed Jan 15 14:47:42 1992
4 -- Author:      GG
5 -- Modified:    FMN - 24/12/97 -> Suppression GEOMLITE
6 --              CQO - 24/12/97 -> BUC50037
7 --              stt:25-02-98; S3558: ajout IfManageStandardEvent
8 --              stt:08-04-98; suppr IfManageStandardEvent
9 --              CAL - 18/08/98 -> S3892. Ajout grilles 3d.
10 --              BGN - 16-09-98; Points d'entree du Triedre (S3819, Phase 1)
11 --              22-09-98 ; BGN : S3989 (anciennement S3819)
12 --                               TypeOfTriedron* from Aspect(et pas V3d)
13 --              CAL - 21/10/98 -> Speciale. Ajout methode Tumble.
14 --              29-OCT-98 : DCB : Adding ScreenCopy () method.
15 --      GG - 10/11/99 : PRO19603 Adding Redraw( area ) method
16 --      GG - 15/12/99 : GER61351 Adding SetBackgroundColor()
17 --                   and    BackgroundColor() methods
18 --      GG - 24/01/00 : -> Remove internal PixToRef() method, use Convert()
19 --                method instead.
20 --              -> Rename internal RefToPix() to Convert() method.
21 --              -> Add ConvertToGrid() methods,
22 --                 the Compute() internal method become private.
23 --              -> Add SetProjModel() method.
24 --      EUG - 25/01/00 : G003
25 --              -> Add methods SetAnimationMode() and
26 --                  AnimationMode()
27 --              -> Add methods SetComputedMode() and
28 --                  ComputedMode()
29 --                 Warning : SetDegenerateModeOn() and Off()
30 --                 become obsolete.
31 --              -> Add methods SetBackFacingModel() and
32 --                  BackFacingModel()
33 --      VKH - 15/11/99 : G004
34 --              -> Add method Dump()
35 --      GG  - IMP210200
36 --              -> Add Transparency() method
37 --
38 --      THA  - 17/08/00 Thomas HARTL <t-hartl@muenchen.matra-dtv.fr>
39 --              -> Add Print method (works only under Windows).
40 --
41 --      GG  - IMP231100
42 --              -> Add IsActiveLight() & IsActivePlane() methods
43 --      SZV - IMP100701
44 --              -> Add ToPixMap() method
45 --              GG - RIC120302 Add NEW SetWindow method.
46 --
47 --              SAV - 22/10/01
48 --                              -> Add EnableDepthTest() & IsDepthTestEnabled().
49 --              VSV - 28/05/02: ZBUFFER mode of Trihedron
50 --
51 --              SAV - 23/12/02  -> Added methods to set background image
52 --
53 --              NKV - 23/07/07  -> Define custom projection and model view matrixes
54 --
55 --              NKV - 08/02/07  -> Add ConvertWithProj() method
56 --
57 ---Copyright:   Matra Datavision 1992
58 --
59
60 deferred class View from V3d
61
62         ---Purpose: Defines the application object VIEW for the
63         --          VIEWER application.
64         --          The methods of this class allow the editing
65         --          and inquiring the parameters linked to the view.
66         --          (Projection,Mapping,Zclipping,DepthCueing,AntiAliasing
67         --           et Conversions) .
68         --  Warning: The default parameters are defined by the class
69         --          Viewer (Example : SetDefaultViewSize()).
70         --          Certain methods are mouse oriented, and it is
71         --          necessary to know the difference between the start and
72         --          the continuation of this gesture in putting the method
73         --          into operation.
74         --          Example : Shifting the eye-view along the screen axes.
75         --
76         --              View->Move(10.,20.,0.,True)     (Starting motion)
77         --              View->Move(15.,-5.,0.,False)    (Next motion)
78
79
80 inherits
81
82         View from Viewer
83
84 uses
85
86         -- S3892
87         Ax3                     from gp,
88         LayerMgr                from V3d,
89         ColorScale              from V3d,
90         ColorScale              from Aspect,
91         Array2OfReal            from TColStd,
92         Grid                    from Aspect,
93         Handle                  from Aspect,
94         Structure               from Graphic3d,
95         Group                   from Graphic3d,
96
97         ListOfTransient                   from V3d,
98         ListIteratorOfListOfTransient     from TColStd,
99         TypeOfView                        from V3d,
100         TypeOfAxe                         from V3d,
101         TypeOfOrientation                 from V3d,
102         TypeOfShadingModel                from V3d,
103         TypeOfSurfaceDetail               from V3d,
104         TextureEnv                        from Graphic3d,
105         TypeOfVisualization               from V3d,
106         TypeOfZclipping                   from V3d,
107         TypeOfProjectionModel             from V3d,
108         TypeOfBackfacingModel             from V3d,
109         Viewer                            from V3d,
110         Light                             from V3d,
111         Plane                             from V3d,
112         View                              from Visual3d,
113         ViewMapping                       from Visual3d,
114         ViewOrientation                   from Visual3d,
115         ContextView                       from Visual3d,
116         Vector                            from Graphic3d,
117         Vertex                            from Graphic3d,
118         Plotter                           from Graphic3d,
119         Window                            from Aspect,
120         PixMap                            from Image,
121         TypeOfImage                       from Image,
122         Background                        from Aspect,
123         GradientBackground                from Aspect,
124         PlotterDriver                     from PlotMgt,
125         TypeOfColor                       from Quantity,
126         NameOfColor                       from Quantity,
127         Color                             from Quantity,
128         Length                            from Quantity,
129         PlaneAngle                        from Quantity,
130         Parameter                         from Quantity,
131         Factor                            from Quantity,
132         Ratio                             from Quantity,
133         Coefficient                       from Quantity,
134         Coordinate                        from V3d,
135         Array2OfReal                      from TColStd,
136         ViewerPointer                     from V3d,
137         TransientManager                  from Visual3d,
138         TypeOfTriedronEcho                from Aspect,
139         TypeOfTriedronPosition            from Aspect,
140         FormatOfSheetPaper                from Aspect,
141         RenderingContext                  from Aspect,
142         GraphicCallbackProc               from Aspect,
143         FillMethod                        from Aspect,
144         GradientFillMethod                from Aspect,
145         FontAspect                        from OSD,
146         AsciiString                       from TCollection,
147         ExtendedString                    from TCollection
148
149 raises
150
151         BadValue from Viewer, TypeMismatch from Standard,
152         MultiplyDefined from Standard,UnMapped from V3d
153
154 is
155
156         Initialize ( VM : mutable Viewer; Type : TypeOfView from V3d = V3d_ORTHOGRAPHIC );
157         ---Purpose: Initialises the view.
158
159         Initialize ( VM : mutable Viewer ; V : View from V3d; Type : TypeOfView from V3d = V3d_ORTHOGRAPHIC );
160         ---Purpose: Initialises the view by copying.
161
162         --------------------------------------------------------
163         ---Category: Methods to modify the Status of the view
164         --------------------------------------------------------
165
166         SetWindow ( me : mutable ; IdWin : Window )
167         ---Purpose: Activates the view in the window specified and Map the
168         --          Window to the screen.
169         raises MultiplyDefined from Standard;
170         ---Level: Public
171         ---Purpose:  Warning! raises MultiplyDefined from Standard
172         --      if the view is already activated in a window.
173         --  Warning: The view is centered and resized to preserve
174         --          the height/width ratio of the window.
175
176         SetWindow ( me            : mutable ;
177                     aWindow       : Window from Aspect;
178                     aContext      : RenderingContext from Aspect;
179                     aDisplayCB    : GraphicCallbackProc from Aspect;
180                     aClientData   : Address from Standard
181           )
182         ---Purpose: Activates the view in the specified Window
183         --      If <aContext> is not NULL the graphic context is used
184         --          to draw something in this view.
185         --      Otherwise an internal graphic context is created.
186         --      If <aDisplayCB> is not NULL then a user display CB is
187         --      call at the end of the OCC graphic traversal and just
188         --      before the swap of buffers. The <aClientData> is pass
189         --      to this call back.
190         raises MultiplyDefined from Standard;
191         ---Level: Public
192         ---Purpose:  Warning! raises MultiplyDefined from Standard
193         --      if the view is already activated in a window.
194         --  Warning: The view is centered and resized to preserve
195         --          the height/width ratio of the window.
196
197         SetMagnify (me: mutable; IdWin            : Window;
198                                  aPreviousView    : View from V3d;
199                                  x1 , y1 , x2 , y2: Integer from Standard)
200         is static;
201
202         Remove ( me );
203         ---Level: Public
204         ---Purpose: Destroys the view.
205
206         Update ( me ) is redefined static;
207         ---Level: Public
208         ---Purpose: Updates the display of the view.
209         --          Must be called to update the view
210         --          when the update mode is deferred (WAIT) .
211
212         Redraw ( me );
213         ---Level: Public
214         ---Purpose: Redisplays the view even if there has not
215         --          been any modification.
216         --          Must be called if the view is shown.
217         --          (Ex: DeIconification ) .
218
219         Redraw ( me ;x,y,width,height: Integer from Standard);
220         ---Level: Public
221         ---Purpose: Redisplays the view area after esxposure.
222     -- [x,y] define the min xy area position
223     -- [width,height] the size of the area in pixel unit.
224
225         MustBeResized ( me : mutable )
226         ---Level: Public
227         ---Purpose: Must be called when the window supporting the
228         --          view changes size.
229         raises UnMapped from V3d;
230         ---Purpose:      if the view is not mapped on a window.
231         --  Warning: The view is centered and resized to preserve
232         --          the height/width ratio of the window.
233
234         DoMapping ( me : mutable );
235         ---Level: Advanced
236         ---Purpose: Must be called when the window supporting the
237         --          view is mapped or unmapped.
238
239         IsEmpty ( me ) returns Boolean;
240         ---Level: Public
241         ---Purpose: Returns the status of the view regarding
242         --          the displayed structures inside
243         --          Returns True is The View is empty
244
245         UpdateLights (me);
246         ---Level: Public
247         ---Purpose: Updates the lights of the view. The view is redrawn.
248
249         --------------------------------------------------------
250         ---Category: Methods to modify the Attributes of the view
251         --------------------------------------------------------
252
253         SetBackgroundColor ( me : mutable ;
254                         Type : TypeOfColor; V1, V2, V3 : Parameter );
255         ---Level: Public
256         ---Purpose: Defines the background colour of the view
257         --          by supplying :
258         --          the colour definition type,
259         --          and the three corresponding values.
260
261         SetBackgroundColor ( me : mutable ; Color : Color from Quantity );
262         ---Level: Public
263         ---Purpose: Defines the background colour of the view
264         --          by supplying :
265         --          the colour object.
266
267         SetBackgroundColor ( me : mutable ; Name : NameOfColor );
268         ---Level: Public
269         ---Purpose: Defines the background colour of the view
270         --          by supplying :
271         --          the colour name in the form Quantity_NOC_xxxx .
272
273         SetBgGradientColors ( me : mutable ;
274                               Color1 : Color from Quantity;
275                               Color2 : Color from Quantity;
276                               FillStyle : GradientFillMethod from Aspect = Aspect_GFM_HOR;
277                               update    : Boolean from Standard = Standard_False );
278         ---Level: Public
279         ---Purpose: Defines the gradient background colours of the view
280         --          by supplying :
281         --          the colour objects.
282
283         SetBgGradientColors ( me : mutable ;
284                               Color1 : NameOfColor;
285                               Color2 : NameOfColor;
286                               FillStyle : GradientFillMethod from Aspect = Aspect_GFM_HOR;
287                               update    : Boolean from Standard = Standard_False );
288         ---Level: Public
289         ---Purpose: Defines the gradient background colours of the view
290         --          by supplying :
291         --          the colour names in the form Quantity_NOC_xxxx .
292
293         SetBgGradientStyle( me      ;
294                             AMethod : GradientFillMethod from Aspect = Aspect_GFM_HOR;
295                             update  : Boolean from Standard = Standard_False);
296         ---Level: Public
297         ---Purpose: Defines the gradient background fill method of the view
298
299         SetBackgroundImage( me : mutable; FileName  : CString from Standard;
300               FillStyle : FillMethod from Aspect = Aspect_FM_CENTERED;
301                   update    : Boolean from Standard = Standard_False );
302
303         SetBgImageStyle( me : mutable; FillStyle : FillMethod from Aspect;
304                                    update    : Boolean from Standard = Standard_False );
305
306         SetAxis ( me : mutable; X,Y,Z : Coordinate ;
307                                 Vx,Vy,Vz : Parameter )
308         ---Level: Public
309         ---Purpose: Definition of an axis from its origin and
310         --          its orientation .
311         --          This will be the current axis for rotations and movements.
312         raises BadValue from Viewer;
313         ---Purpose:  Warning! raises BadValue from Viewer if the vector normal is NULL. .
314
315         SetShadingModel ( me : mutable; Model : TypeOfShadingModel );
316         ---Level: Public
317         ---Purpose: Defines the shading model for the
318         --          visualisation ZBUFFER mode.
319         --          Various models are available.
320
321         SetSurfaceDetail(me  : mutable; SurfaceDetail : TypeOfSurfaceDetail);
322         ---Level: Public
323         ---Purpose: select the kind of rendering for texture mapping
324         --          no texture mapping by default
325
326         SetTextureEnv(me  : mutable; ATexture  :  TextureEnv  from  Graphic3d);
327         ---Level: Public
328         ---Purpose: set the environment texture to use
329         --          no environment texture by default
330
331         SetVisualization ( me : mutable;
332                                 Mode : TypeOfVisualization from V3d );
333         ---Level: Public
334         ---Purpose: Defines the visualisation mode in the view.
335
336         SetAntialiasingOn ( me : mutable );
337         ---Level: Public
338         ---Purpose: Activates antialiasing in the view.
339
340         SetAntialiasingOff ( me : mutable );
341         ---Level: Public
342         ---Purpose: Desactivates antialiasing in the view.
343
344         SetZClippingDepth ( me : mutable; Depth : Length );
345         ---Level: Public
346         ---Purpose: Defines the depth of the medium clipping plane.
347
348         SetZClippingWidth ( me : mutable; Width : Length )
349         ---Level: Public
350         ---Purpose: Defines the thicknes around the medium clippling plane.   .
351                 raises BadValue from Viewer;
352         --      If the thickness is <= 0
353
354         SetZClippingType ( me : mutable; Type : TypeOfZclipping );
355         ---Level: Public
356         ---Purpose: Defines the type of ZClipping.
357
358         SetZCueingDepth ( me : mutable; Depth : Length );
359         ---Level: Public
360         ---Purpose: Defines the depth of the medium plane.
361
362         SetZCueingWidth ( me : mutable; Width : Length )
363         ---Level: Public
364         ---Purpose: Defines the thickness around the medium plane.
365                 raises BadValue from Viewer;
366         --      If thickness is <= 0
367
368         SetZCueingOn ( me : mutable );
369         ---Level: Public
370         ---Purpose: Activates ZCueing in the view.
371
372         SetZCueingOff ( me : mutable );
373         ---Level: Public
374         ---Purpose: Desactivates ZCueing in the view.
375
376         SetLightOn( me : mutable ; MyLight : Light from V3d )
377         ---Level: Public
378         ---Purpose: Activates MyLight in the view.
379                 raises BadValue from Viewer;
380         --      If No More Light can be activated in MyView .
381
382         SetLightOn( me : mutable )
383         ---Level: Public
384         ---Purpose: Activates all the lights defined in this view.
385                 raises BadValue from Viewer;
386         --      If No More Light can be activated in MyView .
387
388         SetLightOff( me : mutable ; MyLight : Light  from V3d );
389         ---Level: Public
390         ---Purpose: Desactivate MyLight in this view.
391
392         SetLightOff( me : mutable );
393         ---Level: Public
394         ---Purpose: Deactivate all the Lights defined in this view.
395
396     IsActiveLight( me ; aLight: Light  from V3d )
397         returns Boolean from Standard;
398         ---Level: Public
399         ---Purpose: Returns TRUE when the light is active in this view.
400
401         SetTransparency( me : mutable ; AnActivity : Boolean = Standard_False);
402         ---Level: Public
403         ---Purpose: Activate/Deactivate the transparency in this view.
404
405         SetPlaneOn( me : mutable ; MyPlane : Plane from V3d )
406         ---Level: Public
407         ---Purpose: Activates the clipping plane in this view.
408                 raises BadValue from Viewer ;
409         ---Purpose:      If No More Plane can be activated in MyView .
410
411         SetPlaneOn( me : mutable )
412         ---Level: Public
413         ---Purpose: Activate all the clipping planes defined in
414         --          this view.
415                 raises BadValue from Viewer;
416         ---Purpose:      If No More Plane can be activated in MyView .
417
418         SetPlaneOff( me : mutable ; MyPlane : Plane  from V3d );
419         ---Level: Public
420         ---Purpose: Desactivates the clipping plane defined
421         --          in this view.
422
423         SetPlaneOff( me : mutable );
424         ---Level: Public
425         ---Purpose: Deactivate all clipping planes defined
426         --          in this view.
427
428     IsActivePlane( me ; aPlane: Plane  from V3d )
429         returns Boolean from Standard;
430         ---Level: Public
431         ---Purpose: Returns TRUE when the plane is active in this view.
432
433         ---------------------------------------------------
434         --           Triedron methods
435         ---------------------------------------------------
436
437     ZBufferTriedronSetup ( me      : mutable;
438                            XColor  : NameOfColor from Quantity = Quantity_NOC_RED;
439                            YColor  : NameOfColor from Quantity = Quantity_NOC_GREEN;
440                            ZColor  : NameOfColor from Quantity = Quantity_NOC_BLUE1;
441                    SizeRatio : Real from Standard = 0.8;
442                    AxisDiametr : Real from Standard = 0.05;
443                    NbFacettes  : Integer from Standard = 12)
444          is static;
445         ---Level: Advanced
446         ---Purpose: Customization of the ZBUFFER Triedron.
447         ---         XColor,YColor,ZColor - colors of axis
448         ---         SizeRatio - ratio of decreasing of the trihedron size when its phisical
449         ---                     position comes out of the view
450         ---         AxisDiametr - diameter relatively to axis length
451         ---         NbFacettes - number of facettes of cylinders and cones
452
453         TriedronDisplay ( me            : mutable;
454                           APosition     : TypeOfTriedronPosition from Aspect  = Aspect_TOTP_CENTER;
455                           AColor        : NameOfColor from Quantity = Quantity_NOC_WHITE ;
456                           AScale        : Real from Standard  =  0.02;
457                           AMode         : TypeOfVisualization from V3d = V3d_WIREFRAME )
458                 is static;
459         ---Level: Advanced
460         ---Purpose: Display of the Triedron.
461         ---         Initialize position, color and length of Triedron axes.
462         ---         The scale is a percent of the window width.
463         ---Category:
464
465         TriedronErase ( me : mutable )
466                 is static;
467         ---Level: Advanced
468         ---Purpose: Erases the Triedron.
469         ---Category:
470
471         TriedronEcho ( me       : mutable;
472                        AType    : TypeOfTriedronEcho from Aspect  = Aspect_TOTE_NONE )
473                 is static;
474         ---Level: Advanced
475         ---Purpose: Highlights the echo zone of the Triedron.
476         ---Category:
477
478         ---------------------------------
479         ---Category: Graduated trihedron
480         ---------------------------------
481
482         GetGraduatedTrihedron(me;
483                               -- Names of axes --
484                               xname, yname, zname : out ExtendedString from TCollection;
485                               -- Draw names --
486                               xdrawname, ydrawname, zdrawname : out Boolean from Standard;
487                               -- Draw values --
488                               xdrawvalues, ydrawvalues, zdrawvalues : out Boolean from Standard;
489                               -- Draw grid --
490                               drawgrid : out Boolean from Standard;
491                               -- Draw axes --
492                               drawaxes : out Boolean from Standard;
493                               -- Number of splits along axes --
494                               nbx, nby, nbz : out Integer from Standard;
495                               -- Offset for drawing values --
496                               xoffset, yoffset, zoffset : out Integer from Standard;
497                               -- Offset for drawing names of axes --
498                               xaxisoffset, yaxisoffset, zaxisoffset : out Integer from Standard;
499                               -- Draw tickmarks --
500                               xdrawtickmarks, ydrawtickmarks, zdrawtickmarks : out Boolean from Standard;
501                               -- Length of tickmarks --
502                               xtickmarklength, ytickmarklength, ztickmarklength : out Integer from Standard;
503                               -- Grid color --
504                               gridcolor : out Color from Quantity;
505                               -- Colors of axis names --
506                               xnamecolor, ynamecolor, znamecolor : out Color from Quantity;
507                               -- Colors of axis and values --
508                               xcolor, ycolor, zcolor : out Color from Quantity;
509                               -- Name of font for names of axes --
510                               fontOfNames : out AsciiString from TCollection;
511                               -- Style of names of axes --
512                               styleOfNames : out FontAspect from OSD;
513                               -- Size of names of axes --
514                               sizeOfNames : out Integer from Standard;
515                               -- Name of font for values --
516                               fontOfValues : out AsciiString from TCollection;
517                               -- Style of values --
518                               styleOfValues : out FontAspect from OSD;
519                               -- Size of values --
520                               sizeOfValues : out Integer from Standard)
521         ---Purpose: Returns data of a graduated trihedron.
522         is static;
523
524         GraduatedTrihedronDisplay(me : mutable;
525                                   -- Names of axes --
526                                   xname : ExtendedString from TCollection = "X";
527                                   yname : ExtendedString from TCollection = "Y";
528                                   zname : ExtendedString from TCollection = "Z";
529                                   -- Draw names --
530                                   xdrawname : Boolean from Standard = Standard_True;
531                                   ydrawname : Boolean from Standard = Standard_True;
532                                   zdrawname : Boolean from Standard = Standard_True;
533                                   -- Draw values --
534                                   xdrawvalues : Boolean from Standard = Standard_True;
535                                   ydrawvalues : Boolean from Standard = Standard_True;
536                                   zdrawvalues : Boolean from Standard = Standard_True;
537                                   -- Draw grid --
538                                   drawgrid : Boolean from Standard = Standard_True;
539                                   -- Draw axes --
540                                   drawaxes : Boolean from Standard = Standard_True;
541                                   -- Number of splits along axes --
542                                   nbx : Integer from Standard = 3;
543                                   nby : Integer from Standard = 3;
544                                   nbz : Integer from Standard = 3;
545                                   -- Offset for drawing values --
546                                   xoffset : Integer from Standard = 10;
547                                   yoffset : Integer from Standard = 10;
548                                   zoffset : Integer from Standard = 10;
549                                   -- Offset for drawing names of axes --
550                                   xaxisoffset : Integer from Standard = 30;
551                                   yaxisoffset : Integer from Standard = 30;
552                                   zaxisoffset : Integer from Standard = 30;
553                                   -- Draw tickmarks --
554                                   xdrawtickmarks : Boolean from Standard = Standard_True;
555                                   ydrawtickmarks : Boolean from Standard = Standard_True;
556                                   zdrawtickmarks : Boolean from Standard = Standard_True;
557                                   -- Length of tickmarks --
558                                   xtickmarklength : Integer from Standard = 10;
559                                   ytickmarklength : Integer from Standard = 10;
560                                   ztickmarklength : Integer from Standard = 10;
561                                   -- Grid color --
562                                   gridcolor : Color from Quantity = Quantity_NOC_WHITE;
563                                   -- X name color --
564                                   xnamecolor : Color from Quantity = Quantity_NOC_RED;
565                                   -- Y name color --
566                                   ynamecolor : Color from Quantity = Quantity_NOC_GREEN;
567                                   -- Z name color --
568                                   znamecolor : Color from Quantity = Quantity_NOC_BLUE1;
569                                   -- X color of axis and values --
570                                   xcolor : Color from Quantity = Quantity_NOC_RED;
571                                   -- Y color of axis and values --
572                                   ycolor : Color from Quantity = Quantity_NOC_GREEN;
573                                   -- Z color of axis and values --
574                                   zcolor : Color from Quantity = Quantity_NOC_BLUE1;
575                                   -- Name of font for names of axes --
576                                   fontOfNames : AsciiString from TCollection = "Arial";
577                                   -- Style of names of axes --
578                                   styleOfNames : FontAspect from OSD = OSD_FA_Bold;
579                                   -- Size of names of axes --
580                                   sizeOfNames : Integer from Standard = 12;
581                                   -- Name of font for values --
582                                   fontOfValues : AsciiString from TCollection = "Arial";
583                                   -- Style of values --
584                                   styleOfValues : FontAspect from OSD = OSD_FA_Regular;
585                                   -- Size of values --
586                                   sizeOfValues : Integer from Standard = 12)
587         ---Purpose: Displays a graduated trihedron.
588         is static;
589
590         GraduatedTrihedronErase(me : mutable)
591         ---Purpose: Erases a graduated trihedron from the view.
592         is static;
593
594         ---------------------------------------------------
595         --           Color Scale methods
596         ---------------------------------------------------
597
598         SetLayerMgr(me : mutable; aMgr : LayerMgr from V3d);
599
600         ColorScaleDisplay(me : mutable);
601
602         ColorScaleErase(me : mutable);
603
604         ColorScaleIsDisplayed(me)
605         returns Boolean from Standard;
606
607         ColorScale(me)
608         returns ColorScale from Aspect;
609
610         --------------------------------------------------------
611         ---Category: Methods to modify the Projection of the view
612         --------------------------------------------------------
613
614         SetFront(me: mutable);
615         ---Level: Public
616         ---Purpose: modify the Projection of the view perpendicularly to
617         --          the privileged plane of the viewer.
618
619         Rotate ( me : mutable ; Ax,Ay,Az : PlaneAngle ;
620                                 Start    : Boolean = Standard_True )
621         ---Level: Public
622         ---Purpose: Rotates the eye about the coordinate system of
623         --          reference of the screen
624         --          for which the origin is the view point of the projection,
625         --          with a relative angular value in RADIANS with respect to
626         --          the initial position expressed by Start = Standard_True
627         raises BadValue from Viewer;
628         ---Purpose:  Warning! raises BadValue from Viewer
629         --      If the eye, the view point, or the high point are
630         --          aligned or confused.
631
632         Rotate ( me : mutable ; Ax,Ay,Az : PlaneAngle ;
633                                 X,Y,Z    : Coordinate ;
634                                 Start    : Boolean = Standard_True )
635         ---Level: Public
636         ---Purpose: Rotates the eye about the coordinate system of
637         --          reference of the screen
638         --          for which the origin is Gravity point {X,Y,Z},
639         --          with a relative angular value in RADIANS with respect to
640         --          the initial position expressed by Start = Standard_True
641                 raises BadValue from Viewer;
642         ---Purpose:      If the eye, the view point, or the high point are
643         --          aligned or confused.
644
645         Rotate ( me : mutable ; Axe      : TypeOfAxe ; Angle : PlaneAngle ;
646                                 X,Y,Z    : Coordinate ;
647                                 Start    : Boolean = Standard_True );
648         ---Level: Public
649         ---Purpose: Rotates the eye about one of the coordinate axes of
650         --          of the view for which the origin is the Gravity point{X,Y,Z}
651         --          with an relative angular value in RADIANS with
652         --          respect to the initial position expressed by
653         --          Start = Standard_True
654
655         Rotate ( me : mutable ; Axe    : TypeOfAxe ; Angle : PlaneAngle ;
656                                 Start : Boolean = Standard_True ) ;
657         ---Level: Public
658         ---Purpose: Rotates the eye about one of the coordinate axes of
659         --          of the view for which the origin is the view point of the
660         --          projection with an relative angular value in RADIANS with
661         --          respect to the initial position expressed by
662         --          Start = Standard_True
663
664         Rotate ( me : mutable ; Angle : PlaneAngle ;
665                                 Start : Boolean = Standard_True );
666         ---Level: Public
667         ---Purpose: Rotates the eye around the current axis a relative
668         --          angular value in RADIANS with respect to the initial
669         --          position expressed by Start = Standard_True
670
671         Move ( me : mutable ; Dx,Dy,Dz : Length ;
672                               Start    : Boolean = Standard_True )
673         ---Level: Public
674         ---Purpose: Movement of the eye parallel to the coordinate system
675         --          of reference of the screen a distance relative to the
676         --          initial position expressed by Start = Standard_True.
677                 raises BadValue from Viewer;
678         --      If the eye, the view point, or the high point are
679         --      aligned or confused.
680
681         Move ( me : mutable ; Axe   : TypeOfAxe ; Length : Length ;
682                               Start : Boolean = Standard_True )
683         ---Level: Public
684         ---Purpose: Movement of the eye parallel to one of the axes of the
685         --          coordinate system of reference of the view a distance
686         --          relative to the initial position expressed by
687         --          Start = Standard_True.
688                 raises BadValue from Viewer;
689         --      If the eye, view point, or high point are aligned or confused.
690
691         Move ( me : mutable ; Length : Length ;
692                               Start  : Boolean = Standard_True )
693         ---Level: Public
694         ---Purpose: Movement of the eye parllel to the current axis
695         --          a distance relative to the initial position
696         --          expressed by Start = Standard_True
697                 raises BadValue from Viewer;
698         --      If the eye, view point, or high point are aligned or confused.
699
700         Translate ( me : mutable ; Dx,Dy,Dz : Length ;
701                                    Start    : Boolean = Standard_True )
702         ---Level: Public
703         ---Purpose: Movement of the ye and the view point parallel to the
704         --          frame of reference of the screen a distance relative
705         --          to the initial position expressed by
706         --          Start = Standard_True
707                 raises BadValue from Viewer;
708         --      If the eye, view point, or high point are aligned or confused.
709
710         Translate ( me : mutable ; Axe   : TypeOfAxe ; Length : Length ;
711                                    Start : Boolean = Standard_True );
712         ---Level: Public
713         ---Purpose: Movement of the eye and the view point parallel to one
714         --          of the axes of the fame of reference of the view a
715         --          distance relative to the initial position
716         --          expressed by Start = Standard_True
717
718         Translate ( me : mutable ; Length : Length ;
719                                    Start  : Boolean = Standard_True );
720         ---Level: Public
721         ---Purpose: Movement of the eye and view point parallel to
722         --          the current axis a distance relative to the initial
723         --          position expressed by Start = Standard_True
724
725          Place (me: mutable; x,y: Integer from Standard;
726                       aZoomFactor: Factor from Quantity = 1)
727         ---Level: Public
728          ---Purpose: places the point of the view corresponding
729          --          at the pixel position x,y at the center of the window
730          --          and updates the view.
731          is redefined static;
732
733         Turn ( me : mutable ; Ax,Ay,Az : PlaneAngle ;
734                               Start    : Boolean = Standard_True )
735         ---Level: Public
736         ---Purpose: Rotation of the view point around the frame of reference
737         --          of the screen for which the origin is the eye of the
738         --          projection with a relative angular value in RADIANS
739         --          with respect to the initial position expressed by
740         --          Start = Standard_True
741                 raises BadValue from Viewer;
742         --      If the eye, view point, or high point are aligned or confused.
743
744         Turn ( me : mutable ; Axe : TypeOfAxe ; Angle : PlaneAngle ;
745                               Start : Boolean = Standard_True )
746        ;
747         ---Level: Public
748         ---Purpose: Rotation of the view point around one of the axes of the
749         --          frame of reference of the view for which the origin is
750         --          the eye of the projection with an angular value in
751         --          RADIANS relative to the initial position expressed by
752         --          Start = Standard_True
753
754         Turn ( me : mutable ; Angle : PlaneAngle ;
755                               Start : Boolean = Standard_True );
756         ---Level: Public
757         ---Purpose: Rotation of the view point around the current axis an
758         --          angular value in RADIANS relative to the initial
759         --          position expressed by Start = Standard_True
760
761         SetTwist ( me : mutable ; Angle : PlaneAngle )
762         ---Level: Public
763         ---Purpose: Defines the angular position of the high point of
764         --          the reference frame of the view with respect to the
765         --          Y screen axis with an absolute angular value in
766         --          RADIANS.
767                 raises BadValue from Viewer;
768         --      If the eye, view point, or high point are aligned or confused.
769
770         SetEye( me : mutable ; X,Y,Z : Coordinate )
771         ---Level: Public
772         ---Purpose: Defines the position of the eye..
773                 raises BadValue from Viewer ;
774         --      If the eye, view point, or high point are aligned or confused.
775
776         SetDepth( me : mutable ; Depth : Length )
777         ---Level: Public
778         ---Purpose: Defines the Depth of the eye from the view point
779         --          without update the projection .
780                 raises BadValue from Viewer ;
781         --      If the Depth is <= 0.
782
783         SetProj( me : mutable ; Vx,Vy,Vz : Parameter )
784         ---Level: Public
785         ---Purpose: Defines the orientation of the projection.
786                 raises BadValue from Viewer ;
787         --      If the eye, view point, or high point are aligned or confused.
788
789         SetProj( me : mutable ; Orientation : TypeOfOrientation )
790         ---Level: Public
791         ---Purpose: Defines the orientation of the projection .
792                 raises BadValue from Viewer ;
793         --      If the eye, view point, or high point are aligned or confused.
794         --          Updates the view
795
796         SetAt( me : mutable ; X,Y,Z : Coordinate )
797         ---Level: Public
798         ---Purpose: Defines the position of the view point.
799                 raises BadValue from Viewer ;
800         --      If the eye, view point, or high point are aligned or confused.
801
802         SetUp( me : mutable ; Vx,Vy,Vz : Parameter )
803         ---Level: Public
804         ---Purpose: Defines the orientation of the high point.
805                 raises BadValue from Viewer ;
806         --      If the eye, view point, or high point are aligned or confused.
807
808         SetUp( me : mutable ; Orientation : TypeOfOrientation )
809         ---Level: Public
810         ---Purpose: Defines the orientation(SO) of the high point.
811                 raises BadValue from Viewer ;
812         --      If the eye, view point, or high point are aligned or confused.
813
814     SetViewOrientation ( me : mutable; VO   : ViewOrientation from Visual3d );
815     ---Level: Public
816     ---Purpose: Modifies the orientation of the view.
817
818         SetViewOrientationDefault( me : mutable );
819         ---Level: Public
820         ---Purpose: Saves the current state of the orientation of the view
821         --          which will be the return state at ResetViewOrientation.
822
823         ResetViewOrientation ( me : mutable );
824         ---Level: Public
825         ---Purpose: Resets the orientation of the view.
826         --          Updates the view
827
828         --------------------------------------------------------
829         ---Category: Methods to modify the Mapping of the view
830         --------------------------------------------------------
831
832         Panning ( me : mutable ; Dx , Dy      : Length ;
833                                  aZoomFactor  : Factor from Quantity = 1;
834                                  Start        : Boolean = Standard_True )
835         ---Level: Public
836         ---Purpose:       translates the center of the view and zooms the view.
837         --       Updates the view.
838         raises BadValue from Viewer ;
839
840         SetCenter ( me : mutable ; Xc , Yc : Coordinate )
841         ---Level: Public
842         ---Purpose: Defines the centre of the view.
843         --          Updates the view.
844                 raises BadValue from Viewer ;
845         --      If one of the dimensions of the projection is NULL.
846
847         SetCenter ( me : mutable ; X,Y: Integer from Standard)
848         ---Level: Public
849         ---Purpose: Defines the centre of the view from a pixel position.
850         --          Updates the view.
851                 raises BadValue from Viewer ;
852         --      If one of the dimensions of the projection is NULL.
853
854         SetSize ( me : mutable ; Size : Length )
855         ---Level: Public
856         ---Purpose: Defines the size of the view while preserving the
857         --          center and height/width ratio of the window supporting
858         --          the view.
859         --          NOTE than the Depth of the View is NOT modified .
860                 raises BadValue from Viewer ;
861         --      If the size of the view is <= 0
862
863         SetZSize ( me : mutable ; Size : Length )
864         ---Level: Public
865         ---Purpose: Defines the Depth size of the view
866         --          Front Plane will be set to Size/2.
867         --          Back  Plane will be set to -Size/2.
868         --          Any Object located Above the Front Plane or
869         --                             behind the Back Plane will be Clipped .
870         --          NOTE than the XY Size of the View is NOT modified .
871                 raises BadValue from Viewer ;
872         --      If the size of the view is <= 0
873
874         SetZoom ( me : mutable ; Coef : Factor ; Start : Boolean = Standard_True )
875         ---Level: Public
876         ---Purpose: Zooms the view by a factor relative to the initial
877         --          value expressed by Start = Standard_True
878         --          Updates the view.
879                 raises BadValue from Viewer ;
880         --      If the zoom coefficient is <= 0
881
882         SetScale ( me : mutable ; Coef : Factor )
883         ---Level: Public
884         ---Purpose: Zooms the view by a factor relative to the value
885         --          initialised by SetViewMappingDefault().
886         --          Updates the view.
887                 raises BadValue from Viewer ;
888         --      If the zoom coefficient is <= 0
889
890     SetAxialScale ( me : mutable ; Sx, Sy, Sz : Real from Standard )
891         ---Level: Public
892         ---Purpose: Sets  anisotropic (axial)  scale  factors  <Sx>, <Sy>, <Sz>  for  view <me>.
893     -- Anisotropic  scaling  operation  is  performed  through  multiplying
894     -- the current view  orientation  matrix  by  a  scaling  matrix:
895     -- || Sx  0   0   0 ||
896     -- || 0   Sy  0   0 ||
897     -- || 0   0   Sz  0 ||
898     -- || 0   0   0   1 ||
899         -- Updates the view.
900                 raises BadValue from Viewer ;
901         --      If the one of factors <= 0
902
903         FitAll ( me : mutable ; Coef : Coefficient = 0.01;
904                       FitZ: Boolean from Standard = Standard_False; update : Boolean from Standard = Standard_True )
905         ---Level: Public
906         ---Purpose: Automatic zoom/panning. Objects in the view are visualised
907         --          so as to occupy the maximum space while respecting the
908         --          margin coefficient and the initial height /width ratio.
909         --          NOTE than the original Z size of the view is NOT modified .
910                 raises BadValue from Viewer ;
911         --      If the margin coefficient is <0 ou >= 1 or
912         --      Updates the view
913
914         ZFitAll ( me : mutable ;  Coef : Coefficient = 1.0 )
915         ---Level: Public
916         ---Purpose: Automatic Depth Panning. Objects visible in the view are
917         --          visualised so as to occupy the maximum Z amount of space
918         --          while respecting the margin coefficient .
919         --          NOTE than the original XY size of the view is NOT modified .
920                 raises BadValue from Viewer ;
921         --      If the margin coefficient is <0 ou or
922         --      If No Objects are displayed in the view
923
924         DepthFitAll( me : mutable ;   Aspect : Coefficient = 0.01;
925                                       Margin : Coefficient = 0.01 );
926         ---Level: Public
927         ---Purpose: Adjusts the viewing volume so as not to clip the displayed objects by front and back
928         --          and back clipping planes. Also sets depth value automatically depending on the
929         --          calculated Z size and Aspect parameter.
930         --          NOTE than the original XY size of the view is NOT modified .
931
932         FitAll ( me : mutable ; Umin, Vmin, Umax, Vmax : Coordinate )
933         ---Level: Public
934         ---Purpose: Centres the defined projection window so that it occupies
935         --          the maximum space while respecting the initial
936         --          height/width ratio.
937         --          NOTE than the original Z size of the view is NOT modified .
938                 raises BadValue from Viewer;
939         --              If the defined projection window has zero size.
940
941
942         WindowFit ( me : mutable ; Xmin, Ymin, Xmax, Ymax : Integer)
943         ---Level: Public
944         ---Purpose: Centres the defined PIXEL window so that it occupies
945         --          the maximum space while respecting the initial
946         --          height/width ratio.
947         --          NOTE than the original Z size of the view is NOT modified .
948                 raises BadValue from Viewer
949         --              If the defined projection window has zero size.
950         is redefined static;
951
952     SetViewingVolume ( me : mutable ; Left, Right, Bottom, Top, ZNear, ZFar : Real from Standard)
953         ---Level: Public
954         ---Purpose: Sets Z and XY size of the view according to given values
955     --          with respecting the initial view depth (eye position)
956                 raises BadValue from Viewer;
957         --              If the ZNear<0, ZFar<0 or ZNear>=Zfar.
958
959     SetViewMapping ( me : mutable; VM   : ViewMapping from Visual3d );
960     ---Level: Public
961     ---Purpose: Modifies the mapping of the view.
962
963         SetViewMappingDefault( me : mutable );
964         ---Level: Public
965         ---Purpose: Saves the current view mapping. This will be the
966         --          state returned from ResetViewmapping.
967
968         ResetViewMapping ( me : mutable );
969         ---Level: Public
970         ---Purpose: Resets the centring of the view.
971         --          Updates the view
972
973         Reset ( me : mutable; update : Boolean from Standard = Standard_True );
974         ---Level: Public
975         ---Purpose: Resets the centring and the orientation of the view
976         --          Updates the view
977         ---------------------------------------------------
978         ---Category: Inquire methods
979         ---------------------------------------------------
980
981         Convert( me ; Vp : Integer ) returns Length
982         ---Level: Public
983         ---Purpose : Converts the PIXEL value
984         --           to a value in the projection plane.
985         raises UnMapped from V3d;
986         --      If the view is not mapped on the window.
987
988         Convert( me ; Xp,Yp : Integer ; Xv,Yv : out Coordinate )
989         ---Level: Public
990         ---Purpose : Converts the point PIXEL into a point projected
991         --           in the reference frame of the projection plane.
992         raises UnMapped from V3d;
993         --      If the view is not mapped on the window.
994
995         Convert( me ; Vv : Length ) returns Integer
996         ---Level: Public
997         ---Purpose : Converts tha value of the projection plane into
998         --           a PIXEL value.
999         raises UnMapped from V3d;
1000         --      If the view is not mapped on the window.
1001
1002         Convert( me ; Xv,Yv : Coordinate ; Xp,Yp : out Integer )
1003         ---Level: Public
1004         ---Purpose : Converts the point defined in the reference frame
1005         --           of the projection plane into a point PIXEL.
1006         raises UnMapped from V3d;
1007         --      If the view is not mapped on the window.
1008
1009         Convert( me ; Xp,Yp : Integer ; X,Y,Z : out Coordinate)
1010         ---Level: Public
1011         ---Purpose : Converts the projected point into a point
1012         --           in the reference frame of the view corresponding
1013         --           to the intersection with the projection plane
1014         --           of the eye/view point vector.
1015         raises UnMapped from V3d;
1016         --      If the view is not mapped on the window.
1017
1018         ConvertWithProj( me ; Xp,Yp : Integer ; X,Y,Z : out Coordinate ; Vx,Vy,Vz : out Parameter)
1019         ---Level: Public
1020         ---Purpose : Converts the projected point into a point
1021         --           in the reference frame of the view corresponding
1022         --           to the intersection with the projection plane
1023         --           of the eye/view point vector and returns the
1024         --           projection ray for further computations.
1025         raises UnMapped from V3d;
1026         --      If the view is not mapped on the window.
1027
1028         ConvertToGrid( me ; Xp,Yp : Integer ; Xg,Yg,Zg : out Coordinate)
1029         ---Level: Public
1030         ---Purpose : Converts the projected point into the nearest grid point
1031         --           in the reference frame of the view corresponding
1032         --           to the intersection with the projection plane
1033         --           of the eye/view point vector and display the grid marker.
1034     --  Warning: When the grid is not active the result is identical
1035     --     to the above Convert() method.
1036     -- How to use :
1037     -- 1) Enable the grid echo display
1038     --    myViewer->SetGridEcho(Standard_True);
1039     -- 2) When application receive a move event :
1040     --   2.1) Check if any object is detected
1041     --     if( myInteractiveContext->MoveTo(x,y) == AIS_SOD_Nothing ) {
1042     --   2.2) Check if the grid is active
1043         --     if( myViewer->Grid()->IsActive() ) {
1044     --   2.3) Display the grid echo and gets the grid point
1045         --       myView->ConvertToGrid(x,y,X,Y,Z);
1046     --   2.4) Else this is the standard case
1047         --     } else myView->Convert(x,y,X,Y,Z);
1048         raises UnMapped from V3d;
1049         --      If the view is not mapped on the window.
1050
1051         ConvertToGrid( me ; X,Y,Z : Coordinate ; Xg,Yg,Zg : out Coordinate)
1052         ---Level: Public
1053         ---Purpose : Converts the point into the nearest grid point
1054         --           and display the grid marker.
1055     ---Warning: When the grid is not active the result is identical
1056     --     to the previous point.
1057         raises UnMapped from V3d;
1058         --      If the view is not mapped on the window.
1059
1060         Convert( me ; X,Y,Z : Coordinate; Xp,Yp : out Integer) ;
1061         ---Level: Public
1062         ---Purpose : Projects the point defined in the reference frame of
1063         --           the view into the projected point in the associated window.
1064
1065 --        RefToPix( me ; X,Y,Z : Coordinate; Xp,Yp : out Integer) ;
1066 --        ---Purpose : Projects the point defined in the reference frame of
1067 --        --           the view into the projected point in the associated window.
1068 --  Obsolete : Use Convert(X,Y,Z,Xp,Yp);
1069
1070 --        PixToRef( me ; Xp,Yp : Integer; X,Y,Z : out Coordinate) ;
1071 --        ---Purpose : Converts the projected point in the associated window of
1072 --        --           the view into the point defined in the reference frame.
1073 --  Obsolete : Use Convert(Xp,Yp,X,Y,Z);
1074
1075         Project( me ; X,Y,Z : Coordinate; Xp,Yp : out Coordinate) ;
1076         ---Level: Public
1077         ---Purpose : Converts the point defined in the user space of
1078         --           the view to the projected view plane point at z 0.
1079
1080         BackgroundColor( me; Type : TypeOfColor ; V1, V2, V3 : out Parameter) ;
1081         ---Level: Public
1082         ---Purpose: Returns the Background color values of the view
1083         --          depending of the color Type.
1084
1085         BackgroundColor( me ) returns Color from Quantity;
1086         ---Level: Public
1087         ---Purpose: Returns the Background color object of the view.
1088
1089         GradientBackgroundColors( me;
1090                                   Color1 : out Color from Quantity;
1091                                   Color2 : out Color from Quantity) ;
1092         ---Level: Public
1093         ---Purpose: Returns the gradient background colour objects of the view.
1094
1095         GradientBackground ( me ) returns GradientBackground from Aspect;
1096         ---Level: Public
1097         ---Purpose: Returns the gradient background of the view.
1098
1099         Scale ( me ) returns Factor ;
1100         ---Level: Public
1101         ---Purpose: Returns the current value of the zoom expressed with
1102         --          respect to SetViewMappingDefault().
1103
1104     AxialScale ( me ; Sx, Sy, Sz : out Real from Standard ) ;
1105         ---Level: Public
1106         ---Purpose: Returns the current values of the anisotropic (axial) scale factors.
1107
1108         Center ( me; Xc,Yc : out Coordinate );
1109         ---Level: Public
1110         ---Purpose: Returns the centre of the view.
1111
1112         Size ( me; Width, Height : out Length );
1113         ---Level: Public
1114         ---Purpose: Returns the height and width of the view.
1115
1116         ZSize ( me ) returns Real ;
1117         ---Level: Public
1118         ---Purpose: Returns the Depth of the view .
1119
1120         Eye( me ; X,Y,Z : out Coordinate );
1121         ---Level: Public
1122         ---Purpose: Returns the position of the eye.
1123
1124         FocalReferencePoint (me ; X,Y,Z : out Coordinate );
1125         ---Level: Public
1126         ---Purpose: Returns the position of point which emanating the
1127         --          projections.
1128
1129         ProjReferenceAxe( me ; Xpix,Ypix           : Integer ;
1130                                XP,YP,ZP,VX,VY,VZ   : out Coordinate );
1131         ---Level: Public
1132         ---Purpose: Returns the coordinate of the point (Xpix,Ypix)
1133         --          in the view (XP,YP,ZP), and the projection vector of the
1134         --          view passing by the point (for PerspectiveView).
1135
1136         Depth( me ) returns Length ;
1137         ---Level: Public
1138         ---Purpose: Returns the Distance between the Eye and View Point.
1139
1140         Proj( me ; Vx,Vy,Vz : out Parameter );
1141         ---Level: Public
1142         ---Purpose: Returns the projection vector.
1143
1144         At( me ; X,Y,Z : out Coordinate );
1145         ---Level: Public
1146         ---Purpose: Returns the position of the view point.
1147
1148         Up( me ; Vx,Vy,Vz : out Parameter );
1149         ---Level: Public
1150         ---Purpose: Returns the vector giving the position of the high point.
1151
1152         Twist( me ) returns PlaneAngle ;
1153         ---Level: Public
1154         ---Purpose: Returns in RADIANS the orientation of the view around
1155         --          the visual axis measured from the Y axis of the screen.
1156
1157         ShadingModel ( me ) returns TypeOfShadingModel ;
1158         ---Level: Public
1159         ---Purpose: Returns the current shading model.
1160
1161         SurfaceDetail(me) returns  TypeOfSurfaceDetail;
1162         ---Level: Public
1163         -- purpose: returns the current SurfaceDetail mode
1164
1165         TextureEnv(me)  returns  TextureEnv  from  Graphic3d;
1166         ---Level: Public
1167         -- purpose: return the current environment texture used
1168
1169         Transparency(me) returns Boolean from Standard;
1170         ---Level: Public
1171         ---Purpose: Returns the transparency activity.
1172
1173         Visualization ( me ) returns TypeOfVisualization from V3d;
1174         ---Level: Public
1175         ---Purpose: Returns the current visualisation mode.
1176
1177         Antialiasing ( me ) returns Boolean;
1178         ---Level: Public
1179         ---Purpose: Indicates if the antialiasing is active (True) or
1180         --          inactive (False).
1181
1182         ZCueing ( me; Depth, Width : out Length ) returns Boolean ;
1183         ---Level: Public
1184         ---Purpose: Returns activity and information on the Zcueing.
1185         --          <Depth> : Depth of plane.
1186         --          <Width> : Thickness around the plane.
1187
1188         ZClipping ( me; Depth, Width : out Length ) returns TypeOfZclipping;
1189         ---Level: Public
1190         ---Purpose: Returns current information on the ZClipping.
1191         --          <Depth> : Depth of plane.
1192         --          <Width> : Thickness around the plane.
1193         --          <TypeOfZclipping>  :        "BACK"
1194         --                                      "FRONT"
1195         --                                      "SLICE"
1196         --                                      "OFF"
1197
1198         IfMoreLights( me ) returns Boolean;
1199         ---Level: Advanced
1200         ---Purpose: Returns True if One light more can be
1201         --          activated in this View.
1202
1203         InitActiveLights(me: mutable);
1204         ---Level: Advanced
1205         ---Purpose: initializes an iteration on the active Lights.
1206
1207         MoreActiveLights (me) returns Boolean from Standard;
1208         ---Level: Advanced
1209         ---Purpose: returns true if there are more active Light(s) to return.
1210
1211         NextActiveLights (me: mutable);
1212         ---Level: Advanced
1213         ---Purpose : Go to the next active Light
1214         --           (if there is not, ActiveLight will raise an exception)
1215
1216         ActiveLight(me) returns mutable Light from V3d;
1217         ---Level: Advanced
1218
1219         IfMorePlanes( me ) returns Boolean;
1220         ---Level: Advanced
1221         ---Purpose: Returns True if One clipping plane more can be
1222         --          activated in this View.
1223
1224         InitActivePlanes(me: mutable);
1225         ---Level: Advanced
1226         ---Purpose: initializes an iteration on the active Planes.
1227
1228         MoreActivePlanes (me) returns Boolean from Standard;
1229         ---Level: Advanced
1230         ---Purpose: returns true if there are more active Plane(s) to return.
1231
1232         NextActivePlanes (me: mutable);
1233         ---Level: Advanced
1234         ---Purpose : Go to the next active Plane
1235         --           (if there is not, ActivePlane will raise an exception)
1236
1237         ActivePlane(me) returns mutable Plane from V3d;
1238         ---Level: Advanced
1239
1240         Viewer ( me ) returns mutable Viewer from V3d;
1241         ---Level: Advanced
1242         ---Purpose: Returns the viewer in which the view has been created.
1243
1244         IfWindow ( me ) returns Boolean;
1245         ---Level: Public
1246         ---Purpose: Returns True if MyView is associated with a window .
1247
1248         Window ( me ) returns mutable Window from Aspect
1249         ---Level: Public
1250         ---Purpose: Returns the Aspect Window associated with the view.
1251                 raises BadValue from Viewer;
1252         --      If MyView is not associated with a window
1253
1254         Type( me ) returns TypeOfView from V3d;
1255         ---Level: Public
1256         ---Purpose: Returns the Type of the View
1257
1258         Pan ( me : mutable; Dx, Dy: Integer from Standard;
1259                              aZoomFactor: Factor from Quantity = 1);
1260         ---Level: Public
1261         ---Purpose: translates the center of the view and zooms the view.
1262         --       and updates the view.
1263
1264         Zoom ( me : mutable; X1 , Y1 , X2 , Y2 : Integer from Standard)
1265         is static;
1266         ---Level: Public
1267         ---Purpose: Zoom the view according to a zoom factor computed
1268         -- from the distance between the 2 mouse position <X1,Y1>,<X2,Y2>
1269
1270         Zoom ( me: mutable; X,Y: Integer from Standard)
1271         is static;
1272         ---Level: Public
1273         ---Purpose: Zoom the view according to a zoom factor computed
1274         -- from the distance between the last and new mouse position <X,Y>
1275
1276         StartZoomAtPoint(me : mutable;
1277                          xpix, ypix : Integer from Standard);
1278         ---Level: Public
1279         ---Purpose: Defines the point (pixel) of zooming (for the method ZoomAtPoint()).
1280
1281         ZoomAtPoint(me : mutable;
1282                     mouseStartX, mouseStartY, mouseEndX, mouseEndY : Integer from Standard);
1283         ---Level: Public
1284         ---Purpose: Zooms the model at a pixel defined by the method StartZoomAtPoint().
1285
1286         AxialScale  ( me: mutable; Dx, Dy: Integer from Standard;  Axis:  TypeOfAxe  from  V3d );
1287         ---Level: Public
1288         ---Purpose: Performs  anisotropic scaling  of  <me>  view  along  the  given  <Axis>.
1289             -- The  scale  factor  is  calculated on a basis of
1290             -- the mouse pointer displacement <Dx,Dy>.
1291         -- The  calculated  scale  factor  is  then  passed  to  SetAxialScale(Sx,  Sy,  Sz)  method.
1292
1293         StartRotation(me : mutable ; X,Y :Integer from Standard;
1294                zRotationThreshold: Ratio from Quantity = 0.0);
1295         ---Level: Public
1296     ---Purpose: Begin the rotation of the view arround the screen axis
1297     -- according to the mouse position <X,Y>.
1298     --  Warning: Enable rotation around the Z screen axis when <zRotationThreshold>
1299     -- factor is > 0 soon the distance from the start point and the center
1300     -- of the view is > (medium viewSize * <zRotationThreshold> ).
1301     -- Generally a value of 0.4 is usable to rotate around XY screen axis
1302     -- inside the circular treshold area and to rotate around Z screen axis
1303     -- outside this area.
1304
1305         Rotation(me:mutable;  X,Y :Integer from Standard);
1306         ---Level: Public
1307     ---Purpose: Continues the rotation of the view
1308     -- with an angle computed from the last and new mouse position <X,Y>.
1309
1310         FitAll ( me : mutable ; aWindow: Window from Aspect;
1311                       Umin, Vmin, Umax, Vmax : Coordinate )
1312         is static private;
1313         ---Level: Public
1314     ---Purpose: Change the scale factor and position of the view
1315     -- such as the bounding box <Umin, Vmin, Umax, Vmax> is contains
1316     -- in the view.
1317
1318
1319         -----------------------------------------
1320         ---Category: Private or Protected methods
1321         -----------------------------------------
1322
1323         SetFocale( me : mutable ; Focale : Length )
1324         ---Purpose: Change View Plane Distance for Perspective Views
1325         raises TypeMismatch from Standard
1326         ---Purpose:  Warning! raises TypeMismatch from Standard if the view
1327         --          is not a perspective view.
1328         is static ;
1329
1330         Focale( me ) returns Length;
1331         ---Purpose: Returns the View Plane Distance for Perspective Views
1332
1333         View ( me) returns mutable View from Visual3d is static ;
1334         ---Level: Advanced
1335         ---Purpose: Returns the associated Visual3d view.
1336
1337         ViewMapping ( me ) returns ViewMapping from Visual3d is static;
1338     ---Level: Advanced
1339     ---Purpose: Returns the current mapping of the view.
1340
1341     ViewOrientation ( me ) returns ViewOrientation from Visual3d is static;
1342     ---Level: Advanced
1343     ---Purpose: Returns the current orientation of the view.
1344
1345         ScreenAxis( myclass ; Vpn,Vup        : Vector from Graphic3d ;
1346                               Xaxe,Yaxe,Zaxe : out Vector from Graphic3d )
1347                                         returns Boolean is private ;
1348         ---Purpose: Determines the screen axes in the reference
1349         --          framework of the view.
1350
1351         InitMatrix ( myclass ; Matrix : out Array2OfReal from TColStd ) is private ;
1352
1353         Multiply( myclass ;
1354                  Left, Right : Array2OfReal from TColStd ;
1355                  Matrix      : out Array2OfReal from TColStd )
1356                  returns Boolean from Standard is private ;
1357
1358         RotAxis( myclass ; Vrp      : Vertex from Graphic3d ;
1359                            Axe      : Vector from Graphic3d ; Angle : PlaneAngle ;
1360                            Matrix   : out Array2OfReal from TColStd ) is private ;
1361         ---Purpose: Determines the rotation matrice around an axis
1362         --          for a given angle.
1363
1364         TrsPoint( myclass ; P      : Vertex from Graphic3d ;
1365                             Matrix : Array2OfReal from TColStd )
1366                                 returns Vertex from Graphic3d is private ;
1367         ---Purpose: Transforms the point P according to the matrice Matrix .
1368
1369         TrsPoint( myclass ; V : Vector from Graphic3d ;
1370                                 Matrix : Array2OfReal from TColStd )
1371                                 returns Vector from Graphic3d is private ;
1372         ---Purpose: Transforms the vector V according to the matrice Matrix .
1373
1374         -----------------------------------------
1375         ---Category: TransientManager methods
1376         -----------------------------------------
1377
1378          TransientManagerBeginDraw(me; DoubleBuffer: Boolean = Standard_False;
1379                                        RetainMode  : Boolean = Standard_False)
1380         ---Level: Public
1381         ---Purpose: Begins any graphics in the view <aView>
1382         --          Redraw any structured graphics in the back buffer before
1383         --          if <DoubleBuffer> is TRUE.
1384         --          Restore the front buffer from the back before
1385         --          if <DoubleBuffer> is FALSE.
1386         --          if <RetainMode> is TRUE.
1387         --          the graphic managed itself exposure,resizing ...
1388         --          if <RetainMode> is FALSE.
1389         --          the application must managed itself exposure,resizing ...
1390         --
1391                 returns Boolean from Standard;
1392
1393          TransientManagerClearDraw(me);
1394         ---Level: Public
1395         ---Purpose: Clear all transient graphics in the view <aView>
1396
1397
1398          TransientManagerBeginAddDraw(me)
1399         ---Level: Public
1400         ---Purpose: Begins any add graphics in the view <aView>
1401         --          Redraw any structured graphics in the back buffer before
1402         --          the application must managed itself exposure,resizing ...
1403         --  Warning: Returns TRUE if transient drawing is enabled in
1404         --         the associated view.
1405         --          Returns FALSE ,if nothing works because something
1406         --         is wrong for the transient principle :
1407         --
1408                 returns Boolean from Standard;
1409
1410         ---------------------------------------------------
1411         -- Category: Methods to modify the class definition
1412         --           Animation Mode
1413         ---------------------------------------------------
1414
1415         SetAnimationModeOn ( me : mutable )
1416                 is static;
1417         ---Level: Advanced
1418         ---Purpose: Activates animation mode.
1419         --      When the animation mode is activated in the view,
1420         --      all Graphic3d_Structure are stored in a graphic object.
1421         ---Category: Methods to modify the class definition
1422
1423         SetAnimationModeOff ( me        : mutable )
1424                 is static;
1425         ---Level: Advanced
1426         ---Purpose: Deactivates the animation mode.
1427         ---Category: Methods to modify the class definition
1428
1429         AnimationModeIsOn ( me )
1430                 returns Boolean from Standard
1431                 is static;
1432         ---Level: Advanced
1433         ---Purpose: Returns the activity of the animation mode.
1434         ---Category: Inquire methods
1435
1436         SetAnimationMode ( me                : mutable;
1437                            anAnimationFlag   : Boolean from Standard = Standard_True;
1438                            aDegenerationFlag : Boolean from Standard = Standard_False
1439         ) is static;
1440         ---Level    : Advanced
1441         ---Purpose  : Enable/Disable animation/degeneration mode
1442         ---Category : Methods to modify the class definition
1443
1444     AnimationMode ( me; isDegenerate: out Boolean from Standard )
1445                 returns Boolean from Standard
1446                 is static;
1447         ---Level    : Advanced
1448         ---Purpose  : Returns the animation and degenerate status.
1449         ---Category: Inquire methods
1450
1451         ---------------------------------------------------
1452         -- Category: Methods to modify the class definition
1453         --           Degenerate Mode
1454         ---------------------------------------------------
1455
1456         SetDegenerateModeOn ( me        : mutable )
1457                 is static;
1458         ---Level    : Obsolete
1459         ---Purpose: Activates degenerate mode.
1460         --      When the degenerate mode is activated in the view,
1461         --      all Graphic3d_Structure with the type TOS_COMPUTED
1462         --      displayed in this view are not computed.
1463     --  Warning: Obsolete method , use SetComputedMode()
1464         ---Category: Methods to modify the class definition
1465
1466         SetDegenerateModeOff ( me       : mutable )
1467                 is static;
1468         ---Level    : Obsolete
1469         ---Purpose: Deactivates the degenerate mode.
1470         --  Category: Methods to modify the class definition
1471         --  Warning: if the computed mode has been disabled in the
1472         --          viewer the mode will remain degenerated.
1473     --  Warning: Obsolete method , use SetComputedMode()
1474
1475         DegenerateModeIsOn ( me )
1476                 returns Boolean from Standard
1477                 is static;
1478         ---Level    : Obsolete
1479         ---Purpose: Returns the activity of the degenerate mode.
1480         ---Category: Inquire methods
1481
1482         SetComputedMode ( me : mutable; aMode : Boolean from Standard )
1483         is static;
1484         ---Level: Advanced
1485         ---Purpose: Switches computed HLR mode in the view
1486         ---Category: Methods to modify the class definition
1487
1488         ComputedMode ( me )
1489         returns Boolean from Standard
1490         is static;
1491         ---Level: Advanced
1492         ---Purpose: Returns the computed HLR mode state
1493         ---Category: Inquire methods
1494
1495         MinMax ( me; Umin,Vmin, Umax,Vmax : out Coordinate ) returns Integer
1496         ---Purpose: Returns the objects number and the projection window
1497         --          of the objects contained in the view.
1498         is static private;
1499
1500         MinMax ( me; Xmin,Ymin,Zmin, Xmax,Ymax,Zmax : out Coordinate )
1501         returns Integer
1502         ---Purpose: Returns the objects number and the box encompassing
1503         --          the objects contained in the view
1504         is static private;
1505
1506         Gravity ( me; X,Y,Z : out Coordinate ) returns Integer
1507         ---Purpose: Returns the Objects number and the gravity center
1508         --          of ALL viewable points in the view
1509         is static private;
1510
1511         Init(me: mutable) is private;
1512
1513         ---Category: for compatibility.
1514
1515         WindowFitAll ( me : mutable ; Xmin, Ymin, Xmax, Ymax : Integer);
1516         ---Purpose: idem than WindowFit
1517
1518         SetPlotter ( me : mutable; aPlotter : Plotter from Graphic3d )
1519         ---Purpose: Set a plotter for plotting the contents of the view
1520         --          field MyPlotter
1521         is virtual;
1522
1523         Plot ( me : mutable )
1524         ---Purpose: Create a 2D View for plotting the contents of the view
1525         raises BadValue from Viewer;
1526         --      if the plotter is undefined.
1527
1528         Compute ( me; AVertex   : Vertex from Graphic3d )
1529                 returns Vertex from Graphic3d
1530                 is static private;
1531         ---Level: Internal
1532         ---Purpose: Returns a new vertex when the grid is activated.
1533
1534         SetGrid ( me    : mutable;
1535                   aPlane: Ax3 from gp;
1536                   aGrid : Grid from Aspect )
1537                 is static;
1538         ---Level: Internal
1539         ---Purpose: Defines or Updates the definition of the
1540         --          grid in <me>
1541         ---Category: Methods to modify the class definition
1542
1543         SetGridGraphicValues ( me       : mutable;
1544                                aGrid    : Grid from Aspect )
1545                 is static;
1546         ---Level: Internal
1547         ---Purpose: Defines or Updates the graphic definition of the
1548         --          grid in <me>
1549         ---Category: Methods to modify the class definition
1550
1551         SetGridActivity ( me    : mutable;
1552                           aFlag : Boolean from Standard )
1553                 is static;
1554         ---Level: Internal
1555         ---Purpose: Defines or Updates the activity of the
1556         --          grid in <me>
1557         ---Category: Methods to modify the class definition
1558
1559         Tumble ( me            : mutable;
1560                  NbImages      : Integer from Standard = 314;
1561                  AnimationMode : Boolean from Standard = Standard_False )
1562                 returns Real from Standard
1563                 is static;
1564         ---Level   : Advanced
1565         ---Purpose: Animates the view <me>
1566         --          Returns the number of images per second
1567         --          if <AnimationMode> is Standard_True, the animation mode
1568         --          is activated.
1569
1570         ScreenCopy (me               : mutable;
1571                     aPlotterDriver   : PlotterDriver from PlotMgt;
1572                     fWhiteBackground : Boolean from Standard = Standard_True;
1573                     aScale           : Factor from Quantity = 1.0
1574         ) is static;
1575         ---Purpose: dump the view
1576
1577         Dump ( me: mutable;
1578                theFile: CString from Standard;
1579                theBufferType : TypeOfImage from Image = Image_TOI_RGB )
1580     returns Boolean from Standard;
1581         ---Level: Public
1582         ---Purpose: dump the full contents of the view at the same
1583         --          scale in the file <theFile>. The file name
1584         --          extension must be one of ".png",".bmp",".jpg",".gif".
1585         --          Returns FALSE when the dump has failed
1586
1587         Dump ( me: mutable;
1588                theFile   : CString from Standard;
1589                theFormat : FormatOfSheetPaper from Aspect;
1590                theBufferType : TypeOfImage from Image = Image_TOI_RGB )
1591     returns Boolean from Standard;
1592         ---Level: Public
1593         ---Purpose: dump the full contents of the view with a
1594         --          different scale according  to the required sheet
1595         --          paper size (format) and the ratio
1596         --          width/height of the view.
1597     --          and returns FALSE when the dump has failed
1598     --  Warning : the file name extension must be one of
1599     --      ".png",".bmp",".jpg",".gif"
1600     --       but make becarefull about the time to dump and
1601     --       resulting file size especially for the A0 format.
1602     --       NOTE that you can use after any standard system utility
1603     --       for editing or sending the image file to a laser printer.
1604     --       (i.e: Microsoft Photo Editor on Windows system
1605     --        or Image Viewer on SUN system)
1606
1607       Print (me; hPrnDC: Handle from Aspect = NULL;
1608              showDialog: Boolean = Standard_True;
1609              showBackground: Boolean = Standard_True;
1610              filename: CString = NULL)
1611       is static;
1612
1613         ---Level: Public
1614         ---Purpose: print the contents of the view to printer with preview.
1615     -- <hPrnDC> : If you have already an PrinterDeviceContext (HDC),
1616     -- then you can pass it to the print routines.
1617         -- If you don't have an PrinterDeviceContext, then this parameter should
1618     -- be NULL.
1619     -- <showDialog> : If hPrnDC == NULL, then you can force the print routines to
1620     -- open a Print Dialog box.
1621         -- If you want to do this, then set showDialog to TRUE
1622         -- If you don't want to see a dialog (only possible, if you have a hPrnDC
1623     -- or the dialog box was opened once before) then set <showDialog> to FALSE.
1624     -- <showBackground> : When set to FALSE then print the view without background color
1625     -- (background is white)
1626         -- else set to TRUE for printing with current background color.
1627     -- <filename>: If != NULL, then the view will be printed to a file.
1628     --  Warning: Works only under Windows.
1629
1630         ToPixMap ( me : mutable;
1631                    theWidth  : Integer from Standard;
1632                    theHeight : Integer from Standard;
1633                    theBufferType : TypeOfImage from Image = Image_TOI_RGB;
1634                    theForceCentered : Boolean from Standard = Standard_True )
1635         returns PixMap from Image;
1636         ---Level   : Public
1637         ---Purpose : dump the full contents of the view
1638         --        to a pixmap of pixel size <theWidth>*<theHeight> and
1639         --        buffer type <theBufferType>. If <theForceCentered> is true
1640         --        view scene will be centered.
1641
1642     SetProjModel( me : mutable;
1643         amOdel: TypeOfProjectionModel from V3d = V3d_TPM_SCREEN )
1644         is static;
1645          ---Level   : Advanced
1646          ---Purpose : Manages projection model
1647
1648     ProjModel( me )
1649         returns TypeOfProjectionModel from V3d
1650         is static;
1651          ---Level   : Advanced
1652          ---Purpose : Returns the current projection model
1653
1654         SetBackFacingModel ( me     : mutable;
1655             aModel : TypeOfBackfacingModel from V3d = V3d_TOBM_AUTOMATIC)
1656             is static;
1657          ---Level   : Public
1658          ---Purpose : Manages display of the back faces
1659      -- When <aModel> is TOBM_AUTOMATIC the object backfaces
1660      -- are displayed only for surface objects and
1661      -- never displayed for solid objects.
1662      -- this was the previous mode.
1663      --      <aModel> is TOBM_ALWAYS_DISPLAYED the object backfaces
1664      --       are always displayed both for surfaces or solids.
1665      --      <aModel> is TOBM_NEVER_DISPLAYED the object backfaces
1666      --       are never displayed.
1667
1668         BackFacingModel ( me )
1669             returns TypeOfBackfacingModel from V3d
1670         is static;
1671          ---Level   : Public
1672          ---Purpose : Returns current state of the back faces display
1673
1674         EnableDepthTest( me; enable : Boolean from Standard = Standard_True )
1675         is static;
1676      ---Level: Public
1677      ---Purpose: turns on/off opengl depth testing
1678
1679         IsDepthTestEnabled( me ) returns Boolean from Standard
1680         is static;
1681      ---Level: Public
1682      ---Purpose: returns the current state of the depth testing
1683
1684         EnableGLLight( me; enable : Boolean from Standard = Standard_True )
1685         is static;
1686      ---Level: Public
1687      ---Purpose: turns on/off opengl lighting, currently used in triedron displaying
1688
1689         IsGLLightEnabled( me ) returns Boolean from Standard
1690         is static;
1691      ---Level: Public
1692      ---Purpose: returns the current state of the gl lighting
1693      --          currently used in triedron displaying
1694
1695
1696 fields
1697
1698         MyType :                TypeOfView from V3d is protected ;
1699         MyViewer :              ViewerPointer from V3d ;
1700         MyActiveLights:         ListOfTransient from V3d;
1701         MyActivePlanes:         ListOfTransient from V3d;
1702
1703         MyView :                View from Visual3d is protected ;
1704         MyViewMapping :         ViewMapping from Visual3d is protected ;
1705         MyViewOrientation :     ViewOrientation from Visual3d ;
1706         MyViewContext :         ContextView from Visual3d ;
1707         MyBackground:           Background from Aspect ;
1708         MyGradientBackground:   GradientBackground from Aspect ;
1709         MyDefaultViewAxis:      Vector from Graphic3d ;
1710         MyDefaultViewPoint:     Vertex from Graphic3d ;
1711
1712         MyWindow:               Window from Aspect;
1713
1714         MyPlotter:              Plotter from Graphic3d;
1715
1716         myActiveLightsIterator: ListIteratorOfListOfTransient from TColStd;
1717         myActivePlanesIterator: ListIteratorOfListOfTransient from TColStd;
1718
1719         sx,sy: Integer from Standard;
1720         rx,ry: Real from Standard;
1721         gx,gy,gz: Real from Standard;
1722         myComputedMode: Boolean from Standard;
1723         SwitchSetFront: Boolean from Standard;
1724         MyZoomAtPointX, MyZoomAtPointY : Integer from Standard;
1725
1726         -- the 3d grid
1727         MyGrid                  :       Grid from Aspect;
1728         MyPlane                 :       Ax3 from gp;
1729
1730         --MyColorScale            :       ColorScale from V3d;
1731         MyLayerMgr              :       LayerMgr from V3d;
1732
1733         -- the transformation between XoY and the grid plane
1734         MyTrsf                  :       Array2OfReal from TColStd;
1735
1736         -- echo
1737         MyGridEchoStructure             :       Structure from Graphic3d;
1738         MyGridEchoGroup                 :       Group from Graphic3d;
1739
1740     MyProjModel         :   TypeOfProjectionModel from V3d is protected;
1741     MyAnimationFlags        :   Integer from Standard;
1742
1743     MyTransparencyFlag      : Boolean from Standard;
1744 friends
1745
1746         SetViewOn from class Viewer from V3d ( me : mutable ),
1747         SetViewOn from class Viewer from V3d ( me : mutable ; View : View from V3d ),
1748         SetViewOff from class Viewer from V3d ( me : mutable ),
1749         SetViewOff from class Viewer from V3d ( me : mutable ; View : View from V3d )
1750
1751 end View;