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