0025910: The material with 0-density causes errors during writing STEP files
[occt.git] / src / OpenGl / OpenGl_View.hxx
CommitLineData
b311480e 1// Created on: 2011-09-20
2// Created by: Sergey ZERCHANINOV
973c2be1 3// Copyright (c) 2011-2014 OPEN CASCADE SAS
b311480e 4//
973c2be1 5// This file is part of Open CASCADE Technology software library.
b311480e 6//
d5f74e42 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
973c2be1 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.
b311480e 12//
973c2be1 13// Alternatively, this file may be used under the terms of Open CASCADE
14// commercial license or contractual agreement.
b311480e 15
2166f0fa
SK
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>
51b10cd4 36#include <Graphic3d_SequenceOfHClipPlane.hxx>
c5751993 37#include <Graphic3d_ZLayerSettings.hxx>
2166f0fa 38#include <Visual3d_TypeOfSurfaceDetail.hxx>
8625ef7e 39#include <Visual3d_TypeOfModel.hxx>
2166f0fa 40
0b0320e7 41#include <OpenGl_AspectFace.hxx>
42#include <OpenGl_BackgroundArray.hxx>
b7cd4ba7 43#include <OpenGl_BVHTreeSelector.hxx>
59f45b7c 44#include <OpenGl_LayerList.hxx>
2166f0fa 45#include <OpenGl_Light.hxx>
73192b37 46#include <OpenGl_LineAttributes.hxx>
2166f0fa 47
bf75be98 48#include <Handle_OpenGl_Context.hxx>
392ac980 49#include <Handle_OpenGl_GraphicDriver.hxx>
2166f0fa
SK
50#include <Handle_OpenGl_Workspace.hxx>
51#include <Handle_OpenGl_View.hxx>
bf75be98 52#include <Handle_OpenGl_Texture.hxx>
2166f0fa 53
2166f0fa
SK
54struct OPENGL_ZCLIP
55{
56 struct {
57 Standard_Boolean IsOn;
58 Standard_ShortReal Limit; /* in the range [0., 1.] */
59 } Back;
60 struct {
61 Standard_Boolean IsOn;
62 Standard_ShortReal Limit; /* in the range [0., 1.] */
63 } Front;
64};
65
66struct OPENGL_FOG
67{
68 Standard_Boolean IsOn;
69 Standard_ShortReal Front; /* in the range [0., 1.] */
70 Standard_ShortReal Back; /* in the range [0., 1.] */
71 TEL_COLOUR Color;
72};
73
b5ac8292 74struct OpenGl_Matrix;
a174a3c5 75class OpenGl_GraduatedTrihedron;
2166f0fa 76class OpenGl_Structure;
a174a3c5 77class OpenGl_Trihedron;
78class Handle(OpenGl_PrinterContext);
392ac980 79class OpenGl_StateCounter;
2166f0fa
SK
80
81class OpenGl_View : public MMgt_TShared
82{
83 public:
392ac980 84 OpenGl_View (const CALL_DEF_VIEWCONTEXT &AContext, OpenGl_StateCounter* theCounter);
2166f0fa
SK
85 virtual ~OpenGl_View ();
86
bf75be98 87 void ReleaseGlResources (const Handle(OpenGl_Context)& theCtx);
88
89 void SetTextureEnv (const Handle(OpenGl_Context)& theCtx,
90 const Handle(Graphic3d_TextureEnv)& theTexture);
e276548b 91 void SetSurfaceDetail (const Visual3d_TypeOfSurfaceDetail AMode);
2166f0fa
SK
92 void SetBackfacing (const Standard_Integer AMode);
93 void SetLights (const CALL_DEF_VIEWCONTEXT &AContext);
94 void SetAntiAliasing (const Standard_Boolean AMode) { myAntiAliasing = AMode; }
51b10cd4 95 void SetClipPlanes (const Graphic3d_SequenceOfHClipPlane &thePlanes) { myClipPlanes = thePlanes; }
2166f0fa
SK
96 void SetVisualisation (const CALL_DEF_VIEWCONTEXT &AContext);
97
c827ea3a 98 const Handle(Graphic3d_Camera)& Camera() { return myCamera; }
b5ac8292 99 void SetCamera (const Handle(Graphic3d_Camera)& theCamera) { myCamera = theCamera; }
100
bf75be98 101 void SetClipLimit (const Graphic3d_CView& theCView);
2166f0fa 102
bf75be98 103 void SetFog (const Graphic3d_CView& theCView, const Standard_Boolean theFlag);
2166f0fa 104
a174a3c5 105 void TriedronDisplay (const Handle(OpenGl_Context)& theCtx,
106 const Aspect_TypeOfTriedronPosition thePosition,
107 const Quantity_NameOfColor theColor,
108 const Standard_Real theScale,
109 const Standard_Boolean theAsWireframe);
110 void TriedronErase (const Handle(OpenGl_Context)& theCtx);
2166f0fa 111
a174a3c5 112 void GraduatedTrihedronDisplay (const Handle(OpenGl_Context)& theCtx,
113 const Graphic3d_CGraduatedTrihedron& theCubic);
114 void GraduatedTrihedronErase (const Handle(OpenGl_Context)& theCtx);
2166f0fa 115
b5ac8292 116 Standard_Real Height () const { return myCamera->ViewDimensions().X(); }
117 Standard_Real Width () const { return myCamera->ViewDimensions().Y(); }
2166f0fa
SK
118
119 Standard_Integer Backfacing () const { return myBackfacing; }
120
30f0ad28 121 const TEL_TRANSFORM_PERSISTENCE * BeginTransformPersistence (const Handle(OpenGl_Context)& theCtx,
122 const TEL_TRANSFORM_PERSISTENCE *theTransPers);
123 void EndTransformPersistence (const Handle(OpenGl_Context)& theCtx);
2166f0fa 124
59f45b7c 125 //! Add structure to display list with specified priority.
126 //! The structure will be added to associated with it z layer.
127 //! If the z layer is not presented in the view, the structure will
128 //! be displayed in default bottom-level z layer.
a1954302 129 void DisplayStructure (const Handle(Graphic3d_Structure)& theStructure,
130 const Standard_Integer thePriority);
59f45b7c 131
132 //! Erase structure from display list.
a1954302 133 void EraseStructure (const Handle(Graphic3d_Structure)& theStructure);
679ecdee 134
135 //! Add structure to the list of immediate structures.
a1954302 136 void DisplayImmediateStructure (const Handle(Graphic3d_Structure)& theStructure);
679ecdee 137
138 //! Erase structure from display list.
139 void EraseImmediateStructure (const OpenGl_Structure* theStructure);
59f45b7c 140
141 //! Insert a new top-level z layer with ID <theLayerId>
a1954302 142 void AddZLayer (const Graphic3d_ZLayerId theLayerId);
59f45b7c 143
144 //! Remove a z layer with ID <theLayerId>
a1954302 145 void RemoveZLayer (const Graphic3d_ZLayerId theLayerId);
59f45b7c 146
147 //! Display structure in z layer with ID <theNewLayerId>
148 //! If the layer with ID <theNewLayerId> is not presented in the view,
149 //! the structure will be displayed in default bottom-level layer.
a1954302 150 void ChangeZLayer (const OpenGl_Structure* theStructure,
151 const Graphic3d_ZLayerId theNewLayerId);
2166f0fa 152
c5751993 153 //! Sets the settings for a single Z layer of specified view.
a1954302 154 void SetZLayerSettings (const Graphic3d_ZLayerId theLayerId,
155 const Graphic3d_ZLayerSettings& theSettings);
c5751993 156
b7cd4ba7 157 //! Changes the priority of a structure within its ZLayer
a1954302 158 void ChangePriority (const OpenGl_Structure* theStructure,
159 const Standard_Integer theNewPriority);
b7cd4ba7 160
0b0320e7 161 void CreateBackgroundTexture (const Standard_CString AFileName,
162 const Aspect_FillMethod AFillStyle);
163
2166f0fa
SK
164 void SetBackgroundTextureStyle (const Aspect_FillMethod FillStyle);
165 void SetBackgroundGradient (const Quantity_Color& AColor1, const Quantity_Color& AColor2, const Aspect_GradientFillMethod AType);
166 void SetBackgroundGradientType (const Aspect_GradientFillMethod AType);
167
a174a3c5 168 void Render (const Handle(OpenGl_PrinterContext)& thePrintContext,
169 const Handle(OpenGl_Workspace)& theWorkspace,
170 const Graphic3d_CView& theCView,
171 const Aspect_CLayer2d& theCUnderLayer,
a1954302 172 const Aspect_CLayer2d& theCOverLayer,
173 const Standard_Boolean theToDrawImmediate);
2166f0fa 174
e276548b 175
0b0320e7 176 void DrawBackground (const Handle(OpenGl_Workspace)& theWorkspace);
e276548b 177
178 //! Returns list of OpenGL Z-layers.
179 const OpenGl_LayerList& LayerList() const { return myZLayers; }
180
181 //! Returns list of openGL light sources.
182 const OpenGl_ListOfLight& LightList() const { return myLights; }
183
184 //! Returns OpenGL environment map.
185 const Handle(OpenGl_Texture)& TextureEnv() const { return myTextureEnv; }
186
187 //! Returns visualization mode for objects in the view.
188 Visual3d_TypeOfSurfaceDetail SurfaceDetail() const { return mySurfaceDetail; }
189
b7cd4ba7 190 //! Returns selector for BVH tree, providing a possibility to store information
191 //! about current view volume and to detect which objects are overlapping it.
192 OpenGl_BVHTreeSelector& BVHTreeSelector() { return myBVHSelector; }
193
194 //! Marks BVH tree for given priority list as dirty and
195 //! marks primitive set for rebuild.
196 void InvalidateBVHData (const Standard_Integer theLayerId);
197
25ef750e 198 //! Returns view-mapping and orientation matrices.
199 void GetMatrices (OpenGl_Mat4& theOrientation,
200 OpenGl_Mat4& theViewMapping) const;
b5ac8292 201
679ecdee 202 //! Returns list of immediate structures rendered on top of main presentation
203 const OpenGl_SequenceOfStructure& ImmediateStructures() const
204 {
205 return myImmediateList;
206 }
207
a1954302 208 //! Returns true if there are immediate structures to display
209 bool HasImmediateStructures() const
210 {
211 return !myImmediateList.IsEmpty()
212 || myZLayers.NbImmediateStructures() != 0;
213 }
214
e276548b 215 //! Returns modification state for ray-tracing.
216 Standard_Size ModificationState() const { return myModificationState; }
e276548b 217
679ecdee 218protected:
2166f0fa 219
a1954302 220 void RenderStructs (const Handle(OpenGl_Workspace)& theWorkspace,
221 const Standard_Boolean theToDrawImmediate);
a174a3c5 222 void RedrawLayer2d (const Handle(OpenGl_PrinterContext)& thePrintContext,
c827ea3a 223 const Handle(OpenGl_Workspace) &theWorkspace,
a174a3c5 224 const Graphic3d_CView& theCView,
225 const Aspect_CLayer2d& theCLayer);
a89742cf 226 void RedrawTrihedron (const Handle(OpenGl_Workspace) &theWorkspace);
2166f0fa 227
b5ac8292 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.
b5ac8292 232 void RedrawScene (const Handle(OpenGl_PrinterContext)& thePrintContext,
a1954302 233 const Handle(OpenGl_Workspace)& theWorkspace,
234 const Standard_Boolean theToDrawImmediate);
b5ac8292 235
73192b37 236 Handle(OpenGl_LineAttributes) myLineAttribs;
237 Handle(OpenGl_Texture) myTextureEnv;
238 Visual3d_TypeOfSurfaceDetail mySurfaceDetail;
239 Standard_Integer myBackfacing;
2166f0fa 240
2166f0fa 241 OPENGL_ZCLIP myZClip;
2166f0fa 242
51b10cd4 243 Graphic3d_SequenceOfHClipPlane myClipPlanes;
4269bd1b 244
b5ac8292 245 Handle(Graphic3d_Camera) myCamera;
246
2166f0fa 247 OPENGL_FOG myFog;
a174a3c5 248 OpenGl_Trihedron* myTrihedron;
249 OpenGl_GraduatedTrihedron* myGraduatedTrihedron;
2166f0fa
SK
250
251 //View_LABViewContext
252 int myVisualization;
8625ef7e 253 Visual3d_TypeOfModel myShadingModel; //!< lighting shading model
2166f0fa
SK
254
255 //View_LABLight
256 OpenGl_ListOfLight myLights;
257
258 //View_LABPlane
259 //View_LABAliasing
260 Standard_Boolean myAntiAliasing;
261
262 //View_LABDepthCueing - fixed index used
263
679ecdee 264 OpenGl_LayerList myZLayers; //!< main list of displayed structure, sorted by layers
265 OpenGl_SequenceOfStructure myImmediateList; //!< list of immediate structures rendered on top of main presentation
2166f0fa 266
2166f0fa
SK
267 const TEL_TRANSFORM_PERSISTENCE *myTransPers;
268 Standard_Boolean myIsTransPers;
269
b5ac8292 270 //! Modification state
271 Standard_Size myProjectionState;
272 Standard_Size myModelViewState;
392ac980 273 OpenGl_StateCounter* myStateCounter;
274
392ac980 275 Standard_Size myCurrLightSourceState;
276
277 typedef std::pair<Standard_Size, Standard_Size> StateInfo;
278
279 StateInfo myLastOrientationState;
280 StateInfo myLastViewMappingState;
281 StateInfo myLastLightSourceState;
30f0ad28 282
b7cd4ba7 283 //! Is needed for selection of overlapping objects and storage of the current view volume
284 OpenGl_BVHTreeSelector myBVHSelector;
285
e276548b 286 Standard_Size myModificationState;
e276548b 287
0b0320e7 288protected: //! @name Background parameters
289
290 OpenGl_AspectFace* myTextureParams; //!< Stores texture and its parameters for textured background
291 OpenGl_BackgroundArray* myBgGradientArray; //!< Primitive array for gradient background
292 OpenGl_BackgroundArray* myBgTextureArray; //!< Primitive array for texture background
293
679ecdee 294public:
295
1c35b92f 296 DEFINE_STANDARD_ALLOC
679ecdee 297 DEFINE_STANDARD_RTTI(OpenGl_View) // Type definition
298
a89742cf 299 friend class OpenGl_Workspace;
300
2166f0fa
SK
301};
302
679ecdee 303#endif // _OpenGl_View_Header