VTK  9.2.5
vtkAbstractMapper.h
Go to the documentation of this file.
1/*=========================================================================
2
3 Program: Visualization Toolkit
4 Module: vtkAbstractMapper.h
5
6 Copyright (c) Ken Martin, Will Schroeder, Bill Lorensen
7 All rights reserved.
8 See Copyright.txt or http://www.kitware.com/Copyright.htm for details.
9
10 This software is distributed WITHOUT ANY WARRANTY; without even
11 the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR
12 PURPOSE. See the above copyright notice for more information.
13
14=========================================================================*/
31#ifndef vtkAbstractMapper_h
32#define vtkAbstractMapper_h
33
34#include "vtkAlgorithm.h"
35#include "vtkRenderingCoreModule.h" // For export macro
36
37#define VTK_SCALAR_MODE_DEFAULT 0
38#define VTK_SCALAR_MODE_USE_POINT_DATA 1
39#define VTK_SCALAR_MODE_USE_CELL_DATA 2
40#define VTK_SCALAR_MODE_USE_POINT_FIELD_DATA 3
41#define VTK_SCALAR_MODE_USE_CELL_FIELD_DATA 4
42#define VTK_SCALAR_MODE_USE_FIELD_DATA 5
43
44#define VTK_GET_ARRAY_BY_ID 0
45#define VTK_GET_ARRAY_BY_NAME 1
46
48class vtkDataSet;
49class vtkPlane;
51class vtkPlanes;
52class vtkTimerLog;
54class vtkWindow;
55
56class VTKRENDERINGCORE_EXPORT vtkAbstractMapper : public vtkAlgorithm
57{
58public:
60 void PrintSelf(ostream& os, vtkIndent indent) override;
61
66
73
75
78 vtkGetMacro(TimeToDraw, double);
80
82
90
92
97 vtkGetObjectMacro(ClippingPlanes, vtkPlaneCollection);
99
105
110
119 static vtkDataArray* GetScalars(vtkDataSet* input, int scalarMode, int arrayAccessMode,
120 int arrayId, const char* arrayName, int& cellFlag);
121
131 static vtkAbstractArray* GetAbstractScalars(vtkDataSet* input, int scalarMode,
132 int arrayAccessMode, int arrayId, const char* arrayName, int& cellFlag);
133
147 vtkDataSet* input, int scalarMode, unsigned char& ghostsToSkip);
148
153
154protected:
157
160 vtkWindow* LastWindow; // Window used for the previous render
162
163private:
164 vtkAbstractMapper(const vtkAbstractMapper&) = delete;
165 void operator=(const vtkAbstractMapper&) = delete;
166};
167
168#endif
Abstract superclass for all arrays.
abstract class specifies interface to map data
virtual void ReleaseGraphicsResources(vtkWindow *)
Release any graphics resources that are being consumed by this mapper.
void RemoveAllClippingPlanes()
Specify clipping planes to be applied when the data is mapped (at most 6 clipping planes can be speci...
static vtkDataArray * GetScalars(vtkDataSet *input, int scalarMode, int arrayAccessMode, int arrayId, const char *arrayName, int &cellFlag)
Internal helper function for getting the active scalars.
vtkMTimeType GetMTime() override
Override Modifiedtime as we have added Clipping planes.
static vtkUnsignedCharArray * GetGhostArray(vtkDataSet *input, int scalarMode, unsigned char &ghostsToSkip)
Returns the ghost array associated with the corresponding scalar mode, if present.
int GetNumberOfClippingPlanes()
Get the number of clipping planes.
~vtkAbstractMapper() override
void PrintSelf(ostream &os, vtkIndent indent) override
Methods invoked by print to print information about the object including superclasses.
void SetClippingPlanes(vtkPlanes *planes)
An alternative way to set clipping planes: use up to six planes found in the supplied instance of the...
void AddClippingPlane(vtkPlane *plane)
Specify clipping planes to be applied when the data is mapped (at most 6 clipping planes can be speci...
virtual void ShallowCopy(vtkAbstractMapper *m)
Make a shallow copy of this mapper.
vtkPlaneCollection * ClippingPlanes
static vtkAbstractArray * GetAbstractScalars(vtkDataSet *input, int scalarMode, int arrayAccessMode, int arrayId, const char *arrayName, int &cellFlag)
Internal helper function for getting the active scalars as an abstract array.
virtual void SetClippingPlanes(vtkPlaneCollection *)
Get/Set the vtkPlaneCollection which specifies the clipping planes.
void RemoveClippingPlane(vtkPlane *plane)
Specify clipping planes to be applied when the data is mapped (at most 6 clipping planes can be speci...
Superclass for all sources, filters, and sinks in VTK.
Definition: vtkAlgorithm.h:63
abstract superclass for arrays of numeric data
Definition: vtkDataArray.h:56
abstract class to specify dataset behavior
Definition: vtkDataSet.h:63
a simple class to control print indentation
Definition: vtkIndent.h:40
maintain a list of planes
perform various plane computations
Definition: vtkPlane.h:37
implicit function for convex set of planes
Definition: vtkPlanes.h:53
Timer support and logging.
Definition: vtkTimerLog.h:96
dynamic, self-adjusting array of unsigned char
window superclass for vtkRenderWindow
Definition: vtkWindow.h:39
vtkTypeUInt32 vtkMTimeType
Definition: vtkType.h:287