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_Vec.hxx>
  27 #include <OpenGl_Workspace.hxx>
  28
  29 #include <NCollection_List.hxx>
  30
  31 class OpenGl_GraphicDriver;
  32
  33 DEFINE_STANDARD_HANDLE(OpenGl_Structure, Graphic3d_CStructure)
  34 typedef NCollection_List<const OpenGl_Structure* > OpenGl_ListOfStructure;
  35
  36 //! Implementation of low-level graphic structure.
  37 class OpenGl_Structure : public Graphic3d_CStructure
  38 {
  39   friend class OpenGl_Group;
  40   DEFINE_STANDARD_RTTIEXT(OpenGl_Structure, Graphic3d_CStructure)
  41 public:
  42
  43   //! Auxiliary wrapper to iterate OpenGl_Structure sequence.
  44   typedef SubclassStructIterator<OpenGl_Structure> StructIterator;
  45
  46   //! Auxiliary wrapper to iterate OpenGl_Group sequence.
  47   typedef SubclassGroupIterator<OpenGl_Group> GroupIterator;
  48
  49 public:
  50
  51   //! Create empty structure
  52   Standard_EXPORT OpenGl_Structure (const Handle(Graphic3d_StructureManager)& theManager);
  53
  54   //! Setup structure graphic state
  55   Standard_EXPORT virtual void OnVisibilityChanged() Standard_OVERRIDE;
  56
  57   //! Clear graphic data
  58   Standard_EXPORT virtual void Clear() Standard_OVERRIDE;
  59
  60   //! Connect other structure to this one
  61   Standard_EXPORT virtual void Connect    (Graphic3d_CStructure& theStructure) Standard_OVERRIDE;
  62
  63   //! Disconnect other structure to this one
  64   Standard_EXPORT virtual void Disconnect (Graphic3d_CStructure& theStructure) Standard_OVERRIDE;
  65
  66   //! Synchronize structure transformation
  67   Standard_EXPORT virtual void SetTransformation (const Handle(TopLoc_Datum3D)& theTrsf) Standard_OVERRIDE;
  68
  69   //! Set transformation persistence.
  70   Standard_EXPORT virtual void SetTransformPersistence (const Handle(Graphic3d_TransformPers)& theTrsfPers) Standard_OVERRIDE;
  71
  72   //! Set z layer ID to display the structure in specified layer
  73   Standard_EXPORT virtual void SetZLayer(const Graphic3d_ZLayerId theLayerIndex) Standard_OVERRIDE;
  74
  75   //! Highlights structure according to the given style and updates corresponding class fields
  76   //! (highlight status and style)
  77   Standard_EXPORT virtual void GraphicHighlight (const Handle(Graphic3d_PresentationAttributes)& theStyle) Standard_OVERRIDE;
  78
  79   //! Unighlights structure and updates corresponding class fields (highlight status and style)
  80   Standard_EXPORT virtual void GraphicUnhighlight() Standard_OVERRIDE;
  81
  82   //! Create shadow link to this structure
  83   Standard_EXPORT virtual Handle(Graphic3d_CStructure) ShadowLink (const Handle(Graphic3d_StructureManager)& theManager) const Standard_OVERRIDE;
  84
  85   //! Create new group within this structure
  86   Standard_EXPORT virtual Handle(Graphic3d_Group) NewGroup (const Handle(Graphic3d_Structure)& theStruct) Standard_OVERRIDE;
  87
  88   //! Remove group from this structure
  89   Standard_EXPORT virtual void RemoveGroup (const Handle(Graphic3d_Group)& theGroup) Standard_OVERRIDE;
  90
  91 public:
  92
  93   //! Access graphic driver
  94   OpenGl_GraphicDriver* GlDriver() const
  95   {
  96     return (OpenGl_GraphicDriver* )myGraphicDriver.operator->();
  97   }
  98
  99   Standard_EXPORT void Clear (const Handle(OpenGl_Context)& theGlCtx);
 100
 101   //! Renders the structure.
 102   Standard_EXPORT virtual void Render  (const Handle(OpenGl_Workspace)& theWorkspace) const;
 103
 104   //! Releases structure resources.
 105   Standard_EXPORT virtual void Release (const Handle(OpenGl_Context)& theGlCtx);
 106
 107   //! This method releases GL resources without actual elements destruction.
 108   //! As result structure could be correctly destroyed layer without GL context
 109   //! (after last window was closed for example).
 110   //!
 111   //! Notice however that reusage of this structure after calling this method is incorrect
 112   //! and will lead to broken visualization due to loosed data.
 113   Standard_EXPORT void ReleaseGlResources (const Handle(OpenGl_Context)& theGlCtx);
 114
 115   //! Returns instanced OpenGL structure.
 116   const OpenGl_Structure* InstancedStructure() const { return myInstancedStructure; }
 117
 118   //! Returns structure modification state (for ray-tracing).
 119   Standard_Size ModificationState() const { return myModificationState; }
 120
 121   //! Resets structure modification state (for ray-tracing).
 122   void ResetModificationState() const { myModificationState = 0; }
 123
 124   //! Is the structure ray-tracable (contains ray-tracable elements)?
 125   Standard_Boolean IsRaytracable() const;
 126
 127   //! Update render transformation matrix.
 128   Standard_EXPORT virtual void updateLayerTransformation() Standard_OVERRIDE;
 129
 130   //! Dumps the content of me into the stream
 131   Standard_EXPORT virtual void DumpJson (Standard_OStream& theOStream, Standard_Integer theDepth = -1) const Standard_OVERRIDE;
 132
 133 protected:
 134
 135   Standard_EXPORT virtual ~OpenGl_Structure();
 136
 137   //! Updates ray-tracable status for structure and its parents.
 138   void UpdateStateIfRaytracable (const Standard_Boolean toCheck = Standard_True) const;
 139
 140   //! Renders groups of structure without applying any attributes (i.e. transform, material etc).
 141   //! @param theWorkspace current workspace
 142   //! @param theHasClosed flag will be set to TRUE if structure contains at least one group of closed primitives
 143   Standard_EXPORT void renderGeometry (const Handle(OpenGl_Workspace)& theWorkspace,
 144                                        bool&                           theHasClosed) const;
 145
 146   //! Render the bounding box.
 147   Standard_EXPORT void renderBoundingBox(const Handle(OpenGl_Workspace)& theWorkspace) const;
 148
 149 protected:
 150
 151   OpenGl_Structure*          myInstancedStructure;
 152   Graphic3d_Mat4             myRenderTrsf; //!< transformation, actually used for rendering (includes Local Origin shift)
 153
 154   mutable Standard_Boolean   myIsRaytracable;
 155   mutable Standard_Size      myModificationState;
 156
 157   Standard_Boolean           myIsMirrored; //!< Used to tell OpenGl to interpret polygons in clockwise order.
 158
 159 };
 160
 161 #endif // OpenGl_Structure_Header