VTK  9.3.20240327
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
128 #ifndef vtkPolyDataMapper_h
129 #define vtkPolyDataMapper_h
130 
131 #include "vtkMapper.h"
132 #include "vtkRenderingCoreModule.h" // For export macro
133 
134 #include <cstdint> // For uintptr_t
135 
136 VTK_ABI_NAMESPACE_BEGIN
137 class vtkPolyData;
138 class vtkRenderer;
139 class vtkRenderWindow;
140 
141 class VTKRENDERINGCORE_EXPORT vtkPolyDataMapper : public vtkMapper
142 {
143 public:
145  vtkTypeMacro(vtkPolyDataMapper, vtkMapper);
146  void PrintSelf(ostream& os, vtkIndent indent) override;
147 
151  virtual void RenderPiece(vtkRenderer*, vtkActor*) {}
152 
156  void Render(vtkRenderer* ren, vtkActor* act) override;
157 
158  using MapperHashType = std::uintptr_t;
167  virtual MapperHashType GenerateHash(vtkPolyData*) { return 0; }
168 
170 
176 
178 
181  void Update(int port) override;
182  void Update() override;
183  vtkTypeBool Update(int port, vtkInformationVector* requests) override;
184  vtkTypeBool Update(vtkInformation* requests) override;
186 
188 
191  vtkSetMacro(Piece, int);
192  vtkGetMacro(Piece, int);
193  vtkSetMacro(NumberOfPieces, int);
194  vtkGetMacro(NumberOfPieces, int);
195  vtkSetMacro(NumberOfSubPieces, int);
196  vtkGetMacro(NumberOfSubPieces, int);
198 
200 
203  vtkSetMacro(GhostLevel, int);
204  vtkGetMacro(GhostLevel, int);
206 
208 
216  vtkSetMacro(SeamlessU, bool);
217  vtkGetMacro(SeamlessU, bool);
218  vtkBooleanMacro(SeamlessU, bool);
219  vtkSetMacro(SeamlessV, bool);
220  vtkGetMacro(SeamlessV, bool);
221  vtkBooleanMacro(SeamlessV, bool);
223 
228  double* GetBounds() VTK_SIZEHINT(6) override;
229  void GetBounds(double bounds[6]) override { this->Superclass::GetBounds(bounds); }
230 
234  void ShallowCopy(vtkAbstractMapper* m) override;
235 
248  virtual void MapDataArrayToVertexAttribute(const char* vertexAttributeName,
249  const char* dataArrayName, int fieldAssociation, int componentno = -1);
250 
251  // Specify a data array to use as the texture coordinate
252  // for a named texture. See vtkProperty.h for how to
253  // name textures.
255  const char* textureName, const char* dataArrayName, int fieldAssociation, int componentno = -1);
256 
260  virtual void RemoveVertexAttributeMapping(const char* vertexAttributeName);
261 
266 
272 
294  {
301  FOCAL_POINT_SHIFT_SCALE
302  };
303 
307  virtual void SetVBOShiftScaleMethod(int) {}
308  virtual int GetVBOShiftScaleMethod() { return this->ShiftScaleMethod; }
309 
324  virtual void SetPauseShiftScale(bool pauseShiftScale) { this->PauseShiftScale = pauseShiftScale; }
325  vtkGetMacro(PauseShiftScale, bool);
326  vtkBooleanMacro(PauseShiftScale, bool);
327 
328 protected:
330  ~vtkPolyDataMapper() override = default;
331 
337  virtual void ComputeBounds();
338 
339  int Piece;
343  bool SeamlessU, SeamlessV;
344  int ShiftScaleMethod; // for points
346 
348 
349 private:
350  vtkPolyDataMapper(const vtkPolyDataMapper&) = delete;
351  void operator=(const vtkPolyDataMapper&) = delete;
352 };
353 
354 VTK_ABI_NAMESPACE_END
355 #endif
virtual double * GetBounds()=0
Return bounding box (array of six doubles) of data expressed as (xmin,xmax, ymin,ymax,...
abstract class specifies interface to map data
represents an object (geometry & properties) in a rendered scene
Definition: vtkActor.h:150
a simple class to control print indentation
Definition: vtkIndent.h:108
Store zero or more vtkInformation instances.
Store vtkAlgorithm input/output information.
abstract class specifies interface to map data to graphics primitives
Definition: vtkMapper.h:136
map vtkPolyData to graphics primitives
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.
vtkPolyData * GetInput()
Specify the input data to map.
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.
@ 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.
double * GetBounds() override
Return bounding box (array of six doubles) of data expressed as (xmin,xmax, ymin,ymax,...
void Render(vtkRenderer *ren, vtkActor *act) override
This calls RenderPiece (in a for loop if streaming is necessary).
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.
static vtkPolyDataMapper * New()
virtual int GetVBOShiftScaleMethod()
virtual void SetPauseShiftScale(bool pauseShiftScale)
Pause per-render updates to VBO shift+scale parameters.
virtual void ComputeBounds()
Called in GetBounds().
concrete dataset represents vertices, lines, polygons, and triangle strips
Definition: vtkPolyData.h:180
create a window for renderers to draw into
abstract specification for renderers
Definition: vtkRenderer.h:171
void GetBounds(T a, double bds[6])
@ port
Definition: vtkX3D.h:447
std::map< DataSetType, DataSet > Piece
Definition: VTXTypes.h:43
int vtkTypeBool
Definition: vtkABI.h:64
#define VTK_SIZEHINT(...)