0023544: Texture management in TKOpenGl should be redesigned
[occt.git] / src / OpenGl / OpenGl_Workspace.hxx
index 7f2a00c..b49634b 100644 (file)
@@ -1,7 +1,21 @@
-// File:      OpenGl_Workspace.hxx
-// Created:   20 September 2011
-// Author:    Sergey ZERCHANINOV
-// Copyright: OPEN CASCADE 2011
+// Created on: 2011-09-20
+// Created by: Sergey ZERCHANINOV
+// Copyright (c) 2011-2012 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.
+//
+// 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.
+//
+// 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.
 
 #ifndef _OpenGl_Workspace_Header
 #define _OpenGl_Workspace_Header
 
 #include <TColStd_Array2OfReal.hxx>
 #include <Quantity_Color.hxx>
+#include <Graphic3d_CView.hxx>
 #include <Graphic3d_TypeOfComposition.hxx>
+#include <Graphic3d_TypeOfTexture.hxx>
+#include <Graphic3d_PtrFrameBuffer.hxx>
+#include <Graphic3d_BufferType.hxx>
+#include <Handle_Graphic3d_TextureParams.hxx>
 
-#include <Graphic3d_CView.hxx>
 #include <Aspect_CLayer2d.hxx>
 #include <Aspect_Handle.hxx>
 #include <Aspect_PrintAlgo.hxx>
-#include <Graphic3d_PtrFrameBuffer.hxx>
-#include <Image_CRawBufferData.hxx>
 
 #include <InterfaceGraphic_Graphic3d.hxx>
 #include <InterfaceGraphic_Visual3d.hxx>
 
 #include <OpenGl_tsm.hxx>
 
+#include <OpenGl_AspectFace.hxx>
 #include <OpenGl_Display.hxx>
 #include <OpenGl_Matrix.hxx>
 #include <OpenGl_NamedStatus.hxx>
 #include <OpenGl_TextParam.hxx>
 
 #include <Handle_OpenGl_View.hxx>
+#include <Handle_OpenGl_Texture.hxx>
 
 class OpenGl_AspectLine;
-class OpenGl_AspectFace;
 class OpenGl_AspectMarker;
 class OpenGl_AspectText;
 class OpenGl_FrameBuffer;
 class OpenGl_Structure;
+class Image_PixMap;
 
 //! Reprepsents window with GL context.
 //! Provides methods to render primitives and maintan GL state.
@@ -48,7 +66,8 @@ public:
   //! Main constructor - prepare GL context for specified window.
   OpenGl_Workspace (const Handle(OpenGl_Display)& theDisplay,
                     const CALL_DEF_WINDOW&        theCWindow,
-                    Aspect_RenderingContext       theGContext);
+                    Aspect_RenderingContext       theGContext,
+                    const Handle(OpenGl_Context)& theShareCtx);
 
   //! Destructor
   virtual ~OpenGl_Workspace();
@@ -61,19 +80,18 @@ public:
                const Aspect_CLayer2d& theCUnderLayer,
                const Aspect_CLayer2d& theCOverLayer);
 
-  //! Redraw window only if needed.
+  //! Deprecated. Simply calls Redraw().
   void Update (const Graphic3d_CView& theCView,
                const Aspect_CLayer2d& theCUnderLayer,
                const Aspect_CLayer2d& theCOverLayer)
   {
-    if (!myIsUpdated)
-      Redraw (theCView, theCUnderLayer, theCOverLayer);
+    Redraw (theCView, theCUnderLayer, theCOverLayer);
   }
 
   //! Special method to perform printing.
   //! System-specific and currently only Win platform implemented.
