0027816: Visualization - provide an API for overriding clipping planes list
[occt.git] / src / V3d / V3d_View.hxx
1 // Created on: 1992-01-15
2 // Created by: GG
3 // Copyright (c) 1992-1999 Matra Datavision
4 // Copyright (c) 1999-2014 OPEN CASCADE SAS
5 //
6 // This file is part of Open CASCADE Technology software library.
7 //
8 // This library is free software; you can redistribute it and/or modify it under
9 // the terms of the GNU Lesser General Public License version 2.1 as published
10 // by the Free Software Foundation, with special exception defined in the file
11 // OCCT_LGPL_EXCEPTION.txt. Consult the file LICENSE_LGPL_21.txt included in OCCT
12 // distribution for complete text of the license and disclaimer of any warranty.
13 //
14 // Alternatively, this file may be used under the terms of Open CASCADE
15 // commercial license or contractual agreement.
16
17 #ifndef _V3d_View_HeaderFile
18 #define _V3d_View_HeaderFile
19
20 #include <Aspect_Background.hxx>
21 #include <Aspect_FillMethod.hxx>
22 #include <Aspect_GradientBackground.hxx>
23 #include <Aspect_GradientFillMethod.hxx>
24 #include <Aspect_Handle.hxx>
25 #include <Aspect_RenderingContext.hxx>
26 #include <Aspect_TypeOfTriedronPosition.hxx>
27 #include <Aspect_TypeOfTriedronEcho.hxx>
28
29 #include <Bnd_Box.hxx>
30
31 #include <gp_Ax3.hxx>
32 #include <gp_Dir.hxx>
33 #include <gp_Pnt.hxx>
34
35 #include <Graphic3d_BufferType.hxx>
36 #include <Graphic3d_Camera.hxx>
37 #include <Graphic3d_ClipPlane.hxx>
38 #include <Graphic3d_CView.hxx>
39 #include <Graphic3d_GraduatedTrihedron.hxx>
40 #include <Graphic3d_RenderingParams.hxx>
41 #include <Graphic3d_SequenceOfHClipPlane.hxx>
42 #include <Graphic3d_Vector.hxx>
43 #include <Graphic3d_Vertex.hxx>
44
45 #include <Image_PixMap.hxx>
46
47 #include <MMgt_TShared.hxx>
48
49 #include <Quantity_Coefficient.hxx>
50 #include <Quantity_Factor.hxx>
51 #include <Quantity_Length.hxx>
52 #include <Quantity_NameOfColor.hxx>
53 #include <Quantity_Parameter.hxx>
54 #include <Quantity_PlaneAngle.hxx>
55 #include <Quantity_Ratio.hxx>
56 #include <Quantity_TypeOfColor.hxx>
57
58 #include <Standard.hxx>
59 #include <Standard_Address.hxx>
60 #include <Standard_Boolean.hxx>
61 #include <Standard_CString.hxx>
62 #include <Standard_Integer.hxx>
63 #include <Standard_Real.hxx>
64 #include <Standard_Type.hxx>
65
66 #include <TColStd_Array2OfReal.hxx>
67 #include <TColStd_ListIteratorOfListOfTransient.hxx>
68
69 #include <V3d_Coordinate.hxx>
70 #include <V3d_ListOfTransient.hxx>
71 #include <V3d_ImageDumpOptions.hxx>
72 #include <V3d_TypeOfAxe.hxx>
73
74 #include <V3d_TypeOfBackfacingModel.hxx>
75 #include <V3d_TypeOfOrientation.hxx>
76 #include <V3d_TypeOfShadingModel.hxx>
77 #include <V3d_TypeOfView.hxx>
78 #include <V3d_TypeOfVisualization.hxx>
79 #include <V3d_Viewer.hxx>
80 #include <V3d_ViewerPointer.hxx>
81
82 class Aspect_Grid;
83 class Aspect_Window;
84 class Bnd_Box;
85 class Graphic3d_Group;
86 class Graphic3d_Structure;
87 class Graphic3d_TextureEnv;
88 class Graphic3d_Vector;
89 class Quantity_Color;
90 class Standard_MultiplyDefined;
91 class Standard_TypeMismatch;
92 class V3d_BadValue;
93 class V3d_Light;
94 class V3d_UnMapped;
95
96 class V3d_View;
97 DEFINE_STANDARD_HANDLE(V3d_View, MMgt_TShared)
98
99 //! Defines the application object VIEW for the
100 //! VIEWER application.
101 //! The methods of this class allow the editing
102 //! and inquiring the parameters linked to the view.
103 //! Provides a set of services common to all types of view.
104 //! Warning: The default parameters are defined by the class
105 //! Viewer (Example : SetDefaultViewSize()).
106 //! Certain methods are mouse oriented, and it is
107 //! necessary to know the difference between the start and
108 //! the continuation of this gesture in putting the method
109 //! into operation.
110 //! Example : Shifting the eye-view along the screen axes.
111 //!
112 //! View->Move(10.,20.,0.,True)     (Starting motion)
113 //! View->Move(15.,-5.,0.,False)    (Next motion)
114 class V3d_View : public MMgt_TShared
115 {
116
117 public:
118
119   //! Initializes the view.
120   Standard_EXPORT V3d_View (const Handle(V3d_Viewer)& theViewer, const V3d_TypeOfView theType = V3d_ORTHOGRAPHIC);
121
122   //! Initializes the view by copying.
123   Standard_EXPORT V3d_View (const Handle(V3d_Viewer)& theViewer, const Handle(V3d_View)& theView);
124
125   //! Default destructor.
126   Standard_EXPORT virtual ~V3d_View();
127
128   //! Activates the view in the specified Window
129   //! If <aContext> is not NULL the graphic context is used
130   //! to draw something in this view.
131   //! Otherwise an internal graphic context is created.
132   //! Warning: The view is centered and resized to preserve
133   //! the height/width ratio of the window.
134   Standard_EXPORT void SetWindow (const Handle(Aspect_Window)& theWindow,
135                                   const Aspect_RenderingContext theContext = NULL);
136
137   Standard_EXPORT void SetMagnify (const Handle(Aspect_Window)& theWindow,
138                                    const Handle(V3d_View)& thePreviousView,
139                                    const Standard_Integer theX1,
140                                    const Standard_Integer theY1,
141                                    const Standard_Integer theX2,
142                                    const Standard_Integer theY2);
143
144   //! Destroys the view.
145   Standard_EXPORT void Remove() const;
146
147   //! Deprecated, Redraw() should be used instead.
148   Standard_EXPORT void Update() const;
149
150   //! Redisplays the view even if there has not
151   //! been any modification.
152   //! Must be called if the view is shown.
153   //! (Ex: DeIconification ) .
154   Standard_EXPORT virtual void Redraw() const;
155
156   //! Updates layer of immediate presentations.
157   Standard_EXPORT virtual void RedrawImmediate() const;
158
159   //! Invalidates view content but does not redraw it.
160   Standard_EXPORT void Invalidate() const;
161
162   //! Returns true if cached view content has been invalidated.
163   Standard_EXPORT Standard_Boolean IsInvalidated() const;
164
165   //! Must be called when the window supporting the
166   //! view changes size.
167   //! if the view is not mapped on a window.
168   //! Warning: The view is centered and resized to preserve
169   //! the height/width ratio of the window.
170   Standard_EXPORT void MustBeResized();
171
172   //! Must be called when the window supporting the
173   //! view is mapped or unmapped.
174   Standard_EXPORT void DoMapping();
175
176   //! Returns the status of the view regarding
177   //! the displayed structures inside
178   //! Returns True is The View is empty
179   Standard_EXPORT Standard_Boolean IsEmpty() const;
180
181   //! Updates the lights of the view. The view is redrawn.
182   Standard_EXPORT void UpdateLights() const;
183
184   //! Sets the automatic z-fit mode and its parameters.
185   //! The auto z-fit has extra parameters which can controlled from application level
186   //! to ensure that the size of viewing volume will be sufficiently large to cover
187   //! the depth of unmanaged objects, for example, transformation persistent ones.
188   //! @param theScaleFactor [in] the scale factor for Z-range.
189   //! The range between Z-min, Z-max projection volume planes
190   //! evaluated by z fitting method will be scaled using this coefficient.
191   //! Program error exception is thrown if negative or zero value
192   //! is passed.
193   Standard_EXPORT void SetAutoZFitMode (const Standard_Boolean theIsOn, const Standard_Real theScaleFactor = 1.0);
194
195   //! returns TRUE if automatic z-fit mode is turned on.
196   Standard_EXPORT Standard_Boolean AutoZFitMode() const;
197
198   //! returns scale factor parameter of automatic z-fit mode.
199   Standard_EXPORT Standard_Real AutoZFitScaleFactor() const;
200
201   //! If automatic z-range fitting is turned on, adjusts Z-min and Z-max
202   //! projection volume planes with call to ZFitAll.
203   Standard_EXPORT void AutoZFit() const;
204
205   //! Change Z-min and Z-max planes of projection volume to match the
206   //! displayed objects.
207   Standard_EXPORT void ZFitAll (const Standard_Real theScaleFactor = 1.0) const;
208
209   //! Defines the background color of the view by the color definition type and the three corresponding values.
210   Standard_EXPORT void SetBackgroundColor (const Quantity_TypeOfColor theType,
211                                            const Quantity_Parameter theV1,
212                                            const Quantity_Parameter theV2,
213                                            const Quantity_Parameter theV3);
214
215   //! Defines the background color of the view.
216   Standard_EXPORT void SetBackgroundColor (const Quantity_Color& theColor);
217
218   //! Defines the background color of the view by supplying the color name in the form Quantity_NOC_xxxx.
219   Standard_EXPORT void SetBackgroundColor (const Quantity_NameOfColor theName);
220
221   //! Defines the gradient background colors of the view by supplying the colors
222   //! and the fill method (horizontal by default).
223   Standard_EXPORT void SetBgGradientColors (const Quantity_Color& theColor1,
224                                             const Quantity_Color& theColor2,
225                                             const Aspect_GradientFillMethod theFillStyle = Aspect_GFM_HOR,
226                                             const Standard_Boolean theToUpdate = Standard_False);
227
228   //! Defines the gradient background colors of the view by supplying  the color names
229   //! and the fill method (horizontal by default).
230   Standard_EXPORT void SetBgGradientColors (const Quantity_NameOfColor theColor1,
231                                             const Quantity_NameOfColor theColor2,
232                                             const Aspect_GradientFillMethod theFillStyle = Aspect_GFM_HOR,
233                                             const Standard_Boolean theToUpdate = Standard_False);
234
235   //! Defines the gradient background fill method of the view.
236   Standard_EXPORT void SetBgGradientStyle (const Aspect_GradientFillMethod theMethod = Aspect_GFM_HOR,
237                                            const Standard_Boolean theToUpdate = Standard_False);
238
239   //! Defines the background texture of the view by supplying the texture image file name
240   //! and fill method (centered by default).
241   Standard_EXPORT void SetBackgroundImage (const Standard_CString theFileName,
242                                            const Aspect_FillMethod theFillStyle = Aspect_FM_CENTERED,
243                                            const Standard_Boolean theToUpdate = Standard_False);
244
245   //! Defines the textured background fill method of the view.
246   Standard_EXPORT void SetBgImageStyle (const Aspect_FillMethod theFillStyle,
247                                         const Standard_Boolean theToUpdate = Standard_False);
248
249   //! Definition of an axis from its origin and
250   //! its orientation .
251   //! This will be the current axis for rotations and movements.
252   //! Warning! raises BadValue from V3d if the vector normal is NULL. .
253   Standard_EXPORT void SetAxis (const V3d_Coordinate X, const V3d_Coordinate Y, const V3d_Coordinate Z, const Quantity_Parameter Vx, const Quantity_Parameter Vy, const Quantity_Parameter Vz);
254
255   //! Defines the shading model for the visualization. Various models are available.
256   Standard_EXPORT void SetShadingModel (const V3d_TypeOfShadingModel theShadingModel);
257
258   //! Sets the environment texture to use. No environment texture by default.
259   Standard_EXPORT void SetTextureEnv (const Handle(Graphic3d_TextureEnv)& theTexture);
260
261   //! Defines the visualization type in the view.
262   Standard_EXPORT void SetVisualization (const V3d_TypeOfVisualization theType);
263
264   //! Activates theLight in the view.
265   Standard_EXPORT void SetLightOn (const Handle(V3d_Light)& theLight);
266
267   //! Activates all the lights defined in this view.
268   Standard_EXPORT void SetLightOn();
269
270   //! Deactivate theLight in this view.
271   Standard_EXPORT void SetLightOff (const Handle(V3d_Light)& theLight);
272
273   //! Deactivate all the Lights defined in this view.
274   Standard_EXPORT void SetLightOff();
275
276   //! Returns TRUE when the light is active in this view.
277   Standard_EXPORT Standard_Boolean IsActiveLight (const Handle(V3d_Light)& theLight) const;
278
279   //! sets the immediate update mode and returns the previous one.
280   Standard_EXPORT Standard_Boolean SetImmediateUpdate (const Standard_Boolean theImmediateUpdate);
281
282   //! Customization of the ZBUFFER Triedron.
283   //! XColor,YColor,ZColor - colors of axis
284   //! SizeRatio - ratio of decreasing of the trihedron size when its physical
285   //! position comes out of the view
286   //! AxisDiametr - diameter relatively to axis length
287   //! NbFacettes - number of facets of cylinders and cones
288   Standard_EXPORT void ZBufferTriedronSetup (const Quantity_NameOfColor theXColor = Quantity_NOC_RED,
289                                              const Quantity_NameOfColor theYColor = Quantity_NOC_GREEN,
290                                              const Quantity_NameOfColor theZColor = Quantity_NOC_BLUE1,
291                                              const Standard_Real theSizeRatio = 0.8,
292                                              const Standard_Real theAxisDiametr = 0.05,
293                                              const Standard_Integer theNbFacettes = 12);
294
295   //! Display of the Triedron.
296   //! Initialize position, color and length of Triedron axes.
297   //! The scale is a percent of the window width.
298   Standard_EXPORT void TriedronDisplay (const Aspect_TypeOfTriedronPosition thePosition = Aspect_TOTP_CENTER,
299                                         const Quantity_NameOfColor theColor = Quantity_NOC_WHITE,
300                                         const Standard_Real theScale = 0.02,
301                                         const V3d_TypeOfVisualization theMode = V3d_WIREFRAME);
302
303   //! Erases the Triedron.
304   Standard_EXPORT void TriedronErase();
305
306   //! Highlights the echo zone of the Triedron.
307   Standard_EXPORT void TriedronEcho (const Aspect_TypeOfTriedronEcho theType = Aspect_TOTE_NONE);
308
309   //! Returns data of a graduated trihedron.
310   Standard_EXPORT const Graphic3d_GraduatedTrihedron& GetGraduatedTrihedron() const;
311
312   //! Displays a graduated trihedron.
313   Standard_EXPORT void GraduatedTrihedronDisplay (const Graphic3d_GraduatedTrihedron& theTrihedronData);
314
315   //! Erases a graduated trihedron from the view.
316   Standard_EXPORT void GraduatedTrihedronErase();
317
318   //! modify the Projection of the view perpendicularly to
319   //! the privileged plane of the viewer.
320   Standard_EXPORT void SetFront();
321
322   //! Rotates the eye about the coordinate system of
323   //! reference of the screen
324   //! for which the origin is the view point of the projection,
325   //! with a relative angular value in RADIANS with respect to
326   //! the initial position expressed by Start = Standard_True
327   //! Warning! raises BadValue from V3d
328   //! If the eye, the view point, or the high point are
329   //! aligned or confused.
330   Standard_EXPORT void Rotate (const Quantity_PlaneAngle Ax, const Quantity_PlaneAngle Ay, const Quantity_PlaneAngle Az, const Standard_Boolean Start = Standard_True);
331
332   //! Rotates the eye about the coordinate system of
333   //! reference of the screen
334   //! for which the origin is Gravity point {X,Y,Z},
335   //! with a relative angular value in RADIANS with respect to
336   //! the initial position expressed by Start = Standard_True
337   //! If the eye, the view point, or the high point are
338   //! aligned or confused.
339   Standard_EXPORT void Rotate (const Quantity_PlaneAngle Ax, const Quantity_PlaneAngle Ay, const Quantity_PlaneAngle Az, const V3d_Coordinate X, const V3d_Coordinate Y, const V3d_Coordinate Z, const Standard_Boolean Start = Standard_True);
340
341   //! Rotates the eye about one of the coordinate axes of
342   //! of the view for which the origin is the Gravity point{X,Y,Z}
343   //! with an relative angular value in RADIANS with
344   //! respect to the initial position expressed by
345   //! Start = Standard_True
346   Standard_EXPORT void Rotate (const V3d_TypeOfAxe Axe, const Quantity_PlaneAngle Angle, const V3d_Coordinate X, const V3d_Coordinate Y, const V3d_Coordinate Z, const Standard_Boolean Start = Standard_True);
347
348   //! Rotates the eye about one of the coordinate axes of
349   //! of the view for which the origin is the view point of the
350   //! projection with an relative angular value in RADIANS with
351   //! respect to the initial position expressed by
352   //! Start = Standard_True
353   Standard_EXPORT void Rotate (const V3d_TypeOfAxe Axe, const Quantity_PlaneAngle Angle, const Standard_Boolean Start = Standard_True);
354
355   //! Rotates the eye around the current axis a relative
356   //! angular value in RADIANS with respect to the initial
357   //! position expressed by Start = Standard_True
358   Standard_EXPORT void Rotate (const Quantity_PlaneAngle Angle, const Standard_Boolean Start = Standard_True);
359
360   //! Movement of the eye parallel to the coordinate system
361   //! of reference of the screen a distance relative to the
362   //! initial position expressed by Start = Standard_True.
363   Standard_EXPORT void Move (const Quantity_Length Dx, const Quantity_Length Dy, const Quantity_Length Dz, const Standard_Boolean Start = Standard_True);
364
365   //! Movement of the eye parallel to one of the axes of the
366   //! coordinate system of reference of the view a distance
367   //! relative to the initial position expressed by
368   //! Start = Standard_True.
369   Standard_EXPORT void Move (const V3d_TypeOfAxe Axe, const Quantity_Length Length, const Standard_Boolean Start = Standard_True);
370
371   //! Movement of the eye parllel to the current axis
372   //! a distance relative to the initial position
373   //! expressed by Start = Standard_True
374   Standard_EXPORT void Move (const Quantity_Length Length, const Standard_Boolean Start = Standard_True);
375
376   //! Movement of the ye and the view point parallel to the
377   //! frame of reference of the screen a distance relative
378   //! to the initial position expressed by
379   //! Start = Standard_True
380   Standard_EXPORT void Translate (const Quantity_Length Dx, const Quantity_Length Dy, const Quantity_Length Dz, const Standard_Boolean Start = Standard_True);
381
382   //! Movement of the eye and the view point parallel to one
383   //! of the axes of the fame of reference of the view a
384   //! distance relative to the initial position
385   //! expressed by Start = Standard_True
386   Standard_EXPORT void Translate (const V3d_TypeOfAxe Axe, const Quantity_Length Length, const Standard_Boolean Start = Standard_True);
387
388   //! Movement of the eye and view point parallel to
389   //! the current axis a distance relative to the initial
390   //! position expressed by Start = Standard_True
391   Standard_EXPORT void Translate (const Quantity_Length Length, const Standard_Boolean Start = Standard_True);
392
393   //! places the point of the view corresponding
394   //! at the pixel position x,y at the center of the window
395   //! and updates the view.
396   Standard_EXPORT void Place (const Standard_Integer theXp, const Standard_Integer theYp, const Quantity_Factor theZoomFactor = 1);
397
398   //! Rotation of the view point around the frame of reference
399   //! of the screen for which the origin is the eye of the
400   //! projection with a relative angular value in RADIANS
401   //! with respect to the initial position expressed by
402   //! Start = Standard_True
403   Standard_EXPORT void Turn (const Quantity_PlaneAngle Ax, const Quantity_PlaneAngle Ay, const Quantity_PlaneAngle Az, const Standard_Boolean Start = Standard_True);
404
405   //! Rotation of the view point around one of the axes of the
406   //! frame of reference of the view for which the origin is
407   //! the eye of the projection with an angular value in
408   //! RADIANS relative to the initial position expressed by
409   //! Start = Standard_True
410   Standard_EXPORT void Turn (const V3d_TypeOfAxe Axe, const Quantity_PlaneAngle Angle, const Standard_Boolean Start = Standard_True);
411
412   //! Rotation of the view point around the current axis an
413   //! angular value in RADIANS relative to the initial
414   //! position expressed by Start = Standard_True
415   Standard_EXPORT void Turn (const Quantity_PlaneAngle Angle, const Standard_Boolean Start = Standard_True);
416
417   //! Defines the angular position of the high point of
418   //! the reference frame of the view with respect to the
419   //! Y screen axis with an absolute angular value in
420   //! RADIANS.
421   Standard_EXPORT void SetTwist (const Quantity_PlaneAngle Angle);
422
423   //! Defines the position of the eye..
424   Standard_EXPORT void SetEye (const V3d_Coordinate X, const V3d_Coordinate Y, const V3d_Coordinate Z);
425
426   //! Defines the Depth of the eye from the view point
427   //! without update the projection .
428   Standard_EXPORT void SetDepth (const Quantity_Length Depth);
429
430   //! Defines the orientation of the projection.
431   Standard_EXPORT void SetProj (const Quantity_Parameter Vx, const Quantity_Parameter Vy, const Quantity_Parameter Vz);
432
433   //! Defines the orientation of the projection .
434   Standard_EXPORT void SetProj (const V3d_TypeOfOrientation Orientation);
435
436   //! Defines the position of the view point.
437   Standard_EXPORT void SetAt (const V3d_Coordinate X, const V3d_Coordinate Y, const V3d_Coordinate Z);
438
439   //! Defines the orientation of the high point.
440   Standard_EXPORT void SetUp (const Quantity_Parameter Vx, const Quantity_Parameter Vy, const Quantity_Parameter Vz);
441
442   //! Defines the orientation(SO) of the high point.
443   Standard_EXPORT void SetUp (const V3d_TypeOfOrientation Orientation);
444
445   //! Saves the current state of the orientation of the view
446   //! which will be the return state at ResetViewOrientation.
447   Standard_EXPORT void SetViewOrientationDefault();
448
449   //! Resets the orientation of the view.
450   //! Updates the view
451   Standard_EXPORT void ResetViewOrientation();
452
453   //! Translates the center of the view along "x" and "y" axes of
454   //! view projection. Can be used to perform interactive panning operation.
455   //! In that case the DXv, DXy parameters specify panning relative to the
456   //! point where the operation is started.
457   //! @param theDXv [in] the relative panning on "x" axis of view projection, in view space coordinates.
458   //! @param theDYv [in] the relative panning on "y" axis of view projection, in view space coordinates.
459   //! @param theZoomFactor [in] the zooming factor.
460   //! @param theToStart [in] pass TRUE when starting panning to remember view
461   //! state prior to panning for relative arguments. If panning is started,
462   //! passing {0, 0} for {theDXv, theDYv} will return view to initial state.
463   //! Performs update of view.
464   Standard_EXPORT void Panning (const Standard_Real theDXv, const Standard_Real theDYv, const Quantity_Factor theZoomFactor = 1, const Standard_Boolean theToStart = Standard_True);
465
466   //! Relocates center of screen to the point, determined by
467   //! {Xp, Yp} pixel coordinates relative to the bottom-left corner of
468   //! screen. To calculate pixel coordinates for any point from world
469   //! coordinate space, it can be projected using "Project".
470   //! @param theXp [in] the x coordinate.
471   //! @param theYp [in] the y coordinate.
472   Standard_EXPORT void SetCenter (const Standard_Integer theXp, const Standard_Integer theYp);
473
474   //! Defines the view projection size in its maximum dimension,
475   //! keeping the inital height/width ratio unchanged.
476   Standard_EXPORT void SetSize (const Quantity_Length theSize);
477
478   //! Defines the Depth size of the view
479   //! Front Plane will be set to Size/2.
480   //! Back  Plane will be set to -Size/2.
481   //! Any Object located Above the Front Plane or
482   //! behind the Back Plane will be Clipped .
483   //! NOTE than the XY Size of the View is NOT modified .
484   Standard_EXPORT void SetZSize (const Quantity_Length SetZSize);
485
486   //! Zooms the view by a factor relative to the initial
487   //! value expressed by Start = Standard_True
488   //! Updates the view.
489   Standard_EXPORT void SetZoom (const Quantity_Factor Coef, const Standard_Boolean Start = Standard_True);
490
491   //! Zooms the view by a factor relative to the value
492   //! initialised by SetViewMappingDefault().
493   //! Updates the view.
494   Standard_EXPORT void SetScale (const Quantity_Factor Coef);
495
496   //! Sets  anisotropic (axial)  scale  factors  <Sx>, <Sy>, <Sz>  for  view <me>.
497   //! Anisotropic  scaling  operation  is  performed  through  multiplying
498   //! the current view  orientation  matrix  by  a  scaling  matrix:
499   //! || Sx  0   0   0 ||
500   //! || 0   Sy  0   0 ||
501   //! || 0   0   Sz  0 ||
502   //! || 0   0   0   1 ||
503   //! Updates the view.
504   Standard_EXPORT void SetAxialScale (const Standard_Real Sx, const Standard_Real Sy, const Standard_Real Sz);
505
506   //! Adjust view parameters to fit the displayed scene, respecting height / width ratio.
507   //! The Z clipping range (depth range) is fitted if AutoZFit flag is TRUE.
508   //! Throws program error exception if margin coefficient is < 0 or >= 1.
509   //! Updates the view.
510   //! @param theMargin [in] the margin coefficient for view borders.
511   //! @param theToUpdate [in] flag to perform view update.
512   Standard_EXPORT void FitAll (const Quantity_Coefficient theMargin = 0.01, const Standard_Boolean theToUpdate = Standard_True);
513
514   //! Adjust view parameters to fit the displayed scene, respecting height / width ratio
515   //! according to the custom bounding box given.
516   //! Throws program error exception if margin coefficient is < 0 or >= 1.
517   //! Updates the view.
518   //! @param theBox [in] the custom bounding box to fit.
519   //! @param theMargin [in] the margin coefficient for view borders.
520   //! @param theToUpdate [in] flag to perform view update.
521   Standard_EXPORT void FitAll (const Bnd_Box& theBox, const Quantity_Coefficient theMargin = 0.01, const Standard_Boolean theToUpdate = Standard_True);
522
523   //! Adjusts the viewing volume so as not to clip the displayed objects by front and back
524   //! and back clipping planes. Also sets depth value automatically depending on the
525   //! calculated Z size and Aspect parameter.
526   //! NOTE than the original XY size of the view is NOT modified .
527   Standard_EXPORT void DepthFitAll (const Quantity_Coefficient Aspect = 0.01, const Quantity_Coefficient Margin = 0.01);
528
529   //! Centers the defined projection window so that it occupies
530   //! the maximum space while respecting the initial
531   //! height/width ratio.
532   //! NOTE than the original Z size of the view is NOT modified .
533   Standard_EXPORT void FitAll (const Standard_Real theMinXv, const Standard_Real theMinYv, const Standard_Real theMaxXv, const Standard_Real theMaxYv);
534
535   //! Centers the defined PIXEL window so that it occupies
536   //! the maximum space while respecting the initial height/width ratio.
537   //! NOTE than the original Z size of the view is NOT modified.
538   //! @param theMinXp [in] pixel coordinates of minimal corner on x screen axis.
539   //! @param theMinYp [in] pixel coordinates of minimal corner on y screen axis.
540   //! @param theMaxXp [in] pixel coordinates of maximal corner on x screen axis.
541   //! @param theMaxYp [in] pixel coordinates of maximal corner on y screen axis.
542   Standard_EXPORT void WindowFit (const Standard_Integer theMinXp, const Standard_Integer theMinYp, const Standard_Integer theMaxXp, const Standard_Integer theMaxYp);
543
544   //! Saves the current view mapping. This will be the
545   //! state returned from ResetViewmapping.
546   Standard_EXPORT void SetViewMappingDefault();
547
548   //! Resets the centering of the view.
549   //! Updates the view
550   Standard_EXPORT void ResetViewMapping();
551
552   //! Resets the centering and the orientation of the view.
553   Standard_EXPORT void Reset (const Standard_Boolean theToUpdate = Standard_True);
554
555   //! Converts the PIXEL value
556   //! to a value in the projection plane.
557   Standard_EXPORT Quantity_Length Convert (const Standard_Integer Vp) const;
558
559   //! Converts the point PIXEL into a point projected
560   //! in the reference frame of the projection plane.
561   Standard_EXPORT void Convert (const Standard_Integer Xp, const Standard_Integer Yp, V3d_Coordinate& Xv, V3d_Coordinate& Yv) const;
562
563   //! Converts tha value of the projection plane into
564   //! a PIXEL value.
565   Standard_EXPORT Standard_Integer Convert (const Quantity_Length Vv) const;
566
567   //! Converts the point defined in the reference frame
568   //! of the projection plane into a point PIXEL.
569   Standard_EXPORT void Convert (const V3d_Coordinate Xv, const V3d_Coordinate Yv, Standard_Integer& Xp, Standard_Integer& Yp) const;
570
571   //! Converts the projected point into a point
572   //! in the reference frame of the view corresponding
573   //! to the intersection with the projection plane
574   //! of the eye/view point vector.
575   Standard_EXPORT void Convert (const Standard_Integer Xp, const Standard_Integer Yp, V3d_Coordinate& X, V3d_Coordinate& Y, V3d_Coordinate& Z) const;
576
577   //! Converts the projected point into a point
578   //! in the reference frame of the view corresponding
579   //! to the intersection with the projection plane
580   //! of the eye/view point vector and returns the
581   //! projection ray for further computations.
582   Standard_EXPORT void ConvertWithProj (const Standard_Integer Xp, const Standard_Integer Yp, V3d_Coordinate& X, V3d_Coordinate& Y, V3d_Coordinate& Z, Quantity_Parameter& Vx, Quantity_Parameter& Vy, Quantity_Parameter& Vz) const;
583
584   //! Converts the projected point into the nearest grid point
585   //! in the reference frame of the view corresponding
586   //! to the intersection with the projection plane
587   //! of the eye/view point vector and display the grid marker.
588   //! Warning: When the grid is not active the result is identical to the above Convert() method.
589   //! How to use:
590   //! 1) Enable the grid echo display
591   //! myViewer->SetGridEcho(Standard_True);
592   //! 2) When application receive a move event:
593   //! 2.1) Check if any object is detected
594   //! if( myInteractiveContext->MoveTo(x,y) == AIS_SOD_Nothing ) {
595   //! 2.2) Check if the grid is active
596   //! if( myViewer->Grid()->IsActive() ) {
597   //! 2.3) Display the grid echo and gets the grid point
598   //! myView->ConvertToGrid(x,y,X,Y,Z);
599   //! myView->Viewer()->ShowGridEcho (myView, Graphic3d_Vertex (X,Y,Z));
600   //! myView->RedrawImmediate();
601   //! 2.4) Else this is the standard case
602   //! } else myView->Convert(x,y,X,Y,Z);
603   Standard_EXPORT void ConvertToGrid (const Standard_Integer Xp, const Standard_Integer Yp, V3d_Coordinate& Xg, V3d_Coordinate& Yg, V3d_Coordinate& Zg) const;
604
605   //! Converts the point into the nearest grid point
606   //! and display the grid marker.
607   Standard_EXPORT void ConvertToGrid (const V3d_Coordinate X, const V3d_Coordinate Y, const V3d_Coordinate Z, V3d_Coordinate& Xg, V3d_Coordinate& Yg, V3d_Coordinate& Zg) const;
608
609   //! Projects the point defined in the reference frame of
610   //! the view into the projected point in the associated window.
611   Standard_EXPORT void Convert (const V3d_Coordinate X, const V3d_Coordinate Y, const V3d_Coordinate Z, Standard_Integer& Xp, Standard_Integer& Yp) const;
612
613   //! Converts the point defined in the user space of
614   //! the view to the projection plane at the depth
615   //! relative to theZ.
616   Standard_EXPORT void Project (const Standard_Real theX,
617                                 const Standard_Real theY,
618                                 const Standard_Real theZ,
619                                 Standard_Real& theXp,
620                                 Standard_Real& theYp) const;
621
622   //! Converts the point defined in the user space of
623   //! the view to the projection plane at the depth
624   //! relative to theZ.
625   Standard_EXPORT void Project (const Standard_Real theX,
626                                 const Standard_Real theY,
627                                 const Standard_Real theZ,
628                                 Standard_Real& theXp,
629                                 Standard_Real& theYp,
630                                 Standard_Real& theZp) const;
631
632   //! Returns the Background color values of the view
633   //! depending of the color Type.
634   Standard_EXPORT void BackgroundColor (const Quantity_TypeOfColor Type, Quantity_Parameter& V1, Quantity_Parameter& V2, Quantity_Parameter& V3) const;
635
636   //! Returns the Background color object of the view.
637   Standard_EXPORT Quantity_Color BackgroundColor() const;
638
639   //! Returns the gradient background colors of the view.
640   Standard_EXPORT void GradientBackgroundColors (Quantity_Color& theColor1, Quantity_Color& theColor2) const;
641
642   //! Returns the gradient background of the view.
643   Standard_EXPORT Aspect_GradientBackground GradientBackground() const;
644
645   //! Returns the current value of the zoom expressed with
646   //! respect to SetViewMappingDefault().
647   Standard_EXPORT Quantity_Factor Scale() const;
648
649   //! Returns the current values of the anisotropic (axial) scale factors.
650   Standard_EXPORT void AxialScale (Standard_Real& Sx, Standard_Real& Sy, Standard_Real& Sz) const;
651
652   //! Returns the height and width of the view.
653   Standard_EXPORT void Size (Quantity_Length& Width, Quantity_Length& Height) const;
654
655   //! Returns the Depth of the view .
656   Standard_EXPORT Standard_Real ZSize() const;
657
658   //! Returns the position of the eye.
659   Standard_EXPORT void Eye (V3d_Coordinate& X, V3d_Coordinate& Y, V3d_Coordinate& Z) const;
660
661   //! Returns the position of point which emanating the
662   //! projections.
663   Standard_EXPORT void FocalReferencePoint (V3d_Coordinate& X, V3d_Coordinate& Y, V3d_Coordinate& Z) const;
664
665   //! Returns the coordinate of the point (Xpix,Ypix)
666   //! in the view (XP,YP,ZP), and the projection vector of the
667   //! view passing by the point (for PerspectiveView).
668   Standard_EXPORT void ProjReferenceAxe (const Standard_Integer Xpix, const Standard_Integer Ypix, V3d_Coordinate& XP, V3d_Coordinate& YP, V3d_Coordinate& ZP, V3d_Coordinate& VX, V3d_Coordinate& VY, V3d_Coordinate& VZ) const;
669
670   //! Returns the Distance between the Eye and View Point.
671   Standard_EXPORT Quantity_Length Depth() const;
672
673   //! Returns the projection vector.
674   Standard_EXPORT void Proj (Quantity_Parameter& Vx, Quantity_Parameter& Vy, Quantity_Parameter& Vz) const;
675
676   //! Returns the position of the view point.
677   Standard_EXPORT void At (V3d_Coordinate& X, V3d_Coordinate& Y, V3d_Coordinate& Z) const;
678
679   //! Returns the vector giving the position of the high point.
680   Standard_EXPORT void Up (Quantity_Parameter& Vx, Quantity_Parameter& Vy, Quantity_Parameter& Vz) const;
681
682   //! Returns in RADIANS the orientation of the view around
683   //! the visual axis measured from the Y axis of the screen.
684   Standard_EXPORT Quantity_PlaneAngle Twist() const;
685
686   //! Returns the current shading model.
687   Standard_EXPORT V3d_TypeOfShadingModel ShadingModel() const;
688
689   Standard_EXPORT Handle(Graphic3d_TextureEnv) TextureEnv() const;
690
691   //! Returns the current visualisation mode.
692   Standard_EXPORT V3d_TypeOfVisualization Visualization() const;
693
694   //! Returns True if One light more can be
695   //! activated in this View.
696   Standard_EXPORT Standard_Boolean IfMoreLights() const;
697
698   //! initializes an iteration on the active Lights.
699   Standard_EXPORT void InitActiveLights();
700
701   //! returns true if there are more active Light(s) to return.
702   Standard_EXPORT Standard_Boolean MoreActiveLights() const;
703
704   //! Go to the next active Light
705   //! (if there is not, ActiveLight will raise an exception)
706   Standard_EXPORT void NextActiveLights();
707
708   Standard_EXPORT Handle(V3d_Light) ActiveLight() const;
709
710   //! Returns the MAX number of light associated to the view.
711   Standard_EXPORT Standard_Integer LightLimit() const;
712
713   //! Returns the viewer in which the view has been created.
714   Standard_EXPORT Handle(V3d_Viewer) Viewer() const;
715
716   //! Returns True if MyView is associated with a window .
717   Standard_EXPORT Standard_Boolean IfWindow() const;
718
719   //! Returns the Aspect Window associated with the view.
720   Standard_EXPORT Handle(Aspect_Window) Window() const;
721
722   //! Returns the Type of the View
723   Standard_EXPORT V3d_TypeOfView Type() const;
724
725   //! Translates the center of the view along "x" and "y" axes of
726   //! view projection. Can be used to perform interactive panning operation.
727   //! In that case the DXp, DXp parameters specify panning relative to the
728   //! point where the operation is started.
729   //! @param theDXp [in] the relative panning on "x" axis of view projection, in pixels.
730   //! @param theDYp [in] the relative panning on "y" axis of view projection, in pixels.
731   //! @param theZoomFactor [in] the zooming factor.
732   //! @param theToStart [in] pass TRUE when starting panning to remember view
733   //! state prior to panning for relative arguments. Passing 0 for relative
734   //! panning parameter should return view panning to initial state.
735   //! Performs update of view.
736   Standard_EXPORT void Pan (const Standard_Integer theDXp, const Standard_Integer theDYp, const Quantity_Factor theZoomFactor = 1, const Standard_Boolean theToStart = Standard_True);
737
738   //! Zoom the view according to a zoom factor computed
739   //! from the distance between the 2 mouse position.
740   //! @param theXp1 [in] the x coordinate of first mouse position, in pixels.
741   //! @param theYp1 [in] the y coordinate of first mouse position, in pixels.
742   //! @param theXp2 [in] the x coordinate of second mouse position, in pixels.
743   //! @param theYp2 [in] the y coordinate of second mouse position, in pixels.
744   Standard_EXPORT void Zoom (const Standard_Integer theXp1, const Standard_Integer theYp1, const Standard_Integer theXp2, const Standard_Integer theYp2);
745
746   //! Defines starting point for ZoomAtPoint view operation.
747   //! @param theXp [in] the x mouse coordinate, in pixels.
748   //! @param theYp [in] the y mouse coordinate, in pixels.
749   Standard_EXPORT void StartZoomAtPoint (const Standard_Integer theXp, const Standard_Integer theYp);
750
751   //! Zooms the model at a pixel defined by the method StartZoomAtPoint().
752   Standard_EXPORT void ZoomAtPoint (const Standard_Integer theMouseStartX, const Standard_Integer theMouseStartY, const Standard_Integer theMouseEndX, const Standard_Integer theMouseEndY);
753
754   //! Performs  anisotropic scaling  of  <me>  view  along  the  given  <Axis>.
755   //! The  scale  factor  is  calculated on a basis of
756   //! the mouse pointer displacement <Dx,Dy>.
757   //! The  calculated  scale  factor  is  then  passed  to  SetAxialScale(Sx,  Sy,  Sz)  method.
758   Standard_EXPORT void AxialScale (const Standard_Integer Dx, const Standard_Integer Dy, const V3d_TypeOfAxe Axis);
759
760   //! Begin the rotation of the view around the screen axis
761   //! according to the mouse position <X,Y>.
762   //! Warning: Enable rotation around the Z screen axis when <zRotationThreshold>
763   //! factor is > 0 soon the distance from the start point and the center
764   //! of the view is > (medium viewSize * <zRotationThreshold> ).
765   //! Generally a value of 0.4 is usable to rotate around XY screen axis
766   //! inside the circular threshold area and to rotate around Z screen axis
767   //! outside this area.
768   Standard_EXPORT void StartRotation (const Standard_Integer X, const Standard_Integer Y, const Quantity_Ratio zRotationThreshold = 0.0);
769
770   //! Continues the rotation of the view
771   //! with an angle computed from the last and new mouse position <X,Y>.
772   Standard_EXPORT void Rotation (const Standard_Integer X, const Standard_Integer Y);
773
774   //! Change View Plane Distance for Perspective Views
775   //! Warning! raises TypeMismatch from Standard if the view
776   //! is not a perspective view.
777   Standard_EXPORT void SetFocale (const Quantity_Length Focale);
778
779   //! Returns the View Plane Distance for Perspective Views
780   Standard_EXPORT Quantity_Length Focale() const;
781
782   //! Returns the associated Graphic3d view.
783   Standard_EXPORT Handle(Graphic3d_CView) View() const;
784
785   //! Switches computed HLR mode in the view.
786   Standard_EXPORT void SetComputedMode (const Standard_Boolean theMode);
787
788   //! Returns the computed HLR mode state.
789   Standard_EXPORT Standard_Boolean ComputedMode() const;
790
791   //! idem than WindowFit
792   Standard_EXPORT void WindowFitAll (const Standard_Integer Xmin, const Standard_Integer Ymin, const Standard_Integer Xmax, const Standard_Integer Ymax);
793
794   //! Defines or Updates the definition of the
795   //! grid in <me>
796   Standard_EXPORT void SetGrid (const gp_Ax3& aPlane, const Handle(Aspect_Grid)& aGrid);
797
798   //! Defines or Updates the activity of the
799   //! grid in <me>
800   Standard_EXPORT void SetGridActivity (const Standard_Boolean aFlag);
801
802   //! dump the full contents of the view at the same
803   //! scale in the file <theFile>. The file name
804   //! extension must be one of ".png",".bmp",".jpg",".gif".
805   //! Returns FALSE when the dump has failed
806   Standard_EXPORT Standard_Boolean Dump (const Standard_CString theFile, const Graphic3d_BufferType& theBufferType = Graphic3d_BT_RGB);
807
808   //! Export scene into the one of the Vector graphics formats (SVG, PS, PDF...).
809   //! In contrast to Bitmaps, Vector graphics is scalable (so you may got quality benefits
810   //! on printing to laser printer). Notice however that results may differ a lot and
811   //! do not contain some elements.
812   Standard_DEPRECATED("Export to Vector graphic is incompatible with Programmable Pipeline and should not be used")
813   Standard_EXPORT Standard_Boolean Export (const Standard_CString theFileName,
814                                            const Graphic3d_ExportFormat theFormat,
815                                            const Graphic3d_SortType theSortType = Graphic3d_ST_BSP_Tree);
816
817   //! Dumps the full contents of the view to a pixmap with specified parameters.
818   Standard_EXPORT Standard_Boolean ToPixMap (Image_PixMap&               theImage,
819                                              const V3d_ImageDumpOptions& theParams);
820
821   //! Dumps the full contents of the view to a pixmap.
822   //! @param theImage          target image, will be re-allocated to match theWidth x theHeight
823   //! @param theWidth          target image width
824   //! @param theHeight         target image height
825   //! @param theBufferType     type of the view buffer to dump (color / depth)
826   //! @param theToAdjustAspect when true, active view aspect ratio will be overridden by (theWidth / theHeight)
827   //! @param theStereoOptions  how to dump stereographic camera
828   Standard_Boolean ToPixMap (Image_PixMap& theImage,
829                              const Standard_Integer theWidth,
830                              const Standard_Integer theHeight,
831                              const Graphic3d_BufferType& theBufferType     = Graphic3d_BT_RGB,
832                              const Standard_Boolean      theToAdjustAspect = Standard_True,
833                              const V3d_StereoDumpOptions theStereoOptions  = V3d_SDO_MONO)
834   {
835     V3d_ImageDumpOptions aParams;
836     aParams.Width  = theWidth;
837     aParams.Height = theHeight;
838     aParams.BufferType = theBufferType;
839     aParams.StereoOptions  = theStereoOptions;
840     aParams.ToAdjustAspect = theToAdjustAspect;
841     return ToPixMap (theImage, aParams);
842   }
843
844   //! Manages display of the back faces
845   //! When <aModel> is TOBM_AUTOMATIC the object backfaces
846   //! are displayed only for surface objects and
847   //! never displayed for solid objects.
848   //! this was the previous mode.
849   //! <aModel> is TOBM_ALWAYS_DISPLAYED the object backfaces
850   //! are always displayed both for surfaces or solids.
851   //! <aModel> is TOBM_NEVER_DISPLAYED the object backfaces
852   //! are never displayed.
853   Standard_EXPORT void SetBackFacingModel (const V3d_TypeOfBackfacingModel theModel = V3d_TOBM_AUTOMATIC);
854
855   //! Returns current state of the back faces display
856   Standard_EXPORT V3d_TypeOfBackfacingModel BackFacingModel() const;
857
858   //! turns on/off opengl lighting, currently used in triedron displaying
859   Standard_EXPORT void EnableGLLight (const Standard_Boolean theIsEnabled = Standard_True) const;
860
861   //! returns the current state of the gl lighting
862   //! currently used in triedron displaying
863   Standard_EXPORT Standard_Boolean IsGLLightEnabled() const;
864
865   //! Adds clip plane to the view. The composition of clip planes truncates the
866   //! rendering space to convex volume. Number of supported clip planes can be consulted
867   //! by PlaneLimit method of associated Graphic3d_GraphicDriver.
868   //! Please be aware that the planes which exceed the limit are ignored during rendering.
869   //! @param thePlane [in] the clip plane to be added to view.
870   Standard_EXPORT virtual void AddClipPlane (const Handle(Graphic3d_ClipPlane)& thePlane);
871
872   //! Removes clip plane from the view.
873   //! @param thePlane [in] the clip plane to be removed from view.
874   Standard_EXPORT virtual void RemoveClipPlane (const Handle(Graphic3d_ClipPlane)& thePlane);
875
876   //! Sets sequence of clip planes to the view. The planes that have been set
877   //! before are removed from the view. The composition of clip planes
878   //! truncates the rendering space to convex volume. Number of supported
879   //! clip planes can be consulted by InquirePlaneLimit method of
880   //! Graphic3d_GraphicDriver. Please be aware that the planes that
881   //! exceed the limit are ignored during rendering.
882   //! @param thePlanes [in] the clip planes to set.
883   Standard_EXPORT void SetClipPlanes (const Handle(Graphic3d_SequenceOfHClipPlane)& thePlanes);
884
885   Standard_DEPRECATED("This method is deprecated - overload taking Handle should be used instead")
886   void SetClipPlanes (const Graphic3d_SequenceOfHClipPlane& thePlanes)
887   {
888     Handle(Graphic3d_SequenceOfHClipPlane) aPlanes = new Graphic3d_SequenceOfHClipPlane (thePlanes);
889     SetClipPlanes (aPlanes);
890   }
891
892   //! Get clip planes.
893   //! @return sequence clip planes that have been set for the view
894   Standard_EXPORT const Handle(Graphic3d_SequenceOfHClipPlane)& ClipPlanes() const;
895
896   //! Returns the MAX number of clipping planes associated to the view.
897   Standard_EXPORT Standard_Integer PlaneLimit() const;
898
899   //! Change camera used by view.
900   Standard_EXPORT void SetCamera (const Handle(Graphic3d_Camera)& theCamera);
901
902   //! Returns camera object of the view.
903   //! @return: handle to camera object, or NULL if 3D view does not use
904   //! the camera approach.
905   Standard_EXPORT const Handle(Graphic3d_Camera)& Camera() const;
906
907   //! Returns current rendering parameters and effect settings.
908   //! By default it returns default parameters of current viewer.
909   //! To define view-specific settings use method V3d_View::ChangeRenderingParams().
910   //! @sa V3d_Viewer::DefaultRenderingParams()
911   Standard_EXPORT const Graphic3d_RenderingParams& RenderingParams() const;
912
913   //! Returns reference to current rendering parameters and effect settings.
914   Standard_EXPORT Graphic3d_RenderingParams& ChangeRenderingParams();
915
916   //! @return flag value of objects culling mechanism
917   Standard_EXPORT Standard_Boolean IsCullingEnabled() const;
918
919   //! Turn on/off automatic culling of objects outside frustrum (ON by default)
920   Standard_EXPORT void SetFrustumCulling (const Standard_Boolean theMode);
921
922 friend   
923   //! Activates all of the views of a viewer attached
924   //! to a window.
925   Standard_EXPORT void V3d_Viewer::SetViewOn();
926 friend   
927   //! Activates a particular view in the Viewer .
928   //! Must be call if the Window attached to the view
929   //! has been Deiconified .
930   Standard_EXPORT void V3d_Viewer::SetViewOn (const Handle(V3d_View)& View);
931 friend   
932   //! Deactivates all the views of a Viewer
933   //! attached to a window.
934   Standard_EXPORT void V3d_Viewer::SetViewOff();
935 friend   
936   //! Deactivates a particular view in the Viewer.
937   //! Must be call if the Window attached to the view
938   //! has been Iconified .
939   Standard_EXPORT void V3d_Viewer::SetViewOff (const Handle(V3d_View)& View);
940
941   //! Fill in the dictionary with diagnostic info.
942   //! Should be called within rendering thread.
943   //!
944   //! This API should be used only for user output or for creating automated reports.
945   //! The format of returned information (e.g. key-value layout)
946   //! is NOT part of this API and can be changed at any time.
947   //! Thus application should not parse returned information to weed out specific parameters.
948   //! @param theDict  destination map for information
949   //! @param theFlags defines the information to be retrieved
950   Standard_EXPORT void DiagnosticInformation (TColStd_IndexedDataMapOfStringString& theDict,
951                                               Graphic3d_DiagnosticInfo theFlags) const;
952
953   DEFINE_STANDARD_RTTIEXT(V3d_View,MMgt_TShared)
954
955 protected:
956
957   Standard_EXPORT void ImmediateUpdate() const;
958
959   //! Transform camera eye, center and scale to fit in the
960   //! passed bounding box specified in WCS.
961   //! @param theCamera [in] the camera.
962   //! @param theBox [in] the bounding box.
963   //! @param theMargin [in] the margin coefficient for view borders.
964   //! @param theResolution [in] the minimum size of projection of
965   //! bounding box in Xv or Yv direction when it considered to
966   //! be a thin plane or point (without a volume).
967   //! In this case only the center of camera is adjusted.
968   //! @param theToEnlargeIfLine [in] if passed TRUE - in cases when the
969   //! whole bounding box projected into thin line going along
970   //! Z-axis of screen, the view plane is enlarged such that
971   //! we see the whole line on rotation, otherwise only the
972   //! center of camera is adjusted.
973   //! @return TRUE if the fit all operation can be done.
974   Standard_EXPORT Standard_Boolean FitMinMax (const Handle(Graphic3d_Camera)& theCamera, const Bnd_Box& theBox, const Standard_Real theMargin, const Standard_Real theResolution = 0.0, const Standard_Boolean theToEnlargeIfLine = Standard_True) const;
975
976   //! Scales camera to fit the view frame of defined width and height
977   //! keeping the aspect. For orthogonal camera the method changes scale,
978   //! for perspective adjusts Eye location about the Center point.
979   //! @param theSizeXv [in] size of viewport frame on "x" axis.
980   //! @param theSizeYv [in] size of viewport frame on "y" axis.
981   Standard_EXPORT void Scale (const Handle(Graphic3d_Camera)& theCamera, const Standard_Real theSizeXv, const Standard_Real theSizeYv) const;
982
983   Standard_EXPORT void Translate (const Handle(Graphic3d_Camera)& theCamera, const Standard_Real theDXv, const Standard_Real theDYv) const;
984
985 private:
986
987   //! Modifies the aspect ratio of the camera when
988   //! the associated window is defined or resized.
989   Standard_EXPORT void SetRatio();
990
991   //! Change the scale factor and position of the view
992   //! such as the bounding box <Umin, Vmin, Umax, Vmax> is contains
993   //! in the view.
994   Standard_EXPORT void FitAll (const Handle(Aspect_Window)& aWindow, const V3d_Coordinate Umin, const V3d_Coordinate Vmin, const V3d_Coordinate Umax, const V3d_Coordinate Vmax);
995   
996   //! Determines the screen axes in the reference
997   //! framework of the view.
998   Standard_EXPORT static Standard_Boolean ScreenAxis (const gp_Dir& Vpn, const gp_Dir& Vup, Graphic3d_Vector& Xaxe, Graphic3d_Vector& Yaxe, Graphic3d_Vector& Zaxe);
999   
1000   //! Transforms the Vertex V according to the matrice Matrix .
1001   Standard_EXPORT static Graphic3d_Vertex TrsPoint (const Graphic3d_Vertex& V, const TColStd_Array2OfReal& Matrix);
1002   
1003   //! Returns the objects number and the projection window
1004   //! of the objects contained in the view.
1005   Standard_EXPORT Standard_Integer MinMax (V3d_Coordinate& Umin, V3d_Coordinate& Vmin, V3d_Coordinate& Umax, V3d_Coordinate& Vmax) const;
1006   
1007   //! Returns the objects number and the box encompassing
1008   //! the objects contained in the view
1009   Standard_EXPORT Standard_Integer MinMax (V3d_Coordinate& Xmin, V3d_Coordinate& Ymin, V3d_Coordinate& Zmin, V3d_Coordinate& Xmax, V3d_Coordinate& Ymax, V3d_Coordinate& Zmax) const;
1010   
1011   //! Returns the Objects number and the gravity center
1012   //! of ALL viewable points in the view
1013   Standard_EXPORT void Gravity (V3d_Coordinate& X, V3d_Coordinate& Y, V3d_Coordinate& Z) const;
1014   
1015   Standard_EXPORT void Init();
1016   
1017   //! Returns a new vertex when the grid is activated.
1018   Standard_EXPORT Graphic3d_Vertex Compute (const Graphic3d_Vertex& AVertex) const;
1019
1020 protected:
1021
1022   Standard_Real myOldMouseX;
1023   Standard_Real myOldMouseY;
1024   gp_Dir myCamStartOpUp;
1025   gp_Pnt myCamStartOpEye;
1026   Standard_Real myCamStartOpBnd[6];
1027   gp_Pnt myCamStartOpCenter;
1028   Handle(Graphic3d_Camera) myDefaultCamera;
1029   Handle(Graphic3d_CView) myView;
1030   Standard_Boolean myImmediateUpdate;
1031
1032 private:
1033
1034   V3d_ViewerPointer MyViewer;
1035   V3d_ListOfTransient MyActiveLights;
1036   Graphic3d_Vector MyDefaultViewAxis;
1037   Graphic3d_Vertex MyDefaultViewPoint;
1038   Handle(Aspect_Window) MyWindow;
1039   TColStd_ListIteratorOfListOfTransient myActiveLightsIterator;
1040   Standard_Integer sx;
1041   Standard_Integer sy;
1042   Standard_Real rx;
1043   Standard_Real ry;
1044   Standard_Real gx;
1045   Standard_Real gy;
1046   Standard_Real gz;
1047   Standard_Boolean myComputedMode;
1048   Standard_Boolean SwitchSetFront;
1049   Standard_Boolean myZRotation;
1050   Standard_Integer MyZoomAtPointX;
1051   Standard_Integer MyZoomAtPointY;
1052   Handle(Aspect_Grid) MyGrid;
1053   gp_Ax3 MyPlane;
1054   TColStd_Array2OfReal MyTrsf;
1055   Handle(Graphic3d_Structure) MyGridEchoStructure;
1056   Handle(Graphic3d_Group) MyGridEchoGroup;
1057   Graphic3d_Vector myXscreenAxis;
1058   Graphic3d_Vector myYscreenAxis;
1059   Graphic3d_Vector myZscreenAxis;
1060   Graphic3d_Vector myViewAxis;
1061   Graphic3d_Vertex myGravityReferencePoint;
1062   Standard_Boolean myAutoZFitIsOn;
1063   Standard_Real myAutoZFitScaleFactor;
1064 };
1065
1066 #endif // _V3d_View_HeaderFile