0030153: Visualization, TKOpenGl - AIS_ColoredShape::SynchronizeAspects() doesn't...
[occt.git] / src / OpenGl / OpenGl_AspectFace.hxx
index b511d55..8d93a11 100644 (file)
 // Created on: 2011-07-13
 // Created by: Sergey ZERCHANINOV
-// Copyright (c) 2011-2012 OPEN CASCADE SAS
+// Copyright (c) 2011-2014 OPEN CASCADE SAS
 //
-// The content of this file is subject to the Open CASCADE Technology Public
-// License Version 6.5 (the "License"). You may not use the content of this file
-// except in compliance with the License. Please obtain a copy of the License
-// at http://www.opencascade.org and read it completely before using this file.
+// This file is part of Open CASCADE Technology software library.
 //
-// The Initial Developer of the Original Code is Open CASCADE S.A.S., having its
-// main offices at: 1, place des Freres Montgolfier, 78280 Guyancourt, France.
+// This library is free software; you can redistribute it and/or modify it under
+// the terms of the GNU Lesser General Public License version 2.1 as published
+// by the Free Software Foundation, with special exception defined in the file
+// OCCT_LGPL_EXCEPTION.txt. Consult the file LICENSE_LGPL_21.txt included in OCCT
+// distribution for complete text of the license and disclaimer of any warranty.
 //
-// The Original Code and all software distributed under the License is
-// distributed on an "AS IS" basis, without warranty of any kind, and the
-// Initial Developer hereby disclaims all such warranties, including without
-// limitation, any warranties of merchantability, fitness for a particular
-// purpose or non-infringement. Please see the License for the specific terms
-// and conditions governing the rights and limitations under the License.
+// Alternatively, this file may be used under the terms of Open CASCADE
+// commercial license or contractual agreement.
 
 #ifndef _OpenGl_AspectFace_Header
 #define _OpenGl_AspectFace_Header
 
-#include <InterfaceGraphic_telem.hxx>
-#include <Aspect_InteriorStyle.hxx>
-#include <TCollection_AsciiString.hxx>
-
-#include <Handle_Graphic3d_TextureParams.hxx>
-#include <Handle_OpenGl_ShaderProgram.hxx>
-#include <Handle_OpenGl_Texture.hxx>
 #include <OpenGl_AspectLine.hxx>
-#include <OpenGl_Element.hxx>
-
+#include <OpenGl_TextureSet.hxx>
 #include <Graphic3d_AspectFillArea3d.hxx>
-#include <Graphic3d_ShaderProgram_Handle.hxx>
+#include <Graphic3d_ShaderProgram.hxx>
 #include <Graphic3d_TextureMap.hxx>
+#include <Graphic3d_BSDF.hxx>
 
-#define OPENGL_AMBIENT_MASK  (1<<0)
-#define OPENGL_DIFFUSE_MASK  (1<<1)
-#define OPENGL_SPECULAR_MASK (1<<2)
-#define OPENGL_EMISSIVE_MASK (1<<3)
-
-class CALL_DEF_CONTEXTFILLAREA;
-
-struct OPENGL_SURF_PROP
-{
-  float        amb, diff, spec, emsv;
-  float        trans, shine;
-  float        env_reflexion;
-  int          isphysic;
-  unsigned int color_mask;
-  TEL_COLOUR speccol, difcol, ambcol, emscol, matcol;
-  DEFINE_STANDARD_ALLOC
-};
+class OpenGl_Texture;
 