-  Standard_Boolean Print (const Graphic3d_CView& theCView, 
-                          const Aspect_CLayer2d& theCUnderLayer, 
+  Standard_Boolean Print (const Graphic3d_CView& theCView,
+                          const Aspect_CLayer2d& theCUnderLayer,
                           const Aspect_CLayer2d& theCOverLayer,
                           const Aspect_Handle    theHPrintDC,
                           const Standard_Boolean theToShowBackground,
@@ -85,7 +103,7 @@ public:
 
   // szvgl: defined in OpenGl_Workspace_1.cxx
   void BeginAnimation (const Standard_Boolean theUseDegeneration,
-                       const Standard_Boolean theUpdateAM); 
+                       const Standard_Boolean theUpdateAM);
   void EndAnimation();
   void EraseAnimation();
 
@@ -112,10 +130,9 @@ public:
 
   Graphic3d_PtrFrameBuffer FBOCreate (const Standard_Integer theWidth, const Standard_Integer theHeight);
   void FBORelease (Graphic3d_PtrFrameBuffer theFBOPtr);
-  Standard_Boolean BufferDump (OpenGl_FrameBuffer *theFBOPtr, Image_CRawBufferData& theBuffer);
-
-  //! Mark this window to be redrawn on next update.
-  void Invalidate() { myIsUpdated = Standard_False; }
+  Standard_Boolean BufferDump (OpenGl_FrameBuffer*         theFBOPtr,
+                               Image_PixMap&               theImage,
+                               const Graphic3d_BufferType& theBufferType);
 
   void UseTransparency (const Standard_Boolean theFlag);
   Standard_Boolean& UseZBuffer()   { return myUseZBuffer; }
@@ -141,21 +158,26 @@ public:
 
   void SetTextParam (const OpenGl_TextParam* theParam) { TextParam_set = theParam; }
 
-  const OpenGl_AspectLine*   AspectLine   (const Standard_Boolean theWithApply);
-  const OpenGl_AspectFace*   AspectFace   (const Standard_Boolean theWithApply);
-  const OpenGl_AspectMarker* AspectMarker (const Standard_Boolean theWithApply);
-  const OpenGl_AspectText*   AspectText   (const Standard_Boolean theWithApply);
+  //// THESE METHODS ARE EXPORTED AS THEY PROVIDE STATE INFO TO USERDRAW
+  Standard_EXPORT const OpenGl_AspectLine*   AspectLine   (const Standard_Boolean theWithApply);
+  Standard_EXPORT const OpenGl_AspectFace*   AspectFace   (const Standard_Boolean theWithApply);
+  Standard_EXPORT const OpenGl_AspectMarker* AspectMarker (const Standard_Boolean theWithApply);
+  Standard_EXPORT const OpenGl_AspectText*   AspectText   (const Standard_Boolean theWithApply);
 
   //! Clear the applied aspect state.
   void ResetAppliedAspect();
 
+  Standard_EXPORT Handle(OpenGl_Texture) DisableTexture();
+  Standard_EXPORT Handle(OpenGl_Texture) EnableTexture (const Handle(OpenGl_Texture)&          theTexture,
+                                                        const Handle(Graphic3d_TextureParams)& theParams = NULL);
+
   //// RELATED TO FONTS ////
 
-  int FindFont (const char*          theFontName,
-                const OSD_FontAspect theFontAspect,
-                const int            theBestSize = -1,
-                const float          theXScale = 1.0f,
-                const float          theYScale = 1.0f)
+  int FindFont (const char*           theFontName,
+                const Font_FontAspect theFontAspect,
+                const int             theBestSize = -1,
+                const float           theXScale = 1.0f,
+                const float           theYScale = 1.0f)
   {
     return myDisplay->FindFont (theFontName, theFontAspect, theBestSize, theXScale, theYScale);
   }
@@ -182,29 +204,32 @@ protected:
   virtual Standard_Boolean Activate();
 
   // TEMPORARY!!!
-  void Redraw1 (const Graphic3d_CView& theCView, 
-                const Aspect_CLayer2d& theCUnderLayer, 
+  void Redraw1 (const Graphic3d_CView& theCView,
+                const Aspect_CLayer2d& theCUnderLayer,
                 const Aspect_CLayer2d& theCOverLayer,
                 const int theToSwap);
 
-protected:
+  void UpdateMaterial (const int flag);
 
-  Handle(OpenGl_View) myView;            // WSViews - now just one view is supported
-  Standard_Boolean    myIsUpdated;       // WSUpdateState
-  Tint                myTransientList;   // WSTransient
-  Standard_Boolean    myIsTransientOpen; // transientOpen
-  Tint                myRetainMode;      // WSRetainMode
+  void setTextureParams (Handle(OpenGl_Texture)&                theTexture,
+                         const Handle(Graphic3d_TextureParams)& theParams);
 
-  Standard_Boolean    myUseTransparency;
-  Standard_Boolean    myUseZBuffer;
-  Standard_Boolean    myUseDepthTest;
-  Standard_Boolean    myUseGLLight;
-  Standard_Boolean    myBackBufferRestored;
+protected: //! @name protected fields
 
-  //// RELATED TO STATUS ////
+  Handle(OpenGl_View)    myView;            // WSViews - now just one view is supported
+  Tint                   myTransientList;   // WSTransient
+  Standard_Boolean       myIsTransientOpen; // transientOpen
+  Tint                   myRetainMode;      // WSRetainMode
 
-  void UpdateMaterial (const int flag);
+  Standard_Boolean       myUseTransparency;
+  Standard_Boolean       myUseZBuffer;
+  Standard_Boolean       myUseDepthTest;
+  Standard_Boolean       myUseGLLight;
+  Standard_Boolean       myBackBufferRestored;
 
+protected: //! @name fields related to status
+
+  Handle(OpenGl_Texture) myTextureBound;    //!< currently bound texture (managed by OpenGl_AspectFace and OpenGl_View environment texture)
   const OpenGl_AspectLine *AspectLine_set, *AspectLine_applied;
   const OpenGl_AspectFace *AspectFace_set, *AspectFace_applied;
   const OpenGl_AspectMarker *AspectMarker_set, *AspectMarker_applied;
@@ -217,11 +242,13 @@ protected:
 
   const TEL_POFFSET_PARAM* PolygonOffset_applied;
 
-public:
+  OpenGl_AspectFace myAspectFaceHl; // Hiddenline aspect
+
+public: //! @name type definition
 
-  DEFINE_STANDARD_RTTI(OpenGl_Workspace) // Type definition
+  DEFINE_STANDARD_RTTI(OpenGl_Workspace)
   DEFINE_STANDARD_ALLOC
 
 };
 
-#endif //_OpenGl_Workspace_Header
+#endif // _OpenGl_Workspace_Header