src/OpenGl/OpenGl_Structure.hxx

   1 // Created on: 2011-08-01
   2 // Created by: Sergey ZERCHANINOV
   3 // Copyright (c) 2011-2014 OPEN CASCADE SAS
   4 //
   5 // This file is part of Open CASCADE Technology software library.
   6 //
   7 // This library is free software; you can redistribute it and/or modify it under
   8 // the terms of the GNU Lesser General Public License version 2.1 as published
   9 // by the Free Software Foundation, with special exception defined in the file
  10 // OCCT_LGPL_EXCEPTION.txt. Consult the file LICENSE_LGPL_21.txt included in OCCT
  11 // distribution for complete text of the license and disclaimer of any warranty.
  12 //
  13 // Alternatively, this file may be used under the terms of Open CASCADE
  14 // commercial license or contractual agreement.
  15
  16 #ifndef OpenGl_Structure_Header
  17 #define OpenGl_Structure_Header
  18
  19 #include <Graphic3d_CStructure.hxx>
  20 #include <Graphic3d_SequenceOfHClipPlane.hxx>
  21
  22 #include <OpenGl_Aspects.hxx>
  23
  24 #include <OpenGl_GraphicDriver.hxx>
  25 #include <OpenGl_Group.hxx>
  26 #include <OpenGl_Matrix.hxx>
  27 #include <OpenGl_Vec.hxx>
  28 #include <OpenGl_Workspace.hxx>
  29
  30 #include <NCollection_List.hxx>
  31
  32 class OpenGl_GraphicDriver;
  33
  34 DEFINE_STANDARD_HANDLE(OpenGl_Structure, Graphic3d_CStructure)
  35 typedef NCollection_List<const OpenGl_Structure* > OpenGl_ListOfStructure;
  36
  37 //! Implementation of low-level graphic structure.
  38 class OpenGl_Structure : public Graphic3d_CStructure
  39 {
  40   friend class OpenGl_Group;
  41   DEFINE_STANDARD_RTTIEXT(OpenGl_Structure, Graphic3d_CStructure)
  42 public:
  43
  44   //! Auxiliary wrapper to iterate OpenGl_Structure sequence.
  45   typedef SubclassStructIterator<OpenGl_Structure> StructIterator;
  46
  47   //! Auxiliary wrapper to iterate OpenGl_Group sequence.
  48   typedef SubclassGroupIterator<OpenGl_Group> GroupIterator;
  49
  50 public:
  51
  52   //! Create empty structure
  53   Standard_EXPORT OpenGl_Structure (const Handle(Graphic3d_StructureManager)& theManager);
  54
  55   //! Setup structure graphic state
  56   Standard_EXPORT virtual void OnVisibilityChanged() Standard_OVERRIDE;
  57
  58   //! Clear graphic data
  59   Standard_EXPORT virtual void Clear() Standard_OVERRIDE;
  60
  61   //! Connect other structure to this one
  62   Standard_EXPORT virtual void Connect    (Graphic3d_CStructure& theStructure) Standard_OVERRIDE;
  63
  64   //! Disconnect other structure to this one
  65   Standard_EXPORT virtual void Disconnect (Graphic3d_CStructure& theStructure) Standard_OVERRIDE;
  66
  67   //! Synchronize structure transformation
  68   Standard_EXPORT virtual void SetTransformation (const Handle(Geom_Transformation)& theTrsf) Standard_OVERRIDE;
  69
  70   //! Set transformation persistence.
  71   Standard_EXPORT virtual void SetTransformPersistence (const Handle(Graphic3d_TransformPers)& theTrsfPers) Standard_OVERRIDE;
  72
  73   //! Set z layer ID to display the structure in specified layer
  74   Standard_EXPORT virtual void SetZLayer(const Graphic3d_ZLayerId theLayerIndex) Standard_OVERRIDE;
  75
  76   //! Highlights structure according to the given style and updates corresponding class fields
  77   //! (highlight status and style)
  78   Standard_EXPORT virtual void GraphicHighlight (const Handle(Graphic3d_PresentationAttributes)& theStyle) Standard_OVERRIDE;
  79
  80   //! Unighlights structure and updates corresponding class fields (highlight status and style)
  81   Standard_EXPORT virtual void GraphicUnhighlight() Standard_OVERRIDE;
  82
  83   //! Create shadow link to this structure
  84   Standard_EXPORT virtual Handle(Graphic3d_CStructure) ShadowLink (const Handle(Graphic3d_StructureManager)& theManager) const Standard_OVERRIDE;
  85
  86   //! Create new group within this structure
  87   Standard_EXPORT virtual Handle(Graphic3d_Group) NewGroup (const Handle(Graphic3d_Structure)& theStruct) Standard_OVERRIDE;
  88
  89   //! Remove group from this structure
  90   Standard_EXPORT virtual void RemoveGroup (const Handle(Graphic3d_Group)& theGroup) Standard_OVERRIDE;
  91
  92 public:
  93
  94   //! Access graphic driver
  95   OpenGl_GraphicDriver* GlDriver() const
  96   {
  97     return (OpenGl_GraphicDriver* )myGraphicDriver.operator->();
  98   }
  99
 100   Standard_EXPORT void Clear (const Handle(OpenGl_Context)& theGlCtx);
 101
 102   //! Renders the structure.
 103   virtual void Render  (const Handle(OpenGl_Workspace)& theWorkspace) const;
 104
 105   //! Releases structure resources.
 106   virtual void Release (const Handle(OpenGl_Context)& theGlCtx);
 107
 108   //! This method releases GL resources without actual elements destruction.
 109   //! As result structure could be correctly destroyed layer without GL context
 110   //! (after last window was closed for example).
 111   //!
 112   //! Notice however that reusage of this structure after calling this method is incorrect
 113   //! and will lead to broken visualization due to loosed data.
 114   Standard_EXPORT void ReleaseGlResources (const Handle(OpenGl_Context)& theGlCtx);
 115
 116   //! Returns instanced OpenGL structure.
 117   const OpenGl_Structure* InstancedStructure() const { return myInstancedStructure; }
 118
 119   //! Returns structure modification state (for ray-tracing).
 120   Standard_Size ModificationState() const { return myModificationState; }
 121
 122   //! Resets structure modification state (for ray-tracing).
 123   void ResetModificationState() const { myModificationState = 0; }
 124
 125   //! Is the structure ray-tracable (contains ray-tracable elements)?
 126   Standard_Boolean IsRaytracable() const;
 127
 128   //! Update render transformation matrix.
 129   Standard_EXPORT virtual void updateLayerTransformation() Standard_OVERRIDE;
 130
 131 protected:
 132
 133   Standard_EXPORT virtual ~OpenGl_Structure();
 134
 135   //! Updates ray-tracable status for structure and its parents.
 136   void UpdateStateIfRaytracable (const Standard_Boolean toCheck = Standard_True) const;
 137
 138   //! Renders groups of structure without applying any attributes (i.e. transform, material etc).
 139   //! @param theWorkspace current workspace
 140   //! @param theHasClosed flag will be set to TRUE if structure contains at least one group of closed primitives
 141   Standard_EXPORT void renderGeometry (const Handle(OpenGl_Workspace)& theWorkspace,
 142                                        bool&                           theHasClosed) const;
 143
 144   //! Render the bounding box.
 145   Standard_EXPORT void renderBoundingBox(const Handle(OpenGl_Workspace)& theWorkspace) const;
 146
 147 protected:
 148
 149   OpenGl_Structure*          myInstancedStructure;
 150   Graphic3d_Mat4             myRenderTrsf; //!< transformation, actually used for rendering (includes Local Origin shift)
 151
 152   mutable Standard_Boolean   myIsRaytracable;
 153   mutable Standard_Size      myModificationState;
 154
 155   Standard_Boolean           myIsMirrored; //!< Used to tell OpenGl to interpret polygons in clockwise order.
 156
 157 };
 158
 159 #endif // OpenGl_Structure_Header