VTK
vtkOpenGLInstanceCulling.h
Go to the documentation of this file.
1 /*=========================================================================
2 
3  Program: Visualization Toolkit
4  Module: vtkOpenGLInstanceCulling.h
5 
6  Copyright (c) Ken Martin, Will Schroeder, Bill Lorensen
7  All rights reserved.
8  See Copyright.txt or http://www.kitware.com/Copyright.htm for details.
9 
10  This software is distributed WITHOUT ANY WARRANTY; without even
11  the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR
12  PURPOSE. See the above copyright notice for more information.
13 
14 =========================================================================*/
15 
66 #ifndef vtkOpenGLInstanceCulling_h
67 #define vtkOpenGLInstanceCulling_h
68 
69 #include "vtkObject.h"
70 #include "vtkOpenGLHelper.h" // For vtkOpenGLHelper
71 #include "vtkRenderingOpenGL2Module.h" // For export macro
72 #include "vtkSmartPointer.h" // For smart pointer
73 
74 #include <vector>
75 
78 class vtkPolyData;
80 
81 class VTKRENDERINGOPENGL2_EXPORT vtkOpenGLInstanceCulling : public vtkObject
82 {
83 public:
86 
87  struct InstanceLOD
88  {
89  float Distance;
90  unsigned int Query;
95 
96  // used for sorting
97  bool operator < (const InstanceLOD& other) const
98  {
99  return this->Distance < other.Distance;
100  }
101  };
102 
106  void InitLOD(vtkPolyData* pd);
107 
115  void AddLOD(float distance, float targetReduction);
116 
120  void BuildCullingShaders(vtkOpenGLShaderCache* cache, vtkIdType numInstances, bool withNormals);
121 
126 
131 
136 
141 
145  void RunCullingShaders(vtkIdType numInstances,
146  vtkOpenGLBufferObject* matrixBuffer,
147  vtkOpenGLBufferObject* colorBuffer,
148  vtkOpenGLBufferObject* normalBuffer);
149 
151 
154  vtkSetMacro(ColorLOD, bool);
155  vtkGetMacro(ColorLOD, bool);
157 
158 protected:
161 
162  void DeleteLODs();
164 
165 private:
167  void operator=(const vtkOpenGLInstanceCulling &) = delete;
168 
169  vtkOpenGLHelper CullingHelper;
170  std::vector<InstanceLOD> LODList;
172  bool ColorLOD = false;
173 };
174 
175 #endif // vtkOpenGLInstanceCulling_h
176 
177 // VTK-HeaderTest-Exclude: vtkOpenGLInstanceCulling.h
vtkOpenGLInstanceCulling::DeleteLODs
void DeleteLODs()
vtkOpenGLInstanceCulling::vtkOpenGLInstanceCulling
vtkOpenGLInstanceCulling()=default
vtkOpenGLBufferObject
OpenGL buffer object.
Definition: vtkOpenGLBufferObject.h:34
vtkOpenGLInstanceCulling::RunCullingShaders
void RunCullingShaders(vtkIdType numInstances, vtkOpenGLBufferObject *matrixBuffer, vtkOpenGLBufferObject *colorBuffer, vtkOpenGLBufferObject *normalBuffer)
Run the culling program and generate LOD buffers.
vtkIdType
int vtkIdType
Definition: vtkType.h:347
vtkOpenGLInstanceCulling::GetNumberOfLOD
vtkIdType GetNumberOfLOD()
Get number of LOD currently declared.
vtkOpenGLInstanceCulling::AddLOD
void AddLOD(float distance, float targetReduction)
Add a level of detail.
vtkOpenGLHelper.h
vtkSmartPointer< vtkPolyData >
vtkObject
abstract base class for most VTK objects
Definition: vtkObject.h:60
vtkOpenGLInstanceCulling::GetLOD
InstanceLOD & GetLOD(vtkIdType index)
Get LOD structure.
vtkOpenGLInstanceCulling::InstanceLOD
Definition: vtkOpenGLInstanceCulling.h:88
operator<
VTKCOMMONCORE_EXPORT bool operator<(const vtkUnicodeString &lhs, const vtkUnicodeString &rhs)
vtkOpenGLInstanceCulling::InstanceLOD::NormalVBO
vtkOpenGLBufferObject * NormalVBO
Definition: vtkOpenGLInstanceCulling.h:93
vtkOpenGLInstanceCulling::GetLODBuffer
vtkOpenGLBufferObject * GetLODBuffer(vtkIdType index)
Get the transform feedback buffer generated by the culling program.
vtkOpenGLIndexBufferObject
OpenGL vertex buffer object.
Definition: vtkOpenGLIndexBufferObject.h:30
vtkOpenGLInstanceCulling::~vtkOpenGLInstanceCulling
~vtkOpenGLInstanceCulling() override
vtkOpenGLInstanceCulling
Frustum culling and LOD management.
Definition: vtkOpenGLInstanceCulling.h:82
vtkOpenGLHelper
Definition: vtkOpenGLHelper.h:31
vtkOpenGLInstanceCulling::BuildCullingShaders
void BuildCullingShaders(vtkOpenGLShaderCache *cache, vtkIdType numInstances, bool withNormals)
Build culling shader program (if not created yet) and binds it.
vtkOpenGLInstanceCulling::New
static vtkOpenGLInstanceCulling * New()
vtkSmartPointer.h
vtkOpenGLInstanceCulling::InstanceLOD::Query
unsigned int Query
Definition: vtkOpenGLInstanceCulling.h:90
vtkOpenGLShaderCache
manage Shader Programs within a context
Definition: vtkOpenGLShaderCache.h:36
vtkOpenGLInstanceCulling::InstanceLOD::PositionVBO
vtkOpenGLBufferObject * PositionVBO
Definition: vtkOpenGLInstanceCulling.h:92
vtkObject.h
vtkOpenGLInstanceCulling::InstanceLOD::Distance
float Distance
Definition: vtkOpenGLInstanceCulling.h:89
vtkOpenGLInstanceCulling::InitLOD
void InitLOD(vtkPolyData *pd)
Initialize LOD with a polydata.
vtkOpenGLInstanceCulling::InstanceLOD::IBO
vtkOpenGLIndexBufferObject * IBO
Definition: vtkOpenGLInstanceCulling.h:91
vtkPolyData
concrete dataset represents vertices, lines, polygons, and triangle strips
Definition: vtkPolyData.h:86
vtkOpenGLInstanceCulling::InstanceLOD::NumberOfInstances
int NumberOfInstances
Definition: vtkOpenGLInstanceCulling.h:94
vtkOpenGLInstanceCulling::UploadCurrentState
void UploadCurrentState(InstanceLOD &lod, vtkPolyData *pd)
vtkX3D::index
@ index
Definition: vtkX3D.h:246
vtkOpenGLInstanceCulling::GetHelper
vtkOpenGLHelper & GetHelper()
Get helper structure.