vtkOpenGLInstanceCulling.h

Go to the documentation of this file.

// SPDX-FileCopyrightText: Copyright (c) Ken Martin, Will Schroeder, Bill Lorensen
// SPDX-License-Identifier: BSD-3-Clause
 
#ifndef vtkOpenGLInstanceCulling_h
#define vtkOpenGLInstanceCulling_h
 
#include "vtkObject.h"
#include "vtkOpenGLHelper.h"           // For vtkOpenGLHelper
#include "vtkRenderingOpenGL2Module.h" // For export macro
#include "vtkSmartPointer.h"           // For smart pointer
 
#include <vector> // for std::vector
 
VTK_ABI_NAMESPACE_BEGIN
class vtkOpenGLIndexBufferObject;
class vtkOpenGLBufferObject;
class vtkPolyData;
class vtkOpenGLShaderCache;
 
class VTKRENDERINGOPENGL2_EXPORT vtkOpenGLInstanceCulling : public vtkObject
{
public:
  static vtkOpenGLInstanceCulling* New();
  vtkTypeMacro(vtkOpenGLInstanceCulling, vtkObject);
  void PrintSelf(ostream& os, vtkIndent indent) override;
 
  struct InstanceLOD
  {
    float Distance;
    unsigned int Query;
    vtkOpenGLIndexBufferObject* IBO;
    vtkOpenGLBufferObject* PositionVBO;
    vtkOpenGLBufferObject* NormalVBO;
    int NumberOfInstances;
 
    // used for sorting
    bool operator<(const InstanceLOD& other) const { return this->Distance < other.Distance; }
  };
 
  void InitLOD(vtkPolyData* pd);
 
  void AddLOD(float distance, float targetReduction);
 
  void BuildCullingShaders(vtkOpenGLShaderCache* cache, vtkIdType numInstances, bool withNormals);
 
  vtkOpenGLHelper& GetHelper();
 
  InstanceLOD& GetLOD(vtkIdType index);
 
  vtkIdType GetNumberOfLOD();
 
  vtkOpenGLBufferObject* GetLODBuffer(vtkIdType index);
 
  void RunCullingShaders(vtkIdType numInstances, vtkOpenGLBufferObject* matrixBuffer,
    vtkOpenGLBufferObject* colorBuffer, vtkOpenGLBufferObject* normalBuffer);
 
 
  vtkSetMacro(ColorLOD, bool);
  vtkGetMacro(ColorLOD, bool);
 
protected:
  vtkOpenGLInstanceCulling() = default;
  ~vtkOpenGLInstanceCulling() override;
 
  void DeleteLODs();
  void UploadCurrentState(InstanceLOD& lod, vtkPolyData* pd);
 
private:
  vtkOpenGLInstanceCulling(const vtkOpenGLInstanceCulling&) = delete;
  void operator=(const vtkOpenGLInstanceCulling&) = delete;
 
  vtkOpenGLHelper CullingHelper;
  std::vector<InstanceLOD> LODList;
  vtkSmartPointer<vtkPolyData> PolyData;
  bool ColorLOD = false;
};
 
VTK_ABI_NAMESPACE_END
#endif // vtkOpenGLInstanceCulling_h