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