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