0024739: TKOpenGl - port ray-tracing from OpenCL to GLSL for better integration and...
[occt.git] / src / OpenGl / OpenGl_Group.cxx
1 // Created on: 2011-08-01
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 #include <OpenGl_Group.hxx>
17
18 #include <OpenGl_GraphicDriver.hxx>
19 #include <OpenGl_Flipper.hxx>
20 #include <OpenGl_PrimitiveArray.hxx>
21 #include <OpenGl_StencilTest.hxx>
22 #include <OpenGl_Structure.hxx>
23 #include <OpenGl_Text.hxx>
24 #include <OpenGl_Workspace.hxx>
25
26 #include <Graphic3d_ArrayOfPrimitives.hxx>
27 #include <Graphic3d_CUserDraw.hxx>
28 #include <Graphic3d_GroupDefinitionError.hxx>
29
30 IMPLEMENT_STANDARD_HANDLE (OpenGl_Group, Graphic3d_Group)
31 IMPLEMENT_STANDARD_RTTIEXT(OpenGl_Group, Graphic3d_Group)
32
33 // =======================================================================
34 // function : OpenGl_Group
35 // purpose  :
36 // =======================================================================
37 OpenGl_Group::OpenGl_Group (const Handle(Graphic3d_Structure)& theStruct)
38 : Graphic3d_Group (theStruct),
39   myAspectLine(NULL),
40   myAspectFace(NULL),
41   myAspectMarker(NULL),
42   myAspectText(NULL),
43   myFirst(NULL),
44   myLast(NULL),
45   myIsRaytracable (Standard_False),
46   myModificationState (0)
47 {
48   Handle(OpenGl_Structure) aStruct = Handle(OpenGl_Structure)::DownCast (myStructure->CStructure());
49   if (aStruct == NULL)
50   {
51     Graphic3d_GroupDefinitionError::Raise ("OpenGl_Group should be created by OpenGl_Structure!");
52   }
53 }
54
55 // =======================================================================
56 // function : ~OpenGl_Group
57 // purpose  :
58 // =======================================================================
59 OpenGl_Group::~OpenGl_Group()
60 {
61   Release (Handle(OpenGl_Context)());
62 }
63
64 // =======================================================================
65 // function : UpdateAspectLine
66 // purpose  :
67 // =======================================================================
68 void OpenGl_Group::UpdateAspectLine (const Standard_Boolean theIsGlobal)
69 {
70   if (!ContextLine.IsDef)
71   {
72     return;
73   }
74
75   if (theIsGlobal || myFirst == NULL)
76   {
77     if (myAspectLine == NULL)
78     {
79       myAspectLine = new OpenGl_AspectLine();
80     }
81     myAspectLine->SetAspect (ContextLine);
82   }
83   else
84   {
85     OpenGl_AspectLine* anAspectLine = new OpenGl_AspectLine();
86     anAspectLine->SetAspect (ContextLine);
87     AddElement (anAspectLine);
88   }
89 }
90
91 // =======================================================================
92 // function : UpdateAspectFace
93 // purpose  :
94 // =======================================================================
95 void OpenGl_Group::UpdateAspectFace (const Standard_Boolean theIsGlobal)
96 {
97   if (!ContextFillArea.IsDef)
98   {
99     return;
100   }
101
102   if (theIsGlobal || myFirst == NULL)
103   {
104     if (myAspectFace == NULL)
105     {
106       myAspectFace = new OpenGl_AspectFace();
107     }
108     myAspectFace->SetAspect (ContextFillArea);
109   }
110   else
111   {
112     OpenGl_AspectFace* anAspectFace = new OpenGl_AspectFace();
113     anAspectFace->SetAspect (ContextFillArea);
114     AddElement (anAspectFace);
115   }
116
117   if (myIsRaytracable)
118   {
119     ++myModificationState;
120     OpenGl_Structure* aStruct = GlStruct();
121     if (aStruct != NULL)
122     {
123       aStruct->UpdateStateWithAncestorStructures();
124     }
125   }
126 }
127
128 // =======================================================================
129 // function : UpdateAspectMarker
130 // purpose  :
131 // =======================================================================
132 void OpenGl_Group::UpdateAspectMarker (const Standard_Boolean theIsGlobal)
133 {
134   if (!ContextMarker.IsDef)
135   {
136     return;
137   }
138
139   if (theIsGlobal || myFirst == NULL)
140   {
141     if (myAspectMarker == NULL)
142     {
143       myAspectMarker = new OpenGl_AspectMarker();
144     }
145     myAspectMarker->SetAspect (ContextMarker);
146   }
147   else
148   {
149     OpenGl_AspectMarker* anAspectMarker = new OpenGl_AspectMarker();
150     anAspectMarker->SetAspect (ContextMarker);
151     AddElement (anAspectMarker);
152   }
153 }
154
155 // =======================================================================
156 // function : UpdateAspectText
157 // purpose  :
158 // =======================================================================
159 void OpenGl_Group::UpdateAspectText (const Standard_Boolean theIsGlobal)
160 {
161   if (!ContextText.IsDef)
162   {
163     return;
164   }
165
166   if (theIsGlobal || myFirst == NULL)
167   {
168     if (myAspectText == NULL)
169     {
170       myAspectText = new OpenGl_AspectText();
171     }
172     myAspectText->SetAspect (ContextText);
173   }
174   else
175   {
176     OpenGl_AspectText* anAspectText = new OpenGl_AspectText();
177     anAspectText->SetAspect (ContextText);
178     AddElement (anAspectText);
179   }
180 }
181
182 // =======================================================================
183 // function : AddPrimitiveArray
184 // purpose  :
185 // =======================================================================
186 void OpenGl_Group::AddPrimitiveArray (const Handle(Graphic3d_ArrayOfPrimitives)& thePrim,
187                                       const Standard_Boolean                     theToEvalMinMax)
188 {
189   if (IsDeleted()
190   || !thePrim->IsValid())
191   {
192     return;
193   }
194
195   OpenGl_PrimitiveArray* anArray = new OpenGl_PrimitiveArray ((CALL_DEF_PARRAY *)thePrim->Array());
196   AddElement (anArray);
197
198   Graphic3d_Group::AddPrimitiveArray (thePrim, theToEvalMinMax);
199 }
200
201 // =======================================================================
202 // function : Text
203 // purpose  :
204 // =======================================================================
205 void OpenGl_Group::Text (const Standard_CString                  theTextUtf,
206                          const Graphic3d_Vertex&                 thePoint,
207                          const Standard_Real                     theHeight,
208                          const Quantity_PlaneAngle               theAngle,
209                          const Graphic3d_TextPath                theTp,
210                          const Graphic3d_HorizontalTextAlignment theHta,
211                          const Graphic3d_VerticalTextAlignment   theVta,
212                          const Standard_Boolean                  theToEvalMinMax)
213 {
214   if (IsDeleted())
215   {
216     return;
217   }
218
219   OpenGl_TextParam  aParams;
220   OpenGl_Structure* aStruct = GlStruct();
221   aParams.Height = int ((theHeight < 2.0) ? aStruct->GlDriver()->DefaultTextHeight() : theHeight);
222   aParams.HAlign = theHta;
223   aParams.VAlign = theVta;
224   const OpenGl_Vec3 aPoint (thePoint.X(), thePoint.Y(), thePoint.Z());
225   OpenGl_Text* aText = new OpenGl_Text (theTextUtf, aPoint, aParams);
226   AddElement (aText);
227   Graphic3d_Group::Text (theTextUtf, thePoint, theHeight, theAngle,
228                          theTp, theHta, theVta, theToEvalMinMax);
229 }
230
231 // =======================================================================
232 // function : UserDraw
233 // purpose  :
234 // =======================================================================
235 void OpenGl_Group::UserDraw (const Standard_Address theObject,
236                              const Standard_Boolean theToEvalMinMax,
237                              const Standard_Boolean theContainsFacet)
238 {
239   if (IsDeleted())
240   {
241     return;
242   }
243
244   OpenGl_Structure* aStruct = GlStruct();
245   if (aStruct->GlDriver()->UserDrawCallback() == NULL)
246   {
247     return;
248   }
249
250   Graphic3d_CUserDraw aUserDraw;
251   aUserDraw.Data   = theObject;
252   aUserDraw.Bounds = theToEvalMinMax ? &myBounds : NULL;
253   OpenGl_Element* aUserDrawElem = aStruct->GlDriver()->UserDrawCallback()(&aUserDraw);
254   if (aUserDrawElem != NULL)
255   {
256     AddElement (aUserDrawElem);
257   }
258   Graphic3d_Group::UserDraw (theObject, theToEvalMinMax, theContainsFacet);
259 }
260
261 // =======================================================================
262 // function : SetFlippingOptions
263 // purpose  :
264 // =======================================================================
265 void OpenGl_Group::SetFlippingOptions (const Standard_Boolean theIsEnabled,
266                                        const gp_Ax2&          theRefPlane)
267 {
268   OpenGl_Flipper* aFlipper = new OpenGl_Flipper (theRefPlane);
269   aFlipper->SetOptions (theIsEnabled);
270   AddElement (aFlipper);
271 }
272
273 // =======================================================================
274 // function : SetStencilTestOptions
275 // purpose  :
276 // =======================================================================
277 void OpenGl_Group::SetStencilTestOptions (const Standard_Boolean theIsEnabled)
278 {
279   OpenGl_StencilTest* aStencilTest = new OpenGl_StencilTest();
280   aStencilTest->SetOptions (theIsEnabled);
281   AddElement (aStencilTest);
282 }
283
284 // =======================================================================
285 // function : AddElement
286 // purpose  :
287 // =======================================================================
288 void OpenGl_Group::AddElement (OpenGl_Element* theElem)
289 {
290   OpenGl_ElementNode *aNode = new OpenGl_ElementNode();
291
292   aNode->elem = theElem;
293   aNode->next = NULL;
294   (myLast? myLast->next : myFirst) = aNode;
295   myLast = aNode;
296
297   if (OpenGl_Raytrace::IsRaytracedElement (aNode))
298   {
299     myModificationState++;
300     myIsRaytracable = Standard_True;
301
302     OpenGl_Structure* aStruct = GlStruct();
303     if (aStruct != NULL)
304     {
305       aStruct->UpdateStateWithAncestorStructures();
306       aStruct->SetRaytracableWithAncestorStructures();
307     }
308   }
309 }
310
311 // =======================================================================
312 // function : Render
313 // purpose  :
314 // =======================================================================
315 void OpenGl_Group::Render (const Handle(OpenGl_Workspace)& theWorkspace) const
316 {
317   // Is rendering in ADD or IMMEDIATE mode?
318   const Handle(OpenGl_RenderFilter)& aFilter = theWorkspace->GetRenderFilter();
319
320   // Setup aspects
321   const OpenGl_AspectLine*   aBackAspectLine   = theWorkspace->AspectLine   (Standard_False);
322   const OpenGl_AspectFace*   aBackAspectFace   = theWorkspace->AspectFace   (Standard_False);
323   const OpenGl_AspectMarker* aBackAspectMarker = theWorkspace->AspectMarker (Standard_False);
324   const OpenGl_AspectText*   aBackAspectText   = theWorkspace->AspectText   (Standard_False);
325   Standard_Boolean isLineSet   = myAspectLine   && myAspectLine->RenderFiltered (theWorkspace, aFilter);
326   Standard_Boolean isFaceSet   = myAspectFace   && myAspectFace->RenderFiltered (theWorkspace, aFilter);
327   Standard_Boolean isMarkerSet = myAspectMarker && myAspectMarker->RenderFiltered (theWorkspace, aFilter);
328   Standard_Boolean isTextSet   = myAspectText   && myAspectText->RenderFiltered (theWorkspace, aFilter);
329
330   // Render group elements
331   for (OpenGl_ElementNode* aNodeIter = myFirst; aNodeIter != NULL; aNodeIter = aNodeIter->next)
332   {
333     aNodeIter->elem->RenderFiltered (theWorkspace, aFilter);
334   }
335
336   // Restore aspects
337   if (isLineSet)
338     theWorkspace->SetAspectLine (aBackAspectLine);
339   if (isFaceSet)
340     theWorkspace->SetAspectFace (aBackAspectFace);
341   if (isMarkerSet)
342     theWorkspace->SetAspectMarker (aBackAspectMarker);
343   if (isTextSet)
344     theWorkspace->SetAspectText (aBackAspectText);
345 }
346
347 // =======================================================================
348 // function : Clear
349 // purpose  :
350 // =======================================================================
351 void OpenGl_Group::Clear (const Standard_Boolean theToUpdateStructureMgr)
352 {
353   if (IsDeleted())
354   {
355     return;
356   }
357
358   OpenGl_Structure* aStruct = GlStruct();
359   const Handle(OpenGl_Context)& aCtx = aStruct->GlDriver()->GetSharedContext();
360
361   Release (aCtx);
362   Graphic3d_Group::Clear (theToUpdateStructureMgr);
363 }
364
365 // =======================================================================
366 // function : Release
367 // purpose  :
368 // =======================================================================
369 void OpenGl_Group::Release (const Handle(OpenGl_Context)& theGlCtx)
370 {
371   // Delete elements
372   while (myFirst != NULL)
373   {
374     OpenGl_ElementNode* aNext = myFirst->next;
375     OpenGl_Element::Destroy (theGlCtx, myFirst->elem);
376     delete myFirst;
377     myFirst = aNext;
378   }
379   myLast = NULL;
380
381   OpenGl_Element::Destroy (theGlCtx, myAspectLine);
382   OpenGl_Element::Destroy (theGlCtx, myAspectFace);
383   OpenGl_Element::Destroy (theGlCtx, myAspectMarker);
384   OpenGl_Element::Destroy (theGlCtx, myAspectText);
385 }