VTK  9.4.20251007
vtkPolyDataMapper.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
18
19#ifndef vtkPolyDataMapper_h
20#define vtkPolyDataMapper_h
21
22#include "vtkMapper.h"
23#include "vtkRenderingCoreModule.h" // For export macro
24#include "vtkWrappingHints.h" // For VTK_MARSHALAUTO
25
26#include <cstdint> // For uintptr_t
27
28VTK_ABI_NAMESPACE_BEGIN
29class vtkPolyData;
30class vtkRenderer;
31class vtkRenderWindow;
32
33class VTKRENDERINGCORE_EXPORT VTK_MARSHALAUTO vtkPolyDataMapper : public vtkMapper
34{
35public:
38 void PrintSelf(ostream& os, vtkIndent indent) override;
39
43 virtual void RenderPiece(vtkRenderer*, vtkActor*) {}
44
48 void Render(vtkRenderer* ren, vtkActor* act) override;
49
50 using MapperHashType = std::uintptr_t;
59 virtual MapperHashType GenerateHash(vtkPolyData*) { return 0; }
60
62
68
70
73 void Update(int port) override;
74 void Update() override;
75 vtkTypeBool Update(int port, vtkInformationVector* requests) override;
76 vtkTypeBool Update(vtkInformation* requests) override;
78
80
83 vtkSetMacro(Piece, int);
84 vtkGetMacro(Piece, int);
85 vtkSetMacro(NumberOfPieces, int);
86 vtkGetMacro(NumberOfPieces, int);
87 vtkSetMacro(NumberOfSubPieces, int);
88 vtkGetMacro(NumberOfSubPieces, int);
90
92
95 vtkSetMacro(GhostLevel, int);
96 vtkGetMacro(GhostLevel, int);
98
100
108 vtkSetMacro(SeamlessU, bool);
109 vtkGetMacro(SeamlessU, bool);
110 vtkBooleanMacro(SeamlessU, bool);
111 vtkSetMacro(SeamlessV, bool);
112 vtkGetMacro(SeamlessV, bool);
113 vtkBooleanMacro(SeamlessV, bool);
115
120 double* GetBounds() VTK_SIZEHINT(6) override;
121 void GetBounds(double bounds[6]) override { this->Superclass::GetBounds(bounds); }
122
127
140 virtual void MapDataArrayToVertexAttribute(const char* vertexAttributeName,
141 const char* dataArrayName, int fieldAssociation, int componentno = -1);
142
143 // Specify a data array to use as the texture coordinate
144 // for a named texture. See vtkProperty.h for how to
145 // name textures.
147 const char* textureName, const char* dataArrayName, int fieldAssociation, int componentno = -1);
148
152 virtual void RemoveVertexAttributeMapping(const char* vertexAttributeName);
153
158
164
195
199 virtual void SetVBOShiftScaleMethod(int) {}
200 virtual int GetVBOShiftScaleMethod() { return this->ShiftScaleMethod; }
201
216 virtual void SetPauseShiftScale(bool pauseShiftScale) { this->PauseShiftScale = pauseShiftScale; }
217 vtkGetMacro(PauseShiftScale, bool);
218 vtkBooleanMacro(PauseShiftScale, bool);
219
220protected:
222 ~vtkPolyDataMapper() override = default;
223
229 virtual void ComputeBounds();
230
231 int Piece;
236 int ShiftScaleMethod; // for points
238
240
241private:
242 vtkPolyDataMapper(const vtkPolyDataMapper&) = delete;
243 void operator=(const vtkPolyDataMapper&) = delete;
244};
245
246VTK_ABI_NAMESPACE_END
247#endif
virtual double * GetBounds()=0
Return bounding box (array of six doubles) of data expressed as (xmin,xmax, ymin,ymax,...
represents an object (geometry & properties) in a rendered scene
Definition vtkActor.h:42
a simple class to control print indentation
Definition vtkIndent.h:29
Store zero or more vtkInformation instances.
Store vtkAlgorithm input/output information.
virtual void MapDataArrayToVertexAttribute(const char *vertexAttributeName, const char *dataArrayName, int fieldAssociation, int componentno=-1)
Select a data array from the point/cell data and map it to a generic vertex attribute.
void PrintSelf(ostream &os, vtkIndent indent) override
Methods invoked by print to print information about the object including superclasses.
virtual void RemoveAllVertexAttributeMappings()
Remove all vertex attributes.
void ShallowCopy(vtkAbstractMapper *m) override
Make a shallow copy of this mapper.
vtkTypeBool ProcessRequest(vtkInformation *, vtkInformationVector **, vtkInformationVector *) override
see vtkAlgorithm for details
void Update(int port) override
Bring this algorithm's outputs up-to-date.
virtual void MapDataArrayToMultiTextureAttribute(const char *textureName, const char *dataArrayName, int fieldAssociation, int componentno=-1)
virtual void SetVBOShiftScaleMethod(int)
A convenience method for enabling/disabling the VBO's shift+scale transform.
ShiftScaleMethodType
Methods for VBO coordinate shift+scale-computation.
@ NEAR_PLANE_SHIFT_SCALE
Shift scale based on camera settings.
@ DISABLE_SHIFT_SCALE
Do not shift/scale point coordinates. Ever!
@ AUTO_SHIFT_SCALE
The default, automatic computation.
@ ALWAYS_AUTO_SHIFT_SCALE
Always shift scale using auto computed values.
@ FOCAL_POINT_SHIFT_SCALE
Shift scale based on camera settings.
@ MANUAL_SHIFT_SCALE
Manual shift/scale (for use with AppendVBO)
@ AUTO_SHIFT
Only Apply the shift.
virtual void RemoveVertexAttributeMapping(const char *vertexAttributeName)
Remove a vertex attribute mapping.
virtual MapperHashType GenerateHash(vtkPolyData *)
This hash integer is computed by concrete graphics implementation of this class.
void Render(vtkRenderer *ren, vtkActor *act) override
This calls RenderPiece (in a for loop if streaming is necessary).
double * GetBounds() override
Return bounding box (array of six doubles) of data expressed as (xmin,xmax, ymin,ymax,...
std::uintptr_t MapperHashType
vtkTypeBool Update(vtkInformation *requests) override
Bring this algorithm's outputs up-to-date.
vtkTypeBool Update(int port, vtkInformationVector *requests) override
Bring this algorithm's outputs up-to-date.
~vtkPolyDataMapper() override=default
void Update() override
Bring this algorithm's outputs up-to-date.
virtual void RenderPiece(vtkRenderer *, vtkActor *)
Implemented by sub classes.
void SetInputData(vtkPolyData *in)
Specify the input data to map.
int FillInputPortInformation(int, vtkInformation *) override
Fill the input port information objects for this algorithm.
virtual int GetVBOShiftScaleMethod()
virtual void SetPauseShiftScale(bool pauseShiftScale)
Pause per-render updates to VBO shift+scale parameters.
vtkPolyData * GetInput()
Specify the input data to map.
virtual void ComputeBounds()
Called in GetBounds().
static vtkPolyDataMapper * New()
concrete dataset represents vertices, lines, polygons, and triangle strips
Definition vtkPolyData.h:72
create a window for renderers to draw into
abstract specification for renderers
Definition vtkRenderer.h:63
int vtkTypeBool
Definition vtkABI.h:64
#define VTK_SIZEHINT(...)
#define VTK_MARSHALAUTO