// Created on: 2011-09-20
// Created by: Sergey ZERCHANINOV
-// Copyright (c) 2011-2012 OPEN CASCADE SAS
+// Copyright (c) 2011-2013 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_Workspace_Header
#define _OpenGl_Workspace_Header
-#include <Handle_OpenGl_Workspace.hxx>
+#include <Graphic3d_BufferType.hxx>
+
+#include <OpenGl_AspectFace.hxx>
+#include <OpenGl_CappingAlgo.hxx>
+#include <OpenGl_FrameBuffer.hxx>
+#include <OpenGl_Material.hxx>
+#include <OpenGl_Matrix.hxx>
+#include <OpenGl_RenderFilter.hxx>
+#include <OpenGl_ShaderObject.hxx>
+#include <OpenGl_ShaderProgram.hxx>
+#include <OpenGl_TextParam.hxx>
+#include <OpenGl_TextureBufferArb.hxx>
+#include <OpenGl_Vec.hxx>
#include <OpenGl_Window.hxx>
-#include <TColStd_Array2OfReal.hxx>
-#include <Quantity_Color.hxx>
-#include <Graphic3d_TypeOfComposition.hxx>
+class OpenGl_View;
+class Image_PixMap;
-#include <Graphic3d_CView.hxx>
-#include <Aspect_CLayer2d.hxx>
-#include <Aspect_Handle.hxx>
-#include <Aspect_PrintAlgo.hxx>
-#include <Graphic3d_PtrFrameBuffer.hxx>
-#include <Image_CRawBufferData.hxx>
+class OpenGl_RaytraceFilter;
+DEFINE_STANDARD_HANDLE (OpenGl_RaytraceFilter, OpenGl_RenderFilter)
-#include <InterfaceGraphic_Graphic3d.hxx>
-#include <InterfaceGraphic_Visual3d.hxx>
+//! Graphical ray-tracing filter.
+//! Filters out all raytracable structures.
+class OpenGl_RaytraceFilter : public OpenGl_RenderFilter
+{
+public:
-#include <OpenGl_tsm.hxx>
+ //! Default constructor.
+ OpenGl_RaytraceFilter() {}
-#include <OpenGl_Display.hxx>
-#include <OpenGl_Matrix.hxx>
-#include <OpenGl_NamedStatus.hxx>
-#include <OpenGl_TextParam.hxx>
+ //! Returns the previously set filter.
+ const Handle(OpenGl_RenderFilter)& PrevRenderFilter()
+ {
+ return myPrevRenderFilter;
+ }
-#include <Handle_OpenGl_View.hxx>
+ //! Remembers the previously set filter.
+ void SetPrevRenderFilter (const Handle(OpenGl_RenderFilter)& theFilter)
+ {
+ myPrevRenderFilter = theFilter;
+ }
+
+ //! Checks whether the element can be rendered or not.
+ //! @param theElement [in] the element to check.
+ //! @return True if element can be rendered.
+ virtual Standard_Boolean ShouldRender (const Handle(OpenGl_Workspace)& theWorkspace,
+ const OpenGl_Element* theElement) Standard_OVERRIDE;
+
+private:
+
+ Handle(OpenGl_RenderFilter) myPrevRenderFilter;
+
+public:
+
+ DEFINE_STANDARD_RTTIEXT(OpenGl_RaytraceFilter,OpenGl_RenderFilter)
+};
-class OpenGl_AspectLine;
-class OpenGl_AspectFace;
-class OpenGl_AspectMarker;
-class OpenGl_AspectText;
-class OpenGl_FrameBuffer;
-class OpenGl_Structure;
+class OpenGl_Workspace;
+DEFINE_STANDARD_HANDLE(OpenGl_Workspace,Standard_Transient)
-//! Reprepsents window with GL context.
-//! Provides methods to render primitives and maintan GL state.
-class OpenGl_Workspace : public OpenGl_Window
+//! Rendering workspace.
+//! Provides methods to render primitives and maintain GL state.
+class OpenGl_Workspace : public Standard_Transient
{
public:
- //! Main constructor - prepare GL context for specified window.
- OpenGl_Workspace (const Handle(OpenGl_Display)& theDisplay,
- const CALL_DEF_WINDOW& theCWindow,
- Aspect_RenderingContext theGContext);
+ //! Constructor of rendering workspace.
+ Standard_EXPORT OpenGl_Workspace (OpenGl_View* theView, const Handle(OpenGl_Window)& theWindow);
//! Destructor
- virtual ~OpenGl_Workspace();
-
- void SetActiveView (const Handle(OpenGl_View)& theView) { myView = theView; }
- const Handle(OpenGl_View)& ActiveView () const { return myView; }
-
- //! Redraw the window.
- void Redraw (const Graphic3d_CView& theCView,
- const Aspect_CLayer2d& theCUnderLayer,
- const Aspect_CLayer2d& theCOverLayer);
-
- //! Redraw window only if needed.
- void Update (const Graphic3d_CView& theCView,
- const Aspect_CLayer2d& theCUnderLayer,
- const Aspect_CLayer2d& theCOverLayer)
- {
- if (!myIsUpdated)
- 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,
- const Aspect_CLayer2d& theCOverLayer,
- const Aspect_Handle theHPrintDC,
- const Standard_Boolean theToShowBackground,
- const Standard_CString theFileName,
- const Aspect_PrintAlgo thePrintAlgorithm,
- const Standard_Real theScaleFactor);
-
- void DisplayCallback (const Graphic3d_CView& theCView, int theReason);
-
- // szvgl: defined in OpenGl_Workspace_1.cxx
- void BeginAnimation (const Standard_Boolean theUseDegeneration,
- const Standard_Boolean theUpdateAM);
- void EndAnimation();
- void EraseAnimation();
-
- Standard_Boolean BeginAddMode();
- void EndAddMode();
- void ClearImmediatMode (const Graphic3d_CView& theCView,
- const Standard_Boolean theToFlush);
- void RedrawImmediatMode();
- Standard_Boolean BeginImmediatMode (const Graphic3d_CView& theCView,
- const Standard_Boolean theUseDepthTest,
- const Standard_Boolean theRetainMode);
- void EndImmediatMode();
- void Transform (const TColStd_Array2OfReal& theMatrix, const Graphic3d_TypeOfComposition theType);
- void DrawStructure (const OpenGl_Structure* theStructure);
- void BeginPolyline();
- void EndPolyline();
- void Draw (const Standard_ShortReal theX, const Standard_ShortReal theY, const Standard_ShortReal theZ);
- void Move (const Standard_ShortReal theX, const Standard_ShortReal theY, const Standard_ShortReal theZ);
- void SetLineColor (const Standard_ShortReal theR, const Standard_ShortReal theG, const Standard_ShortReal theB);
- void SetLineType (const Standard_Integer theType);
- void SetLineWidth (const Standard_ShortReal theWidth);
- void SetMinMax (const Standard_ShortReal X1, const Standard_ShortReal Y1, const Standard_ShortReal Z1,
- const Standard_ShortReal X2, const Standard_ShortReal Y2, const Standard_ShortReal Z2);
-
- 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; }
-
- void UseTransparency (const Standard_Boolean theFlag);
- Standard_Boolean& UseZBuffer() { return myUseZBuffer; }
- Standard_Boolean& UseDepthTest() { return myUseDepthTest; }
- Standard_Boolean& UseGLLight() { return myUseGLLight; }
+ virtual ~OpenGl_Workspace() {}
+
+ //! Activate rendering context.
+ Standard_EXPORT Standard_Boolean Activate();
+
+ OpenGl_View* View() const { return myView; }
+
+ const Handle(OpenGl_Context)& GetGlContext() { return myGlContext; }
+
+ Standard_EXPORT Handle(OpenGl_FrameBuffer) FBOCreate (const Standard_Integer theWidth, const Standard_Integer theHeight);
+
+ Standard_EXPORT void FBORelease (Handle(OpenGl_FrameBuffer)& theFbo);
+
+ Standard_Boolean BufferDump (const Handle(OpenGl_FrameBuffer)& theFbo,
+ Image_PixMap& theImage,
+ const Graphic3d_BufferType& theBufferType);
+
+ Standard_EXPORT Standard_Integer Width() const;
+
+ Standard_EXPORT Standard_Integer Height() const;
+
+ //! Setup Z-buffer usage flag (without affecting GL state!).
+ //! Returns previously set flag.
+ Standard_Boolean SetUseZBuffer (const Standard_Boolean theToUse)
+ {
+ const Standard_Boolean wasUsed = myUseZBuffer;
+ myUseZBuffer = theToUse;
+ return wasUsed;
+ }
+
+ //! @return true if usage of Z buffer is enabled.
+ Standard_Boolean& UseZBuffer() { return myUseZBuffer; }
+
+ //! @return true if depth writing is enabled.
+ Standard_Boolean& UseDepthWrite() { return myUseDepthWrite; }
+
+ //! @return true if clipping algorithm enabled
+ Standard_EXPORT Standard_Boolean IsCullingEnabled() const;
//// RELATED TO STATUS ////
- Standard_Integer NamedStatus;
+ //! Return true if active group might activate face culling (e.g. primitives are closed).
+ bool ToAllowFaceCulling() const { return myToAllowFaceCulling; }
+
+ //! Allow or disallow face culling.
+ //! This call does NOT affect current state of back face culling;
+ //! ApplyAspectFace() should be called to update state.
+ void SetAllowFaceCulling (bool theToAllow) { myToAllowFaceCulling = theToAllow; }
- Standard_Integer DegenerateModel;
- Standard_ShortReal SkipRatio;
+ //! Return true if following structures should apply highlight color.
+ bool ToHighlight() const { return !myHighlightStyle.IsNull(); }
- const TEL_COLOUR* HighlightColor;
+ //! Return highlight style.
+ const Handle(Graphic3d_PresentationAttributes)& HighlightStyle() const { return myHighlightStyle; }
- const OpenGl_Matrix* SetViewMatrix (const OpenGl_Matrix* );
- const OpenGl_Matrix* SetStructureMatrix (const OpenGl_Matrix* );
+ //! Set highlight style.
+ void SetHighlightStyle (const Handle(Graphic3d_PresentationAttributes)& theStyle) { myHighlightStyle = theStyle; }
- const OpenGl_AspectLine* SetAspectLine (const OpenGl_AspectLine* theAspect);
- const OpenGl_AspectFace* SetAspectFace (const OpenGl_AspectFace* theAspect);
- const OpenGl_AspectMarker* SetAspectMarker (const OpenGl_AspectMarker* theAspect);
- const OpenGl_AspectText* SetAspectText (const OpenGl_AspectText* theAspect);
+ //! Return line color taking into account highlight flag.
+ const OpenGl_Vec4& LineColor() const
+ {
+ return !myHighlightStyle.IsNull()
+ ? myHighlightStyle->ColorRGBA()
+ : myAspectLineSet->Aspect()->ColorRGBA();
+ }
- void SetTextParam (const OpenGl_TextParam* theParam) { TextParam_set = theParam; }
+ //! Return edge color taking into account highlight flag.
+ const OpenGl_Vec4& EdgeColor() const
+ {
+ return !myHighlightStyle.IsNull()
+ ? myHighlightStyle->ColorRGBA()
+ : myAspectFaceSet->AspectEdge()->Aspect()->ColorRGBA();
+ }
- 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);
+ //! Return marker color taking into account highlight flag.
+ const OpenGl_Vec4& MarkerColor() const
+ {
+ return !myHighlightStyle.IsNull()
+ ? myHighlightStyle->ColorRGBA()
+ : myAspectMarkerSet->Aspect()->ColorRGBA();
+ }
- //! Clear the applied aspect state.
+ //! Return Interior color taking into account highlight flag.
+ const OpenGl_Vec4& InteriorColor() const
+ {
+ return !myHighlightStyle.IsNull()
+ ? myHighlightStyle->ColorRGBA()
+ : myAspectFaceSet->Aspect()->InteriorColorRGBA();
+ }
+
+ //! Return text color taking into account highlight flag.
+ const OpenGl_Vec4& TextColor() const
+ {
+ return !myHighlightStyle.IsNull()
+ ? myHighlightStyle->ColorRGBA()
+ : myAspectTextSet->Aspect()->ColorRGBA();
+ }
+
+ //! Return text Subtitle color taking into account highlight flag.
+ const OpenGl_Vec4& TextSubtitleColor() const
+ {
+ return !myHighlightStyle.IsNull()
+ ? myHighlightStyle->ColorRGBA()
+ : myAspectTextSet->Aspect()->ColorSubTitleRGBA();
+ }
+
+ //! Currently set line aspect (can differ from applied).
+ const OpenGl_AspectLine* AspectLine() const { return myAspectLineSet; }
+
+ //! Currently set face aspect (can differ from applied).
+ const OpenGl_AspectFace* AspectFace() const { return myAspectFaceSet; }
+
+ //! Currently set marker aspect (can differ from applied).
+ const OpenGl_AspectMarker* AspectMarker() const { return myAspectMarkerSet; }
+
+ //! Currently set text aspect (can differ from applied).
+ const OpenGl_AspectText* AspectText() const { return myAspectTextSet; }
+
+ //! Assign new line aspect (will be applied within ApplyAspectLine()).
+ Standard_EXPORT const OpenGl_AspectLine* SetAspectLine (const OpenGl_AspectLine* theAspect);
+
+ //! Assign new face aspect (will be applied within ApplyAspectFace()).
+ Standard_EXPORT const OpenGl_AspectFace* SetAspectFace (const OpenGl_AspectFace* theAspect);
+
+ //! Assign new marker aspect (will be applied within ApplyAspectMarker()).
+ Standard_EXPORT const OpenGl_AspectMarker* SetAspectMarker (const OpenGl_AspectMarker* theAspect);
+
+ //! Assign new text aspect (will be applied within ApplyAspectText()).
+ Standard_EXPORT const OpenGl_AspectText* SetAspectText (const OpenGl_AspectText* theAspect);
+
+ //! Apply line aspect.
+ //! @return aspect set by SetAspectLine()
+ const OpenGl_AspectLine* ApplyAspectLine() { return myAspectLineSet; }
+
+ //! Apply face aspect.
+ //! @return aspect set by SetAspectFace()
+ Standard_EXPORT const OpenGl_AspectFace* ApplyAspectFace();
+
+ //! Apply marker aspect.
+ //! @return aspect set by SetAspectMarker()
+ Standard_EXPORT const OpenGl_AspectMarker* ApplyAspectMarker();
+
+ //! Apply text aspect.
+ //! @return aspect set by SetAspectText()
+ const OpenGl_AspectText* ApplyAspectText() { return myAspectTextSet; }
+
+ //! Clear the applied aspect state to default values.
void ResetAppliedAspect();
- //// RELATED TO FONTS ////
+ Standard_EXPORT Handle(OpenGl_Texture) DisableTexture();
+ Standard_EXPORT Handle(OpenGl_Texture) EnableTexture (const Handle(OpenGl_Texture)& theTexture,
+ const Handle(Graphic3d_TextureParams)& theParams = NULL);
+ const Handle(OpenGl_Texture)& ActiveTexture() const { return myTextureBound; }
- int FindFont (const char* theFontName,
- const OSD_FontAspect theFontAspect,
- const int theBestSize = -1,
- const float theXScale = 1.0f,
- const float theYScale = 1.0f)
+ //! Set filter for restricting rendering of particular elements.
+ //! Filter can be applied for rendering passes used by recursive
+ //! rendering algorithms for rendering elements of groups.
+ //! @param theFilter [in] the filter instance.
+ inline void SetRenderFilter (const Handle(OpenGl_RenderFilter)& theFilter)
{
- return myDisplay->FindFont (theFontName, theFontAspect, theBestSize, theXScale, theYScale);
+ myRenderFilter = theFilter;
}
- void StringSize (const wchar_t* theText, int& theWidth, int& theAscent, int& theDescent)
+ //! Get rendering filter.
+ //! @return filter instance.
+ inline const Handle(OpenGl_RenderFilter)& GetRenderFilter() const
{
- myDisplay->StringSize (theText, theWidth, theAscent, theDescent);
+ return myRenderFilter;
}
- void RenderText (const wchar_t* theText, const int theIs2d,
- const float theX, const float theY, const float theZ)
+ //! @return applied view matrix.
+ inline const OpenGl_Matrix* ViewMatrix() const { return ViewMatrix_applied; }
+
+ //! @return applied model structure matrix.
+ inline const OpenGl_Matrix* ModelMatrix() const { return StructureMatrix_applied; }
+
+ //! Sets and applies current polygon offset.
+ void SetPolygonOffset (const Graphic3d_PolygonOffset& theParams);
+
+ //! Returns currently applied polygon offset parameters.
+ const Graphic3d_PolygonOffset& AppliedPolygonOffset() { return myPolygonOffsetApplied; }
+
+ //! Returns capping algorithm rendering filter.
+ const Handle(OpenGl_CappingAlgoFilter)& DefaultCappingAlgoFilter() const
{
- const OpenGl_AspectText* anAspect = AspectText (Standard_True);
- myDisplay->RenderText (theText, theIs2d, theX, theY, theZ, anAspect, TextParam_applied);
+ return myDefaultCappingAlgoFilter;
}
-protected:
+ //! Returns face aspect for none culling mode.
+ const OpenGl_AspectFace& NoneCulling() const
+ {
+ return myNoneCulling;
+ }
- void CopyBuffers (Tint vid, int FrontToBack,
- Tfloat xm, Tfloat ym, Tfloat zm,
- Tfloat XM, Tfloat YM, Tfloat ZM,
- Tint flag);
+ //! Returns face aspect for front face culling mode.
+ const OpenGl_AspectFace& FrontCulling() const
+ {
+ return myFrontCulling;
+ }
- virtual Standard_Boolean Activate();
+ //! Sets a new environment texture.
+ void SetEnvironmentTexture (const Handle(OpenGl_Texture)& theTexture)
+ {
+ myEnvironmentTexture = theTexture;
+ }
- // TEMPORARY!!!
- void Redraw1 (const Graphic3d_CView& theCView,
- const Aspect_CLayer2d& theCUnderLayer,
- const Aspect_CLayer2d& theCOverLayer,
- const int theToSwap);
+ //! Returns environment texture.
+ const Handle(OpenGl_Texture)& EnvironmentTexture() const
+ {
+ return myEnvironmentTexture;
+ }
protected:
- 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;
-
- //// RELATED TO STATUS ////
+protected: //! @name protected fields
- void UpdateMaterial (const int flag);
+ OpenGl_View* myView;
+ Handle(OpenGl_Window) myWindow;
+ Handle(OpenGl_Context) myGlContext;
+ Standard_Boolean myUseZBuffer;
+ Standard_Boolean myUseDepthWrite;
+ Handle(OpenGl_CappingAlgoFilter) myDefaultCappingAlgoFilter;
+ OpenGl_AspectFace myNoneCulling;
+ OpenGl_AspectFace myFrontCulling;
- const OpenGl_AspectLine *AspectLine_set, *AspectLine_applied;
- const OpenGl_AspectFace *AspectFace_set, *AspectFace_applied;
- const OpenGl_AspectMarker *AspectMarker_set, *AspectMarker_applied;
- const OpenGl_AspectText *AspectText_set, *AspectText_applied;
+protected: //! @name fields related to status
- const OpenGl_TextParam *TextParam_set, *TextParam_applied;
+ Handle(OpenGl_RenderFilter) myRenderFilter;
+ Handle(OpenGl_Texture) myTextureBound; //!< currently bound texture (managed by OpenGl_AspectFace and OpenGl_View environment texture)
+ const OpenGl_AspectLine* myAspectLineSet;
+ const OpenGl_AspectFace* myAspectFaceSet;
+ Handle(Graphic3d_AspectFillArea3d) myAspectFaceApplied;
+ const OpenGl_AspectMarker* myAspectMarkerSet;
+ Handle(Graphic3d_AspectMarker3d) myAspectMarkerApplied;
+ const OpenGl_AspectText* myAspectTextSet;
+ Handle(Graphic3d_PresentationAttributes) myAspectFaceAppliedWithHL;
const OpenGl_Matrix* ViewMatrix_applied;
const OpenGl_Matrix* StructureMatrix_applied;
- const TEL_POFFSET_PARAM* PolygonOffset_applied;
+ bool myToAllowFaceCulling; //!< allow back face culling
+ Handle(Graphic3d_PresentationAttributes) myHighlightStyle; //!< active highlight style
-public:
+ OpenGl_Matrix myModelViewMatrix; //!< Model matrix with applied structure transformations
+
+ Graphic3d_PolygonOffset myPolygonOffsetApplied; //!< currently applied polygon offset
+
+ OpenGl_AspectFace myAspectFaceHl; //!< Hiddenline aspect
+
+ Handle(OpenGl_Texture) myEnvironmentTexture;
+
+public: //! @name type definition
- DEFINE_STANDARD_RTTI(OpenGl_Workspace) // Type definition
+ DEFINE_STANDARD_RTTIEXT(OpenGl_Workspace,Standard_Transient)
DEFINE_STANDARD_ALLOC
};
-#endif //_OpenGl_Workspace_Header
+#endif // _OpenGl_Workspace_Header
projects / occt.git / blobdiff