src/OpenGl/OpenGl_PrimitiveArray.hxx

   1 // Created on: 2011-07-13
   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_PrimitiveArray_Header
  17 #define OpenGl_PrimitiveArray_Header
  18
  19 #include <OpenGl_IndexBuffer.hxx>
  20
  21 #include <InterfaceGraphic_Graphic3d.hxx>
  22 #include <Aspect_InteriorStyle.hxx>
  23 #include <Aspect_TypeOfMarker.hxx>
  24 #include <Graphic3d_TypeOfPrimitiveArray.hxx>
  25 #include <Graphic3d_IndexBuffer.hxx>
  26 #include <Graphic3d_BoundBuffer.hxx>
  27
  28 #include <OpenGl_Element.hxx>
  29
  30 class OpenGl_GraphicDriver;
  31 class Handle(OpenGl_ShaderProgram);
  32
  33 //! Class for rendering of arbitrary primitive array.
  34 class OpenGl_PrimitiveArray : public OpenGl_Element
  35 {
  36 public:
  37   // OpenGL does not provide a constant for "none" draw mode.
  38   // So we define our own one that does not conflict with GL constants
  39   // and utilizes common GL invalid value
  40   enum
  41   {
  42     DRAW_MODE_NONE = -1
  43   };
  44
  45   //! Empty constructor
  46   Standard_EXPORT OpenGl_PrimitiveArray (const OpenGl_GraphicDriver* theDriver);
  47
  48   //! Default constructor
  49   Standard_EXPORT OpenGl_PrimitiveArray (const OpenGl_GraphicDriver*          theDriver,
  50                                          const Graphic3d_TypeOfPrimitiveArray theType,
  51                                          const Handle(Graphic3d_IndexBuffer)& theIndices,
  52                                          const Handle(Graphic3d_Buffer)&      theAttribs,
  53                                          const Handle(Graphic3d_BoundBuffer)& theBounds);
  54
  55   //! Destructor
  56   Standard_EXPORT virtual ~OpenGl_PrimitiveArray();
  57
  58   //! Render primitives to the window
  59   Standard_EXPORT virtual void Render  (const Handle(OpenGl_Workspace)& theWorkspace) const;
  60
  61   //! Release OpenGL resources (VBOs)
  62   Standard_EXPORT virtual void Release (OpenGl_Context* theContext);
  63
  64   //! Return true if VBOs initialization has been performed.
  65   //! VBO initialization is performed during first Render() call.
  66   //! Notice that this flag does not indicate VBOs validity.
  67   Standard_Boolean IsInitialized() const { return myIsVboInit; }
  68
  69   //! Invalidate VBO content without destruction.
  70   void Invalidate() const { myIsVboInit = Standard_False; }
  71
  72   //! @return primitive type (GL_LINES, GL_TRIANGLES and others)
  73   GLint DrawMode() const { return myDrawMode; }
  74
  75   //! @return indices array
  76   const Handle(Graphic3d_IndexBuffer)& Indices() const { return myIndices; }
  77
  78   //! @return attributes array
  79   const Handle(Graphic3d_Buffer)& Attributes() const { return myAttribs; }
  80
  81   //! @return bounds array
  82   const Handle(Graphic3d_BoundBuffer)& Bounds() const { return myBounds; }
  83
  84   //! Returns unique ID of primitive array.
  85   const Standard_Size GetUID() const { return myUID; }
  86
  87   //! Initialize indices, attributes and bounds with new data.
  88   Standard_EXPORT void InitBuffers (const Handle(OpenGl_Context)&        theContext,
  89                                     const Graphic3d_TypeOfPrimitiveArray theType,
  90                                     const Handle(Graphic3d_IndexBuffer)& theIndices,
  91                                     const Handle(Graphic3d_Buffer)&      theAttribs,
  92                                     const Handle(Graphic3d_BoundBuffer)& theBounds);
  93
  94 protected:
  95
  96   //! VBO initialization procedures
  97   //! @param theCtx        bound GL context
  98   //! @param theToKeepData when true, myAttribs will not be nullified after VBO creation
  99   Standard_EXPORT Standard_Boolean buildVBO (const Handle(OpenGl_Context)& theCtx,
 100                                              const Standard_Boolean        theToKeepData) const;
 101
 102   Standard_EXPORT void clearMemoryGL (const Handle(OpenGl_Context)& theGlCtx) const;
 103
 104 private:
 105
 106   //! Initialize normal (OpenGL-provided) VBO
 107   Standard_Boolean initNormalVbo (const Handle(OpenGl_Context)& theCtx) const;
 108
 109   //! Main procedure to draw array
 110   void drawArray (const Handle(OpenGl_Workspace)& theWorkspace,
 111                   const Graphic3d_Vec4*           theFaceColors,
 112                   const Standard_Boolean          theHasVertColor) const;
 113
 114   //! Auxiliary procedures
 115   void drawEdges (const TEL_COLOUR*               theEdgeColour,
 116                   const Handle(OpenGl_Workspace)& theWorkspace) const;
 117
 118   void drawMarkers (const Handle(OpenGl_Workspace)& theWorkspace) const;
 119
 120   //! Sets OpenGL draw mode according to the input type of primitive array.
 121   //! If buffer of attributes is empty, draw mode is set to NONE to avoid invalid array rendering.
 122   //! @param theType type of primitive array.
 123   void setDrawMode (const Graphic3d_TypeOfPrimitiveArray theType);
 124
 125   //! Rebuilds the array of vertex attributes so that it can be drawn without indices.
 126   Standard_Boolean processIndices (const Handle(OpenGl_Context)& theContext) const;
 127
 128 protected:
 129
 130   mutable Handle(OpenGl_VertexBuffer)   myVboIndices;
 131   mutable Handle(OpenGl_VertexBuffer)   myVboAttribs;
 132
 133   mutable Handle(Graphic3d_IndexBuffer) myIndices;
 134   mutable Handle(Graphic3d_Buffer)      myAttribs;
 135   mutable Handle(Graphic3d_BoundBuffer) myBounds;
 136   GLint                                 myDrawMode;
 137   mutable Standard_Boolean              myIsVboInit;
 138
 139   Standard_Size                         myUID; //!< Unique ID of primitive array.
 140
 141 public:
 142
 143   DEFINE_STANDARD_ALLOC
 144
 145 };
 146
 147 #endif //OpenGl_PrimitiveArray_Header