+//! The element holding Graphic3d_AspectFillArea3d.
 class OpenGl_AspectFace : public OpenGl_Element
 {
 
 public:
 
-  OpenGl_AspectFace();
-
-  //! Copy parameters
-  void SetAspect (const CALL_DEF_CONTEXTFILLAREA& theAspect);
-  void SetAspect (const Handle(Graphic3d_AspectFillArea3d)& theAspect);
-
-  //! Set edge aspect.
-  void SetAspectEdge (const OpenGl_AspectLine* theAspectEdge)
-  {
-    myAspectEdge = *theAspectEdge;
-  }
-
-  //! @return edge aspect.
-  const OpenGl_AspectLine* AspectEdge() const 
-  {
-    return &myAspectEdge;
-  }
-
-  //! @return interior style
-  const Aspect_InteriorStyle InteriorStyle() const
-  {
-    return myInteriorStyle;
-  }
-
-  Aspect_InteriorStyle& ChangeInteriorStyle()
-  {
-    return myInteriorStyle;
-  }
-
-  //! @return edge on flag.
-  int Edge() const
-  {
-    return myEdge;
-  }
+  //! Empty constructor.
+  Standard_EXPORT OpenGl_AspectFace();
 
-  //! @return edge on flag.
-  int& ChangeEdge()
-  {
-    return myEdge;
-  }
+  //! Create and assign parameters.
+  Standard_EXPORT OpenGl_AspectFace (const Handle(Graphic3d_AspectFillArea3d)& theAspect);
 
-  //! @return hatch type.
-  int Hatch() const
-  {
-    return myHatch;
-  }
+  //! Return aspect.
+  const Handle(Graphic3d_AspectFillArea3d)& Aspect() const { return myAspect; }
 
-  //! @return hatch type variable.
-  int& ChangeHatch()
-  {
-    return myHatch;
-  }
+  //! Assign parameters.
+  Standard_EXPORT void SetAspect (const Handle(Graphic3d_AspectFillArea3d)& theAspect);
 
-  //! @return distinguishing mode.
-  int DistinguishingMode() const
-  {
-    return myDistinguishingMode;
-  }
-
-  //! @return distinguishing mode.
-  int& ChangeDistinguishingMode()
-  {
-    return myDistinguishingMode;
-  }
-
-  //! @return culling mode.
-  int CullingMode() const
-  {
-    return myCullingMode;
-  }
-
-  //! @return culling mode.
-  int& ChangeCullingMode()
-  {
-    return myCullingMode;
-  }
-
-  //! @return front material properties.
-  const OPENGL_SURF_PROP& IntFront() const
-  {
-    return myIntFront;
-  }
-
-  //! @return front material properties.
-  OPENGL_SURF_PROP& ChangeIntFront()
-  {
-    return myIntFront;
-  }
-
-  //! @return back material properties.
-  const OPENGL_SURF_PROP& IntBack() const
-  {
-    return myIntBack;
-  }
-
-  //! @return back material properties.
-  OPENGL_SURF_PROP& ChangeIntBack()
-  {
-    return myIntBack;
-  }
-
-  //! @return polygon offset parameters.
-  const TEL_POFFSET_PARAM& PolygonOffset() const
-  {
-    return myPolygonOffset;
-  }
-
-  //! @return polygon offset parameters.
-  TEL_POFFSET_PARAM& ChangePolygonOffset()
-  {
-    return myPolygonOffset;
-  }
+  //! Set edge aspect.
+  void SetAspectEdge (const OpenGl_AspectLine* theAspectEdge) { myAspectEdge = *theAspectEdge; }
 
-  //! @return texture mapping flag.
-  bool DoTextureMap() const
-  {
-    return myDoTextureMap;
-  }
+  //! @return edge aspect.
+  const OpenGl_AspectLine* AspectEdge() const  { return &myAspectEdge; }
 
-  //! @return texture mapping flag.
-  bool& ChangeDoTextureMap()
-  {
-    return myDoTextureMap;
-  }
+  //! Returns Shading Model.
+  Graphic3d_TypeOfShadingModel ShadingModel() const { return myShadingModel; }
 
-  //! @return texture mapping parameters.
-  const Handle(Graphic3d_TextureParams)& TextureParams() const
-  {
-    return myTexture->GetParams();
-  }
+  //! Set if lighting should be disabled or not.
+  void SetNoLighting() { myShadingModel = Graphic3d_TOSM_UNLIT; }
 
-  //! @return texture map.
-  const Handle(OpenGl_Texture)& TextureRes (const Handle(OpenGl_Workspace)& theWorkspace) const
+  //! Returns textures map.
+  const Handle(OpenGl_TextureSet)& TextureSet (const Handle(OpenGl_Context)& theCtx) const
   {
     if (!myResources.IsTextureReady())
     {
-      myResources.BuildTexture (theWorkspace, myTexture);
+      myResources.BuildTextures (theCtx, myAspect->TextureSet());
       myResources.SetTextureReady();
     }
-
-    return myResources.Texture;
+    return myResources.TextureSet();
   }
 
   //! Init and return OpenGl shader program resource.
   //! @return shader program resource.
-  const Handle(OpenGl_ShaderProgram)& ShaderProgramRes (const Handle(OpenGl_Workspace)& theWorkspace) const 
+  const Handle(OpenGl_ShaderProgram)& ShaderProgramRes (const Handle(OpenGl_Context)& theCtx) const
   {
     if (!myResources.IsShaderReady())
     {
-      myResources.BuildShader (theWorkspace, myShaderProgram);
+      myResources.BuildShader (theCtx, myAspect->ShaderProgram());
       myResources.SetShaderReady();
     }
 
     return myResources.ShaderProgram;
   }
 
-  virtual void Render  (const Handle(OpenGl_Workspace)& theWorkspace) const;
-  virtual void Release (const Handle(OpenGl_Context)&   theContext);
-
-protected:
-
-  void convertMaterial (const CALL_DEF_MATERIAL& theMat,
-                        OPENGL_SURF_PROP&        theSurf);
-
-protected: //! @name ordinary aspect properties
+  Standard_EXPORT virtual void Render  (const Handle(OpenGl_Workspace)& theWorkspace) const Standard_OVERRIDE;
+  Standard_EXPORT virtual void Release (OpenGl_Context* theContext) Standard_OVERRIDE;
 
-  Aspect_InteriorStyle            myInteriorStyle;
-  int                             myEdge;
-  int                             myHatch;
-  int                             myDistinguishingMode;
-  int                             myCullingMode;
-  OPENGL_SURF_PROP                myIntFront;
-  OPENGL_SURF_PROP                myIntBack;
-  TEL_POFFSET_PARAM               myPolygonOffset;
-  bool                            myDoTextureMap;
-  Handle(Graphic3d_TextureMap)    myTexture;
-  Handle(Graphic3d_ShaderProgram) myShaderProgram;
+  //! Update presentation aspects parameters after their modification.
+  virtual void SynchronizeAspects() Standard_OVERRIDE { SetAspect (myAspect); }
 
 protected:
 
@@ -241,35 +91,57 @@ protected:
   mutable struct Resources
   {
   public:
+    //! Empty constructor.
     Resources()
-      : myIsTextureReady (Standard_False),
-        myIsShaderReady  (Standard_False) {}
+    : myIsTextureReady (Standard_False),
+      myIsShaderReady  (Standard_False) {}
 
+    //! Return TRUE if texture resource is up-to-date.
     Standard_Boolean IsTextureReady() const { return myIsTextureReady; }
+
+    //! Return TRUE if shader resource is up-to-date.
     Standard_Boolean IsShaderReady () const { return myIsShaderReady;  }
+
+    //! Set texture resource up-to-date state.
     void SetTextureReady() { myIsTextureReady = Standard_True; }
+
+    //! Set shader resource up-to-date state.
     void SetShaderReady () { myIsShaderReady  = Standard_True; }
-    void ResetTextureReadiness() { myIsTextureReady = Standard_False; }
+
+    //! Reset shader resource up-to-date state.
     void ResetShaderReadiness () { myIsShaderReady  = Standard_False; }
 
-    void BuildTexture (const Handle(OpenGl_Workspace)& theWS, const Handle(Graphic3d_TextureMap)& theTexture);
-    void BuildShader  (const Handle(OpenGl_Workspace)& theWS, const Handle(Graphic3d_ShaderProgram)& theShader);
+    //! Return textures array.
+    const Handle(OpenGl_TextureSet)& TextureSet() const { return myTextures; }
+
+    //! Update texture resource up-to-date state.
+    Standard_EXPORT void UpdateTexturesRediness (const Handle(Graphic3d_TextureSet)& theTextures);
+
+    //! Build texture resource.
+    Standard_EXPORT void BuildTextures (const Handle(OpenGl_Context)& theCtx,
+                                        const Handle(Graphic3d_TextureSet)& theTextures);
+
+    //! Build shader resource.
+    Standard_EXPORT void BuildShader  (const Handle(OpenGl_Context)&          theCtx,
+                                       const Handle(Graphic3d_ShaderProgram)& theShader);
+
+    //! Release texture resource.
+    Standard_EXPORT void ReleaseTextures (OpenGl_Context* theCtx);
 
-    Handle(OpenGl_Texture)  Texture;
-    TCollection_AsciiString TextureId;
     Handle(OpenGl_ShaderProgram) ShaderProgram;
     TCollection_AsciiString      ShaderProgramId;
 
   private:
 
+    Handle(OpenGl_TextureSet) myTextures;
     Standard_Boolean myIsTextureReady;
     Standard_Boolean myIsShaderReady;
 
   } myResources;
 
-protected:
-
-  OpenGl_AspectLine               myAspectEdge;
+  Handle(Graphic3d_AspectFillArea3d) myAspect;
+  OpenGl_AspectLine                  myAspectEdge;
+  Graphic3d_TypeOfShadingModel       myShadingModel;
 
 public: