d1e6129bf4e52b32372fb8c9cdd3cfe4e1b2d522
[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_Boolean AutoZFitMode() const { return myAutoZFitIsOn; }
183
184   //! returns scale factor parameter of automatic z-fit mode.
185   Standard_Real AutoZFitScaleFactor() const { return myAutoZFitScaleFactor; }
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   //! @param theOrientation camera direction
414   //! @param theIsYup       flag indicating Y-up (TRUE) or Z-up (FALSE) convention
415   Standard_EXPORT void SetProj (const V3d_TypeOfOrientation theOrientation,
416                                 const Standard_Boolean theIsYup = Standard_False);
417
418   //! Defines the position of the view point.
419   Standard_EXPORT void SetAt (const Standard_Real X, const Standard_Real Y, const Standard_Real Z);
420
421   //! Defines the orientation of the high point.
422   Standard_EXPORT void SetUp (const Standard_Real Vx, const Standard_Real Vy, const Standard_Real Vz);
423
424   //! Defines the orientation(SO) of the high point.
425   Standard_EXPORT void SetUp (const V3d_TypeOfOrientation Orientation);
426
427   //! Saves the current state of the orientation of the view
428   //! which will be the return state at ResetViewOrientation.
429   Standard_EXPORT void SetViewOrientationDefault();
430
431   //! Resets the orientation of the view.
432   //! Updates the view
433   Standard_EXPORT void ResetViewOrientation();
434
435   //! Translates the center of the view along "x" and "y" axes of
436   //! view projection. Can be used to perform interactive panning operation.
437   //! In that case the DXv, DXy parameters specify panning relative to the
438   //! point where the operation is started.
439   //! @param theDXv [in] the relative panning on "x" axis of view projection, in view space coordinates.
440   //! @param theDYv [in] the relative panning on "y" axis of view projection, in view space coordinates.
441   //! @param theZoomFactor [in] the zooming factor.
442   //! @param theToStart [in] pass TRUE when starting panning to remember view
443   //! state prior to panning for relative arguments. If panning is started,
444   //! passing {0, 0} for {theDXv, theDYv} will return view to initial state.
445   //! Performs update of view.
446   Standard_EXPORT void Panning (const Standard_Real theDXv, const Standard_Real theDYv, const Standard_Real theZoomFactor = 1, const Standard_Boolean theToStart = Standard_True);
447
448   //! Relocates center of screen to the point, determined by
449   //! {Xp, Yp} pixel coordinates relative to the bottom-left corner of
450   //! screen. To calculate pixel coordinates for any point from world
451   //! coordinate space, it can be projected using "Project".
452   //! @param theXp [in] the x coordinate.
453   //! @param theYp [in] the y coordinate.
454   Standard_EXPORT void SetCenter (const Standard_Integer theXp, const Standard_Integer theYp);
455
456   //! Defines the view projection size in its maximum dimension,
457   //! keeping the inital height/width ratio unchanged.
458   Standard_EXPORT void SetSize (const Standard_Real theSize);
459
460   //! Defines the Depth size of the view
461   //! Front Plane will be set to Size/2.
462   //! Back  Plane will be set to -Size/2.
463   //! Any Object located Above the Front Plane or
464   //! behind the Back Plane will be Clipped .
465   //! NOTE than the XY Size of the View is NOT modified .
466   Standard_EXPORT void SetZSize (const Standard_Real SetZSize);
467
468   //! Zooms the view by a factor relative to the initial
469   //! value expressed by Start = Standard_True
470   //! Updates the view.
471   Standard_EXPORT void SetZoom (const Standard_Real Coef, const Standard_Boolean Start = Standard_True);
472
473   //! Zooms the view by a factor relative to the value
474   //! initialised by SetViewMappingDefault().
475   //! Updates the view.
476   Standard_EXPORT void SetScale (const Standard_Real Coef);
477
478   //! Sets  anisotropic (axial)  scale  factors  <Sx>, <Sy>, <Sz>  for  view <me>.
479   //! Anisotropic  scaling  operation  is  performed  through  multiplying
480   //! the current view  orientation  matrix  by  a  scaling  matrix:
481   //! || Sx  0   0   0 ||
482   //! || 0   Sy  0   0 ||
483   //! || 0   0   Sz  0 ||
484   //! || 0   0   0   1 ||
485   //! Updates the view.
486   Standard_EXPORT void SetAxialScale (const Standard_Real Sx, const Standard_Real Sy, const Standard_Real Sz);
487
488   //! Adjust view parameters to fit the displayed scene, respecting height / width ratio.
489   //! The Z clipping range (depth range) is fitted if AutoZFit flag is TRUE.
490   //! Throws program error exception if margin coefficient is < 0 or >= 1.
491   //! Updates the view.
492   //! @param theMargin [in] the margin coefficient for view borders.
493   //! @param theToUpdate [in] flag to perform view update.
494   Standard_EXPORT void FitAll (const Standard_Real theMargin = 0.01, const Standard_Boolean theToUpdate = Standard_True);
495
496   //! Adjust view parameters to fit the displayed scene, respecting height / width ratio
497   //! according to the custom bounding box given.
498   //! Throws program error exception if margin coefficient is < 0 or >= 1.
499   //! Updates the view.
500   //! @param theBox [in] the custom bounding box to fit.
501   //! @param theMargin [in] the margin coefficient for view borders.
502   //! @param theToUpdate [in] flag to perform view update.
503   Standard_EXPORT void FitAll (const Bnd_Box& theBox, const Standard_Real theMargin = 0.01, const Standard_Boolean theToUpdate = Standard_True);
504
505   //! Adjusts the viewing volume so as not to clip the displayed objects by front and back
506   //! and back clipping planes. Also sets depth value automatically depending on the
507   //! calculated Z size and Aspect parameter.
508   //! NOTE than the original XY size of the view is NOT modified .
509   Standard_EXPORT void DepthFitAll (const Standard_Real Aspect = 0.01, const Standard_Real Margin = 0.01);
510
511   //! Centers the defined projection window so that it occupies
512   //! the maximum space while respecting the initial
513   //! height/width ratio.
514   //! NOTE than the original Z size of the view is NOT modified .
515   Standard_EXPORT void FitAll (const Standard_Real theMinXv, const Standard_Real theMinYv, const Standard_Real theMaxXv, const Standard_Real theMaxYv);
516
517   //! Centers the defined PIXEL window so that it occupies
518   //! the maximum space while respecting the initial height/width ratio.
519   //! NOTE than the original Z size of the view is NOT modified.
520   //! @param theMinXp [in] pixel coordinates of minimal corner on x screen axis.
521   //! @param theMinYp [in] pixel coordinates of minimal corner on y screen axis.
522   //! @param theMaxXp [in] pixel coordinates of maximal corner on x screen axis.
523   //! @param theMaxYp [in] pixel coordinates of maximal corner on y screen axis.
524   Standard_EXPORT void WindowFit (const Standard_Integer theMinXp, const Standard_Integer theMinYp, const Standard_Integer theMaxXp, const Standard_Integer theMaxYp);
525
526   //! Saves the current view mapping. This will be the
527   //! state returned from ResetViewmapping.
528   Standard_EXPORT void SetViewMappingDefault();
529
530   //! Resets the centering of the view.
531   //! Updates the view
532   Standard_EXPORT void ResetViewMapping();
533
534   //! Resets the centering and the orientation of the view.
535   Standard_EXPORT void Reset (const Standard_Boolean theToUpdate = Standard_True);
536
537   //! Converts the PIXEL value
538   //! to a value in the projection plane.
539   Standard_EXPORT Standard_Real Convert (const Standard_Integer Vp) const;
540
541   //! Converts the point PIXEL into a point projected
542   //! in the reference frame of the projection plane.
543   Standard_EXPORT void Convert (const Standard_Integer Xp, const Standard_Integer Yp,
544                                 Standard_Real& Xv, Standard_Real& Yv) const;
545
546   //! Converts tha value of the projection plane into
547   //! a PIXEL value.
548   Standard_EXPORT Standard_Integer Convert (const Standard_Real Vv) const;
549
550   //! Converts the point defined in the reference frame
551   //! of the projection plane into a point PIXEL.
552   Standard_EXPORT void Convert (const Standard_Real Xv, const Standard_Real Yv,
553                                 Standard_Integer& Xp, Standard_Integer& Yp) const;
554
555   //! Converts the projected point into a point
556   //! in the reference frame of the view corresponding
557   //! to the intersection with the projection plane
558   //! of the eye/view point vector.
559   Standard_EXPORT void Convert (const Standard_Integer Xp, const Standard_Integer Yp,
560                                 Standard_Real& X, Standard_Real& Y, Standard_Real& Z) const;
561
562   //! Converts the projected point into a point
563   //! in the reference frame of the view corresponding
564   //! to the intersection with the projection plane
565   //! of the eye/view point vector and returns the
566   //! projection ray for further computations.
567   Standard_EXPORT void ConvertWithProj (const Standard_Integer Xp, const Standard_Integer Yp,
568                                         Standard_Real& X,  Standard_Real& Y,  Standard_Real& Z,
569                                         Standard_Real& Vx, Standard_Real& Vy, Standard_Real& Vz) const;
570
571   //! Converts the projected point into the nearest grid 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 and display the grid marker.
575   //! Warning: When the grid is not active the result is identical to the above Convert() method.
576   //! How to use:
577   //! 1) Enable the grid echo display
578   //! myViewer->SetGridEcho(Standard_True);
579   //! 2) When application receive a move event:
580   //! 2.1) Check if any object is detected
581   //! if( myInteractiveContext->MoveTo(x,y) == AIS_SOD_Nothing ) {
582   //! 2.2) Check if the grid is active
583   //! if( myViewer->Grid()->IsActive() ) {
584   //! 2.3) Display the grid echo and gets the grid point
585   //! myView->ConvertToGrid(x,y,X,Y,Z);
586   //! myView->Viewer()->ShowGridEcho (myView, Graphic3d_Vertex (X,Y,Z));
587   //! myView->RedrawImmediate();
588   //! 2.4) Else this is the standard case
589   //! } else myView->Convert(x,y,X,Y,Z);
590   Standard_EXPORT void ConvertToGrid (const Standard_Integer Xp, const Standard_Integer Yp,
591                                       Standard_Real& Xg, Standard_Real& Yg, Standard_Real& Zg) const;
592
593   //! Converts the point into the nearest grid point
594   //! and display the grid marker.
595   Standard_EXPORT void ConvertToGrid (const Standard_Real X, const Standard_Real Y, const Standard_Real Z,
596                                       Standard_Real& Xg, Standard_Real& Yg, Standard_Real& Zg) const;
597
598   //! Projects the point defined in the reference frame of
599   //! the view into the projected point in the associated window.
600   Standard_EXPORT void Convert (const Standard_Real X, const Standard_Real Y, const Standard_Real Z,
601                                 Standard_Integer& Xp, Standard_Integer& Yp) const;
602
603   //! Converts the point defined in the user space of
604   //! the view to the projection plane at the depth
605   //! relative to theZ.
606   Standard_EXPORT void Project (const Standard_Real theX,
607                                 const Standard_Real theY,
608                                 const Standard_Real theZ,
609                                 Standard_Real& theXp,
610                                 Standard_Real& theYp) const;
611
612   //! Converts the point defined in the user space of
613   //! the view to the projection plane at the depth
614   //! relative to theZ.
615   Standard_EXPORT void Project (const Standard_Real theX,
616                                 const Standard_Real theY,
617                                 const Standard_Real theZ,
618                                 Standard_Real& theXp,
619                                 Standard_Real& theYp,
620                                 Standard_Real& theZp) const;
621
622   //! Returns the Background color values of the view
623   //! depending of the color Type.
624   Standard_EXPORT void BackgroundColor (const Quantity_TypeOfColor Type, Standard_Real& V1, Standard_Real& V2, Standard_Real& V3) const;
625
626   //! Returns the Background color object of the view.
627   Standard_EXPORT Quantity_Color BackgroundColor() const;
628
629   //! Returns the gradient background colors of the view.
630   Standard_EXPORT void GradientBackgroundColors (Quantity_Color& theColor1, Quantity_Color& theColor2) const;
631
632   //! Returns the gradient background of the view.
633   Standard_EXPORT Aspect_GradientBackground GradientBackground() const;
634
635   //! Returns the current value of the zoom expressed with
636   //! respect to SetViewMappingDefault().
637   Standard_EXPORT Standard_Real Scale() const;
638
639   //! Returns the current values of the anisotropic (axial) scale factors.
640   Standard_EXPORT void AxialScale (Standard_Real& Sx, Standard_Real& Sy, Standard_Real& Sz) const;
641
642   //! Returns the height and width of the view.
643   Standard_EXPORT void Size (Standard_Real& Width, Standard_Real& Height) const;
644
645   //! Returns the Depth of the view .
646   Standard_EXPORT Standard_Real ZSize() const;
647
648   //! Returns the position of the eye.
649   Standard_EXPORT void Eye (Standard_Real& X, Standard_Real& Y, Standard_Real& Z) const;
650
651   //! Returns the position of point which emanating the projections.
652   void FocalReferencePoint (Standard_Real& X, Standard_Real& Y, Standard_Real& Z) const { Eye (X,Y,Z); }
653
654   //! Returns the coordinate of the point (Xpix,Ypix)
655   //! in the view (XP,YP,ZP), and the projection vector of the
656   //! view passing by the point (for PerspectiveView).
657   Standard_EXPORT void ProjReferenceAxe (const Standard_Integer Xpix, const Standard_Integer Ypix,
658                                          Standard_Real& XP, Standard_Real& YP, Standard_Real& ZP,
659                                          Standard_Real& VX, Standard_Real& VY, Standard_Real& VZ) const;
660
661   //! Returns the Distance between the Eye and View Point.
662   Standard_EXPORT Standard_Real Depth() const;
663
664   //! Returns the projection vector.
665   Standard_EXPORT void Proj (Standard_Real& Vx, Standard_Real& Vy, Standard_Real& Vz) const;
666
667   //! Returns the position of the view point.
668   Standard_EXPORT void At (Standard_Real& X, Standard_Real& Y, Standard_Real& Z) const;
669
670   //! Returns the vector giving the position of the high point.
671   Standard_EXPORT void Up (Standard_Real& Vx, Standard_Real& Vy, Standard_Real& Vz) const;
672
673   //! Returns in RADIANS the orientation of the view around
674   //! the visual axis measured from the Y axis of the screen.
675   Standard_EXPORT Standard_Real Twist() const;
676
677   //! Returns the current shading model.
678   Standard_EXPORT Graphic3d_TypeOfShadingModel ShadingModel() const;
679
680   Standard_EXPORT Handle(Graphic3d_TextureEnv) TextureEnv() const;
681
682   //! Returns the current visualisation mode.
683   Standard_EXPORT V3d_TypeOfVisualization Visualization() const;
684
685   //! Returns True if One light more can be
686   //! activated in this View.
687   Standard_EXPORT Standard_Boolean IfMoreLights() const;
688
689   //! Return iterator for defined lights.
690   V3d_ListOfLightIterator ActiveLightIterator() const { return V3d_ListOfLightIterator (myActiveLights); }
691
692   //! initializes an iteration on the active Lights.
693   void InitActiveLights() { myActiveLightsIterator.Initialize (myActiveLights); }
694
695   //! returns true if there are more active Light(s) to return.
696   Standard_Boolean MoreActiveLights() const { return myActiveLightsIterator.More(); }
697
698   //! Go to the next active Light (if there is not, ActiveLight will raise an exception)
699   void NextActiveLights() { myActiveLightsIterator.Next(); }
700
701   const Handle(V3d_Light)& ActiveLight() const { return myActiveLightsIterator.Value(); }
702
703   //! Returns the MAX number of light associated to the view.
704   Standard_EXPORT Standard_Integer LightLimit() const;
705
706   //! Returns the viewer in which the view has been created.
707   Handle(V3d_Viewer) Viewer() const { return MyViewer; }
708
709   //! Returns True if MyView is associated with a window .
710   Standard_EXPORT Standard_Boolean IfWindow() const;
711
712   //! Returns the Aspect Window associated with the view.
713   const Handle(Aspect_Window)& Window() const { return MyWindow; }
714
715   //! Returns the Type of the View
716   Standard_EXPORT V3d_TypeOfView Type() const;
717
718   //! Translates the center of the view along "x" and "y" axes of
719   //! view projection. Can be used to perform interactive panning operation.
720   //! In that case the DXp, DXp parameters specify panning relative to the
721   //! point where the operation is started.
722   //! @param theDXp [in] the relative panning on "x" axis of view projection, in pixels.
723   //! @param theDYp [in] the relative panning on "y" axis of view projection, in pixels.
724   //! @param theZoomFactor [in] the zooming factor.
725   //! @param theToStart [in] pass TRUE when starting panning to remember view
726   //! state prior to panning for relative arguments. Passing 0 for relative
727   //! panning parameter should return view panning to initial state.
728   //! Performs update of view.
729   Standard_EXPORT void Pan (const Standard_Integer theDXp, const Standard_Integer theDYp, const Standard_Real theZoomFactor = 1, const Standard_Boolean theToStart = Standard_True);
730
731   //! Zoom the view according to a zoom factor computed
732   //! from the distance between the 2 mouse position.
733   //! @param theXp1 [in] the x coordinate of first mouse position, in pixels.
734   //! @param theYp1 [in] the y coordinate of first mouse position, in pixels.
735   //! @param theXp2 [in] the x coordinate of second mouse position, in pixels.
736   //! @param theYp2 [in] the y coordinate of second mouse position, in pixels.
737   Standard_EXPORT void Zoom (const Standard_Integer theXp1, const Standard_Integer theYp1, const Standard_Integer theXp2, const Standard_Integer theYp2);
738
739   //! Defines starting point for ZoomAtPoint view operation.
740   //! @param theXp [in] the x mouse coordinate, in pixels.
741   //! @param theYp [in] the y mouse coordinate, in pixels.
742   Standard_EXPORT void StartZoomAtPoint (const Standard_Integer theXp, const Standard_Integer theYp);
743
744   //! Zooms the model at a pixel defined by the method StartZoomAtPoint().
745   Standard_EXPORT void ZoomAtPoint (const Standard_Integer theMouseStartX, const Standard_Integer theMouseStartY, const Standard_Integer theMouseEndX, const Standard_Integer theMouseEndY);
746
747   //! Performs  anisotropic scaling  of  <me>  view  along  the  given  <Axis>.
748   //! The  scale  factor  is  calculated on a basis of
749   //! the mouse pointer displacement <Dx,Dy>.
750   //! The  calculated  scale  factor  is  then  passed  to  SetAxialScale(Sx,  Sy,  Sz)  method.
751   Standard_EXPORT void AxialScale (const Standard_Integer Dx, const Standard_Integer Dy, const V3d_TypeOfAxe Axis);
752
753   //! Begin the rotation of the view around the screen axis
754   //! according to the mouse position <X,Y>.
755   //! Warning: Enable rotation around the Z screen axis when <zRotationThreshold>
756   //! factor is > 0 soon the distance from the start point and the center
757   //! of the view is > (medium viewSize * <zRotationThreshold> ).
758   //! Generally a value of 0.4 is usable to rotate around XY screen axis
759   //! inside the circular threshold area and to rotate around Z screen axis
760   //! outside this area.
761   Standard_EXPORT void StartRotation (const Standard_Integer X, const Standard_Integer Y, const Standard_Real zRotationThreshold = 0.0);
762
763   //! Continues the rotation of the view
764   //! with an angle computed from the last and new mouse position <X,Y>.
765   Standard_EXPORT void Rotation (const Standard_Integer X, const Standard_Integer Y);
766
767   //! Change View Plane Distance for Perspective Views
768   //! Warning! raises TypeMismatch from Standard if the view
769   //! is not a perspective view.
770   Standard_EXPORT void SetFocale (const Standard_Real Focale);
771
772   //! Returns the View Plane Distance for Perspective Views
773   Standard_EXPORT Standard_Real Focale() const;
774
775   //! Returns the associated Graphic3d view.
776   const Handle(Graphic3d_CView)& View() const { return myView; }
777
778   //! Switches computed HLR mode in the view.
779   Standard_EXPORT void SetComputedMode (const Standard_Boolean theMode);
780
781   //! Returns the computed HLR mode state.
782   Standard_EXPORT Standard_Boolean ComputedMode() const;
783
784   //! idem than WindowFit
785   void WindowFitAll (const Standard_Integer Xmin, const Standard_Integer Ymin, const Standard_Integer Xmax, const Standard_Integer Ymax)
786   {
787     WindowFit (Xmin, Ymin, Xmax, Ymax);
788   }
789
790   //! Transform camera eye, center and scale to fit in the passed bounding box specified in WCS.
791   //! @param theCamera [in] the camera
792   //! @param theBox    [in] the bounding box
793   //! @param theMargin [in] the margin coefficient for view borders
794   //! @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);
795   //!                           in this case only the center of camera is adjusted
796   //! @param theToEnlargeIfLine [in] when TRUE - in cases when the whole bounding box projected into thin line going along Z-axis of screen,
797   //!                                the view plane is enlarged such thatwe see the whole line on rotation, otherwise only the center of camera is adjusted.
798   //! @return TRUE if the fit all operation can be done
799   Standard_EXPORT Standard_Boolean FitMinMax (const Handle(Graphic3d_Camera)& theCamera,
800                                               const Bnd_Box& theBox,
801                                               const Standard_Real theMargin,
802                                               const Standard_Real theResolution = 0.0,
803                                               const Standard_Boolean theToEnlargeIfLine = Standard_True) const;
804
805   //! Defines or Updates the definition of the
806   //! grid in <me>
807   Standard_EXPORT void SetGrid (const gp_Ax3& aPlane, const Handle(Aspect_Grid)& aGrid);
808
809   //! Defines or Updates the activity of the
810   //! grid in <me>
811   Standard_EXPORT void SetGridActivity (const Standard_Boolean aFlag);
812
813   //! Dumps the full contents of the View into the image file. This is an alias for ToPixMap() with Image_AlienPixMap.
814   //! @param theFile destination image file (image format is determined by file extension like .png, .bmp, .jpg)
815   //! @param theBufferType buffer to dump
816   //! @return FALSE when the dump has failed
817   Standard_EXPORT Standard_Boolean Dump (const Standard_CString theFile, const Graphic3d_BufferType& theBufferType = Graphic3d_BT_RGB);
818
819   //! Dumps the full contents of the view to a pixmap with specified parameters.
820   //! Internally this method calls Redraw() with an offscreen render buffer of requested target size (theWidth x theHeight),
821   //! so that there is no need resizing a window control for making a dump of different size.
822   Standard_EXPORT Standard_Boolean ToPixMap (Image_PixMap&               theImage,
823                                              const V3d_ImageDumpOptions& theParams);
824
825   //! Dumps the full contents of the view to a pixmap.
826   //! Internally this method calls Redraw() with an offscreen render buffer of requested target size (theWidth x theHeight),
827   //! so that there is no need resizing a window control for making a dump of different size.
828   //! @param theImage          target image, will be re-allocated to match theWidth x theHeight
829   //! @param theWidth          target image width
830   //! @param theHeight         target image height
831   //! @param theBufferType     type of the view buffer to dump (color / depth)
832   //! @param theToAdjustAspect when true, active view aspect ratio will be overridden by (theWidth / theHeight)
833   //! @param theStereoOptions  how to dump stereographic camera
834   Standard_Boolean ToPixMap (Image_PixMap& theImage,
835                              const Standard_Integer theWidth,
836                              const Standard_Integer theHeight,
837                              const Graphic3d_BufferType& theBufferType     = Graphic3d_BT_RGB,
838                              const Standard_Boolean      theToAdjustAspect = Standard_True,
839                              const V3d_StereoDumpOptions theStereoOptions  = V3d_SDO_MONO)
840   {
841     V3d_ImageDumpOptions aParams;
842     aParams.Width  = theWidth;
843     aParams.Height = theHeight;
844     aParams.BufferType = theBufferType;
845     aParams.StereoOptions  = theStereoOptions;
846     aParams.ToAdjustAspect = theToAdjustAspect;
847     return ToPixMap (theImage, aParams);
848   }
849
850   //! Manages display of the back faces
851   //! When <aModel> is TOBM_AUTOMATIC the object backfaces
852   //! are displayed only for surface objects and
853   //! never displayed for solid objects.
854   //! this was the previous mode.
855   //! <aModel> is TOBM_ALWAYS_DISPLAYED the object backfaces
856   //! are always displayed both for surfaces or solids.
857   //! <aModel> is TOBM_NEVER_DISPLAYED the object backfaces
858   //! are never displayed.
859   Standard_EXPORT void SetBackFacingModel (const V3d_TypeOfBackfacingModel theModel = V3d_TOBM_AUTOMATIC);
860
861   //! Returns current state of the back faces display
862   Standard_EXPORT V3d_TypeOfBackfacingModel BackFacingModel() const;
863
864   //! Adds clip plane to the view. The composition of clip planes truncates the
865   //! rendering space to convex volume. Number of supported clip planes can be consulted
866   //! by PlaneLimit method of associated Graphic3d_GraphicDriver.
867   //! Please be aware that the planes which exceed the limit are ignored during rendering.
868   //! @param thePlane [in] the clip plane to be added to view.
869   Standard_EXPORT virtual void AddClipPlane (const Handle(Graphic3d_ClipPlane)& thePlane);
870
871   //! Removes clip plane from the view.
872   //! @param thePlane [in] the clip plane to be removed from view.
873   Standard_EXPORT virtual void RemoveClipPlane (const Handle(Graphic3d_ClipPlane)& thePlane);
874
875   //! Sets sequence of clip planes to the view. The planes that have been set
876   //! before are removed from the view. The composition of clip planes
877   //! truncates the rendering space to convex volume. Number of supported
878   //! clip planes can be consulted by InquirePlaneLimit method of
879   //! Graphic3d_GraphicDriver. Please be aware that the planes that
880   //! exceed the limit are ignored during rendering.
881   //! @param thePlanes [in] the clip planes to set.
882   Standard_EXPORT void SetClipPlanes (const Handle(Graphic3d_SequenceOfHClipPlane)& thePlanes);
883
884   Standard_DEPRECATED("This method is deprecated - overload taking Handle should be used instead")
885   void SetClipPlanes (const Graphic3d_SequenceOfHClipPlane& thePlanes)
886   {
887     Handle(Graphic3d_SequenceOfHClipPlane) aPlanes = new Graphic3d_SequenceOfHClipPlane (thePlanes);
888     SetClipPlanes (aPlanes);
889   }
890
891   //! Get clip planes.
892   //! @return sequence clip planes that have been set for the view
893   Standard_EXPORT const Handle(Graphic3d_SequenceOfHClipPlane)& ClipPlanes() const;
894
895   //! Returns the MAX number of clipping planes associated to the view.
896   Standard_EXPORT Standard_Integer PlaneLimit() const;
897
898   //! Change camera used by view.
899   Standard_EXPORT void SetCamera (const Handle(Graphic3d_Camera)& theCamera);
900
901   //! Returns camera object of the view.
902   //! @return: handle to camera object, or NULL if 3D view does not use
903   //! the camera approach.
904   Standard_EXPORT const Handle(Graphic3d_Camera)& Camera() const;
905
906   //! Return default camera.
907   const Handle(Graphic3d_Camera)& DefaultCamera() const { return myDefaultCamera; }
908
909   //! Returns current rendering parameters and effect settings.
910   //! By default it returns default parameters of current viewer.
911   //! To define view-specific settings use method V3d_View::ChangeRenderingParams().
912   //! @sa V3d_Viewer::DefaultRenderingParams()
913   Standard_EXPORT const Graphic3d_RenderingParams& RenderingParams() const;
914
915   //! Returns reference to current rendering parameters and effect settings.
916   Standard_EXPORT Graphic3d_RenderingParams& ChangeRenderingParams();
917
918   //! @return flag value of objects culling mechanism
919   Standard_Boolean IsCullingEnabled() const { return RenderingParams().FrustumCullingState == Graphic3d_RenderingParams::FrustumCulling_On; }
920
921   //! Turn on/off automatic culling of objects outside frustum (ON by default)
922   void SetFrustumCulling (Standard_Boolean theMode) { ChangeRenderingParams().FrustumCullingState = theMode ? Graphic3d_RenderingParams::FrustumCulling_On : Graphic3d_RenderingParams::FrustumCulling_Off; }
923
924   //! Fill in the dictionary with diagnostic info.
925   //! Should be called within rendering thread.
926   //!
927   //! This API should be used only for user output or for creating automated reports.
928   //! The format of returned information (e.g. key-value layout)
929   //! is NOT part of this API and can be changed at any time.
930   //! Thus application should not parse returned information to weed out specific parameters.
931   //! @param theDict  destination map for information
932   //! @param theFlags defines the information to be retrieved
933   Standard_EXPORT void DiagnosticInformation (TColStd_IndexedDataMapOfStringString& theDict,
934                                               Graphic3d_DiagnosticInfo theFlags) const;
935
936   //! Returns string with statistic performance info.
937   Standard_EXPORT TCollection_AsciiString StatisticInformation() const;
938
939   //! Fills in the dictionary with statistic performance info.
940   Standard_EXPORT void StatisticInformation (TColStd_IndexedDataMapOfStringString& theDict) const;
941
942   DEFINE_STANDARD_RTTIEXT(V3d_View,Standard_Transient)
943
944 protected:
945
946   Standard_EXPORT void ImmediateUpdate() const;
947
948   //! Scales camera to fit the view frame of defined width and height
949   //! keeping the aspect. For orthogonal camera the method changes scale,
950   //! for perspective adjusts Eye location about the Center point.
951   //! @param theSizeXv [in] size of viewport frame on "x" axis.
952   //! @param theSizeYv [in] size of viewport frame on "y" axis.
953   Standard_EXPORT void Scale (const Handle(Graphic3d_Camera)& theCamera, const Standard_Real theSizeXv, const Standard_Real theSizeYv) const;
954
955   Standard_EXPORT void Translate (const Handle(Graphic3d_Camera)& theCamera, const Standard_Real theDXv, const Standard_Real theDYv) const;
956
957 private:
958
959   //! Modifies the aspect ratio of the camera when
960   //! the associated window is defined or resized.
961   Standard_EXPORT void SetRatio();
962
963   //! Determines the screen axes in the reference
964   //! framework of the view.
965   Standard_EXPORT static Standard_Boolean screenAxis (const gp_Dir& theVpn, const gp_Dir& theVup,
966                                                       gp_Vec& theXaxe, gp_Vec& theYaxe, gp_Vec& theZaxe);
967   
968   //! Transforms the Vertex V according to the matrice Matrix .
969   Standard_EXPORT static gp_XYZ TrsPoint (const Graphic3d_Vertex& V, const TColStd_Array2OfReal& Matrix);
970   
971   //! Returns the objects number and the projection window
972   //! of the objects contained in the view.
973   Standard_EXPORT Standard_Integer MinMax (Standard_Real& Umin, Standard_Real& Vmin, Standard_Real& Umax, Standard_Real& Vmax) const;
974   
975   //! Returns the objects number and the box encompassing
976   //! the objects contained in the view
977   Standard_EXPORT Standard_Integer MinMax (Standard_Real& Xmin, Standard_Real& Ymin, Standard_Real& Zmin, Standard_Real& Xmax, Standard_Real& Ymax, Standard_Real& Zmax) const;
978   
979   //! Returns the Objects number and the gravity center
980   //! of ALL viewable points in the view
981   Standard_EXPORT void Gravity (Standard_Real& X, Standard_Real& Y, Standard_Real& Z) const;
982   
983   Standard_EXPORT void Init();
984   
985   //! Returns a new vertex when the grid is activated.
986   Standard_EXPORT Graphic3d_Vertex Compute (const Graphic3d_Vertex& AVertex) const;
987
988 protected:
989
990   Standard_Real myOldMouseX;
991   Standard_Real myOldMouseY;
992   gp_Dir myCamStartOpUp;
993   gp_Pnt myCamStartOpEye;
994   Standard_Real myCamStartOpBnd[6];
995   gp_Pnt myCamStartOpCenter;
996   Handle(Graphic3d_Camera) myDefaultCamera;
997   Handle(Graphic3d_CView) myView;
998   Standard_Boolean myImmediateUpdate;
999
1000 private:
1001
1002   V3d_ViewerPointer MyViewer;
1003   V3d_ListOfLight myActiveLights;
1004   gp_Dir myDefaultViewAxis;
1005   gp_Pnt myDefaultViewPoint;
1006   Handle(Aspect_Window) MyWindow;
1007   V3d_ListOfLight::Iterator myActiveLightsIterator;
1008   Standard_Integer sx;
1009   Standard_Integer sy;
1010   Standard_Real rx;
1011   Standard_Real ry;
1012   Standard_Real gx;
1013   Standard_Real gy;
1014   Standard_Real gz;
1015   Standard_Boolean myComputedMode;
1016   Standard_Boolean SwitchSetFront;
1017   Standard_Boolean myZRotation;
1018   Standard_Integer MyZoomAtPointX;
1019   Standard_Integer MyZoomAtPointY;
1020   Handle(V3d_Trihedron) myTrihedron;
1021   Handle(Aspect_Grid) MyGrid;
1022   gp_Ax3 MyPlane;
1023   TColStd_Array2OfReal MyTrsf;
1024   Handle(Graphic3d_Structure) MyGridEchoStructure;
1025   Handle(Graphic3d_Group) MyGridEchoGroup;
1026   gp_Vec myXscreenAxis;
1027   gp_Vec myYscreenAxis;
1028   gp_Vec myZscreenAxis;
1029   gp_Dir myViewAxis;
1030   Graphic3d_Vertex myGravityReferencePoint;
1031   Standard_Boolean myAutoZFitIsOn;
1032   Standard_Real myAutoZFitScaleFactor;
1033
1034 };
1035
1036 #endif // _V3d_View_HeaderFile