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