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_ClippingIterator.hxx>
20 #include <OpenGl_GraphicDriver.hxx>
21 #include <OpenGl_ShaderManager.hxx>
22 #include <OpenGl_ShaderProgram.hxx>
23 #include <OpenGl_StructureShadow.hxx>
24 #include <OpenGl_Vec.hxx>
25 #include <OpenGl_View.hxx>
26 #include <OpenGl_Workspace.hxx>
28 IMPLEMENT_STANDARD_RTTIEXT(OpenGl_Structure,Graphic3d_CStructure)
30 // =======================================================================
31 // function : renderBoundingBox
33 // =======================================================================
34 void OpenGl_Structure::renderBoundingBox (const Handle(OpenGl_Workspace)& theWorkspace) const
36 if (!myBndBox.IsValid())
41 const Handle(OpenGl_Context)& aCtx = theWorkspace->GetGlContext();
42 const Handle(OpenGl_TextureSet) aPrevTexture = aCtx->BindTextures (Handle(OpenGl_TextureSet)(), Handle(OpenGl_ShaderProgram)());
43 const Graphic3d_ZLayerSettings& aLayer = myGraphicDriver->ZLayerSettings (myZLayer);
44 const Graphic3d_Vec3d aMoveVec = myTrsfPers.IsNull()
45 && !aLayer.OriginTransformation().IsNull()
46 ? -Graphic3d_Vec3d (aLayer.Origin().X(), aLayer.Origin().Y(), aLayer.Origin().Z())
47 : Graphic3d_Vec3d (0.0, 0.0, 0.0);
48 if (aCtx->core20fwd != NULL
49 && aCtx->ShaderManager()->BindBoundBoxProgram())
51 const Graphic3d_Vec3d aCenter = myBndBox.Center() + aMoveVec;
52 const Graphic3d_Vec3d aSize = myBndBox.Size();
53 aCtx->ActiveProgram()->SetUniform (aCtx, "occBBoxCenter", Graphic3d_Vec3 ((float )aCenter.x(), (float )aCenter.y(), (float )aCenter.z()));
54 aCtx->ActiveProgram()->SetUniform (aCtx, "occBBoxSize", Graphic3d_Vec3 ((float )aSize.x(), (float )aSize.y(), (float )aSize.z()));
55 aCtx->SetColor4fv (theWorkspace->InteriorColor());
57 const Handle(OpenGl_VertexBuffer)& aBoundBoxVertBuffer = aCtx->ShaderManager()->BoundBoxVertBuffer();
58 aBoundBoxVertBuffer->BindAttribute (aCtx, Graphic3d_TOA_POS);
59 aCtx->core20fwd->glDrawArrays (GL_LINES, 0, aBoundBoxVertBuffer->GetElemsNb());
60 aBoundBoxVertBuffer->UnbindAttribute(aCtx, Graphic3d_TOA_POS);
62 #if !defined(GL_ES_VERSION_2_0)
63 else if (aCtx->core11 != NULL)
65 const Graphic3d_Vec3d aMind = myBndBox.CornerMin() + aMoveVec;
66 const Graphic3d_Vec3d aMaxd = myBndBox.CornerMax() + aMoveVec;
67 const Graphic3d_Vec3 aMin ((float )aMind.x(), (float )aMind.y(), (float )aMind.z());
68 const Graphic3d_Vec3 aMax ((float )aMaxd.x(), (float )aMaxd.y(), (float )aMaxd.z());
69 const OpenGl_Vec3 aVerts[16] =
71 OpenGl_Vec3 (aMin.x(), aMin.y(), aMin.z()),
72 OpenGl_Vec3 (aMin.x(), aMin.y(), aMax.z()),
73 OpenGl_Vec3 (aMin.x(), aMax.y(), aMax.z()),
74 OpenGl_Vec3 (aMin.x(), aMax.y(), aMin.z()),
75 OpenGl_Vec3 (aMin.x(), aMin.y(), aMin.z()),
76 OpenGl_Vec3 (aMax.x(), aMin.y(), aMin.z()),
77 OpenGl_Vec3 (aMax.x(), aMin.y(), aMax.z()),
78 OpenGl_Vec3 (aMax.x(), aMax.y(), aMax.z()),
79 OpenGl_Vec3 (aMax.x(), aMax.y(), aMin.z()),
80 OpenGl_Vec3 (aMax.x(), aMin.y(), aMin.z()),
81 OpenGl_Vec3 (aMax.x(), aMax.y(), aMin.z()),
82 OpenGl_Vec3 (aMin.x(), aMax.y(), aMin.z()),
83 OpenGl_Vec3 (aMin.x(), aMax.y(), aMax.z()),
84 OpenGl_Vec3 (aMax.x(), aMax.y(), aMax.z()),
85 OpenGl_Vec3 (aMax.x(), aMin.y(), aMax.z()),
86 OpenGl_Vec3 (aMin.x(), aMin.y(), aMax.z())
89 aCtx->ShaderManager()->BindLineProgram (Handle(OpenGl_TextureSet)(), Aspect_TOL_SOLID, Graphic3d_TOSM_UNLIT, Graphic3d_AlphaMode_Opaque, false, Handle(OpenGl_ShaderProgram)());
90 aCtx->SetColor4fv (theWorkspace->InteriorColor());
91 aCtx->core11fwd->glDisable (GL_LIGHTING);
92 aCtx->core11->glEnableClientState (GL_VERTEX_ARRAY);
93 aCtx->core11->glVertexPointer (3, GL_FLOAT, 0, aVerts[0].GetData());
94 aCtx->core11fwd->glDrawArrays (GL_LINE_STRIP, 0, 16);
95 aCtx->core11->glDisableClientState (GL_VERTEX_ARRAY);
98 aCtx->BindTextures (aPrevTexture, Handle(OpenGl_ShaderProgram)());
101 // =======================================================================
102 // function : OpenGl_Structure
104 // =======================================================================
105 OpenGl_Structure::OpenGl_Structure (const Handle(Graphic3d_StructureManager)& theManager)
106 : Graphic3d_CStructure (theManager),
107 myInstancedStructure (NULL),
108 myIsRaytracable (Standard_False),
109 myModificationState (0),
110 myIsMirrored (Standard_False)
112 updateLayerTransformation();
115 // =======================================================================
116 // function : ~OpenGl_Structure
118 // =======================================================================
119 OpenGl_Structure::~OpenGl_Structure()
121 Release (Handle(OpenGl_Context)());
124 // =======================================================================
125 // function : SetZLayer
127 // =======================================================================
128 void OpenGl_Structure::SetZLayer (const Graphic3d_ZLayerId theLayerIndex)
130 Graphic3d_CStructure::SetZLayer (theLayerIndex);
131 updateLayerTransformation();
134 // =======================================================================
135 // function : SetTransformation
137 // =======================================================================
138 void OpenGl_Structure::SetTransformation (const Handle(TopLoc_Datum3D)& theTrsf)
141 myIsMirrored = Standard_False;
142 if (!myTrsf.IsNull())
144 // Determinant of transform matrix less then 0 means that mirror transform applied.
145 const gp_Trsf& aTrsf = myTrsf->Transformation();
146 const Standard_Real aDet = aTrsf.Value(1, 1) * (aTrsf.Value (2, 2) * aTrsf.Value (3, 3) - aTrsf.Value (3, 2) * aTrsf.Value (2, 3))
147 - aTrsf.Value(1, 2) * (aTrsf.Value (2, 1) * aTrsf.Value (3, 3) - aTrsf.Value (3, 1) * aTrsf.Value (2, 3))
148 + aTrsf.Value(1, 3) * (aTrsf.Value (2, 1) * aTrsf.Value (3, 2) - aTrsf.Value (3, 1) * aTrsf.Value (2, 2));
149 myIsMirrored = aDet < 0.0;
152 updateLayerTransformation();
155 ++myModificationState;
159 // =======================================================================
160 // function : SetTransformPersistence
162 // =======================================================================
163 void OpenGl_Structure::SetTransformPersistence (const Handle(Graphic3d_TransformPers)& theTrsfPers)
165 myTrsfPers = theTrsfPers;
166 updateLayerTransformation();
169 // =======================================================================
170 // function : updateLayerTransformation
172 // =======================================================================
173 void OpenGl_Structure::updateLayerTransformation()
176 if (!myTrsf.IsNull())
178 aRenderTrsf = myTrsf->Trsf();
181 const Graphic3d_ZLayerSettings& aLayer = myGraphicDriver->ZLayerSettings (myZLayer);
182 if (!aLayer.OriginTransformation().IsNull()
183 && myTrsfPers.IsNull())
185 aRenderTrsf.SetTranslationPart (aRenderTrsf.TranslationPart() - aLayer.Origin());
187 aRenderTrsf.GetMat4 (myRenderTrsf);
190 // =======================================================================
191 // function : GraphicHighlight
193 // =======================================================================
194 void OpenGl_Structure::GraphicHighlight (const Handle(Graphic3d_PresentationAttributes)& theStyle)
196 myHighlightStyle = theStyle;
200 // =======================================================================
201 // function : GraphicUnhighlight
203 // =======================================================================
204 void OpenGl_Structure::GraphicUnhighlight()
207 myHighlightStyle.Nullify();
210 // =======================================================================
211 // function : OnVisibilityChanged
213 // =======================================================================
214 void OpenGl_Structure::OnVisibilityChanged()
218 ++myModificationState;
222 // =======================================================================
223 // function : IsRaytracable
225 // =======================================================================
226 Standard_Boolean OpenGl_Structure::IsRaytracable() const
228 if (!myGroups.IsEmpty()
231 return Standard_True;
234 return myInstancedStructure != NULL
235 && myInstancedStructure->IsRaytracable();
238 // =======================================================================
239 // function : UpdateRaytracableState
241 // =======================================================================
242 void OpenGl_Structure::UpdateStateIfRaytracable (const Standard_Boolean toCheck) const
244 myIsRaytracable = !toCheck;
245 if (!myIsRaytracable)
247 for (OpenGl_Structure::GroupIterator anIter (myGroups); anIter.More(); anIter.Next())
249 if (anIter.Value()->IsRaytracable())
251 myIsRaytracable = Standard_True;
259 ++myModificationState;
263 // =======================================================================
264 // function : Connect
266 // =======================================================================
267 void OpenGl_Structure::Connect (Graphic3d_CStructure& theStructure)
269 OpenGl_Structure* aStruct = static_cast<OpenGl_Structure*> (&theStructure);
271 Standard_ASSERT_RAISE (myInstancedStructure == NULL || myInstancedStructure == aStruct,
272 "Error! Instanced structure is already defined");
274 myInstancedStructure = aStruct;
276 if (aStruct->IsRaytracable())
278 UpdateStateIfRaytracable (Standard_False);
282 // =======================================================================
283 // function : Disconnect
285 // =======================================================================
286 void OpenGl_Structure::Disconnect (Graphic3d_CStructure& theStructure)
288 OpenGl_Structure* aStruct = static_cast<OpenGl_Structure*> (&theStructure);
290 if (myInstancedStructure == aStruct)
292 myInstancedStructure = NULL;
294 if (aStruct->IsRaytracable())
296 UpdateStateIfRaytracable();
301 // =======================================================================
302 // function : NewGroup
304 // =======================================================================
305 Handle(Graphic3d_Group) OpenGl_Structure::NewGroup (const Handle(Graphic3d_Structure)& theStruct)
307 Handle(OpenGl_Group) aGroup = new OpenGl_Group (theStruct);
308 myGroups.Append (aGroup);
312 // =======================================================================
313 // function : RemoveGroup
315 // =======================================================================
316 void OpenGl_Structure::RemoveGroup (const Handle(Graphic3d_Group)& theGroup)
318 if (theGroup.IsNull())
323 for (Graphic3d_SequenceOfGroup::Iterator aGroupIter (myGroups); aGroupIter.More(); aGroupIter.Next())
325 // Check for the given group
326 if (aGroupIter.Value() == theGroup)
328 const Standard_Boolean wasRaytracable =
329 static_cast<const OpenGl_Group&> (*theGroup).IsRaytracable();
331 theGroup->Clear (Standard_False);
335 UpdateStateIfRaytracable();
338 myGroups.Remove (aGroupIter);
344 // =======================================================================
347 // =======================================================================
348 void OpenGl_Structure::Clear()
350 Clear (GlDriver()->GetSharedContext());
353 // =======================================================================
356 // =======================================================================
357 void OpenGl_Structure::Clear (const Handle(OpenGl_Context)& theGlCtx)
359 Standard_Boolean aRaytracableGroupDeleted (Standard_False);
362 for (OpenGl_Structure::GroupIterator aGroupIter (myGroups); aGroupIter.More(); aGroupIter.Next())
364 aRaytracableGroupDeleted |= aGroupIter.Value()->IsRaytracable();
367 aGroupIter.ChangeValue()->Release (theGlCtx);
371 if (aRaytracableGroupDeleted)
373 myIsRaytracable = Standard_False;
376 Is2dText = Standard_False;
377 IsForHighlight = Standard_False;
380 // =======================================================================
381 // function : renderGeometry
383 // =======================================================================
384 void OpenGl_Structure::renderGeometry (const Handle(OpenGl_Workspace)& theWorkspace,
385 bool& theHasClosed) const
387 if (myInstancedStructure != NULL)
389 myInstancedStructure->renderGeometry (theWorkspace, theHasClosed);
392 for (OpenGl_Structure::GroupIterator aGroupIter (myGroups); aGroupIter.More(); aGroupIter.Next())
394 theHasClosed = theHasClosed || aGroupIter.Value()->IsClosed();
395 aGroupIter.Value()->Render (theWorkspace);
399 // =======================================================================
402 // =======================================================================
403 void OpenGl_Structure::Render (const Handle(OpenGl_Workspace) &theWorkspace) const
405 // Process the structure only if visible
411 const Handle(OpenGl_Context)& aCtx = theWorkspace->GetGlContext();
413 // Render named status
414 if (highlight && !myHighlightStyle.IsNull() && myHighlightStyle->Method() != Aspect_TOHM_BOUNDBOX)
416 theWorkspace->SetHighlightStyle (myHighlightStyle);
419 // Apply local transformation
420 aCtx->ModelWorldState.Push();
421 OpenGl_Mat4& aModelWorld = aCtx->ModelWorldState.ChangeCurrent();
422 aModelWorld = myRenderTrsf;
424 const Standard_Boolean anOldGlNormalize = aCtx->IsGlNormalizeEnabled();
425 #if !defined(GL_ES_VERSION_2_0)
426 // detect scale transform
427 if (aCtx->core11 != NULL
430 const Standard_Real aScale = myTrsf->Trsf().ScaleFactor();
431 if (Abs (aScale - 1.0) > Precision::Confusion())
433 aCtx->SetGlNormalizeEnabled (Standard_True);
438 if (!myTrsfPers.IsNull())
440 aCtx->WorldViewState.Push();
441 OpenGl_Mat4& aWorldView = aCtx->WorldViewState.ChangeCurrent();
442 myTrsfPers->Apply (theWorkspace->View()->Camera(),
443 aCtx->ProjectionState.Current(), aWorldView,
444 aCtx->VirtualViewport()[2], aCtx->VirtualViewport()[3]);
446 #if !defined(GL_ES_VERSION_2_0)
447 if (!aCtx->IsGlNormalizeEnabled()
448 && aCtx->core11 != NULL)
450 const Standard_Real aScale = Graphic3d_TransformUtils::ScaleFactor<Standard_ShortReal> (aWorldView);
451 if (Abs (aScale - 1.0) > Precision::Confusion())
453 aCtx->SetGlNormalizeEnabled (Standard_True);
459 // Take into account transform persistence
460 aCtx->ApplyModelViewMatrix();
463 const OpenGl_Aspects* aPrevAspectFace = theWorkspace->Aspects();
465 // Apply correction for mirror transform
468 aCtx->core11fwd->glFrontFace (GL_CW);
471 // Collect clipping planes of structure scope
472 aCtx->ChangeClipping().SetLocalPlanes (myClipPlanes);
474 // True if structure is fully clipped
475 bool isClipped = false;
476 bool hasDisabled = false;
477 if (aCtx->Clipping().IsClippingOrCappingOn())
479 const Graphic3d_BndBox3d& aBBox = BoundingBox();
480 if (!myClipPlanes.IsNull()
481 && myClipPlanes->ToOverrideGlobal())
483 aCtx->ChangeClipping().DisableGlobal();
484 hasDisabled = aCtx->Clipping().HasDisabled();
486 else if (!myTrsfPers.IsNull())
488 if (myTrsfPers->IsZoomOrRotate())
490 // Zoom/rotate persistence object lives in two worlds at the same time.
491 // Global clipping planes can not be trivially applied without being converted
492 // into local space of transformation persistence object.
493 // As more simple alternative - just clip entire object by its anchor point defined in the world space.
494 const gp_Pnt anAnchor = myTrsfPers->AnchorPoint();
495 for (OpenGl_ClippingIterator aPlaneIt (aCtx->Clipping()); aPlaneIt.More() && aPlaneIt.IsGlobal(); aPlaneIt.Next())
497 const Handle(Graphic3d_ClipPlane)& aPlane = aPlaneIt.Value();
503 // check for clipping
504 const Graphic3d_Vec4d aCheckPnt (anAnchor.X(), anAnchor.Y(), anAnchor.Z(), 1.0);
505 if (aPlane->ProbePoint (aCheckPnt) == Graphic3d_ClipState_Out)
513 aCtx->ChangeClipping().DisableGlobal();
514 hasDisabled = aCtx->Clipping().HasDisabled();
517 // Set of clipping planes that do not intersect the structure,
518 // and thus can be disabled to improve rendering performance
520 && myTrsfPers.IsNull())
522 for (OpenGl_ClippingIterator aPlaneIt (aCtx->Clipping()); aPlaneIt.More(); aPlaneIt.Next())
524 const Handle(Graphic3d_ClipPlane)& aPlane = aPlaneIt.Value();
525 if (aPlaneIt.IsDisabled())
530 const Graphic3d_ClipState aBoxState = aPlane->ProbeBox (aBBox);
531 if (aBoxState == Graphic3d_ClipState_In)
533 aCtx->ChangeClipping().SetEnabled (aPlaneIt, false);
536 else if (aBoxState == Graphic3d_ClipState_Out && myBndBoxClipCheck)
544 if ((!myClipPlanes.IsNull() && !myClipPlanes->IsEmpty())
547 // Set OCCT state uniform variables
548 aCtx->ShaderManager()->UpdateClippingState();
553 bool hasClosedPrims = false;
556 renderGeometry (theWorkspace, hasClosedPrims);
559 // Reset correction for mirror transform
562 aCtx->core11fwd->glFrontFace (GL_CCW);
565 // Render capping for structure groups
567 && aCtx->Clipping().IsCappingOn())
569 OpenGl_CappingAlgo::RenderCapping (theWorkspace, *this);
572 // Revert structure clippings
575 // enable planes that were previously disabled
576 aCtx->ChangeClipping().RestoreDisabled();
578 aCtx->ChangeClipping().SetLocalPlanes (Handle(Graphic3d_SequenceOfHClipPlane)());
579 if ((!myClipPlanes.IsNull() && !myClipPlanes->IsEmpty())
582 // Set OCCT state uniform variables
583 aCtx->ShaderManager()->RevertClippingState();
586 // Restore local transformation
587 aCtx->ModelWorldState.Pop();
588 aCtx->SetGlNormalizeEnabled (anOldGlNormalize);
591 theWorkspace->SetAspects (aPrevAspectFace);
593 // Apply highlight box
595 && !myHighlightStyle.IsNull()
596 && myHighlightStyle->Method() == Aspect_TOHM_BOUNDBOX)
598 aCtx->ApplyModelViewMatrix();
599 theWorkspace->SetHighlightStyle (myHighlightStyle);
600 renderBoundingBox (theWorkspace);
603 if (!myTrsfPers.IsNull())
605 aCtx->WorldViewState.Pop();
608 // Restore named status
609 theWorkspace->SetHighlightStyle (Handle(Graphic3d_PresentationAttributes)());
612 // =======================================================================
613 // function : Release
615 // =======================================================================
616 void OpenGl_Structure::Release (const Handle(OpenGl_Context)& theGlCtx)
620 myHighlightStyle.Nullify();
623 // =======================================================================
624 // function : ReleaseGlResources
626 // =======================================================================
627 void OpenGl_Structure::ReleaseGlResources (const Handle(OpenGl_Context)& theGlCtx)
629 for (OpenGl_Structure::GroupIterator aGroupIter (myGroups); aGroupIter.More(); aGroupIter.Next())
631 aGroupIter.ChangeValue()->Release (theGlCtx);
635 //=======================================================================
636 //function : ShadowLink
638 //=======================================================================
639 Handle(Graphic3d_CStructure) OpenGl_Structure::ShadowLink (const Handle(Graphic3d_StructureManager)& theManager) const
641 return new OpenGl_StructureShadow (theManager, this);
644 //=======================================================================
645 //function : DumpJson
647 //=======================================================================
648 void OpenGl_Structure::DumpJson (Standard_OStream& theOStream, Standard_Integer theDepth) const
650 OCCT_DUMP_TRANSIENT_CLASS_BEGIN (theOStream)
652 OCCT_DUMP_BASE_CLASS (theOStream, theDepth, Graphic3d_CStructure)
654 OCCT_DUMP_FIELD_VALUE_POINTER (theOStream, myInstancedStructure)
656 OCCT_DUMP_FIELD_VALUE_NUMERICAL (theOStream, myIsRaytracable)
657 OCCT_DUMP_FIELD_VALUE_NUMERICAL (theOStream, myModificationState)
658 OCCT_DUMP_FIELD_VALUE_NUMERICAL (theOStream, myIsMirrored)