// Created on: 2011-08-01 // Created by: Sergey ZERCHANINOV // Copyright (c) 2011-2014 OPEN CASCADE SAS // // This file is part of Open CASCADE Technology software library. // // 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. // // Alternatively, this file may be used under the terms of Open CASCADE // commercial license or contractual agreement. #ifndef OpenGl_Structure_HeaderFile #define OpenGl_Structure_HeaderFile #include #include #include #include #include DEFINE_STANDARD_HANDLE(OpenGl_Structure, Graphic3d_CStructure) typedef NCollection_List OpenGl_ListOfStructure; //! Implementation of low-level graphic structure. class OpenGl_Structure : public Graphic3d_CStructure { friend class OpenGl_Group; DEFINE_STANDARD_RTTIEXT(OpenGl_Structure, Graphic3d_CStructure) public: //! Auxiliary wrapper to iterate OpenGl_Structure sequence. typedef SubclassStructIterator StructIterator; //! Auxiliary wrapper to iterate OpenGl_Group sequence. typedef SubclassGroupIterator GroupIterator; public: //! Create empty structure Standard_EXPORT OpenGl_Structure (const Handle(Graphic3d_StructureManager)& theManager); //! Setup structure graphic state Standard_EXPORT virtual void OnVisibilityChanged() Standard_OVERRIDE; //! Clear graphic data Standard_EXPORT virtual void Clear() Standard_OVERRIDE; //! Connect other structure to this one Standard_EXPORT virtual void Connect (Graphic3d_CStructure& theStructure) Standard_OVERRIDE; //! Disconnect other structure to this one Standard_EXPORT virtual void Disconnect (Graphic3d_CStructure& theStructure) Standard_OVERRIDE; //! Synchronize structure transformation Standard_EXPORT virtual void SetTransformation (const Handle(TopLoc_Datum3D)& theTrsf) Standard_OVERRIDE; //! Set transformation persistence. Standard_EXPORT virtual void SetTransformPersistence (const Handle(Graphic3d_TransformPers)& theTrsfPers) Standard_OVERRIDE; //! Set z layer ID to display the structure in specified layer Standard_EXPORT virtual void SetZLayer(const Graphic3d_ZLayerId theLayerIndex) Standard_OVERRIDE; //! Highlights structure according to the given style and updates corresponding class fields //! (highlight status and style) Standard_EXPORT virtual void GraphicHighlight (const Handle(Graphic3d_PresentationAttributes)& theStyle) Standard_OVERRIDE; //! Unighlights structure and updates corresponding class fields (highlight status and style) Standard_EXPORT virtual void GraphicUnhighlight() Standard_OVERRIDE; //! Create shadow link to this structure Standard_EXPORT virtual Handle(Graphic3d_CStructure) ShadowLink (const Handle(Graphic3d_StructureManager)& theManager) const Standard_OVERRIDE; //! Create new group within this structure Standard_EXPORT virtual Handle(Graphic3d_Group) NewGroup (const Handle(Graphic3d_Structure)& theStruct) Standard_OVERRIDE; //! Remove group from this structure Standard_EXPORT virtual void RemoveGroup (const Handle(Graphic3d_Group)& theGroup) Standard_OVERRIDE; public: //! Access graphic driver OpenGl_GraphicDriver* GlDriver() const { return (OpenGl_GraphicDriver* )myGraphicDriver.operator->(); } Standard_EXPORT void Clear (const Handle(OpenGl_Context)& theGlCtx); //! Renders the structure. Standard_EXPORT virtual void Render (const Handle(OpenGl_Workspace)& theWorkspace) const; //! Releases structure resources. Standard_EXPORT virtual void Release (const Handle(OpenGl_Context)& theGlCtx); //! This method releases GL resources without actual elements destruction. //! As result structure could be correctly destroyed layer without GL context //! (after last window was closed for example). //! //! Notice however that reusage of this structure after calling this method is incorrect //! and will lead to broken visualization due to loosed data. Standard_EXPORT void ReleaseGlResources (const Handle(OpenGl_Context)& theGlCtx); //! Returns instanced OpenGL structure. const OpenGl_Structure* InstancedStructure() const { return myInstancedStructure; } //! Returns structure modification state (for ray-tracing). Standard_Size ModificationState() const { return myModificationState; } //! Resets structure modification state (for ray-tracing). void ResetModificationState() const { myModificationState = 0; } //! Is the structure ray-tracable (contains ray-tracable elements)? Standard_Boolean IsRaytracable() const; //! Update render transformation matrix. Standard_EXPORT virtual void updateLayerTransformation() Standard_OVERRIDE; //! Dumps the content of me into the stream Standard_EXPORT virtual void DumpJson (Standard_OStream& theOStream, Standard_Integer theDepth = -1) const Standard_OVERRIDE; protected: Standard_EXPORT virtual ~OpenGl_Structure(); //! Updates ray-tracable status for structure and its parents. void UpdateStateIfRaytracable (const Standard_Boolean toCheck = Standard_True) const; //! Renders groups of structure without applying any attributes (i.e. transform, material etc). //! @param theWorkspace current workspace //! @param theHasClosed flag will be set to TRUE if structure contains at least one group of closed primitives Standard_EXPORT void renderGeometry (const Handle(OpenGl_Workspace)& theWorkspace, bool& theHasClosed) const; //! Render the bounding box. Standard_EXPORT void renderBoundingBox(const Handle(OpenGl_Workspace)& theWorkspace) const; //! Apply transform persistence into context. //! It disables shadows on non-3d objects when toEnable is true and restores otherwise. //! @param[in] theCtx current context //! @param[in] theTrsfPers transform persistence //! @param[in] theIsLocal specifies if transform persistence is defined locally or to entire presentation //! @param[out] theOldCastShadows state of the previous cast shadows state Standard_EXPORT void applyPersistence (const Handle(OpenGl_Context)& theCtx, const Handle(Graphic3d_TransformPers)& theTrsfPersistence, const Standard_Boolean theIsLocal, Standard_Boolean& theOldCastShadows) const; //! Restore context from transform persistence changes. //! @param[in] theCtx current context //! @param[in] theTrsfPers transform persistence //! @param[in] theIsLocal specifies if transform persistence is defined locally or to entire presentation //! @param[in] theOldCastShadows state of the previous cast shadows state Standard_EXPORT void revertPersistence (const Handle(OpenGl_Context)& theCtx, const Handle(Graphic3d_TransformPers)& theTrsfPersistence, const Standard_Boolean theIsLocal, const Standard_Boolean theOldCastShadows) const; protected: OpenGl_Structure* myInstancedStructure; Graphic3d_Mat4 myRenderTrsf; //!< transformation, actually used for rendering (includes Local Origin shift) mutable Standard_Boolean myIsRaytracable; mutable Standard_Size myModificationState; Standard_Boolean myIsMirrored; //!< Used to tell OpenGl to interpret polygons in clockwise order. }; #endif // OpenGl_Structure_Header