VTK  9.3.0
vtkCompositePolyDataMapper2.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
25#ifndef vtkCompositePolyDataMapper2_h
26#define vtkCompositePolyDataMapper2_h
27
28#include "vtkDeprecation.h" // For VTK_DEPRECATED_IN_9_3_0
29#include "vtkRenderingOpenGL2Module.h" // For export macro
30#include "vtkSmartPointer.h" // for vtkSmartPointer
31#include "vtk_glew.h" // for OpenGL enums
32// clang-format off
33// Must be included after vtk_glew.h for GL_ES_VERSION_3_0
34#ifndef GL_ES_VERSION_3_0
36#define vtkOpenGLPolyDataMapperImplementation vtkOpenGLPolyDataMapper
37#else
39#define vtkOpenGLPolyDataMapperImplementation vtkOpenGLES30PolyDataMapper
40#endif
41// clang-format on
42
43#include "vtkColor.h" // used for ivars
44#include <map> // use for ivars
45#include <stack> // used for ivars
46#include <vector> // used for ivars
47
48VTK_ABI_NAMESPACE_BEGIN
52
53class VTK_DEPRECATED_IN_9_3_0("Please use vtkCompositePolyDataMapper instead")
54 VTKRENDERINGOPENGL2_EXPORT vtkCompositePolyDataMapper2
56{
57public:
60 void PrintSelf(ostream& os, vtkIndent indent) override;
61
63
68 bool HasOpaqueGeometry() override;
71
73
79
81
84 void SetBlockVisibility(unsigned int index, bool visible);
85 bool GetBlockVisibility(unsigned int index);
86 void RemoveBlockVisibility(unsigned int index);
89
91
94 void SetBlockColor(unsigned int index, const double color[3]);
95 void SetBlockColor(unsigned int index, double r, double g, double b)
96 {
97 double color[3] = { r, g, b };
98 this->SetBlockColor(index, color);
99 }
100 double* GetBlockColor(unsigned int index);
101 void RemoveBlockColor(unsigned int index);
104
106
109 void SetBlockOpacity(unsigned int index, double opacity);
110 double GetBlockOpacity(unsigned int index);
111 void RemoveBlockOpacity(unsigned int index);
114
121 vtkSetMacro(ColorMissingArraysWithNanColor, bool);
122 vtkGetMacro(ColorMissingArraysWithNanColor, bool);
123 vtkBooleanMacro(ColorMissingArraysWithNanColor, bool);
132
136 void Render(vtkRenderer* ren, vtkActor* act) override;
137
141 void SetVBOShiftScaleMethod(int m) override;
142
147 void SetPauseShiftScale(bool pauseShiftScale) override;
148
150
155 int idx, int port, int connection, int fieldAssociation, const char* name) override;
157 int idx, int port, int connection, int fieldAssociation, int fieldAttributeType) override;
158 void SetInputArrayToProcess(int idx, vtkInformation* info) override;
160
164 std::vector<vtkPolyData*> GetRenderedList() { return this->RenderedList; }
165
171 vtkHardwareSelector* sel, std::vector<unsigned int>& pixeloffsets, vtkProp* prop) override;
172
177
178protected:
181
188
192 int FillInputPortInformation(int port, vtkInformation* info) override;
193
197 void ComputeBounds() override;
198
204 vtkRenderer* vtkNotUsed(ren), vtkActor* vtkNotUsed(act))
205 {
206 }
207
212
213 // what "index" are we currently rendering, -1 means none
215 std::map<const std::string, vtkCompositeMapperHelper2*> Helpers;
216 std::map<vtkPolyData*, vtkCompositeMapperHelperData*> HelperDataMap;
218
220
221 // copy values to the helpers
223
225 {
226 public:
227 std::stack<bool> Visibility;
228 std::stack<bool> Pickability;
229 std::stack<double> Opacity;
230 std::stack<vtkColor3d> AmbientColor;
231 std::stack<vtkColor3d> DiffuseColor;
232 std::stack<vtkColor3d> SpecularColor;
233 std::stack<vtkColor3d> SelectionColor;
234 std::stack<float> SelectionOpacity;
235 };
236
237 bool RecursiveHasTranslucentGeometry(vtkDataObject* dobj, unsigned int& flat_index);
240
242 vtkRenderer* renderer, vtkActor* actor, vtkDataObject* dobj, unsigned int& flat_index);
244
247 vtkRenderer* renderer, vtkActor* actor, vtkDataObject* dobj, unsigned int& flat_index);
248
253
255
261
262 std::vector<vtkPolyData*> RenderedList;
263
264private:
265 double ColorResult[3];
266
268 void operator=(const vtkCompositePolyDataMapper2&) = delete;
269};
270
271VTK_ABI_NAMESPACE_END
272#endif
represents an object (geometry & properties) in a rendered scene
Definition vtkActor.h:50
virtual void SetInputArrayToProcess(int idx, int port, int connection, int fieldAssociation, const char *name)
Set the input data arrays that this algorithm will process.
Rendering attributes for a multi-block dataset.
Helper class for vtkCompositePolyDataMapper2 that is a subclass of vtkOpenGLPolyDataMapper.
mapper for composite dataset consisting of polygonal data.
void SetInputArrayToProcess(int idx, int port, int connection, int fieldAssociation, int fieldAttributeType) override
Call SetInputArrayToProcess on helpers.
void BuildRenderValues(vtkRenderer *renderer, vtkActor *actor, vtkDataObject *dobj, unsigned int &flat_index)
void RemoveBlockVisibility(unsigned int index)
Set/get the visibility for a block given its flat index.
int FillInputPortInformation(int port, vtkInformation *info) override
Need to define the type of data handled by this mapper.
~vtkCompositePolyDataMapper2() override
static vtkCompositePolyDataMapper2 * New()
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 ...
bool HasOpaqueGeometry() override
Some introspection on the type of data the mapper will render used by props to determine if they shou...
double GetBlockOpacity(unsigned int index)
Set/get the opacity for a block given its flat index.
void ReleaseGraphicsResources(vtkWindow *) override
Release any graphics resources that are being consumed by this mapper.
std::vector< vtkPolyData * > GetRenderedList()
Accessor to the ordered list of PolyData that we end last drew.
void SetBlockVisibility(unsigned int index, bool visible)
Set/get the visibility for a block given its flat index.
void SetInputArrayToProcess(int idx, int port, int connection, int fieldAssociation, const char *name) override
Call SetInputArrayToProcess on helpers.
double * GetBlockColor(unsigned int index)
Set/get the color for a block given its flat index.
vtkTimeStamp BoundsMTime
Time stamp for computation of bounds.
bool RecursiveHasTranslucentGeometry(vtkDataObject *dobj, unsigned int &flat_index)
void SetVBOShiftScaleMethod(int m) override
A convenience method for enabling/disabling the VBO's shift+scale transform.
std::map< vtkPolyData *, vtkCompositeMapperHelperData * > HelperDataMap
virtual void InitializeHelpersBeforeRendering(vtkRenderer *vtkNotUsed(ren), vtkActor *vtkNotUsed(act))
This method is called before RenderPiece is called on helpers.
void PrintSelf(ostream &os, vtkIndent indent) override
std::map< const std::string, vtkCompositeMapperHelper2 * > Helpers
void SetBlockOpacity(unsigned int index, double opacity)
Set/get the opacity for a block given its flat index.
void SetBlockColor(unsigned int index, const double color[3])
Set/get the color for a block given its flat index.
void SetPauseShiftScale(bool pauseShiftScale) override
Pause updates of shift-scale parameters based on camera position.
vtkCompositeDataDisplayAttributes * GetCompositeDataDisplayAttributes()
Set/get the composite data set attributes.
virtual void CopyMapperValuesToHelper(vtkCompositeMapperHelper2 *helper)
bool GetBlockVisibility(unsigned int index)
Set/get the visibility for a block given its flat index.
void RemoveBlockColor(unsigned int index)
Set/get the color for a block given its flat index.
bool ColorMissingArraysWithNanColor
If the current 'color by' array is missing on some datasets, color these dataset by the LookupTable's...
virtual vtkCompositeMapperHelper2 * CreateHelper()
void RemoveBlockVisibilities()
Set/get the visibility for a block given its flat index.
vtkExecutive * CreateDefaultExecutive() override
We need to override this method because the standard streaming demand driven pipeline is not what we ...
void SetInputArrayToProcess(int idx, vtkInformation *info) override
Call SetInputArrayToProcess on helpers.
void RemoveBlockColors()
Set/get the color for a block given its flat index.
vtkSmartPointer< vtkCompositeDataDisplayAttributes > CompositeAttributes
Composite data set attributes.
void RenderBlock(vtkRenderer *renderer, vtkActor *actor, vtkDataObject *dobj, unsigned int &flat_index)
bool HasTranslucentPolygonalGeometry() override
Some introspection on the type of data the mapper will render used by props to determine if they shou...
std::vector< vtkPolyData * > RenderedList
void Render(vtkRenderer *ren, vtkActor *act) override
This calls RenderPiece (in a for loop if streaming is necessary).
void SetBlockColor(unsigned int index, double r, double g, double b)
Set/get the color for a block given its flat index.
void RemoveBlockOpacity(unsigned int index)
Set/get the opacity for a block given its flat index.
void RemoveBlockOpacities()
Set/get the opacity for a block given its flat index.
void SetCompositeDataDisplayAttributes(vtkCompositeDataDisplayAttributes *attributes)
Set/get the composite data set attributes.
void ComputeBounds() override
Need to loop over the hierarchy to compute bounds.
vtkMTimeType GetMTime() override
Overridden to include vtkCompositeDataDisplayAttributes' mtime.
general representation of visualization data
Superclass for all pipeline executives in VTK.
a simple class to control print indentation
Definition vtkIndent.h:38
Store vtkAlgorithm input/output information.
abstract superclass for all actors, volumes and annotations
Definition vtkProp.h:52
abstract specification for renderers
Definition vtkRenderer.h:68
Hold a reference to a vtkObjectBase instance.
Class to make storing and comparing state quick and easy.
record modification and/or execution time
window superclass for vtkRenderWindow
Definition vtkWindow.h:34
#define vtkOpenGLPolyDataMapperImplementation
#define vtkOpenGLPolyDataMapperImplementation
#define VTK_DEPRECATED_IN_9_3_0(reason)
vtkTypeUInt32 vtkMTimeType
Definition vtkType.h:270