VTK  9.3.0
vtkOpenGLBatchedPolyDataMapper.h
Go to the documentation of this file.
1 // SPDX-FileCopyrightText: Copyright (c) Ken Martin, Will Schroeder, Bill Lorensen
2 // SPDX-License-Identifier: BSD-3-Clause
3 
18 #ifndef vtkOpenGLBatchedPolyDataMapper_h
19 #define vtkOpenGLBatchedPolyDataMapper_h
20 
21 #include "vtkColor.h" // class uses vtkColor
22 #include "vtkNew.h" // for ivar
23 #include "vtkOpenGLCompositePolyDataMapperDelegator.h" // for struct BatchElement
24 #include "vtkRenderingOpenGL2Module.h" // for export macro
25 #include "vtkSmartPointer.h" // for arg
26 #include "vtk_glew.h" // for OpenGL defs
27 
28 // clang-format off
29 // Must be included after vtk_glew.h for GL_ES_VERSION_3_0
30 #ifndef GL_ES_VERSION_3_0
32 #define vtkOpenGLPolyDataMapperImplementation vtkOpenGLPolyDataMapper
33 #else
35 #define vtkOpenGLPolyDataMapperImplementation vtkOpenGLES30PolyDataMapper
36 #endif
37 // clang-format on
38 
39 #include <cstdint> // for std::uintptr_t
40 #include <memory> // for shared_ptr
41 
42 VTK_ABI_NAMESPACE_BEGIN
44 class vtkPolyData;
45 
46 class VTKRENDERINGOPENGL2_EXPORT vtkOpenGLBatchedPolyDataMapper
48 {
49 public:
52  void PrintSelf(ostream& os, vtkIndent indent) override;
53 
55 
60  void AddBatchElement(unsigned int flatIndex, BatchElement&& batchElement);
64 
68  std::vector<vtkPolyData*> GetRenderedList() const;
70 
74  void RenderPiece(vtkRenderer* renderer, vtkActor* actor) override;
77 
83  vtkHardwareSelector* sel, std::vector<unsigned int>& pixeloffsets, vtkProp* prop) override;
84 
86  GLBatchElement* glBatchElement, std::vector<unsigned int>& mypixels);
87 
88 protected:
91 
92  void RenderPieceDraw(vtkRenderer* renderer, vtkActor* actor) override;
93  void UpdateCameraShiftScale(vtkRenderer* renderer, vtkActor* actoror) override;
94 
98  void DrawIBO(vtkRenderer* renderer, vtkActor* actoror, int primType, vtkOpenGLHelper& CellBO,
99  GLenum mode, int pointSize);
100 
104  virtual void SetShaderValues(
105  vtkShaderProgram* prog, GLBatchElement* glBatchElement, size_t primOffset);
106 
111  void UpdateShaders(vtkOpenGLHelper& cellBO, vtkRenderer* renderer, vtkActor* actor) override;
112 
118  std::map<vtkShader::Type, vtkShader*> shaders, vtkRenderer* renderer, vtkActor* actor) override;
119 
123  bool GetNeedToRebuildBufferObjects(vtkRenderer* renderer, vtkActor* actor) override;
124 
128  void BuildBufferObjects(vtkRenderer* renderer, vtkActor* actor) override;
129  virtual void AppendOneBufferObject(vtkRenderer* renderer, vtkActor* actor,
130  GLBatchElement* glBatchElement, vtkIdType& vertexOffset, std::vector<unsigned char>& colors,
131  std::vector<float>& norms);
132 
137  vtkPolyData* poly, std::vector<unsigned int> (&indices)[4], vtkIdType offset) override;
138 
145 
146  // Reference to CPDM
147  vtkCompositePolyDataMapper* Parent = nullptr;
148  // Maps an address of a vtkPolyData to its rendering attributes.
149  std::map<std::uintptr_t, std::unique_ptr<GLBatchElement>> VTKPolyDataToGLBatchElement;
150  // Index arrays for vert, line, poly, strip, edge, stripedge
151  std::vector<unsigned int> IndexArray[PrimitiveEnd];
152  // Whether primitive IDs are used
154  // Whether override color is used for a vtkPolyData
156  // Reference to the current selector.
158  // used by the hardware selector
159  std::vector<std::vector<unsigned int>> PickPixels;
160  // cached array map
161  std::map<vtkAbstractArray*, vtkDataArray*> ColorArrayMap;
162 
163 private:
165  void operator=(const vtkOpenGLBatchedPolyDataMapper&) = delete;
166 };
167 
168 VTK_ABI_NAMESPACE_END
169 #endif
represents an object (geometry & properties) in a rendered scene
Definition: vtkActor.h:41
a class that renders hierarchical polygonal data
general representation of visualization data
Definition: vtkDataObject.h:55
a simple class to control print indentation
Definition: vtkIndent.h:29
An OpenGL mapper for batched rendering of vtkPolyData.
void ClearBatchElements()
API to add and query a GLBatchElement instance per vtkPolyData.
std::vector< std::vector< unsigned int > > PickPixels
void ReplaceShaderColor(std::map< vtkShader::Type, vtkShader * > shaders, vtkRenderer *renderer, vtkActor *actor) override
Perform string replacements on the shader templates, called from ReplaceShaderValues.
void RenderPiece(vtkRenderer *renderer, vtkActor *actor) override
Implemented by sub classes.
void UpdateShaders(vtkOpenGLHelper &cellBO, vtkRenderer *renderer, vtkActor *actor) override
Make sure appropriate shaders are defined, compiled and bound.
void BuildSelectionIBO(vtkPolyData *poly, std::vector< unsigned int >(&indices)[4], vtkIdType offset) override
Build the selection IBOs, called by UpdateBufferObjects.
virtual void AppendOneBufferObject(vtkRenderer *renderer, vtkActor *actor, GLBatchElement *glBatchElement, vtkIdType &vertexOffset, std::vector< unsigned char > &colors, std::vector< float > &norms)
void RenderPieceDraw(vtkRenderer *renderer, vtkActor *actor) override
BatchElement * GetBatchElement(vtkPolyData *polydata)
API to add and query a GLBatchElement instance per vtkPolyData.
void AddBatchElement(unsigned int flatIndex, BatchElement &&batchElement)
API to add and query a GLBatchElement instance per vtkPolyData.
void DrawIBO(vtkRenderer *renderer, vtkActor *actoror, int primType, vtkOpenGLHelper &CellBO, GLenum mode, int pointSize)
Draws primitives.
std::map< vtkAbstractArray *, vtkDataArray * > ColorArrayMap
int CanUseTextureMapForColoring(vtkDataObject *) override
Returns if we can use texture maps for scalar coloring.
void PrintSelf(ostream &os, vtkIndent indent) override
void BuildBufferObjects(vtkRenderer *renderer, vtkActor *actor) override
Build the VBO/IBO, called by UpdateBufferObjects.
void ProcessSelectorPixelBuffers(vtkHardwareSelector *sel, std::vector< unsigned int > &pixeloffsets, vtkProp *prop) override
allows a mapper to update a selections color buffers Called from a prop which in turn is called from ...
virtual void SetShaderValues(vtkShaderProgram *prog, GLBatchElement *glBatchElement, size_t primOffset)
Applies rendering attributes for the corresponding polydata in the glBatchElement.
~vtkOpenGLBatchedPolyDataMapper() override
void UpdateCameraShiftScale(vtkRenderer *renderer, vtkActor *actoror) override
virtual void ProcessCompositePixelBuffers(vtkHardwareSelector *sel, vtkProp *prop, GLBatchElement *glBatchElement, std::vector< unsigned int > &mypixels)
std::map< std::uintptr_t, std::unique_ptr< GLBatchElement > > VTKPolyDataToGLBatchElement
std::vector< vtkPolyData * > GetRenderedList() const
Accessor to the ordered list of PolyData that we last drew.
bool GetNeedToRebuildBufferObjects(vtkRenderer *renderer, vtkActor *actor) override
Does the VBO/IBO need to be rebuilt.
void SetParent(vtkCompositePolyDataMapper *parent)
static vtkOpenGLBatchedPolyDataMapper * New()
vtkCompositePolyDataMapperDelegator::BatchElement BatchElement
concrete dataset represents vertices, lines, polygons, and triangle strips
Definition: vtkPolyData.h:80
abstract superclass for all actors, volumes and annotations
Definition: vtkProp.h:46
abstract specification for renderers
Definition: vtkRenderer.h:62
The ShaderProgram uses one or more Shader objects.
@ mode
Definition: vtkX3D.h:247
@ offset
Definition: vtkX3D.h:438
#define vtkOpenGLPolyDataMapperImplementation
int vtkIdType
Definition: vtkType.h:315