0029353: Optimization of TPrsStd_AISPresentation::SetSelectionMode()
[occt.git] / src / OpenGl / OpenGl_PrimitiveArray.hxx
CommitLineData
b311480e 1// Created on: 2011-07-13
2// Created by: Sergey ZERCHANINOV
973c2be1 3// Copyright (c) 2011-2014 OPEN CASCADE SAS
b311480e 4//
973c2be1 5// This file is part of Open CASCADE Technology software library.
b311480e 6//
d5f74e42 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
973c2be1 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.
b311480e 12//
973c2be1 13// Alternatively, this file may be used under the terms of Open CASCADE
14// commercial license or contractual agreement.
b311480e 15
2166f0fa
SK
16#ifndef OpenGl_PrimitiveArray_Header
17#define OpenGl_PrimitiveArray_Header
18
871fa103 19#include <OpenGl_IndexBuffer.hxx>
2166f0fa 20
2166f0fa 21#include <Aspect_InteriorStyle.hxx>
a577aaab 22#include <Aspect_TypeOfMarker.hxx>
871fa103 23#include <Graphic3d_TypeOfPrimitiveArray.hxx>
24#include <Graphic3d_IndexBuffer.hxx>
25#include <Graphic3d_BoundBuffer.hxx>
2166f0fa
SK
26
27#include <OpenGl_Element.hxx>
28
8d3f219f 29class OpenGl_GraphicDriver;
30
7d3e64ef 31//! Class for rendering of arbitrary primitive array.
2166f0fa
SK
32class OpenGl_PrimitiveArray : public OpenGl_Element
33{
34public:
8e0a2b19 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.
1d03e66d 37 enum
38 {
39 DRAW_MODE_NONE = -1
40 };
2166f0fa 41
e1c659da 42 //! Empty constructor
43 Standard_EXPORT OpenGl_PrimitiveArray (const OpenGl_GraphicDriver* theDriver);
44
2166f0fa 45 //! Default constructor
e1c659da 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();
2166f0fa 54
2166f0fa 55 //! Render primitives to the window
64c6d8df 56 Standard_EXPORT virtual void Render (const Handle(OpenGl_Workspace)& theWorkspace) const Standard_OVERRIDE;
e1c659da 57
58 //! Release OpenGL resources (VBOs)
64c6d8df 59 Standard_EXPORT virtual void Release (OpenGl_Context* theContext) Standard_OVERRIDE;
5e27df78 60
e1c659da 61 //! Return true if VBOs initialization has been performed.
62 //! VBO initialization is performed during first Render() call.
63 //! Notice that this flag does not indicate VBOs validity.
64 Standard_Boolean IsInitialized() const { return myIsVboInit; }
2166f0fa 65
536d98e2 66 //! Invalidate VBO content without destruction.
67 void Invalidate() const { myIsVboInit = Standard_False; }
68
871fa103 69 //! @return primitive type (GL_LINES, GL_TRIANGLES and others)
70 GLint DrawMode() const { return myDrawMode; }
2166f0fa 71
8e0a2b19 72 //! Return TRUE if primitive type generates shaded triangulation.
64c6d8df 73 virtual Standard_Boolean IsFillDrawMode() const Standard_OVERRIDE { return myIsFillType; }
8e0a2b19 74
871fa103 75 //! @return indices array
76 const Handle(Graphic3d_IndexBuffer)& Indices() const { return myIndices; }
2166f0fa 77
871fa103 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
8d3f219f 84 //! Returns unique ID of primitive array.
487bf1ce 85 Standard_Size GetUID() const { return myUID; }
8d3f219f 86
a79f67f8 87 //! Initialize indices, attributes and bounds with new data.
e1c659da 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);
a79f67f8 93
0b0320e7 94protected:
7d3e64ef 95
2166f0fa 96 //! VBO initialization procedures
7d3e64ef 97 //! @param theCtx bound GL context
98 //! @param theToKeepData when true, myAttribs will not be nullified after VBO creation
0b0320e7 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
104private:
105
106 //! Initialize normal (OpenGL-provided) VBO
107 Standard_Boolean initNormalVbo (const Handle(OpenGl_Context)& theCtx) const;
2166f0fa
SK
108
109 //! Main procedure to draw array
7d3e64ef 110 void drawArray (const Handle(OpenGl_Workspace)& theWorkspace,
8625ef7e 111 const Graphic3d_Vec4* theFaceColors,
112 const Standard_Boolean theHasVertColor) const;
2166f0fa
SK
113
114 //! Auxiliary procedures
b6472664 115 void drawEdges (const OpenGl_Vec4& theEdgeColour,
2166f0fa
SK
116 const Handle(OpenGl_Workspace)& theWorkspace) const;
117
7d3e64ef 118 void drawMarkers (const Handle(OpenGl_Workspace)& theWorkspace) const;
a577aaab 119
a79f67f8 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
e99a2f7c 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
2166f0fa
SK
128protected:
129
7d3e64ef 130 mutable Handle(OpenGl_VertexBuffer) myVboIndices;
871fa103 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;
8e0a2b19 136 GLshort myDrawMode;
137 mutable Standard_Boolean myIsFillType;
871fa103 138 mutable Standard_Boolean myIsVboInit;
2166f0fa 139
8d3f219f 140 Standard_Size myUID; //!< Unique ID of primitive array.
141
2166f0fa
SK
142public:
143
1c35b92f 144 DEFINE_STANDARD_ALLOC
2166f0fa
SK
145
146};
147
148#endif //OpenGl_PrimitiveArray_Header