src/OpenGl/OpenGl_Workspace.hxx

   1 // Created on: 2011-09-20
   2 // Created by: Sergey ZERCHANINOV
   3 // Copyright (c) 2011-2013 OPEN CASCADE SAS
   4 //
   5 // The content of this file is subject to the Open CASCADE Technology Public
   6 // License Version 6.5 (the "License"). You may not use the content of this file
   7 // except in compliance with the License. Please obtain a copy of the License
   8 // at http://www.opencascade.org and read it completely before using this file.
   9 //
  10 // The Initial Developer of the Original Code is Open CASCADE S.A.S., having its
  11 // main offices at: 1, place des Freres Montgolfier, 78280 Guyancourt, France.
  12 //
  13 // The Original Code and all software distributed under the License is
  14 // distributed on an "AS IS" basis, without warranty of any kind, and the
  15 // Initial Developer hereby disclaims all such warranties, including without
  16 // limitation, any warranties of merchantability, fitness for a particular
  17 // purpose or non-infringement. Please see the License for the specific terms
  18 // and conditions governing the rights and limitations under the License.
  19
  20 #ifndef _OpenGl_Workspace_Header
  21 #define _OpenGl_Workspace_Header
  22
  23 #include <Handle_OpenGl_Workspace.hxx>
  24 #include <OpenGl_Window.hxx>
  25
  26 #include <TColStd_Array2OfReal.hxx>
  27 #include <Quantity_Color.hxx>
  28 #include <Graphic3d_CView.hxx>
  29 #include <Graphic3d_TypeOfComposition.hxx>
  30 #include <Graphic3d_TypeOfTexture.hxx>
  31 #include <Graphic3d_PtrFrameBuffer.hxx>
  32 #include <Graphic3d_BufferType.hxx>
  33 #include <Handle_Graphic3d_TextureParams.hxx>
  34
  35 #include <Aspect_CLayer2d.hxx>
  36 #include <Aspect_Handle.hxx>
  37 #include <Aspect_PrintAlgo.hxx>
  38
  39 #include <InterfaceGraphic_Graphic3d.hxx>
  40 #include <InterfaceGraphic_Visual3d.hxx>
  41
  42 #include <NCollection_Sequence.hxx>
  43
  44 #include <OpenGl_tsm.hxx>
  45
  46 #include <OpenGl_AspectFace.hxx>
  47 #include <OpenGl_Display.hxx>
  48 #include <OpenGl_Matrix.hxx>
  49 #include <OpenGl_NamedStatus.hxx>
  50 #include <OpenGl_PrinterContext.hxx>
  51 #include <OpenGl_TextParam.hxx>
  52
  53 #include <Handle_OpenGl_View.hxx>
  54 #include <Handle_OpenGl_Texture.hxx>
  55
  56 class OpenGl_AspectLine;
  57 class OpenGl_AspectMarker;
  58 class OpenGl_AspectText;
  59 class OpenGl_FrameBuffer;
  60 class OpenGl_Structure;
  61 class Image_PixMap;
  62
  63 //! Reprepsents window with GL context.
  64 //! Provides methods to render primitives and maintan GL state.
  65 class OpenGl_Workspace : public OpenGl_Window
  66 {
  67 public:
  68
  69   //! Main constructor - prepare GL context for specified window.
  70   OpenGl_Workspace (const Handle(OpenGl_Display)& theDisplay,
  71                     const CALL_DEF_WINDOW&        theCWindow,
  72                     Aspect_RenderingContext       theGContext,
  73                     const Handle(OpenGl_Context)& theShareCtx);
  74
  75   //! Destructor
  76   virtual ~OpenGl_Workspace();
  77
  78   void SetActiveView (const Handle(OpenGl_View)& theView) { myView = theView; }
  79   const Handle(OpenGl_View)& ActiveView () const { return myView; }
  80
  81   //! Redraw the window.
  82   void Redraw (const Graphic3d_CView& theCView,
  83                const Aspect_CLayer2d& theCUnderLayer,
  84                const Aspect_CLayer2d& theCOverLayer);
  85
  86   //! Deprecated. Simply calls Redraw().
  87   void Update (const Graphic3d_CView& theCView,
  88                const Aspect_CLayer2d& theCUnderLayer,
  89                const Aspect_CLayer2d& theCOverLayer)
  90   {
  91     Redraw (theCView, theCUnderLayer, theCOverLayer);
  92   }
  93
  94   //! Special method to perform printing.
  95   //! System-specific and currently only Win platform implemented.
  96   Standard_Boolean Print (const Handle(OpenGl_PrinterContext)& thePrintContext,
  97                           const Graphic3d_CView& theCView,
  98                           const Aspect_CLayer2d& theCUnderLayer,
  99                           const Aspect_CLayer2d& theCOverLayer,
 100                           const Aspect_Handle    theHPrintDC,
 101                           const Standard_Boolean theToShowBackground,
 102                           const Standard_CString theFileName,
 103                           const Aspect_PrintAlgo thePrintAlgorithm,
 104                           const Standard_Real    theScaleFactor);
 105
 106   const Handle(OpenGl_PrinterContext)& PrinterContext() const
 107   {
 108     return myPrintContext;
 109   }
 110
 111   void DisplayCallback (const Graphic3d_CView& theCView, int theReason);
 112
 113   Standard_Boolean SetImmediateModeDrawToFront (const Standard_Boolean theDrawToFrontBuffer);
 114   Standard_Boolean BeginAddMode();
 115   void EndAddMode();
 116   void ClearImmediatMode (const Graphic3d_CView& theCView,
 117                           const Standard_Boolean theToFlush);
 118   void RedrawImmediatMode();
 119   Standard_Boolean BeginImmediatMode (const Graphic3d_CView& theCView,
 120                                       const Standard_Boolean theUseDepthTest,
 121                                       const Standard_Boolean theRetainMode);
 122   void EndImmediatMode();
 123   void DrawStructure (const OpenGl_Structure* theStructure);
 124
 125   Graphic3d_PtrFrameBuffer FBOCreate (const Standard_Integer theWidth, const Standard_Integer theHeight);
 126   void FBORelease (Graphic3d_PtrFrameBuffer theFBOPtr);
 127   Standard_Boolean BufferDump (OpenGl_FrameBuffer*         theFBOPtr,
 128                                Image_PixMap&               theImage,
 129                                const Graphic3d_BufferType& theBufferType);
 130
 131   void UseTransparency (const Standard_Boolean theFlag);
 132   Standard_Boolean& UseZBuffer()   { return myUseZBuffer; }
 133   Standard_Boolean& UseDepthTest() { return myUseDepthTest; }
 134   Standard_Boolean& UseGLLight()   { return myUseGLLight; }
 135
 136   //// RELATED TO STATUS ////
 137
 138   Standard_Integer   NamedStatus;
 139
 140   const TEL_COLOUR* HighlightColor;
 141
 142   const OpenGl_Matrix* SetViewMatrix (const OpenGl_Matrix* );
 143   const OpenGl_Matrix* SetStructureMatrix (const OpenGl_Matrix* );
 144
 145   const OpenGl_AspectLine*   SetAspectLine   (const OpenGl_AspectLine*   theAspect);
 146   const OpenGl_AspectFace*   SetAspectFace   (const OpenGl_AspectFace*   theAspect);
 147   const OpenGl_AspectMarker* SetAspectMarker (const OpenGl_AspectMarker* theAspect);
 148   const OpenGl_AspectText*   SetAspectText   (const OpenGl_AspectText*   theAspect);
 149
 150   void SetTextParam (const OpenGl_TextParam* theParam) { TextParam_set = theParam; }
 151
 152   //// THESE METHODS ARE EXPORTED AS THEY PROVIDE STATE INFO TO USERDRAW
 153   Standard_EXPORT const OpenGl_AspectLine*   AspectLine   (const Standard_Boolean theWithApply);
 154   Standard_EXPORT const OpenGl_AspectFace*   AspectFace   (const Standard_Boolean theWithApply);
 155   Standard_EXPORT const OpenGl_AspectMarker* AspectMarker (const Standard_Boolean theWithApply);
 156   Standard_EXPORT const OpenGl_AspectText*   AspectText   (const Standard_Boolean theWithApply);
 157   inline const OpenGl_TextParam* AspectTextParams() const
 158   {
 159     return TextParam_applied;
 160   }
 161
 162   //! Clear the applied aspect state.
 163   void ResetAppliedAspect();
 164
 165   Standard_EXPORT Handle(OpenGl_Texture) DisableTexture();
 166   Standard_EXPORT Handle(OpenGl_Texture) EnableTexture (const Handle(OpenGl_Texture)&          theTexture,
 167                                                         const Handle(Graphic3d_TextureParams)& theParams = NULL);
 168
 169 protected:
 170
 171   void CopyBuffers (const Standard_Boolean theFrontToBack);
 172
 173   virtual Standard_Boolean Activate();
 174
 175   // TEMPORARY!!!
 176   void Redraw1 (const Graphic3d_CView& theCView,
 177                 const Aspect_CLayer2d& theCUnderLayer,
 178                 const Aspect_CLayer2d& theCOverLayer,
 179                 const int theToSwap);
 180
 181   void UpdateMaterial (const int flag);
 182
 183   void setTextureParams (Handle(OpenGl_Texture)&                theTexture,
 184                          const Handle(Graphic3d_TextureParams)& theParams);
 185
 186 protected: //! @name protected fields
 187
 188   Handle(OpenGl_PrinterContext) myPrintContext;
 189   Handle(OpenGl_View)    myView;            // WSViews - now just one view is supported
 190   Standard_Boolean       myIsTransientOpen; // transientOpen
 191   Standard_Boolean       myRetainMode;
 192   Standard_Boolean       myTransientDrawToFront; //!< optimization flag for immediate mode (to render directly to the front buffer)
 193
 194   NCollection_Sequence<const OpenGl_Structure*> myTransientList;
 195
 196   Standard_Boolean       myUseTransparency;
 197   Standard_Boolean       myUseZBuffer;
 198   Standard_Boolean       myUseDepthTest;
 199   Standard_Boolean       myUseGLLight;
 200   Standard_Boolean       myBackBufferRestored;
 201
 202 protected: //! @name fields related to status
 203
 204   Handle(OpenGl_Texture) myTextureBound;    //!< currently bound texture (managed by OpenGl_AspectFace and OpenGl_View environment texture)
 205   const OpenGl_AspectLine *AspectLine_set, *AspectLine_applied;
 206   const OpenGl_AspectFace *AspectFace_set, *AspectFace_applied;
 207   const OpenGl_AspectMarker *AspectMarker_set, *AspectMarker_applied;
 208   const OpenGl_AspectText *AspectText_set, *AspectText_applied;
 209
 210   const OpenGl_TextParam *TextParam_set, *TextParam_applied;
 211
 212   const OpenGl_Matrix* ViewMatrix_applied;
 213   const OpenGl_Matrix* StructureMatrix_applied;
 214
 215   const TEL_POFFSET_PARAM* PolygonOffset_applied;
 216
 217   OpenGl_AspectFace myAspectFaceHl; // Hiddenline aspect
 218
 219 public: //! @name type definition
 220
 221   DEFINE_STANDARD_RTTI(OpenGl_Workspace)
 222   DEFINE_STANDARD_ALLOC
 223
 224 };
 225
 226 #endif // _OpenGl_Workspace_Header