VTK  9.4.20250114
vtkCompositePolyDataMapper.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
41#ifndef vtkCompositePolyDataMapper_h
42#define vtkCompositePolyDataMapper_h
43
44#include "vtkPolyDataMapper.h"
45
46#include "vtkRenderingCoreModule.h" // for export macro
47#include "vtkStateStorage.h" // for ivar
48#include "vtkWrappingHints.h" // For VTK_MARSHALAUTO
49
50#include <array> // for ColorResult. Remove when double* GetBlockColor gets removed.
51#include <memory> // for unique_ptr
52#include <vector> // for return
53
54VTK_ABI_NAMESPACE_BEGIN
55class vtkActor;
60class vtkInformation;
61class vtkPolyData;
62class vtkRenderer;
63
64class VTKRENDERINGCORE_EXPORT VTK_MARSHALAUTO vtkCompositePolyDataMapper : public vtkPolyDataMapper
65{
66public:
69 void PrintSelf(ostream& os, vtkIndent indent) override;
70
75 void Render(vtkRenderer* renderer, vtkActor* actor) override;
76
78
81 double* GetBounds() VTK_SIZEHINT(6) override;
82 void GetBounds(double bounds[6]) override { this->Superclass::GetBounds(bounds); }
84
88 void ShallowCopy(vtkAbstractMapper* mapper) override;
89
94
96
101 bool HasOpaqueGeometry() override;
104
106
112
114
117 void SetBlockVisibility(unsigned int index, bool visible);
118 bool GetBlockVisibility(unsigned int index);
119 void RemoveBlockVisibility(unsigned int index);
122
124
127 void SetBlockColor(unsigned int index, const double color[3]);
128 void SetBlockColor(unsigned int index, double r, double g, double b)
129 {
130 double color[3] = { r, g, b };
131 this->SetBlockColor(index, color);
132 }
133 void GetBlockColor(unsigned int index, double color[3]);
134 void RemoveBlockColor(unsigned int index);
137
139
142 void SetBlockOpacity(unsigned int index, double opacity);
143 double GetBlockOpacity(unsigned int index);
144 void RemoveBlockOpacity(unsigned int index);
147
149
152 void SetBlockScalarMode(unsigned int index, int value);
153 int GetBlockScalarMode(unsigned int index);
154 void RemoveBlockScalarMode(unsigned int index);
157
159
162 void SetBlockArrayAccessMode(unsigned int index, int value);
163 int GetBlockArrayAccessMode(unsigned int index);
164 void RemoveBlockArrayAccessMode(unsigned int index);
167
169
172 void SetBlockArrayComponent(unsigned int index, int value);
173 int GetBlockArrayComponent(unsigned int index);
174 void RemoveBlockArrayComponent(unsigned int index);
177
179
182 void SetBlockArrayId(unsigned int index, int value);
183 int GetBlockArrayId(unsigned int index);
184 void RemoveBlockArrayId(unsigned int index);
187
189
192 void SetBlockArrayName(unsigned int index, const std::string& value);
193 std::string GetBlockArrayName(unsigned int index);
194 void RemoveBlockArrayName(unsigned int index);
197
199
202 void SetBlockFieldDataTupleId(unsigned int index, vtkIdType value);
204 void RemoveBlockFieldDataTupleId(unsigned int index);
207
209
215 vtkSetMacro(ColorMissingArraysWithNanColor, bool);
216 vtkGetMacro(ColorMissingArraysWithNanColor, bool);
217 vtkBooleanMacro(ColorMissingArraysWithNanColor, bool);
219
221
226 int idx, int port, int connection, int fieldAssociation, const char* name) override;
228 int idx, int port, int connection, int fieldAssociation, int fieldAttributeType) override;
229 void SetInputArrayToProcess(int idx, vtkInformation* info) override;
231
235 std::vector<vtkPolyData*> GetRenderedList();
236
242 vtkHardwareSelector* sel, std::vector<unsigned int>& pixeloffsets, vtkProp* prop) override;
243
247 void SetVBOShiftScaleMethod(int method) override;
248
254 void SetPauseShiftScale(bool pauseShiftScale) override;
255
260
261protected:
264
265 MapperHashType InsertPolyData(vtkPolyData* polydata, const unsigned int& flatIndex);
266
273
277 int FillInputPortInformation(int port, vtkInformation* info) override;
278
287
295 {
296 }
297
304 {
305 }
306
311
316
320 void ComputeBounds() override;
321
322 bool RecursiveHasTranslucentGeometry(vtkDataObject* dobj, unsigned int& flat_index);
323
325 vtkRenderer* renderer, vtkActor* actor, vtkDataObject* dobj, unsigned int& flat_index);
326
333
338
343 bool ColorMissingArraysWithNanColor = false;
344
349
351 bool HasTranslucentGeometry = false;
355
356private:
358 void operator=(const vtkCompositePolyDataMapper&) = delete;
359
360 class vtkInternals;
361 std::unique_ptr<vtkInternals> Internals;
362};
363
364VTK_ABI_NAMESPACE_END
365#endif
abstract class specifies interface to map data
represents an object (geometry & properties) in a rendered scene
Definition vtkActor.h:151
void SetInputArrayToProcess(const char *name, int fieldAssociation)
Set the input data arrays that this algorithm will process.
Rendering attributes for a multi-block dataset.
abstract superclass for composite (multi-block or AMR) datasets
Delegates rendering of multiple polydata that share similar signatures.
a class that renders hierarchical polygonal data
std::vector< vtkPolyData * > GetRenderedList()
Accessor to the ordered list of PolyData that we last drew.
void SetBlockFieldDataTupleId(unsigned int index, vtkIdType value)
void RemoveBlockColor(unsigned int index)
Set/get the color for a block given its flat index.
vtkCompositeDataDisplayAttributes * GetCompositeDataDisplayAttributes()
Set/get the composite data set attributes.
double GetBlockOpacity(unsigned int index)
Set/get the opacity for a block given its flat index.
MapperHashType InsertPolyData(vtkPolyData *polydata, const unsigned int &flatIndex)
bool GetBlockVisibility(unsigned int index)
Set/get the visibility for a block given its flat index.
void SetBlockArrayAccessMode(unsigned int index, int value)
void ComputeBounds() override
Need to loop over the hierarchy to compute bounds.
void SetCompositeDataDisplayAttributes(vtkCompositeDataDisplayAttributes *attributes)
Set/get the composite data set attributes.
void RemoveBlockArrayAccessMode(unsigned int index)
void RemoveBlockOpacity(unsigned int index)
Set/get the opacity for a block given its flat index.
virtual vtkCompositePolyDataMapperDelegator * CreateADelegator()
This is the build method for creating the delegator.
void RemoveBlockColors()
Set/get the color for a block given its flat index.
vtkPolyDataMapper::MapperHashType GenerateHash(vtkPolyData *polydata) override
Creates an empty polydata mapper and asks the mapper to hash the polydata.
void SetVBOShiftScaleMethod(int method) override
A convenience method for enabling/disabling the VBO's shift+scale transform.
int GetBlockScalarMode(unsigned int index)
vtkExecutive * CreateDefaultExecutive() override
We need to override this method because the standard streaming demand driven pipeline is not what we ...
void RemoveBlockArrayName(unsigned int index)
vtkMTimeType GetMTime() override
Overridden to include vtkCompositeDataDisplayAttributes' mtime.
vtkNew< vtkPolyDataMapper > PrototypeMapper
A prototype of the object factory override mapper.
void RemoveBlockVisibility(unsigned int index)
Set/get the visibility for a block given its flat index.
void SetBlockArrayComponent(unsigned int index, int value)
void SetBlockVisibility(unsigned int index, bool visible)
Set/get the visibility for a block given its flat index.
bool RecursiveHasTranslucentGeometry(vtkDataObject *dobj, unsigned int &flat_index)
virtual void PreRender(const std::vector< vtkSmartPointer< vtkCompositePolyDataMapperDelegator > > &, vtkRenderer *, vtkActor *)
Invoked just before all delegators render their datasets.
void SetBlockScalarMode(unsigned int index, int value)
void SetInputArrayToProcess(int idx, int port, int connection, int fieldAssociation, int fieldAttributeType) override
Call SetInputArrayToProcess on helpers.
void SetBlockArrayId(unsigned int index, int value)
void Render(vtkRenderer *renderer, vtkActor *actor) override
Standard method for rendering a mapper.
void ShallowCopy(vtkAbstractMapper *mapper) override
Make a shallow copy of this mapper.
void ReleaseGraphicsResources(vtkWindow *) override
Release the underlying resources associated with this mapper.
void GetBlockColor(unsigned int index, 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.
vtkSmartPointer< vtkCompositeDataDisplayAttributes > CompositeAttributes
Composite data set attributes.
void PrintSelf(ostream &os, vtkIndent indent) override
Methods invoked by print to print information about the object including superclasses.
void SetBlockColor(unsigned int index, const double color[3])
Set/get the color for a block given its flat index.
static vtkCompositePolyDataMapper * New()
void RemoveBlockOpacities()
Set/get the opacity for a block given its flat index.
void RemoveBlockVisibilities()
Set/get the visibility for a block given its flat index.
void RemoveBlockScalarMode(unsigned int index)
void SetInputArrayToProcess(int idx, vtkInformation *info) override
Call SetInputArrayToProcess on helpers.
void RemoveBlockArrayId(unsigned int index)
void RemoveBlockArrayComponent(unsigned int index)
int GetBlockArrayComponent(unsigned int index)
double * GetBounds() override
Standard vtkProp method to get 3D bounds of a 3D prop.
void SetBlockArrayName(unsigned int index, const std::string &value)
void BuildRenderValues(vtkRenderer *renderer, vtkActor *actor, vtkDataObject *dobj, unsigned int &flat_index)
std::string GetBlockArrayName(unsigned int index)
~vtkCompositePolyDataMapper() override
void SetBlockOpacity(unsigned int index, double opacity)
Set/get the opacity for a block given its flat index.
virtual void PostRender(const std::vector< vtkSmartPointer< vtkCompositePolyDataMapperDelegator > > &, vtkRenderer *, vtkActor *)
Invoked just after all delegators render their datasets.
virtual vtkDataObjectTreeIterator * MakeAnIterator(vtkCompositeDataSet *dataset)
Initialize an iterator for the composite dataset.
void RemoveBlockFieldDataTupleId(unsigned int index)
vtkIdType GetBlockFieldDataTupleId(unsigned int index)
int GetBlockArrayId(unsigned int index)
bool HasTranslucentPolygonalGeometry() override
Some introspection on the type of data the mapper will render used by props to determine if they shou...
bool HasOpaqueGeometry() override
Some introspection on the type of data the mapper will render used by props to determine if they shou...
void SetBlockColor(unsigned int index, double r, double g, double b)
Set/get the color 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.
int FillInputPortInformation(int port, vtkInformation *info) override
Need to define the type of data handled by this mapper.
vtkTimeStamp BoundsMTime
Time stamp for computation of bounds.
int GetBlockArrayAccessMode(unsigned int index)
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 ...
superclass for composite data iterators
general representation of visualization data
Superclass for all pipeline executives in VTK.
a simple class to control print indentation
Definition vtkIndent.h:108
Store vtkAlgorithm input/output information.
double * GetBounds() override
Return bounding box (array of six doubles) of data expressed as (xmin,xmax, ymin,ymax,...
Allocate and hold a VTK object.
Definition vtkNew.h:167
map vtkPolyData to graphics primitives
std::uintptr_t MapperHashType
concrete dataset represents vertices, lines, polygons, and triangle strips
abstract superclass for all actors, volumes and annotations
Definition vtkProp.h:66
abstract specification for renderers
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:48
int vtkIdType
Definition vtkType.h:315
vtkTypeUInt32 vtkMTimeType
Definition vtkType.h:270
#define VTK_SIZEHINT(...)
#define VTK_MARSHALAUTO