0024307: TKOpenGl - efficient culling of large number of presentations
[occt.git] / src / OpenGl / OpenGl_View.hxx
1 // Created on: 2011-09-20
2 // Created by: Sergey ZERCHANINOV
3 // Copyright (c) 2011-2014 OPEN CASCADE SAS
4 //
5 // This file is part of Open CASCADE Technology software library.
6 //
7 // This library is free software; you can redistribute it and/or modify it under
8 // the terms of the GNU Lesser General Public License version 2.1 as published
9 // by the Free Software Foundation, with special exception defined in the file
10 // OCCT_LGPL_EXCEPTION.txt. Consult the file LICENSE_LGPL_21.txt included in OCCT
11 // distribution for complete text of the license and disclaimer of any warranty.
12 //
13 // Alternatively, this file may be used under the terms of Open CASCADE
14 // commercial license or contractual agreement.
15
16 #ifndef _OpenGl_View_Header
17 #define _OpenGl_View_Header
18
19 #include <MMgt_TShared.hxx>
20 #include <Standard_DefineHandle.hxx>
21
22 #include <TColStd_Array2OfReal.hxx>
23 #include <NCollection_List.hxx>
24
25 #include <Quantity_NameOfColor.hxx>
26 #include <Aspect_FillMethod.hxx>
27 #include <Aspect_GradientFillMethod.hxx>
28 #include <Aspect_TypeOfTriedronPosition.hxx>
29 #include <Aspect_CLayer2d.hxx>
30
31 #include <InterfaceGraphic_Graphic3d.hxx>
32 #include <InterfaceGraphic_Visual3d.hxx>
33
34 #include <Graphic3d_CView.hxx>
35 #include <Graphic3d_CGraduatedTrihedron.hxx>
36 #include <Graphic3d_SequenceOfHClipPlane.hxx>
37 #include <Graphic3d_ZLayerSettings.hxx>
38 #include <Visual3d_TypeOfSurfaceDetail.hxx>
39
40 #include <OpenGl_BVHTreeSelector.hxx>
41 #include <OpenGl_LayerList.hxx>
42 #include <OpenGl_Light.hxx>
43 #include <OpenGl_LineAttributes.hxx>
44
45 #include <Handle_OpenGl_Context.hxx>
46 #include <Handle_OpenGl_GraphicDriver.hxx>
47 #include <Handle_OpenGl_Workspace.hxx>
48 #include <Handle_OpenGl_View.hxx>
49 #include <Handle_OpenGl_Texture.hxx>
50
51 struct OPENGL_BG_TEXTURE
52 {
53   Tuint             TexId;
54   Tint              Width;
55   Tint              Height;
56   Aspect_FillMethod Style;
57 };
58
59 struct OPENGL_BG_GRADIENT
60 {
61   TEL_COLOUR color1;
62   TEL_COLOUR color2;
63   Aspect_GradientFillMethod type;
64 };
65
66 struct OPENGL_ZCLIP
67 {
68   struct {
69     Standard_Boolean   IsOn;
70     Standard_ShortReal Limit; /* in the range [0., 1.] */
71   } Back;
72   struct {
73     Standard_Boolean   IsOn;
74     Standard_ShortReal Limit; /* in the range [0., 1.] */
75   } Front;
76 };
77
78 struct OPENGL_FOG
79 {
80   Standard_Boolean   IsOn;
81   Standard_ShortReal Front; /* in the range [0., 1.] */
82   Standard_ShortReal Back; /* in the range [0., 1.] */
83   TEL_COLOUR         Color;
84 };
85
86 struct OpenGl_Matrix;
87 class OpenGl_GraduatedTrihedron;
88 class OpenGl_Structure;
89 class OpenGl_Trihedron;
90 class Handle(OpenGl_PrinterContext);
91 class OpenGl_StateCounter;
92
93 class OpenGl_View : public MMgt_TShared
94 {
95  public:
96   OpenGl_View (const CALL_DEF_VIEWCONTEXT &AContext, OpenGl_StateCounter* theCounter);
97   virtual ~OpenGl_View ();
98
99   void ReleaseGlResources (const Handle(OpenGl_Context)& theCtx);
100
101   void SetTextureEnv (const Handle(OpenGl_Context)&       theCtx,
102                       const Handle(Graphic3d_TextureEnv)& theTexture);
103   void SetSurfaceDetail (const Visual3d_TypeOfSurfaceDetail AMode);
104   void SetBackfacing (const Standard_Integer AMode);
105   void SetLights (const CALL_DEF_VIEWCONTEXT &AContext);
106   void SetAntiAliasing (const Standard_Boolean AMode) { myAntiAliasing = AMode; }
107   void SetClipPlanes (const Graphic3d_SequenceOfHClipPlane &thePlanes) { myClipPlanes = thePlanes; }
108   void SetVisualisation (const CALL_DEF_VIEWCONTEXT &AContext);
109
110   void SetCamera (const Handle(Graphic3d_Camera)& theCamera) { myCamera = theCamera; }
111
112   void SetClipLimit (const Graphic3d_CView& theCView);
113
114   void SetFog (const Graphic3d_CView& theCView, const Standard_Boolean theFlag);
115
116   void TriedronDisplay (const Handle(OpenGl_Context)&       theCtx,
117                         const Aspect_TypeOfTriedronPosition thePosition,
118                         const Quantity_NameOfColor          theColor,
119                         const Standard_Real                 theScale,
120                         const Standard_Boolean              theAsWireframe);
121   void TriedronErase (const Handle(OpenGl_Context)& theCtx);
122
123   void GraduatedTrihedronDisplay (const Handle(OpenGl_Context)&        theCtx,
124                                   const Graphic3d_CGraduatedTrihedron& theCubic);
125   void GraduatedTrihedronErase (const Handle(OpenGl_Context)& theCtx);
126
127   Standard_Real Height () const { return myCamera->ViewDimensions().X(); }
128   Standard_Real Width () const { return myCamera->ViewDimensions().Y(); }
129
130   Standard_Integer Backfacing () const { return myBackfacing; }
131
132   const TEL_TRANSFORM_PERSISTENCE * BeginTransformPersistence (const Handle(OpenGl_Context)& theCtx,
133                                                                const TEL_TRANSFORM_PERSISTENCE *theTransPers);
134   void EndTransformPersistence (const Handle(OpenGl_Context)& theCtx);
135
136   //! Add structure to display list with specified priority.
137   //! The structure will be added to associated with it z layer.
138   //! If the z layer is not presented in the view, the structure will
139   //! be displayed in default bottom-level z layer.
140   void DisplayStructure (const OpenGl_Structure* theStructure,
141                          const Standard_Integer  thePriority);
142
143   //! Erase structure from display list.
144   void EraseStructure (const OpenGl_Structure* theStructure);
145
146   //! Add structure to the list of immediate structures.
147   void DisplayImmediateStructure (const OpenGl_Structure* theStructure);
148
149   //! Erase structure from display list.
150   void EraseImmediateStructure (const OpenGl_Structure* theStructure);
151
152   //! Insert a new top-level z layer with ID <theLayerId>
153   void AddZLayer (const Standard_Integer theLayerId);
154
155   //! Remove a z layer with ID <theLayerId>
156   void RemoveZLayer (const Standard_Integer theLayerId);
157
158   //! Display structure in z layer with ID <theNewLayerId>
159   //! If the layer with ID <theNewLayerId> is not presented in the view,
160   //! the structure will be displayed in default bottom-level layer.
161   void ChangeZLayer (const OpenGl_Structure *theStructure,
162                      const Standard_Integer  theNewLayerId);
163
164   //! Sets the settings for a single Z layer of specified view.
165   void SetZLayerSettings (const Standard_Integer theLayerId,
166                           const Graphic3d_ZLayerSettings theSettings);
167
168   //! Changes the priority of a structure within its ZLayer
169   void ChangePriority (const OpenGl_Structure *theStructure,
170                        const Standard_Integer theNewPriority);
171
172   void CreateBackgroundTexture (const Standard_CString AFileName, const Aspect_FillMethod AFillStyle);
173   void SetBackgroundTextureStyle (const Aspect_FillMethod FillStyle);
174   void SetBackgroundGradient (const Quantity_Color& AColor1, const Quantity_Color& AColor2, const Aspect_GradientFillMethod AType);
175   void SetBackgroundGradientType (const Aspect_GradientFillMethod AType);
176
177   void Render (const Handle(OpenGl_PrinterContext)& thePrintContext,
178                const Handle(OpenGl_Workspace)&      theWorkspace,
179                const Graphic3d_CView&               theCView,
180                const Aspect_CLayer2d&               theCUnderLayer,
181                const Aspect_CLayer2d&               theCOverLayer);
182
183
184   void DrawBackground (OpenGl_Workspace& theWorkspace);
185
186   //! Returns list of OpenGL Z-layers.
187   const OpenGl_LayerList& LayerList() const { return myZLayers; }
188
189   //! Returns list of openGL light sources.
190   const OpenGl_ListOfLight& LightList() const { return myLights; }
191
192   //! Returns OpenGL environment map.
193   const Handle(OpenGl_Texture)& TextureEnv() const { return myTextureEnv; }
194
195   //! Returns visualization mode for objects in the view.
196   Visual3d_TypeOfSurfaceDetail SurfaceDetail() const { return mySurfaceDetail; }
197
198   //! Returns selector for BVH tree, providing a possibility to store information
199   //! about current view volume and to detect which objects are overlapping it.
200   OpenGl_BVHTreeSelector& BVHTreeSelector() { return myBVHSelector; }
201
202   //! Marks BVH tree for given priority list as dirty and
203   //! marks primitive set for rebuild.
204   void InvalidateBVHData (const Standard_Integer theLayerId);
205
206   void GetMatrices (TColStd_Array2OfReal&  theMatOrient,
207                     TColStd_Array2OfReal&  theMatMapping) const;
208
209   //! Returns list of immediate structures rendered on top of main presentation
210   const OpenGl_SequenceOfStructure& ImmediateStructures() const
211   {
212     return myImmediateList;
213   }
214
215   //! Returns modification state for ray-tracing.
216   Standard_Size ModificationState() const { return myModificationState; }
217
218 protected:
219
220   void RenderStructs (const Handle(OpenGl_Workspace) &AWorkspace);
221   void RedrawLayer2d (const Handle(OpenGl_PrinterContext)& thePrintContext,
222                       const Graphic3d_CView&               theCView,
223                       const Aspect_CLayer2d&               theCLayer);
224
225   //! Redraw contents of model scene: clipping planes,
226   //! lights, structures. The peculiar properties of "scene" is that
227   //! it requires empty Z-Buffer and uses projection and orientation
228   //! matrices supplied by 3d view.
229   //! @param thePrintCtx [in] printer context which facilitates tiled printing.
230   //! @param theWorkspace [in] rendering workspace.
231   //! @param theCView [in] view data.
232   //! @param theProjection [in] view projection matrix.
233   //! @param theOrientation [in] view orientation matrix.
234   void RedrawScene (const Handle(OpenGl_PrinterContext)& thePrintContext,
235                     const Handle(OpenGl_Workspace)& theWorkspace,
236                     const OpenGl_Matrix* theProjection,
237                     const OpenGl_Matrix* theOrientation);
238
239   Handle(OpenGl_LineAttributes) myLineAttribs;
240   Handle(OpenGl_Texture)        myTextureEnv;
241   Visual3d_TypeOfSurfaceDetail  mySurfaceDetail;
242   Standard_Integer              myBackfacing;
243
244   OPENGL_BG_TEXTURE  myBgTexture;
245   OPENGL_BG_GRADIENT myBgGradient;
246
247   OPENGL_ZCLIP   myZClip;
248
249   Graphic3d_SequenceOfHClipPlane myClipPlanes;
250   
251   Handle(Graphic3d_Camera) myCamera;
252
253   OPENGL_FOG myFog;
254   OpenGl_Trihedron*          myTrihedron;
255   OpenGl_GraduatedTrihedron* myGraduatedTrihedron;
256
257   //View_LABViewContext
258   int myVisualization;
259   int myIntShadingMethod;
260
261   //View_LABLight
262   OpenGl_ListOfLight myLights;
263
264   //View_LABPlane
265   //View_LABAliasing
266   Standard_Boolean myAntiAliasing;
267
268   //View_LABDepthCueing - fixed index used
269
270   OpenGl_LayerList           myZLayers;       //!< main list of displayed structure, sorted by layers
271   OpenGl_SequenceOfStructure myImmediateList; //!< list of immediate structures rendered on top of main presentation
272
273   const TEL_TRANSFORM_PERSISTENCE *myTransPers;
274   Standard_Boolean myIsTransPers;
275
276   //! Modification state
277   Standard_Size myProjectionState;
278   Standard_Size myModelViewState;
279   OpenGl_StateCounter* myStateCounter;
280
281   Standard_Size myCurrLightSourceState;
282
283   typedef std::pair<Standard_Size, Standard_Size> StateInfo;
284
285   StateInfo myLastOrientationState;
286   StateInfo myLastViewMappingState;
287   StateInfo myLastLightSourceState;
288
289   //! Is needed for selection of overlapping objects and storage of the current view volume
290   OpenGl_BVHTreeSelector myBVHSelector;
291
292   Standard_Size myModificationState;
293
294 public:
295
296   DEFINE_STANDARD_ALLOC
297   DEFINE_STANDARD_RTTI(OpenGl_View) // Type definition
298
299 };
300
301 #endif // _OpenGl_View_Header