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