1 // Created on: 2011-08-01
2 // Created by: Sergey ZERCHANINOV
3 // Copyright (c) 2011-2014 OPEN CASCADE SAS
5 // This file is part of Open CASCADE Technology software library.
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.
13 // Alternatively, this file may be used under the terms of Open CASCADE
14 // commercial license or contractual agreement.
16 #include <OpenGl_CappingAlgo.hxx>
17 #include <OpenGl_Context.hxx>
18 #include <OpenGl_GlCore11.hxx>
19 #include <OpenGl_GraphicDriver.hxx>
20 #include <OpenGl_ShaderManager.hxx>
21 #include <OpenGl_ShaderProgram.hxx>
22 #include <OpenGl_StructureShadow.hxx>
23 #include <OpenGl_Vec.hxx>
24 #include <OpenGl_View.hxx>
25 #include <OpenGl_Workspace.hxx>
27 #include <Graphic3d_SequenceOfHClipPlane.hxx>
30 IMPLEMENT_STANDARD_RTTIEXT(OpenGl_Structure,Graphic3d_CStructure)
32 //! Auxiliary class for bounding box presentation
33 class OpenGl_BndBoxPrs : public OpenGl_Element
39 OpenGl_BndBoxPrs (const Graphic3d_BndBox4f& theBndBox)
41 const float Xm = theBndBox.CornerMin().x();
42 const float Ym = theBndBox.CornerMin().y();
43 const float Zm = theBndBox.CornerMin().z();
44 const float XM = theBndBox.CornerMax().x();
45 const float YM = theBndBox.CornerMax().y();
46 const float ZM = theBndBox.CornerMax().z();
48 myVerts[0] = OpenGl_Vec3 (Xm, Ym, Zm);
49 myVerts[1] = OpenGl_Vec3 (Xm, Ym, ZM);
50 myVerts[2] = OpenGl_Vec3 (Xm, YM, ZM);
51 myVerts[3] = OpenGl_Vec3 (Xm, YM, Zm);
52 myVerts[4] = OpenGl_Vec3 (Xm, Ym, Zm);
53 myVerts[5] = OpenGl_Vec3 (XM, Ym, Zm);
54 myVerts[6] = OpenGl_Vec3 (XM, Ym, ZM);
55 myVerts[7] = OpenGl_Vec3 (XM, YM, ZM);
56 myVerts[8] = OpenGl_Vec3 (XM, YM, Zm);
57 myVerts[9] = OpenGl_Vec3 (XM, Ym, Zm);
58 myVerts[10] = OpenGl_Vec3 (XM, YM, Zm);
59 myVerts[11] = OpenGl_Vec3 (Xm, YM, Zm);
60 myVerts[12] = OpenGl_Vec3 (Xm, YM, ZM);
61 myVerts[13] = OpenGl_Vec3 (XM, YM, ZM);
62 myVerts[14] = OpenGl_Vec3 (XM, Ym, ZM);
63 myVerts[15] = OpenGl_Vec3 (Xm, Ym, ZM);
66 //! Render presentation
67 virtual void Render (const Handle(OpenGl_Workspace)& theWorkspace) const
69 #if !defined(GL_ES_VERSION_2_0)
71 const Handle(OpenGl_Texture) aPrevTexture = theWorkspace->DisableTexture();
73 glDisable (GL_LIGHTING);
75 // Use highlight colors
76 theWorkspace->GetGlContext()->core11->glColor3fv (theWorkspace->LineColor().GetData());
78 glEnableClientState (GL_VERTEX_ARRAY);
79 glVertexPointer (3, GL_FLOAT, 0, (GLfloat* )&myVerts);
80 glDrawArrays (GL_LINE_STRIP, 0, 16);
81 glDisableClientState (GL_VERTEX_ARRAY);
84 if (!aPrevTexture.IsNull())
86 theWorkspace->EnableTexture (aPrevTexture);
93 //! Release graphical resources
94 virtual void Release (OpenGl_Context*)
101 //! Protected destructor
102 virtual ~OpenGl_BndBoxPrs() {}
106 OpenGl_Vec3 myVerts[16]; //!< vertices array
110 DEFINE_STANDARD_ALLOC
114 /*----------------------------------------------------------------------*/
116 // =======================================================================
117 // function : OpenGl_Structure
119 // =======================================================================
120 OpenGl_Structure::OpenGl_Structure (const Handle(Graphic3d_StructureManager)& theManager)
121 : Graphic3d_CStructure (theManager),
122 myHighlightColor (NULL),
123 myInstancedStructure (NULL),
124 myIsRaytracable (Standard_False),
125 myModificationState (0),
126 myIsCulled (Standard_True),
127 myIsMirrored (Standard_False)
132 // =======================================================================
133 // function : ~OpenGl_Structure
135 // =======================================================================
136 OpenGl_Structure::~OpenGl_Structure()
138 Release (Handle(OpenGl_Context)());
141 // =======================================================================
142 // function : UpdateTransformation
144 // =======================================================================
145 void OpenGl_Structure::UpdateTransformation()
147 const OpenGl_Mat4& aMat = Graphic3d_CStructure::Transformation;
148 Standard_ShortReal aDet =
149 aMat.GetValue(0, 0) * (aMat.GetValue(1, 1) * aMat.GetValue(2, 2) - aMat.GetValue(2, 1) * aMat.GetValue(1, 2)) -
150 aMat.GetValue(0, 1) * (aMat.GetValue(1, 0) * aMat.GetValue(2, 2) - aMat.GetValue(2, 0) * aMat.GetValue(1, 2)) +
151 aMat.GetValue(0, 2) * (aMat.GetValue(1, 0) * aMat.GetValue(2, 1) - aMat.GetValue(2, 0) * aMat.GetValue(1, 1));
153 // Determinant of transform matrix less then 0 means that mirror transform applied.
154 myIsMirrored = aDet < 0.0f;
158 ++myModificationState;
162 // =======================================================================
163 // function : clearHighlightBox
165 // =======================================================================
166 void OpenGl_Structure::clearHighlightBox (const Handle(OpenGl_Context)& theGlCtx)
168 if (!myHighlightBox.IsNull())
170 myHighlightBox->Release (theGlCtx);
171 myHighlightBox.Nullify();
175 // =======================================================================
176 // function : HighlightWithColor
178 // =======================================================================
179 void OpenGl_Structure::HighlightWithColor (const Graphic3d_Vec3& theColor,
180 const Standard_Boolean theToCreate)
182 const Handle(OpenGl_Context)& aContext = GlDriver()->GetSharedContext();
184 setHighlightColor (aContext, theColor);
186 clearHighlightColor (aContext);
189 // =======================================================================
190 // function : HighlightWithBndBox
192 // =======================================================================
193 void OpenGl_Structure::HighlightWithBndBox (const Handle(Graphic3d_Structure)& theStruct,
194 const Standard_Boolean theToCreate)
196 const Handle(OpenGl_Context)& aContext = GlDriver()->GetSharedContext();
199 clearHighlightBox (aContext);
203 if (!myHighlightBox.IsNull())
205 myHighlightBox->Release (aContext);
209 myHighlightBox = new OpenGl_Group (theStruct);
212 myHighlightBox->SetGroupPrimitivesAspect (new Graphic3d_AspectLine3d (HighlightColor, Aspect_TOL_SOLID, 1.0));
214 OpenGl_BndBoxPrs* aBndBoxPrs = new OpenGl_BndBoxPrs (myBndBox);
215 myHighlightBox->AddElement (aBndBoxPrs);
218 // =======================================================================
219 // function : setHighlightColor
221 // =======================================================================
222 void OpenGl_Structure::setHighlightColor (const Handle(OpenGl_Context)& theGlCtx,
223 const Graphic3d_Vec3& theColor)
225 clearHighlightBox (theGlCtx);
226 if (myHighlightColor == NULL)
228 myHighlightColor = new OpenGl_Vec4 (theColor, 1.0f);
232 myHighlightColor->xyz() = theColor;
236 // =======================================================================
237 // function : clearHighlightColor
239 // =======================================================================
240 void OpenGl_Structure::clearHighlightColor (const Handle(OpenGl_Context)& theGlCtx)
242 clearHighlightBox(theGlCtx);
243 delete myHighlightColor;
244 myHighlightColor = NULL;
247 // =======================================================================
248 // function : OnVisibilityChanged
250 // =======================================================================
251 void OpenGl_Structure::OnVisibilityChanged()
255 ++myModificationState;
259 // =======================================================================
260 // function : IsRaytracable
262 // =======================================================================
263 Standard_Boolean OpenGl_Structure::IsRaytracable() const
265 if (!myGroups.IsEmpty())
267 return myIsRaytracable; // geometry structure
269 else if (myInstancedStructure != NULL)
271 return myInstancedStructure->IsRaytracable(); // instance structure
274 return Standard_False; // has no any groups or structures
277 // =======================================================================
278 // function : UpdateRaytracableState
280 // =======================================================================
281 void OpenGl_Structure::UpdateStateIfRaytracable (const Standard_Boolean toCheck) const
283 myIsRaytracable = !toCheck || OpenGl_Raytrace::IsRaytracedStructure (this);
287 ++myModificationState;
291 // =======================================================================
292 // function : Connect
294 // =======================================================================
295 void OpenGl_Structure::Connect (Graphic3d_CStructure& theStructure)
297 OpenGl_Structure* aStruct = static_cast<OpenGl_Structure*> (&theStructure);
299 Standard_ASSERT_RAISE (myInstancedStructure == NULL || myInstancedStructure == aStruct,
300 "Error! Instanced structure is already defined");
302 myInstancedStructure = aStruct;
304 if (aStruct->IsRaytracable())
306 UpdateStateIfRaytracable (Standard_False);
310 // =======================================================================
311 // function : Disconnect
313 // =======================================================================
314 void OpenGl_Structure::Disconnect (Graphic3d_CStructure& theStructure)
316 OpenGl_Structure* aStruct = static_cast<OpenGl_Structure*> (&theStructure);
318 if (myInstancedStructure == aStruct)
320 myInstancedStructure = NULL;
322 if (aStruct->IsRaytracable())
324 UpdateStateIfRaytracable();
329 // =======================================================================
330 // function : NewGroup
332 // =======================================================================
333 Handle(Graphic3d_Group) OpenGl_Structure::NewGroup (const Handle(Graphic3d_Structure)& theStruct)
335 Handle(OpenGl_Group) aGroup = new OpenGl_Group (theStruct);
336 myGroups.Append (aGroup);
340 // =======================================================================
341 // function : RemoveGroup
343 // =======================================================================
344 void OpenGl_Structure::RemoveGroup (const Handle(Graphic3d_Group)& theGroup)
346 if (theGroup.IsNull())
351 for (Graphic3d_SequenceOfGroup::Iterator aGroupIter (myGroups); aGroupIter.More(); aGroupIter.Next())
353 // Check for the given group
354 if (aGroupIter.Value() == theGroup)
356 const Standard_Boolean wasRaytracable =
357 static_cast<const OpenGl_Group&> (*theGroup).IsRaytracable();
359 theGroup->Clear (Standard_False);
363 UpdateStateIfRaytracable();
366 myGroups.Remove (aGroupIter);
372 // =======================================================================
375 // =======================================================================
376 void OpenGl_Structure::Clear()
378 Clear (GlDriver()->GetSharedContext());
381 // =======================================================================
384 // =======================================================================
385 void OpenGl_Structure::Clear (const Handle(OpenGl_Context)& theGlCtx)
387 Standard_Boolean aRaytracableGroupDeleted (Standard_False);
390 for (OpenGl_Structure::GroupIterator aGroupIter (myGroups); aGroupIter.More(); aGroupIter.Next())
392 aRaytracableGroupDeleted |= aGroupIter.Value()->IsRaytracable();
395 aGroupIter.ChangeValue()->Release (theGlCtx);
399 if (aRaytracableGroupDeleted)
401 myIsRaytracable = Standard_False;
404 Is2dText = Standard_False;
405 IsForHighlight = Standard_False;
408 // =======================================================================
409 // function : renderGeometry
411 // =======================================================================
412 void OpenGl_Structure::renderGeometry (const Handle(OpenGl_Workspace)& theWorkspace,
413 bool& theHasClosed) const
415 if (myInstancedStructure != NULL)
417 myInstancedStructure->renderGeometry (theWorkspace, theHasClosed);
420 for (OpenGl_Structure::GroupIterator aGroupIter (myGroups); aGroupIter.More(); aGroupIter.Next())
422 theHasClosed = theHasClosed || aGroupIter.Value()->IsClosed();
423 aGroupIter.Value()->Render (theWorkspace);
427 // =======================================================================
428 // function : renderClosedGeometry
430 // =======================================================================
431 void OpenGl_Structure::renderClosedGeometry (const Handle(OpenGl_Workspace)& theWorkspace) const
433 if (myInstancedStructure != NULL)
435 myInstancedStructure->renderClosedGeometry (theWorkspace);
438 for (OpenGl_Structure::GroupIterator aGroupIter (myGroups); aGroupIter.More(); aGroupIter.Next())
440 if (aGroupIter.Value()->IsClosed())
442 aGroupIter.Value()->Render (theWorkspace);
447 // =======================================================================
450 // =======================================================================
451 void OpenGl_Structure::Render (const Handle(OpenGl_Workspace) &theWorkspace) const
453 // Process the structure only if visible
459 const Handle(OpenGl_Context)& aCtx = theWorkspace->GetGlContext();
461 // Render named status
464 theWorkspace->SetHighlight (true);
467 // Apply local transformation
468 aCtx->ModelWorldState.Push();
469 aCtx->ModelWorldState.SetCurrent (Transformation);
471 const Standard_Boolean anOldGlNormalize = aCtx->IsGlNormalizeEnabled();
473 #if !defined(GL_ES_VERSION_2_0)
474 // detect scale transform
475 if (aCtx->core11 != NULL)
477 const Standard_ShortReal aScaleX = Transformation.GetRow (0).xyz().SquareModulus();
478 if (Abs (aScaleX - 1.f) > Precision::Confusion())
480 aCtx->SetGlNormalizeEnabled (Standard_True);
485 if (TransformPersistence.Flags)
487 OpenGl_Mat4 aProjection = aCtx->ProjectionState.Current();
488 OpenGl_Mat4 aWorldView = aCtx->WorldViewState.Current();
489 TransformPersistence.Apply (aProjection, aWorldView, theWorkspace->Width(), theWorkspace->Height());
491 aCtx->ProjectionState.Push();
492 aCtx->WorldViewState.Push();
493 aCtx->ProjectionState.SetCurrent (aProjection);
494 aCtx->WorldViewState.SetCurrent (aWorldView);
495 aCtx->ApplyProjectionMatrix();
497 #if !defined(GL_ES_VERSION_2_0)
498 if (!aCtx->IsGlNormalizeEnabled()
499 && aCtx->core11 != NULL)
501 const Standard_Real aScale = Graphic3d_TransformUtils::ScaleFactor<Standard_ShortReal> (aWorldView);
502 if (Abs (aScale - 1.0f) > Precision::Confusion())
504 aCtx->SetGlNormalizeEnabled (Standard_True);
510 // Take into account transform persistence
511 aCtx->ApplyModelViewMatrix();
514 const OpenGl_AspectLine* aPrevAspectLine = theWorkspace->AspectLine();
515 const OpenGl_AspectFace* aPrevAspectFace = theWorkspace->AspectFace();
516 const OpenGl_AspectMarker* aPrevAspectMarker = theWorkspace->AspectMarker();
517 const OpenGl_AspectText* aPrevAspectText = theWorkspace->AspectText();
519 // Apply correction for mirror transform
522 aCtx->core11fwd->glFrontFace (GL_CW);
525 // Apply highlight color
526 const OpenGl_Vec4* aHighlightColor = theWorkspace->HighlightColor;
527 if (myHighlightColor)
528 theWorkspace->HighlightColor = myHighlightColor;
530 // Set up plane equations for non-structure transformed global model-view matrix
531 // List of planes to be applied to context state
532 NCollection_Handle<Graphic3d_SequenceOfHClipPlane> aUserPlanes;
534 // Collect clipping planes of structure scope
535 if (!myClipPlanes.IsEmpty())
537 Graphic3d_SequenceOfHClipPlane::Iterator aClippingIter (myClipPlanes);
538 for (; aClippingIter.More(); aClippingIter.Next())
540 const Handle(Graphic3d_ClipPlane)& aClipPlane = aClippingIter.Value();
541 if (!aClipPlane->IsOn())
546 if (aUserPlanes.IsNull())
548 aUserPlanes = new Graphic3d_SequenceOfHClipPlane();
551 aUserPlanes->Append (aClipPlane);
555 if (!aUserPlanes.IsNull() && !aUserPlanes->IsEmpty())
557 // add planes at loaded view matrix state
558 aCtx->ChangeClipping().AddWorld (aCtx, *aUserPlanes);
560 // Set OCCT state uniform variables
561 aCtx->ShaderManager()->UpdateClippingState();
565 bool hasClosedPrims = false;
566 renderGeometry (theWorkspace, hasClosedPrims);
568 // Reset correction for mirror transform
571 aCtx->core11fwd->glFrontFace (GL_CCW);
574 // Render capping for structure groups
576 && !aCtx->Clipping().Planes().IsEmpty())
578 OpenGl_CappingAlgo::RenderCapping (theWorkspace, *this);
581 // Revert structure clippings
582 if (!aUserPlanes.IsNull() && !aUserPlanes->IsEmpty())
584 aCtx->ChangeClipping().Remove (aCtx, *aUserPlanes);
586 // Set OCCT state uniform variables
587 aCtx->ShaderManager()->RevertClippingState();
590 // Restore local transformation
591 aCtx->ModelWorldState.Pop();
592 aCtx->SetGlNormalizeEnabled (anOldGlNormalize);
593 if (TransformPersistence.Flags)
595 aCtx->ProjectionState.Pop();
596 aCtx->WorldViewState.Pop();
597 aCtx->ApplyProjectionMatrix();
600 // Restore highlight color
601 theWorkspace->HighlightColor = aHighlightColor;
604 theWorkspace->SetAspectLine (aPrevAspectLine);
605 theWorkspace->SetAspectFace (aPrevAspectFace);
606 theWorkspace->SetAspectMarker (aPrevAspectMarker);
607 theWorkspace->SetAspectText (aPrevAspectText);
609 // Apply highlight box
610 if (!myHighlightBox.IsNull())
612 myHighlightBox->Render (theWorkspace);
615 // Restore named status
616 theWorkspace->SetHighlight (false);
619 // =======================================================================
620 // function : Release
622 // =======================================================================
623 void OpenGl_Structure::Release (const Handle(OpenGl_Context)& theGlCtx)
627 clearHighlightColor (theGlCtx);
630 // =======================================================================
631 // function : ReleaseGlResources
633 // =======================================================================
634 void OpenGl_Structure::ReleaseGlResources (const Handle(OpenGl_Context)& theGlCtx)
636 for (OpenGl_Structure::GroupIterator aGroupIter (myGroups); aGroupIter.More(); aGroupIter.Next())
638 aGroupIter.ChangeValue()->Release (theGlCtx);
640 if (!myHighlightBox.IsNull())
642 myHighlightBox->Release (theGlCtx.operator->());
646 //=======================================================================
647 //function : ShadowLink
649 //=======================================================================
650 Handle(Graphic3d_CStructure) OpenGl_Structure::ShadowLink (const Handle(Graphic3d_StructureManager)& theManager) const
652 return new OpenGl_StructureShadow (theManager, this);