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_AspectLine.hxx>
  23 #include <OpenGl_AspectFace.hxx>
  24 #include <OpenGl_AspectMarker.hxx>
  25 #include <OpenGl_AspectText.hxx>
  26
  27 #include <OpenGl_GraphicDriver.hxx>
  28 #include <OpenGl_Group.hxx>
  29 #include <OpenGl_Matrix.hxx>
  30 #include <OpenGl_Vec.hxx>
  31 #include <OpenGl_Workspace.hxx>
  32
  33 #include <NCollection_List.hxx>
  34
  35 class OpenGl_Structure;
  36 class OpenGl_GraphicDriver;
  37
  38 typedef NCollection_List<const OpenGl_Structure* > OpenGl_ListOfStructure;
  39
  40 //! Implementation of low-level graphic structure.
  41 class OpenGl_Structure : public Graphic3d_CStructure
  42 {
  43   friend class OpenGl_Group;
  44
  45 public:
  46
  47   //! Auxiliary wrapper to iterate OpenGl_Group sequence.
  48   class GroupIterator
  49   {
  50
  51   public:
  52     GroupIterator (const Graphic3d_SequenceOfGroup& theGroups) : myIter (theGroups) {}
  53     Standard_Boolean More() const     { return myIter.More(); }
  54     void Next()                       { myIter.Next(); }
  55     const OpenGl_Group* Value() const { return (const OpenGl_Group* )(myIter.Value().operator->()); }
  56     OpenGl_Group*       ChangeValue() { return (OpenGl_Group* )(myIter.ChangeValue().operator->()); }
  57
  58   private:
  59     Graphic3d_SequenceOfGroup::Iterator myIter;
  60
  61   };
  62
  63 public:
  64
  65   //! Create empty structure
  66   Standard_EXPORT OpenGl_Structure (const Handle(Graphic3d_StructureManager)& theManager);
  67
  68   //! Setup structure graphic state
  69   Standard_EXPORT virtual void OnVisibilityChanged() Standard_OVERRIDE;
  70
  71   //! Clear graphic data
  72   Standard_EXPORT virtual void Clear() Standard_OVERRIDE;
  73
  74   //! Connect other structure to this one
  75   Standard_EXPORT virtual void Connect    (Graphic3d_CStructure& theStructure) Standard_OVERRIDE;
  76
  77   //! Disconnect other structure to this one
  78   Standard_EXPORT virtual void Disconnect (Graphic3d_CStructure& theStructure) Standard_OVERRIDE;
  79
  80   //! Synchronize structure transformation
  81   Standard_EXPORT virtual void SetTransformation (const Handle(Geom_Transformation)& theTrsf) Standard_OVERRIDE;
  82
  83   //! Set transformation persistence.
  84   Standard_EXPORT virtual void SetTransformPersistence (const Handle(Graphic3d_TransformPers)& theTrsfPers) Standard_OVERRIDE;
  85
  86   //! Set z layer ID to display the structure in specified layer
  87   Standard_EXPORT virtual void SetZLayer(const Graphic3d_ZLayerId theLayerIndex) Standard_OVERRIDE;
  88
  89   //! Highlights structure according to the given style and updates corresponding class fields
  90   //! (highlight status and style)
  91   Standard_EXPORT virtual void GraphicHighlight (const Handle(Graphic3d_HighlightStyle)& theStyle,
  92                                                  const Handle(Graphic3d_Structure)&      theStruct) Standard_OVERRIDE;
  93
  94   //! Unighlights structure and updates corresponding class fields (highlight status and style)
  95   Standard_EXPORT virtual void GraphicUnhighlight() Standard_OVERRIDE;
  96
  97   //! Create shadow link to this structure
  98   Standard_EXPORT virtual Handle(Graphic3d_CStructure) ShadowLink (const Handle(Graphic3d_StructureManager)& theManager) const Standard_OVERRIDE;
  99
 100   //! Create new group within this structure
 101   Standard_EXPORT virtual Handle(Graphic3d_Group) NewGroup (const Handle(Graphic3d_Structure)& theStruct) Standard_OVERRIDE;
 102
 103   //! Remove group from this structure
 104   Standard_EXPORT virtual void RemoveGroup (const Handle(Graphic3d_Group)& theGroup) Standard_OVERRIDE;
 105
 106 public:
 107
 108   //! Access graphic driver
 109   OpenGl_GraphicDriver* GlDriver() const
 110   {
 111     return (OpenGl_GraphicDriver* )myGraphicDriver.operator->();
 112   }
 113
 114   Standard_EXPORT void Clear (const Handle(OpenGl_Context)& theGlCtx);
 115
 116   //! Renders the structure.
 117   virtual void Render  (const Handle(OpenGl_Workspace)& theWorkspace) const;
 118
 119   //! Releases structure resources.
 120   virtual void Release (const Handle(OpenGl_Context)& theGlCtx);
 121
 122   //! Marks structure as not overlapping view volume (as it is by default).
 123   void ResetCullingStatus() const
 124   {
 125     if (!IsAlwaysRendered())
 126     {
 127       myIsCulled = Standard_True;
 128     }
 129   }
 130
 131   //! Marks structure as overlapping the current view volume one.
 132   //! The method is called during traverse of BVH tree.
 133   void MarkAsNotCulled() const { myIsCulled = Standard_False; }
 134
 135   //! Returns Standard_False if the structure hits the current view volume, otherwise
 136   //! returns Standard_True. The default value for all structures before each traverse
 137   //! of BVH tree is Standard_True.
 138   Standard_Boolean IsCulled() const { return myIsCulled; }
 139
 140   //! Checks if the structure should be included into BVH tree or not.
 141   Standard_Boolean IsAlwaysRendered() const
 142   {
 143     return IsInfinite
 144         || IsForHighlight
 145         || IsMutable
 146         || Is2dText
 147         || (!myTrsfPers.IsNull() && myTrsfPers->IsTrihedronOr2d());
 148   }
 149
 150   //! This method releases GL resources without actual elements destruction.
 151   //! As result structure could be correctly destroyed layer without GL context
 152   //! (after last window was closed for example).
 153   //!
 154   //! Notice however that reusage of this structure after calling this method is incorrect
 155   //! and will lead to broken visualization due to loosed data.
 156   Standard_EXPORT void ReleaseGlResources (const Handle(OpenGl_Context)& theGlCtx);
 157
 158   //! Returns instanced OpenGL structure.
 159   const OpenGl_Structure* InstancedStructure() const { return myInstancedStructure; }
 160
 161   //! Returns structure modification state (for ray-tracing).
 162   Standard_Size ModificationState() const { return myModificationState; }
 163
 164   //! Resets structure modification state (for ray-tracing).
 165   void ResetModificationState() const { myModificationState = 0; }
 166
 167   //! Is the structure ray-tracable (contains ray-tracable elements)?
 168   Standard_Boolean IsRaytracable() const;
 169
 170   //! Update render transformation matrix.
 171   Standard_EXPORT void updateLayerTransformation();
 172
 173 protected:
 174
 175   Standard_EXPORT virtual ~OpenGl_Structure();
 176
 177   //! Updates ray-tracable status for structure and its parents.
 178   void UpdateStateIfRaytracable (const Standard_Boolean toCheck = Standard_True) const;
 179
 180   //! Renders groups of structure without applying any attributes (i.e. transform, material etc).
 181   //! @param theWorkspace current workspace
 182   //! @param theHasClosed flag will be set to TRUE if structure contains at least one group of closed primitives
 183   Standard_EXPORT void renderGeometry (const Handle(OpenGl_Workspace)& theWorkspace,
 184                                        bool&                           theHasClosed) const;
 185
 186   //! Highlight structure using boundary box
 187   Standard_EXPORT void highlightWithBndBox (const Handle(Graphic3d_Structure)& theStruct);
 188
 189   //! Invalidates highlight box and releases graphic resources it uses
 190   Standard_EXPORT void clearHighlightBox (const Handle(OpenGl_Context)& theGlCtx);
 191
 192 protected:
 193
 194   Handle(OpenGl_Group)       myHighlightBox;
 195
 196   OpenGl_Structure*          myInstancedStructure;
 197   Graphic3d_Mat4             myRenderTrsf; //!< transformation, actually used for rendering (includes Local Origin shift)
 198
 199   mutable Standard_Boolean   myIsRaytracable;
 200   mutable Standard_Size      myModificationState;
 201
 202   mutable Standard_Boolean   myIsCulled; //!< A status specifying is structure needs to be rendered after BVH tree traverse.
 203
 204   Standard_Boolean           myIsMirrored; //!< Used to tell OpenGl to interpret polygons in clockwise order.
 205
 206 public:
 207
 208   DEFINE_STANDARD_RTTIEXT(OpenGl_Structure,Graphic3d_CStructure) // Type definition
 209
 210 };
 211
 212 DEFINE_STANDARD_HANDLE(OpenGl_Structure, Graphic3d_CStructure)
 213
 214 #endif // OpenGl_Structure_Header