0032289: Visualization - add NCollection_Mat3 for 3x3 matrix similar to NCollection_Mat4
[occt.git] / src / OpenGl / OpenGl_Workspace.cxx
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 #include <OpenGl_Workspace.hxx>
17
18 #include <OpenGl_ArbFBO.hxx>
19 #include <OpenGl_Aspects.hxx>
20 #include <OpenGl_Context.hxx>
21 #include <OpenGl_Element.hxx>
22 #include <OpenGl_FrameBuffer.hxx>
23 #include <OpenGl_GlCore15.hxx>
24 #include <OpenGl_SceneGeometry.hxx>
25 #include <OpenGl_Structure.hxx>
26 #include <OpenGl_Sampler.hxx>
27 #include <OpenGl_ShaderManager.hxx>
28 #include <OpenGl_Texture.hxx>
29 #include <OpenGl_View.hxx>
30 #include <OpenGl_Window.hxx>
31
32 #include <Graphic3d_TextureParams.hxx>
33 #include <Graphic3d_TransformUtils.hxx>
34
35 IMPLEMENT_STANDARD_RTTIEXT(OpenGl_Workspace,Standard_Transient)
36
37 // =======================================================================
38 // function : Init
39 // purpose  :
40 // =======================================================================
41 void OpenGl_Material::Init (const OpenGl_Context& theCtx,
42                             const Graphic3d_MaterialAspect& theFront,
43                             const Quantity_Color& theFrontColor,
44                             const Graphic3d_MaterialAspect& theBack,
45                             const Quantity_Color& theBackColor)
46 {
47   init (theCtx, theFront, theFrontColor, 0);
48   if (&theFront != &theBack)
49   {
50     init (theCtx, theBack, theBackColor, 1);
51   }
52   else
53   {
54     Common[1] = Common[0];
55     Pbr[1] = Pbr[0];
56   }
57 }
58
59 // =======================================================================
60 // function : init
61 // purpose  :
62 // =======================================================================
63 void OpenGl_Material::init (const OpenGl_Context& theCtx,
64                             const Graphic3d_MaterialAspect& theMat,
65                             const Quantity_Color& theInteriorColor,
66                             const Standard_Integer theIndex)
67 {
68   OpenGl_MaterialCommon& aCommon = Common[theIndex];
69   OpenGl_MaterialPBR&    aPbr    = Pbr[theIndex];
70   aPbr.ChangeMetallic()  = theMat.PBRMaterial().Metallic();
71   aPbr.ChangeRoughness() = theMat.PBRMaterial().NormalizedRoughness();
72   aPbr.EmissionIOR = Graphic3d_Vec4 (theMat.PBRMaterial().Emission(), theMat.PBRMaterial().IOR());
73
74   const OpenGl_Vec3& aSrcAmb = theMat.AmbientColor();
75   const OpenGl_Vec3& aSrcDif = theMat.DiffuseColor();
76   const OpenGl_Vec3& aSrcSpe = theMat.SpecularColor();
77   const OpenGl_Vec3& aSrcEms = theMat.EmissiveColor();
78   aCommon.SpecularShininess.SetValues (aSrcSpe,128.0f * theMat.Shininess()); // interior color is ignored for Specular
79   switch (theMat.MaterialType())
80   {
81     case Graphic3d_MATERIAL_ASPECT:
82     {
83       aCommon.Diffuse .SetValues (aSrcDif * theInteriorColor, theMat.Alpha());
84       aCommon.Ambient .SetValues (aSrcAmb * theInteriorColor, 1.0f);
85       aCommon.Emission.SetValues (aSrcEms * theInteriorColor, 1.0f);
86       aPbr  .BaseColor.SetValues (theInteriorColor, theMat.Alpha());
87       break;
88     }
89     case Graphic3d_MATERIAL_PHYSIC:
90     {
91       aCommon.Diffuse .SetValues (aSrcDif, theMat.Alpha());
92       aCommon.Ambient .SetValues (aSrcAmb, 1.0f);
93       aCommon.Emission.SetValues (aSrcEms, 1.0f);
94       aPbr.BaseColor = theMat.PBRMaterial().Color();
95       break;
96     }
97   }
98
99   aCommon.Diffuse  = theCtx.Vec4FromQuantityColor (aCommon.Diffuse);
100   aCommon.Ambient  = theCtx.Vec4FromQuantityColor (aCommon.Ambient);
101   aCommon.SpecularShininess = theCtx.Vec4FromQuantityColor (aCommon.SpecularShininess);
102   aCommon.Emission = theCtx.Vec4FromQuantityColor (aCommon.Emission);
103 }
104
105 // =======================================================================
106 // function : OpenGl_Workspace
107 // purpose  :
108 // =======================================================================
109 OpenGl_Workspace::OpenGl_Workspace (OpenGl_View* theView, const Handle(OpenGl_Window)& theWindow)
110 : myView (theView),
111   myWindow (theWindow),
112   myGlContext (!theWindow.IsNull() ? theWindow->GetGlContext() : NULL),
113   myUseZBuffer    (Standard_True),
114   myUseDepthWrite (Standard_True),
115   //
116   myNbSkippedTranspElems (0),
117   myRenderFilter (OpenGl_RenderFilter_Empty),
118   //
119   myAspectsSet (&myDefaultAspects),
120   //
121   myToAllowFaceCulling (false)
122 {
123   if (!myGlContext.IsNull() && myGlContext->MakeCurrent())
124   {
125     myGlContext->core11fwd->glPixelStorei (GL_UNPACK_ALIGNMENT, 1);
126
127     // General initialization of the context
128   #if !defined(GL_ES_VERSION_2_0)
129     if (myGlContext->core11ffp != NULL)
130     {
131       // enable two-side lighting by default
132       myGlContext->core11ffp->glLightModeli ((GLenum )GL_LIGHT_MODEL_TWO_SIDE, GL_TRUE);
133       myGlContext->core11fwd->glHint (GL_POINT_SMOOTH_HINT, GL_FASTEST);
134       if (myGlContext->caps->ffpEnable)
135       {
136         myGlContext->core11fwd->glHint (GL_FOG_HINT, GL_FASTEST);
137       }
138     }
139
140     myGlContext->core11fwd->glHint (GL_LINE_SMOOTH_HINT,    GL_FASTEST);
141     myGlContext->core11fwd->glHint (GL_POLYGON_SMOOTH_HINT, GL_FASTEST);
142     if (myGlContext->Vendor() == "microsoft corporation"
143     && !myGlContext->IsGlGreaterEqual (1, 2))
144     {
145       // this software implementation causes too slow rendering into GL_FRONT on modern Windows
146       theView->SetImmediateModeDrawToFront (false);
147     }
148   #endif
149   }
150
151   myNoneCulling .Aspect()->SetFaceCulling (Graphic3d_TypeOfBackfacingModel_DoubleSided);
152   myNoneCulling .Aspect()->SetDrawEdges (false);
153   myNoneCulling .Aspect()->SetAlphaMode (Graphic3d_AlphaMode_Opaque);
154
155   myFrontCulling.Aspect()->SetFaceCulling (Graphic3d_TypeOfBackfacingModel_BackCulled);
156   myFrontCulling.Aspect()->SetDrawEdges (false);
157   myFrontCulling.Aspect()->SetAlphaMode (Graphic3d_AlphaMode_Opaque);
158 }
159
160 // =======================================================================
161 // function : Activate
162 // purpose  :
163 // =======================================================================
164 Standard_Boolean OpenGl_Workspace::Activate()
165 {
166   if (myWindow.IsNull() || !myWindow->Activate())
167   {
168     return Standard_False;
169   }
170
171   if (myGlContext->core11ffp == NULL)
172   {
173     if (myGlContext->caps->ffpEnable)
174     {
175     #if defined(GL_ES_VERSION_2_0)
176       Message::SendWarning ("Warning: FFP is unsupported by OpenGL ES");
177     #else
178       Message::SendWarning ("Warning: FFP is unsupported by OpenGL Core Profile");
179     #endif
180       myGlContext->caps->ffpEnable = false;
181     }
182   }
183
184   if (myGlContext->caps->useZeroToOneDepth
185   && !myGlContext->arbClipControl)
186   {
187     Message::SendWarning ("Warning: glClipControl() requires OpenGL 4.5 or GL_ARB_clip_control extension");
188     myGlContext->caps->useZeroToOneDepth = false;
189   }
190   myView->Camera()->SetZeroToOneDepth (myGlContext->caps->useZeroToOneDepth);
191 #if !defined(GL_ES_VERSION_2_0)
192   if (myGlContext->arbClipControl)
193   {
194     myGlContext->Functions()->glClipControl (GL_LOWER_LEFT, myGlContext->caps->useZeroToOneDepth ? GL_ZERO_TO_ONE : GL_NEGATIVE_ONE_TO_ONE);
195   }
196 #endif
197
198   ResetAppliedAspect();
199
200   // reset state for safety
201   myGlContext->BindProgram (Handle(OpenGl_ShaderProgram)());
202   if (myGlContext->core20fwd != NULL)
203   {
204     myGlContext->core20fwd->glUseProgram (OpenGl_ShaderProgram::NO_PROGRAM);
205   }
206   if (myGlContext->caps->ffpEnable)
207   {
208     myGlContext->ShaderManager()->PushState (Handle(OpenGl_ShaderProgram)());
209   }
210   return Standard_True;
211 }
212
213 //=======================================================================
214 //function : ResetAppliedAspect
215 //purpose  : Sets default values of GL parameters in accordance with default aspects
216 //=======================================================================
217 void OpenGl_Workspace::ResetAppliedAspect()
218 {
219   myGlContext->BindDefaultVao();
220
221   myHighlightStyle.Nullify();
222   myToAllowFaceCulling  = false;
223   myAspectsSet = &myDefaultAspects;
224   myAspectsApplied.Nullify();
225   myGlContext->SetPolygonOffset (Graphic3d_PolygonOffset());
226
227   ApplyAspects();
228   myGlContext->SetLineStipple(myDefaultAspects.Aspect()->LinePattern());
229   myGlContext->SetLineWidth  (myDefaultAspects.Aspect()->LineWidth());
230   if (myGlContext->core15fwd != NULL)
231   {
232     myGlContext->core15fwd->glActiveTexture (GL_TEXTURE0);
233   }
234 }
235
236 // =======================================================================
237 // function : SetDefaultPolygonOffset
238 // purpose  :
239 // =======================================================================
240 Graphic3d_PolygonOffset OpenGl_Workspace::SetDefaultPolygonOffset (const Graphic3d_PolygonOffset& theOffset)
241 {
242   Graphic3d_PolygonOffset aPrev = myDefaultAspects.Aspect()->PolygonOffset();
243   myDefaultAspects.Aspect()->SetPolygonOffset (theOffset);
244   if (myAspectsApplied == myDefaultAspects.Aspect()
245    || myAspectsApplied.IsNull()
246    || (myAspectsApplied->PolygonOffset().Mode & Aspect_POM_None) == Aspect_POM_None)
247   {
248     myGlContext->SetPolygonOffset (theOffset);
249   }
250   return aPrev;
251 }
252
253 // =======================================================================
254 // function : SetAspects
255 // purpose  :
256 // =======================================================================
257 const OpenGl_Aspects* OpenGl_Workspace::SetAspects (const OpenGl_Aspects* theAspect)
258 {
259   const OpenGl_Aspects* aPrevAspects = myAspectsSet;
260   myAspectsSet = theAspect;
261   return aPrevAspects;
262 }
263
264 // =======================================================================
265 // function : ApplyAspects
266 // purpose  :
267 // =======================================================================
268 const OpenGl_Aspects* OpenGl_Workspace::ApplyAspects (bool theToBindTextures)
269 {
270   bool toSuppressBackFaces = myView->BackfacingModel() == Graphic3d_TypeOfBackfacingModel_BackCulled;
271   if (myView->BackfacingModel() == Graphic3d_TypeOfBackfacingModel_Auto)
272   {
273     toSuppressBackFaces = myAspectsSet->Aspect()->FaceCulling() == Graphic3d_TypeOfBackfacingModel_BackCulled;
274     if (myAspectsSet->Aspect()->FaceCulling() == Graphic3d_TypeOfBackfacingModel_Auto
275      && myToAllowFaceCulling)
276     {
277       toSuppressBackFaces = true;
278       if (myAspectsSet->Aspect()->InteriorStyle() == Aspect_IS_HATCH
279        || myAspectsSet->Aspect()->AlphaMode() == Graphic3d_AlphaMode_Blend
280        || myAspectsSet->Aspect()->AlphaMode() == Graphic3d_AlphaMode_Mask
281        || myAspectsSet->Aspect()->AlphaMode() == Graphic3d_AlphaMode_MaskBlend
282        || (myAspectsSet->Aspect()->AlphaMode() == Graphic3d_AlphaMode_BlendAuto
283         && myAspectsSet->Aspect()->FrontMaterial().Transparency() != 0.0f))
284       {
285         // disable culling in case of translucent shading aspect
286         toSuppressBackFaces = false;
287       }
288     }
289   }
290   myGlContext->SetCullBackFaces (toSuppressBackFaces);
291
292   if (myAspectsSet->Aspect() == myAspectsApplied
293    && myHighlightStyle == myAspectFaceAppliedWithHL)
294   {
295     return myAspectsSet;
296   }
297   myAspectFaceAppliedWithHL = myHighlightStyle;
298
299   // Aspect_POM_None means: do not change current settings
300   if ((myAspectsSet->Aspect()->PolygonOffset().Mode & Aspect_POM_None) != Aspect_POM_None)
301   {
302     myGlContext->SetPolygonOffset (myAspectsSet->Aspect()->PolygonOffset());
303   }
304
305   const Aspect_InteriorStyle anIntstyle = myAspectsSet->Aspect()->InteriorStyle();
306   if (myAspectsApplied.IsNull()
307    || myAspectsApplied->InteriorStyle() != anIntstyle)
308   {
309   #if !defined(GL_ES_VERSION_2_0)
310     myGlContext->SetPolygonMode (anIntstyle == Aspect_IS_POINT ? GL_POINT : GL_FILL);
311     myGlContext->SetPolygonHatchEnabled (anIntstyle == Aspect_IS_HATCH);
312   #endif
313   }
314
315 #if !defined(GL_ES_VERSION_2_0)
316   if (anIntstyle == Aspect_IS_HATCH)
317   {
318     myGlContext->SetPolygonHatchStyle (myAspectsSet->Aspect()->HatchStyle());
319   }
320 #endif
321
322   // Case of hidden line
323   if (anIntstyle == Aspect_IS_HIDDENLINE)
324   {
325     // copy all values including line edge aspect
326     *myAspectFaceHl.Aspect() = *myAspectsSet->Aspect();
327     myAspectFaceHl.Aspect()->SetShadingModel (Graphic3d_TOSM_UNLIT);
328     myAspectFaceHl.Aspect()->SetInteriorColor (myView->BackgroundColor().GetRGB());
329     myAspectFaceHl.Aspect()->SetDistinguish (false);
330     myAspectFaceHl.SetNoLighting();
331     myAspectsSet = &myAspectFaceHl;
332   }
333   else
334   {
335     myGlContext->SetShadingMaterial (myAspectsSet, myHighlightStyle);
336   }
337
338   if (theToBindTextures)
339   {
340     const Handle(OpenGl_TextureSet)& aTextureSet = TextureSet();
341     myGlContext->BindTextures (aTextureSet, Handle(OpenGl_ShaderProgram)());
342   }
343
344   if ((myView->ShadingModel() == Graphic3d_TOSM_PBR
345     || myView->ShadingModel() == Graphic3d_TOSM_PBR_FACET)
346    && !myView->myPBREnvironment.IsNull()
347    &&  myView->myPBREnvironment->IsNeededToBeBound())
348   {
349     myView->myPBREnvironment->Bind (myGlContext);
350   }
351
352   myAspectsApplied = myAspectsSet->Aspect();
353   return myAspectsSet;
354 }
355
356 // =======================================================================
357 // function : Width
358 // purpose  :
359 // =======================================================================
360 Standard_Integer OpenGl_Workspace::Width()  const
361 {
362   return !myView->GlWindow().IsNull() ? myView->GlWindow()->Width() : 0;
363 }
364
365 // =======================================================================
366 // function : Height
367 // purpose  :
368 // =======================================================================
369 Standard_Integer OpenGl_Workspace::Height() const
370 {
371   return !myView->GlWindow().IsNull() ? myView->GlWindow()->Height() : 0;
372 }
373
374 // =======================================================================
375 // function : FBOCreate
376 // purpose  :
377 // =======================================================================
378 Handle(OpenGl_FrameBuffer) OpenGl_Workspace::FBOCreate (const Standard_Integer theWidth,
379                                                         const Standard_Integer theHeight)
380 {
381   // activate OpenGL context
382   if (!Activate())
383     return Handle(OpenGl_FrameBuffer)();
384
385   // create the FBO
386   const Handle(OpenGl_Context)& aCtx = GetGlContext();
387   aCtx->BindTextures (Handle(OpenGl_TextureSet)(), Handle(OpenGl_ShaderProgram)());
388   Handle(OpenGl_FrameBuffer) aFrameBuffer = new OpenGl_FrameBuffer();
389   if (!aFrameBuffer->Init (aCtx, theWidth, theHeight, GL_SRGB8_ALPHA8, GL_DEPTH24_STENCIL8, 0))
390   {
391     aFrameBuffer->Release (aCtx.operator->());
392     return Handle(OpenGl_FrameBuffer)();
393   }
394   return aFrameBuffer;
395 }
396
397 // =======================================================================
398 // function : FBORelease
399 // purpose  :
400 // =======================================================================
401 void OpenGl_Workspace::FBORelease (Handle(OpenGl_FrameBuffer)& theFbo)
402 {
403   // activate OpenGL context
404   if (!Activate()
405    || theFbo.IsNull())
406   {
407     return;
408   }
409
410   theFbo->Release (GetGlContext().operator->());
411   theFbo.Nullify();
412 }
413
414 // =======================================================================
415 // function : BufferDump
416 // purpose  :
417 // =======================================================================
418 Standard_Boolean OpenGl_Workspace::BufferDump (const Handle(OpenGl_FrameBuffer)& theFbo,
419                                                Image_PixMap&                     theImage,
420                                                const Graphic3d_BufferType&       theBufferType)
421 {
422   return !theImage.IsEmpty()
423       && Activate()
424       && OpenGl_FrameBuffer::BufferDump (GetGlContext(), theFbo, theImage, theBufferType);
425 }
426
427 // =======================================================================
428 // function : ShouldRender
429 // purpose  :
430 // =======================================================================
431 bool OpenGl_Workspace::ShouldRender (const OpenGl_Element* theElement,
432                                      const OpenGl_Group*   theGroup)
433 {
434   // render only non-raytracable elements when RayTracing is enabled
435   if ((myRenderFilter & OpenGl_RenderFilter_NonRaytraceableOnly) != 0)
436   {
437     if (!theGroup->HasPersistence() && OpenGl_Raytrace::IsRaytracedElement (theElement))
438     {
439       return false;
440     }
441   }
442   else if ((myRenderFilter & OpenGl_RenderFilter_FillModeOnly) != 0)
443   {
444     if (!theElement->IsFillDrawMode())
445     {
446       return false;
447     }
448   }
449
450   // handle opaque/transparency render passes
451   if ((myRenderFilter & OpenGl_RenderFilter_OpaqueOnly) != 0)
452   {
453     if (!theElement->IsFillDrawMode())
454     {
455       return true;
456     }
457
458     if (OpenGl_Context::CheckIsTransparent (myAspectsSet, myHighlightStyle))
459     {
460       ++myNbSkippedTranspElems;
461       return false;
462     }
463   }
464   else if ((myRenderFilter & OpenGl_RenderFilter_TransparentOnly) != 0)
465   {
466     if (!theElement->IsFillDrawMode())
467     {
468       if (dynamic_cast<const OpenGl_Aspects*> (theElement) == NULL)
469       {
470         return false;
471       }
472     }
473     else if (!OpenGl_Context::CheckIsTransparent (myAspectsSet, myHighlightStyle))
474     {
475       return false;
476     }
477   }
478   return true;
479 }
480
481 // =======================================================================
482 // function : DumpJson
483 // purpose  :
484 // =======================================================================
485 void OpenGl_Workspace::DumpJson (Standard_OStream& theOStream, Standard_Integer theDepth) const
486 {
487   OCCT_DUMP_TRANSIENT_CLASS_BEGIN (theOStream)
488
489   OCCT_DUMP_FIELD_VALUE_NUMERICAL (theOStream, myUseZBuffer)
490   OCCT_DUMP_FIELD_VALUE_NUMERICAL (theOStream, myUseDepthWrite)
491
492   OCCT_DUMP_FIELD_VALUES_DUMPED (theOStream, theDepth, &myNoneCulling)
493   OCCT_DUMP_FIELD_VALUES_DUMPED (theOStream, theDepth, &myFrontCulling)
494
495   OCCT_DUMP_FIELD_VALUE_NUMERICAL (theOStream, myNbSkippedTranspElems)
496   OCCT_DUMP_FIELD_VALUE_NUMERICAL (theOStream, myRenderFilter)
497
498   OCCT_DUMP_FIELD_VALUES_DUMPED (theOStream, theDepth, &myDefaultAspects)
499
500   OCCT_DUMP_FIELD_VALUES_DUMPED (theOStream, theDepth, myAspectsSet)
501   OCCT_DUMP_FIELD_VALUES_DUMPED (theOStream, theDepth, myAspectsApplied.get())
502
503   OCCT_DUMP_FIELD_VALUE_NUMERICAL (theOStream, myToAllowFaceCulling)
504
505   OCCT_DUMP_FIELD_VALUES_DUMPED (theOStream, theDepth, &myAspectFaceHl)
506 }