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