0031394: Visualization, TKOpenGl - define OpenGl_Element::EstimatedDataSize() interface
[occt.git] / 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 <Aspect_InteriorStyle.hxx>
22 #include <Aspect_TypeOfMarker.hxx>
23 #include <Graphic3d_TypeOfPrimitiveArray.hxx>
24 #include <Graphic3d_IndexBuffer.hxx>
25 #include <Graphic3d_BoundBuffer.hxx>
26
27 #include <OpenGl_Element.hxx>
28
29 class OpenGl_GraphicDriver;
30
31 //! Class for rendering of arbitrary primitive array.
32 class OpenGl_PrimitiveArray : public OpenGl_Element
33 {
34 public:
35   //! OpenGL does not provide a constant for "none" draw mode.
36   //! So we define our own one that does not conflict with GL constants and utilizes common GL invalid value.
37   enum
38   {
39     DRAW_MODE_NONE = -1
40   };
41
42   //! Empty constructor
43   Standard_EXPORT OpenGl_PrimitiveArray (const OpenGl_GraphicDriver* theDriver);
44
45   //! Default constructor
46   Standard_EXPORT OpenGl_PrimitiveArray (const OpenGl_GraphicDriver*          theDriver,
47                                          const Graphic3d_TypeOfPrimitiveArray theType,
48                                          const Handle(Graphic3d_IndexBuffer)& theIndices,
49                                          const Handle(Graphic3d_Buffer)&      theAttribs,
50                                          const Handle(Graphic3d_BoundBuffer)& theBounds);
51
52   //! Destructor
53   Standard_EXPORT virtual ~OpenGl_PrimitiveArray();
54
55   //! Render primitives to the window
56   Standard_EXPORT virtual void Render  (const Handle(OpenGl_Workspace)& theWorkspace) const Standard_OVERRIDE;
57
58   //! Release OpenGL resources (VBOs)
59   Standard_EXPORT virtual void Release (OpenGl_Context* theContext) Standard_OVERRIDE;
60
61   //! Returns estimated GPU memory usage for holding data without considering overheads and allocation alignment rules.
62   Standard_EXPORT virtual Standard_Size EstimatedDataSize() const Standard_OVERRIDE;
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 TRUE if primitive type generates shaded triangulation.
76   virtual Standard_Boolean IsFillDrawMode() const Standard_OVERRIDE { return myIsFillType; }
77
78   //! @return indices array
79   const Handle(Graphic3d_IndexBuffer)& Indices() const { return myIndices; }
80
81   //! @return attributes array
82   const Handle(Graphic3d_Buffer)& Attributes() const { return myAttribs; }
83
84   //! @return bounds array
85   const Handle(Graphic3d_BoundBuffer)& Bounds() const { return myBounds; }
86
87   //! Returns unique ID of primitive array. 
88   Standard_Size GetUID() const { return myUID; }
89
90   //! Initialize indices, attributes and bounds with new data.
91   Standard_EXPORT void InitBuffers (const Handle(OpenGl_Context)&        theContext,
92                                     const Graphic3d_TypeOfPrimitiveArray theType,
93                                     const Handle(Graphic3d_IndexBuffer)& theIndices,
94                                     const Handle(Graphic3d_Buffer)&      theAttribs,
95                                     const Handle(Graphic3d_BoundBuffer)& theBounds);
96
97 public:
98
99   //! Returns index VBO.
100   const Handle(OpenGl_VertexBuffer)& IndexVbo() const { return  myVboIndices; }
101
102   //! Returns attributes VBO.
103   const Handle(OpenGl_VertexBuffer)& AttributesVbo() const { return myVboAttribs; }
104
105   //! Dumps the content of me into the stream
106   Standard_EXPORT virtual void DumpJson (Standard_OStream& theOStream, Standard_Integer theDepth = -1) const Standard_OVERRIDE;
107
108 protected:
109
110   //! VBO initialization procedures
111   //! @param theCtx        bound GL context
112   //! @param theToKeepData when true, myAttribs will not be nullified after VBO creation
113   Standard_EXPORT Standard_Boolean buildVBO (const Handle(OpenGl_Context)& theCtx,
114                                              const Standard_Boolean        theToKeepData) const;
115
116   //! Patch VBO sub-date within invalidated range.
117   Standard_EXPORT void updateVBO (const Handle(OpenGl_Context)& theCtx) const;
118
119   //! Release GL memory.
120   Standard_EXPORT void clearMemoryGL (const Handle(OpenGl_Context)& theGlCtx) const;
121
122 private:
123
124   //! Initialize normal (OpenGL-provided) VBO
125   Standard_Boolean initNormalVbo (const Handle(OpenGl_Context)& theCtx) const;
126
127   //! Main procedure to draw array
128   void drawArray (const Handle(OpenGl_Workspace)& theWorkspace,
129                   const Graphic3d_Vec4*           theFaceColors,
130                   const Standard_Boolean          theHasVertColor) const;
131
132   //! Auxiliary procedures
133   void drawEdges (const Handle(OpenGl_Workspace)& theWorkspace) const;
134
135   void drawMarkers (const Handle(OpenGl_Workspace)& theWorkspace) const;
136
137   //! Sets OpenGL draw mode according to the input type of primitive array.
138   //! If buffer of attributes is empty, draw mode is set to NONE to avoid invalid array rendering.
139   //! @param theType type of primitive array.
140   void setDrawMode (const Graphic3d_TypeOfPrimitiveArray theType);
141
142   //! Rebuilds the array of vertex attributes so that it can be drawn without indices.
143   Standard_Boolean processIndices (const Handle(OpenGl_Context)& theContext) const;
144
145 protected:
146
147   mutable Handle(OpenGl_VertexBuffer)   myVboIndices;
148   mutable Handle(OpenGl_VertexBuffer)   myVboAttribs;
149
150   mutable Handle(Graphic3d_IndexBuffer) myIndices;
151   mutable Handle(Graphic3d_Buffer)      myAttribs;
152   mutable Handle(Graphic3d_BoundBuffer) myBounds;
153   GLshort                               myDrawMode;
154   mutable Standard_Boolean              myIsFillType;
155   mutable Standard_Boolean              myIsVboInit;
156
157   Standard_Size                         myUID; //!< Unique ID of primitive array. 
158
159 public:
160
161   DEFINE_STANDARD_ALLOC
162
163 };
164
165 #endif //OpenGl_PrimitiveArray_Header