351127a9b00fe2ef3b154db108fcad84f9e72cb7
[occt.git] / 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_Caps)&    theCaps,
74                     const Handle(OpenGl_Context)& theShareCtx);
75
76   //! Destructor
77   virtual ~OpenGl_Workspace();
78
79   void SetActiveView (const Handle(OpenGl_View)& theView) { myView = theView; }
80   const Handle(OpenGl_View)& ActiveView () const { return myView; }
81
82   //! Redraw the window.
83   void Redraw (const Graphic3d_CView& theCView,
84                const Aspect_CLayer2d& theCUnderLayer,
85                const Aspect_CLayer2d& theCOverLayer);
86
87   //! Deprecated. Simply calls Redraw().
88   void Update (const Graphic3d_CView& theCView,
89                const Aspect_CLayer2d& theCUnderLayer,
90                const Aspect_CLayer2d& theCOverLayer)
91   {
92     Redraw (theCView, theCUnderLayer, theCOverLayer);
93   }
94
95   //! Special method to perform printing.
96   //! System-specific and currently only Win platform implemented.
97   Standard_Boolean Print (const Handle(OpenGl_PrinterContext)& thePrintContext,
98                           const Graphic3d_CView& theCView,
99                           const Aspect_CLayer2d& theCUnderLayer,
100                           const Aspect_CLayer2d& theCOverLayer,
101                           const Aspect_Handle    theHPrintDC,
102                           const Standard_Boolean theToShowBackground,
103                           const Standard_CString theFileName,
104                           const Aspect_PrintAlgo thePrintAlgorithm,
105                           const Standard_Real    theScaleFactor);
106
107   const Handle(OpenGl_PrinterContext)& PrinterContext() const
108   {
109     return myPrintContext;
110   }
111
112   void DisplayCallback (const Graphic3d_CView& theCView, int theReason);
113
114   Standard_Boolean SetImmediateModeDrawToFront (const Standard_Boolean theDrawToFrontBuffer);
115   Standard_Boolean BeginAddMode();
116   void EndAddMode();
117   void ClearImmediatMode (const Graphic3d_CView& theCView,
118                           const Standard_Boolean theToFlush);
119   void RedrawImmediatMode();
120   Standard_Boolean BeginImmediatMode (const Graphic3d_CView& theCView,
121                                       const Standard_Boolean theUseDepthTest,
122                                       const Standard_Boolean theRetainMode);
123   void EndImmediatMode();
124   void DrawStructure (const OpenGl_Structure* theStructure);
125
126   Graphic3d_PtrFrameBuffer FBOCreate (const Standard_Integer theWidth, const Standard_Integer theHeight);
127   void FBORelease (Graphic3d_PtrFrameBuffer theFBOPtr);
128   Standard_Boolean BufferDump (OpenGl_FrameBuffer*         theFBOPtr,
129                                Image_PixMap&               theImage,
130                                const Graphic3d_BufferType& theBufferType);
131
132   void UseTransparency (const Standard_Boolean theFlag);
133   Standard_Boolean& UseZBuffer()   { return myUseZBuffer; }
134   Standard_Boolean& UseDepthTest() { return myUseDepthTest; }
135   Standard_Boolean& UseGLLight()   { return myUseGLLight; }
136
137   //// RELATED TO STATUS ////
138
139   Standard_Integer   NamedStatus;
140
141   const TEL_COLOUR* HighlightColor;
142
143   const OpenGl_Matrix* SetViewMatrix (const OpenGl_Matrix* );
144   const OpenGl_Matrix* SetStructureMatrix (const OpenGl_Matrix* );
145
146   const OpenGl_AspectLine*   SetAspectLine   (const OpenGl_AspectLine*   theAspect);
147   const OpenGl_AspectFace*   SetAspectFace   (const OpenGl_AspectFace*   theAspect);
148   const OpenGl_AspectMarker* SetAspectMarker (const OpenGl_AspectMarker* theAspect);
149   const OpenGl_AspectText*   SetAspectText   (const OpenGl_AspectText*   theAspect);
150
151   void SetTextParam (const OpenGl_TextParam* theParam) { TextParam_set = theParam; }
152
153   //// THESE METHODS ARE EXPORTED AS THEY PROVIDE STATE INFO TO USERDRAW
154   Standard_EXPORT const OpenGl_AspectLine*   AspectLine   (const Standard_Boolean theWithApply);
155   Standard_EXPORT const OpenGl_AspectFace*   AspectFace   (const Standard_Boolean theWithApply);
156   Standard_EXPORT const OpenGl_AspectMarker* AspectMarker (const Standard_Boolean theWithApply);
157   Standard_EXPORT const OpenGl_AspectText*   AspectText   (const Standard_Boolean theWithApply);
158   inline const OpenGl_TextParam* AspectTextParams() const
159   {
160     return TextParam_applied;
161   }
162
163   //! Clear the applied aspect state.
164   void ResetAppliedAspect();
165
166   Standard_EXPORT Handle(OpenGl_Texture) DisableTexture();
167   Standard_EXPORT Handle(OpenGl_Texture) EnableTexture (const Handle(OpenGl_Texture)&          theTexture,
168                                                         const Handle(Graphic3d_TextureParams)& theParams = NULL);
169
170 protected:
171
172   void CopyBuffers (const Standard_Boolean theFrontToBack);
173
174   virtual Standard_Boolean Activate();
175
176   // TEMPORARY!!!
177   void Redraw1 (const Graphic3d_CView& theCView,
178                 const Aspect_CLayer2d& theCUnderLayer,
179                 const Aspect_CLayer2d& theCOverLayer,
180                 const int theToSwap);
181
182   void UpdateMaterial (const int flag);
183
184   void setTextureParams (Handle(OpenGl_Texture)&                theTexture,
185                          const Handle(Graphic3d_TextureParams)& theParams);
186
187 protected: //! @name protected fields
188
189   Handle(OpenGl_PrinterContext) myPrintContext;
190   Handle(OpenGl_View)    myView;            // WSViews - now just one view is supported
191   Standard_Boolean       myIsTransientOpen; // transientOpen
192   Standard_Boolean       myRetainMode;
193   Standard_Boolean       myTransientDrawToFront; //!< optimization flag for immediate mode (to render directly to the front buffer)
194
195   NCollection_Sequence<const OpenGl_Structure*> myTransientList;
196
197   Standard_Boolean       myUseTransparency;
198   Standard_Boolean       myUseZBuffer;
199   Standard_Boolean       myUseDepthTest;
200   Standard_Boolean       myUseGLLight;
201   Standard_Boolean       myBackBufferRestored;
202
203 protected: //! @name fields related to status
204
205   Handle(OpenGl_Texture) myTextureBound;    //!< currently bound texture (managed by OpenGl_AspectFace and OpenGl_View environment texture)
206   const OpenGl_AspectLine *AspectLine_set, *AspectLine_applied;
207   const OpenGl_AspectFace *AspectFace_set, *AspectFace_applied;
208   const OpenGl_AspectMarker *AspectMarker_set, *AspectMarker_applied;
209   const OpenGl_AspectText *AspectText_set, *AspectText_applied;
210
211   const OpenGl_TextParam *TextParam_set, *TextParam_applied;
212
213   const OpenGl_Matrix* ViewMatrix_applied;
214   const OpenGl_Matrix* StructureMatrix_applied;
215
216   const TEL_POFFSET_PARAM* PolygonOffset_applied;
217
218   OpenGl_AspectFace myAspectFaceHl; // Hiddenline aspect
219
220 public: //! @name type definition
221
222   DEFINE_STANDARD_RTTI(OpenGl_Workspace)
223   DEFINE_STANDARD_ALLOC
224
225 };
226
227 #endif // _OpenGl_Workspace_Header