VTK  9.4.20241214
Public Types | Public Member Functions | Static Public Member Functions | Protected Member Functions | Protected Attributes | List of all members
vtkPolyDataMapper2D Class Reference

draw vtkPolyData onto the image plane More...

#include <vtkPolyDataMapper2D.h>

Inheritance diagram for vtkPolyDataMapper2D:
[legend]
Collaboration diagram for vtkPolyDataMapper2D:
[legend]

Public Types

typedef vtkMapper2D Superclass
 
- Public Types inherited from vtkMapper2D
typedef vtkAbstractMapper Superclass
 
- Public Types inherited from vtkAbstractMapper
typedef vtkAlgorithm Superclass
 
- Public Types inherited from vtkAlgorithm
enum  DesiredOutputPrecision { SINGLE_PRECISION , DOUBLE_PRECISION , DEFAULT_PRECISION }
 Values used for setting the desired output precision for various algorithms. More...
 
typedef vtkObject Superclass
 

Public Member Functions

virtual vtkTypeBool IsA (const char *type)
 Return 1 if this class is the same type of (or a subclass of) the named class.
 
vtkPolyDataMapper2DNewInstance () const
 
void PrintSelf (ostream &os, vtkIndent indent) override
 Methods invoked by print to print information about the object including superclasses.
 
virtual void CreateDefaultLookupTable ()
 Create default lookup table.
 
const char * GetColorModeAsString ()
 Return the method of coloring scalar data.
 
const char * GetArrayName ()
 Get the array name or number and component to color by.
 
int GetArrayId ()
 
int GetArrayAccessMode ()
 
int GetArrayComponent ()
 
vtkMTimeType GetMTime () override
 Overload standard modified time function.
 
vtkUnsignedCharArrayMapScalars (double alpha)
 Map the scalars (if there are any scalars and ScalarVisibility is on) through the lookup table, returning an unsigned char RGBA array.
 
void ShallowCopy (vtkAbstractMapper *m) override
 Make a shallow copy of this mapper.
 
void SetInputData (vtkPolyData *in)
 Set the input to the mapper.
 
vtkPolyDataGetInput ()
 Set the input to the mapper.
 
void SetLookupTable (vtkScalarsToColors *lut)
 Specify a lookup table for the mapper to use.
 
vtkScalarsToColorsGetLookupTable ()
 Specify a lookup table for the mapper to use.
 
virtual void SetScalarVisibility (vtkTypeBool)
 Turn on/off flag to control whether scalar data is used to color objects.
 
virtual vtkTypeBool GetScalarVisibility ()
 Turn on/off flag to control whether scalar data is used to color objects.
 
virtual void ScalarVisibilityOn ()
 Turn on/off flag to control whether scalar data is used to color objects.
 
virtual void ScalarVisibilityOff ()
 Turn on/off flag to control whether scalar data is used to color objects.
 
virtual void SetColorMode (int)
 Control how the scalar data is mapped to colors.
 
virtual int GetColorMode ()
 Control how the scalar data is mapped to colors.
 
void SetColorModeToDefault ()
 Control how the scalar data is mapped to colors.
 
void SetColorModeToMapScalars ()
 Control how the scalar data is mapped to colors.
 
void SetColorModeToDirectScalars ()
 Control how the scalar data is mapped to colors.
 
virtual void SetUseLookupTableScalarRange (vtkTypeBool)
 Control whether the mapper sets the lookuptable range based on its own ScalarRange, or whether it will use the LookupTable ScalarRange regardless of it's own setting.
 
virtual vtkTypeBool GetUseLookupTableScalarRange ()
 Control whether the mapper sets the lookuptable range based on its own ScalarRange, or whether it will use the LookupTable ScalarRange regardless of it's own setting.
 
virtual void UseLookupTableScalarRangeOn ()
 Control whether the mapper sets the lookuptable range based on its own ScalarRange, or whether it will use the LookupTable ScalarRange regardless of it's own setting.
 
virtual void UseLookupTableScalarRangeOff ()
 Control whether the mapper sets the lookuptable range based on its own ScalarRange, or whether it will use the LookupTable ScalarRange regardless of it's own setting.
 
virtual void SetScalarRange (double, double)
 Specify range in terms of scalar minimum and maximum (smin,smax).
 
void SetScalarRange (double[2])
 Specify range in terms of scalar minimum and maximum (smin,smax).
 
virtual double * GetScalarRange ()
 Specify range in terms of scalar minimum and maximum (smin,smax).
 
virtual void GetScalarRange (double data[2])
 Specify range in terms of scalar minimum and maximum (smin,smax).
 
virtual void SetScalarMode (int)
 Control how the filter works with scalar point data and cell attribute data.
 
virtual int GetScalarMode ()
 Control how the filter works with scalar point data and cell attribute data.
 
void SetScalarModeToDefault ()
 Control how the filter works with scalar point data and cell attribute data.
 
void SetScalarModeToUsePointData ()
 Control how the filter works with scalar point data and cell attribute data.
 
void SetScalarModeToUseCellData ()
 Control how the filter works with scalar point data and cell attribute data.
 
void SetScalarModeToUsePointFieldData ()
 Control how the filter works with scalar point data and cell attribute data.
 
void SetScalarModeToUseCellFieldData ()
 Control how the filter works with scalar point data and cell attribute data.
 
void ColorByArrayComponent (int arrayNum, int component)
 Choose which component of which field data array to color by.
 
void ColorByArrayComponent (const char *arrayName, int component)
 Choose which component of which field data array to color by.
 
virtual void SetTransformCoordinate (vtkCoordinate *)
 Specify a vtkCoordinate object to be used to transform the vtkPolyData point coordinates.
 
virtual vtkCoordinateGetTransformCoordinate ()
 Specify a vtkCoordinate object to be used to transform the vtkPolyData point coordinates.
 
virtual bool GetTransformCoordinateUseDouble ()
 Specify whether or not rounding to integers the transformed points when TransformCoordinate is set.
 
virtual void SetTransformCoordinateUseDouble (bool)
 Specify whether or not rounding to integers the transformed points when TransformCoordinate is set.
 
virtual void TransformCoordinateUseDoubleOn ()
 Specify whether or not rounding to integers the transformed points when TransformCoordinate is set.
 
virtual void TransformCoordinateUseDoubleOff ()
 Specify whether or not rounding to integers the transformed points when TransformCoordinate is set.
 
- Public Member Functions inherited from vtkMapper2D
virtual vtkTypeBool IsA (const char *type)
 Return 1 if this class is the same type of (or a subclass of) the named class.
 
vtkMapper2DNewInstance () const
 
void PrintSelf (ostream &os, vtkIndent indent) override
 Methods invoked by print to print information about the object including superclasses.
 
virtual void RenderOverlay (vtkViewport *, vtkActor2D *)
 
virtual void RenderOpaqueGeometry (vtkViewport *, vtkActor2D *)
 
virtual void RenderTranslucentPolygonalGeometry (vtkViewport *, vtkActor2D *)
 
virtual vtkTypeBool HasTranslucentPolygonalGeometry ()
 
- Public Member Functions inherited from vtkAbstractMapper
virtual vtkTypeBool IsA (const char *type)
 Return 1 if this class is the same type of (or a subclass of) the named class.
 
vtkAbstractMapperNewInstance () const
 
void PrintSelf (ostream &os, vtkIndent indent) override
 Methods invoked by print to print information about the object including superclasses.
 
vtkMTimeType GetMTime () override
 Override Modifiedtime as we have added Clipping planes.
 
virtual void ReleaseGraphicsResources (vtkWindow *)
 Release any graphics resources that are being consumed by this mapper.
 
void SetClippingPlanes (vtkPlanes *planes)
 An alternative way to set clipping planes: use up to six planes found in the supplied instance of the implicit function vtkPlanes.
 
virtual void ShallowCopy (vtkAbstractMapper *m)
 Make a shallow copy of this mapper.
 
int GetNumberOfClippingPlanes ()
 Get the number of clipping planes.
 
virtual double GetTimeToDraw ()
 Get the time required to draw the geometry last time it was rendered.
 
void AddClippingPlane (vtkPlane *plane)
 Specify clipping planes to be applied when the data is mapped (at most 6 clipping planes can be specified).
 
void RemoveClippingPlane (vtkPlane *plane)
 Specify clipping planes to be applied when the data is mapped (at most 6 clipping planes can be specified).
 
void RemoveAllClippingPlanes ()
 Specify clipping planes to be applied when the data is mapped (at most 6 clipping planes can be specified).
 
virtual void SetClippingPlanes (vtkPlaneCollection *)
 Get/Set the vtkPlaneCollection which specifies the clipping planes.
 
virtual vtkPlaneCollectionGetClippingPlanes ()
 Get/Set the vtkPlaneCollection which specifies the clipping planes.
 
- Public Member Functions inherited from vtkAlgorithm
virtual vtkTypeBool IsA (const char *type)
 Return 1 if this class is the same type of (or a subclass of) the named class.
 
vtkAlgorithmNewInstance () const
 
void PrintSelf (ostream &os, vtkIndent indent) override
 Methods invoked by print to print information about the object including superclasses.
 
vtkTypeBool HasExecutive ()
 Check whether this algorithm has an assigned executive.
 
vtkExecutiveGetExecutive ()
 Get this algorithm's executive.
 
virtual void SetExecutive (vtkExecutive *executive)
 Set this algorithm's executive.
 
virtual vtkTypeBool ProcessRequest (vtkInformation *request, vtkInformationVector **inInfo, vtkInformationVector *outInfo)
 Upstream/Downstream requests form the generalized interface through which executives invoke a algorithm's functionality.
 
vtkTypeBool ProcessRequest (vtkInformation *request, vtkCollection *inInfo, vtkInformationVector *outInfo)
 Version of ProcessRequest() that is wrapped.
 
virtual int ComputePipelineMTime (vtkInformation *request, vtkInformationVector **inInfoVec, vtkInformationVector *outInfoVec, int requestFromOutputPort, vtkMTimeType *mtime)
 A special version of ProcessRequest meant specifically for the pipeline modified time request.
 
virtual int ModifyRequest (vtkInformation *request, int when)
 This method gives the algorithm a chance to modify the contents of a request before or after (specified in the when argument) it is forwarded.
 
vtkInformationGetInputPortInformation (int port)
 Get the information object associated with an input port.
 
vtkInformationGetOutputPortInformation (int port)
 Get the information object associated with an output port.
 
int GetNumberOfInputPorts ()
 Get the number of input ports used by the algorithm.
 
int GetNumberOfOutputPorts ()
 Get the number of output ports provided by the algorithm.
 
void SetAbortExecuteAndUpdateTime ()
 Set AbortExecute Flag and update LastAbortTime.
 
void UpdateProgress (double amount)
 Update the progress of the process object.
 
bool CheckAbort ()
 Checks to see if this filter should abort.
 
vtkInformationGetInputArrayInformation (int idx)
 Get the info object for the specified input array to this algorithm.
 
void RemoveAllInputs ()
 Remove all the input data.
 
vtkDataObjectGetOutputDataObject (int port)
 Get the data object that will contain the algorithm output for the given port.
 
vtkDataObjectGetInputDataObject (int port, int connection)
 Get the data object that will contain the algorithm input for the given port and given connection.
 
virtual void RemoveInputConnection (int port, vtkAlgorithmOutput *input)
 Remove a connection from the given input port index.
 
virtual void RemoveInputConnection (int port, int idx)
 Remove a connection given by index idx.
 
virtual void RemoveAllInputConnections (int port)
 Removes all input connections.
 
virtual void SetInputDataObject (int port, vtkDataObject *data)
 Sets the data-object as an input on the given port index.
 
virtual void SetInputDataObject (vtkDataObject *data)
 
virtual void AddInputDataObject (int port, vtkDataObject *data)
 Add the data-object as an input to this given port.
 
virtual void AddInputDataObject (vtkDataObject *data)
 
vtkAlgorithmOutputGetOutputPort (int index)
 Get a proxy object corresponding to the given output port of this algorithm.
 
vtkAlgorithmOutputGetOutputPort ()
 
int GetNumberOfInputConnections (int port)
 Get the number of inputs currently connected to a port.
 
int GetTotalNumberOfInputConnections ()
 Get the total number of inputs for this algorithm.
 
vtkAlgorithmOutputGetInputConnection (int port, int index)
 Get the algorithm output port connected to an input port.
 
vtkAlgorithmGetInputAlgorithm (int port, int index, int &algPort)
 Returns the algorithm and the output port index of that algorithm connected to a port-index pair.
 
vtkAlgorithmGetInputAlgorithm (int port, int index)
 Returns the algorithm connected to a port-index pair.
 
vtkAlgorithmGetInputAlgorithm ()
 Equivalent to GetInputAlgorithm(0, 0).
 
vtkExecutiveGetInputExecutive (int port, int index)
 Returns the executive associated with a particular input connection.
 
vtkExecutiveGetInputExecutive ()
 Equivalent to GetInputExecutive(0, 0)
 
vtkInformationGetInputInformation (int port, int index)
 Return the information object that is associated with a particular input connection.
 
vtkInformationGetInputInformation ()
 Equivalent to GetInputInformation(0, 0)
 
vtkInformationGetOutputInformation (int port)
 Return the information object that is associated with a particular output port.
 
virtual vtkTypeBool Update (int port, vtkInformationVector *requests)
 This method enables the passing of data requests to the algorithm to be used during execution (in addition to bringing a particular port up-to-date).
 
virtual vtkTypeBool Update (vtkInformation *requests)
 Convenience method to update an algorithm after passing requests to its first output port.
 
virtual int UpdatePiece (int piece, int numPieces, int ghostLevels, const int extents[6]=nullptr)
 Convenience method to update an algorithm after passing requests to its first output port.
 
virtual VTK_UNBLOCKTHREADS int UpdateExtent (const int extents[6])
 Convenience method to update an algorithm after passing requests to its first output port.
 
virtual VTK_UNBLOCKTHREADS int UpdateTimeStep (double time, int piece=-1, int numPieces=1, int ghostLevels=0, const int extents[6]=nullptr)
 Convenience method to update an algorithm after passing requests to its first output port.
 
virtual VTK_UNBLOCKTHREADS void UpdateInformation ()
 Bring the algorithm's information up-to-date.
 
virtual void UpdateDataObject ()
 Create output object(s).
 
virtual void PropagateUpdateExtent ()
 Propagate meta-data upstream.
 
virtual VTK_UNBLOCKTHREADS void UpdateWholeExtent ()
 Bring this algorithm's outputs up-to-date.
 
void ConvertTotalInputToPortConnection (int ind, int &port, int &conn)
 Convenience routine to convert from a linear ordering of input connections to a port/connection pair.
 
void RemoveNoPriorTemporalAccessInformationKey ()
 Removes any information key vtkStreamingDemandDrivenPipeline::NO_PRIOR_TEMPORAL_ACCESS() to all output ports of this vtkAlgorithm.
 
virtual vtkInformationGetInformation ()
 Set/Get the information object associated with this algorithm.
 
virtual void SetInformation (vtkInformation *)
 Set/Get the information object associated with this algorithm.
 
bool UsesGarbageCollector () const override
 Participate in garbage collection.
 
virtual void SetAbortExecute (vtkTypeBool)
 Set/Get the AbortExecute flag for the process object.
 
virtual vtkTypeBool GetAbortExecute ()
 Set/Get the AbortExecute flag for the process object.
 
virtual void AbortExecuteOn ()
 Set/Get the AbortExecute flag for the process object.
 
virtual void AbortExecuteOff ()
 Set/Get the AbortExecute flag for the process object.
 
virtual double GetProgress ()
 Get the execution progress of a process object.
 
void SetContainerAlgorithm (vtkAlgorithm *containerAlg)
 Set/get a Container algorithm for this algorithm.
 
vtkAlgorithmGetContainerAlgorithm ()
 Set/get a Container algorithm for this algorithm.
 
virtual void SetAbortOutput (bool)
 Set/Get an internal variable used to communicate between the algorithm and executive.
 
virtual bool GetAbortOutput ()
 Set/Get an internal variable used to communicate between the algorithm and executive.
 
void SetProgressShiftScale (double shift, double scale)
 Specify the shift and scale values to use to apply to the progress amount when UpdateProgress is called.
 
virtual double GetProgressShift ()
 Specify the shift and scale values to use to apply to the progress amount when UpdateProgress is called.
 
virtual double GetProgressScale ()
 Specify the shift and scale values to use to apply to the progress amount when UpdateProgress is called.
 
void SetProgressText (const char *ptext)
 Set the current text message associated with the progress state.
 
virtual char * GetProgressText ()
 Set the current text message associated with the progress state.
 
virtual unsigned long GetErrorCode ()
 The error code contains a possible error that occurred while reading or writing the file.
 
void SetInputArrayToProcess (const char *name, int fieldAssociation)
 Set the input data arrays that this algorithm will process.
 
virtual void SetInputArrayToProcess (int idx, int port, int connection, int fieldAssociation, const char *name)
 Set the input data arrays that this algorithm will process.
 
virtual void SetInputArrayToProcess (int idx, int port, int connection, int fieldAssociation, int fieldAttributeType)
 Set the input data arrays that this algorithm will process.
 
virtual void SetInputArrayToProcess (int idx, vtkInformation *info)
 Set the input data arrays that this algorithm will process.
 
virtual void SetInputArrayToProcess (int idx, int port, int connection, const char *fieldAssociation, const char *attributeTypeorName)
 Set the input data arrays that this algorithm will process.
 
virtual void SetInputConnection (int port, vtkAlgorithmOutput *input)
 Set the connection for the given input port index.
 
virtual void SetInputConnection (vtkAlgorithmOutput *input)
 Set the connection for the given input port index.
 
virtual void AddInputConnection (int port, vtkAlgorithmOutput *input)
 Add a connection to the given input port index.
 
virtual void AddInputConnection (vtkAlgorithmOutput *input)
 Add a connection to the given input port index.
 
virtual VTK_UNBLOCKTHREADS void Update (int port)
 Bring this algorithm's outputs up-to-date.
 
virtual VTK_UNBLOCKTHREADS void Update ()
 Bring this algorithm's outputs up-to-date.
 
virtual void SetReleaseDataFlag (vtkTypeBool)
 Turn release data flag on or off for all output ports.
 
virtual vtkTypeBool GetReleaseDataFlag ()
 Turn release data flag on or off for all output ports.
 
void ReleaseDataFlagOn ()
 Turn release data flag on or off for all output ports.
 
void ReleaseDataFlagOff ()
 Turn release data flag on or off for all output ports.
 
int UpdateExtentIsEmpty (vtkInformation *pinfo, vtkDataObject *output)
 This detects when the UpdateExtent will generate no data This condition is satisfied when the UpdateExtent has zero volume (0,-1,...) or the UpdateNumberOfPieces is 0.
 
int UpdateExtentIsEmpty (vtkInformation *pinfo, int extentType)
 This detects when the UpdateExtent will generate no data This condition is satisfied when the UpdateExtent has zero volume (0,-1,...) or the UpdateNumberOfPieces is 0.
 
int * GetUpdateExtent ()
 These functions return the update extent for output ports that use 3D extents.
 
int * GetUpdateExtent (int port)
 These functions return the update extent for output ports that use 3D extents.
 
void GetUpdateExtent (int &x0, int &x1, int &y0, int &y1, int &z0, int &z1)
 These functions return the update extent for output ports that use 3D extents.
 
void GetUpdateExtent (int port, int &x0, int &x1, int &y0, int &y1, int &z0, int &z1)
 These functions return the update extent for output ports that use 3D extents.
 
void GetUpdateExtent (int extent[6])
 These functions return the update extent for output ports that use 3D extents.
 
void GetUpdateExtent (int port, int extent[6])
 These functions return the update extent for output ports that use 3D extents.
 
int GetUpdatePiece ()
 These functions return the update extent for output ports that use piece extents.
 
int GetUpdatePiece (int port)
 These functions return the update extent for output ports that use piece extents.
 
int GetUpdateNumberOfPieces ()
 These functions return the update extent for output ports that use piece extents.
 
int GetUpdateNumberOfPieces (int port)
 These functions return the update extent for output ports that use piece extents.
 
int GetUpdateGhostLevel ()
 These functions return the update extent for output ports that use piece extents.
 
int GetUpdateGhostLevel (int port)
 These functions return the update extent for output ports that use piece extents.
 
void SetProgressObserver (vtkProgressObserver *)
 If an ProgressObserver is set, the algorithm will report progress through it rather than directly.
 
virtual vtkProgressObserverGetProgressObserver ()
 If an ProgressObserver is set, the algorithm will report progress through it rather than directly.
 
void SetNoPriorTemporalAccessInformationKey (int key)
 Set to all output ports of this algorithm the information key vtkStreamingDemandDrivenPipeline::NO_PRIOR_TEMPORAL_ACCESS().
 
void SetNoPriorTemporalAccessInformationKey ()
 Set to all output ports of this algorithm the information key vtkStreamingDemandDrivenPipeline::NO_PRIOR_TEMPORAL_ACCESS().
 
- Public Member Functions inherited from vtkObject
 vtkBaseTypeMacro (vtkObject, vtkObjectBase)
 
virtual void DebugOn ()
 Turn debugging output on.
 
virtual void DebugOff ()
 Turn debugging output off.
 
bool GetDebug ()
 Get the value of the debug flag.
 
void SetDebug (bool debugFlag)
 Set the value of the debug flag.
 
virtual void Modified ()
 Update the modification time for this object.
 
virtual vtkMTimeType GetMTime ()
 Return this object's modified time.
 
void PrintSelf (ostream &os, vtkIndent indent) override
 Methods invoked by print to print information about the object including superclasses.
 
void RemoveObserver (unsigned long tag)
 
void RemoveObservers (unsigned long event)
 
void RemoveObservers (const char *event)
 
void RemoveAllObservers ()
 
vtkTypeBool HasObserver (unsigned long event)
 
vtkTypeBool HasObserver (const char *event)
 
vtkTypeBool InvokeEvent (unsigned long event)
 
vtkTypeBool InvokeEvent (const char *event)
 
std::string GetObjectDescription () const override
 The object description printed in messages and PrintSelf output.
 
unsigned long AddObserver (unsigned long event, vtkCommand *, float priority=0.0f)
 Allow people to add/remove/invoke observers (callbacks) to any VTK object.
 
unsigned long AddObserver (const char *event, vtkCommand *, float priority=0.0f)
 Allow people to add/remove/invoke observers (callbacks) to any VTK object.
 
vtkCommandGetCommand (unsigned long tag)
 Allow people to add/remove/invoke observers (callbacks) to any VTK object.
 
void RemoveObserver (vtkCommand *)
 Allow people to add/remove/invoke observers (callbacks) to any VTK object.
 
void RemoveObservers (unsigned long event, vtkCommand *)
 Allow people to add/remove/invoke observers (callbacks) to any VTK object.
 
void RemoveObservers (const char *event, vtkCommand *)
 Allow people to add/remove/invoke observers (callbacks) to any VTK object.
 
vtkTypeBool HasObserver (unsigned long event, vtkCommand *)
 Allow people to add/remove/invoke observers (callbacks) to any VTK object.
 
vtkTypeBool HasObserver (const char *event, vtkCommand *)
 Allow people to add/remove/invoke observers (callbacks) to any VTK object.
 
template<class U , class T >
unsigned long AddObserver (unsigned long event, U observer, void(T::*callback)(), float priority=0.0f)
 Overloads to AddObserver that allow developers to add class member functions as callbacks for events.
 
template<class U , class T >
unsigned long AddObserver (unsigned long event, U observer, void(T::*callback)(vtkObject *, unsigned long, void *), float priority=0.0f)
 Overloads to AddObserver that allow developers to add class member functions as callbacks for events.
 
template<class U , class T >
unsigned long AddObserver (unsigned long event, U observer, bool(T::*callback)(vtkObject *, unsigned long, void *), float priority=0.0f)
 Allow user to set the AbortFlagOn() with the return value of the callback method.
 
vtkTypeBool InvokeEvent (unsigned long event, void *callData)
 This method invokes an event and return whether the event was aborted or not.
 
vtkTypeBool InvokeEvent (const char *event, void *callData)
 This method invokes an event and return whether the event was aborted or not.
 
virtual void SetObjectName (const std::string &objectName)
 Set/get the name of this object for reporting purposes.
 
virtual std::string GetObjectName () const
 Set/get the name of this object for reporting purposes.
 
- Public Member Functions inherited from vtkObjectBase
const char * GetClassName () const
 Return the class name as a string.
 
virtual std::string GetObjectDescription () const
 The object description printed in messages and PrintSelf output.
 
virtual vtkTypeBool IsA (const char *name)
 Return 1 if this class is the same type of (or a subclass of) the named class.
 
virtual vtkIdType GetNumberOfGenerationsFromBase (const char *name)
 Given the name of a base class of this class type, return the distance of inheritance between this class type and the named class (how many generations of inheritance are there between this class and the named class).
 
virtual void Delete ()
 Delete a VTK object.
 
virtual void FastDelete ()
 Delete a reference to this object.
 
void InitializeObjectBase ()
 
void Print (ostream &os)
 Print an object to an ostream.
 
void Register (vtkObjectBase *o)
 Increase the reference count (mark as used by another object).
 
virtual void UnRegister (vtkObjectBase *o)
 Decrease the reference count (release by another object).
 
int GetReferenceCount ()
 Return the current reference count of this object.
 
void SetReferenceCount (int)
 Sets the reference count.
 
bool GetIsInMemkind () const
 A local state flag that remembers whether this object lives in the normal or extended memory space.
 
virtual void PrintHeader (ostream &os, vtkIndent indent)
 Methods invoked by print to print information about the object including superclasses.
 
virtual void PrintTrailer (ostream &os, vtkIndent indent)
 Methods invoked by print to print information about the object including superclasses.
 

Static Public Member Functions

static vtkTypeBool IsTypeOf (const char *type)
 
static vtkPolyDataMapper2DSafeDownCast (vtkObjectBase *o)
 
static vtkPolyDataMapper2DNew ()
 
- Static Public Member Functions inherited from vtkMapper2D
static vtkTypeBool IsTypeOf (const char *type)
 
static vtkMapper2DSafeDownCast (vtkObjectBase *o)
 
- Static Public Member Functions inherited from vtkAbstractMapper
static vtkTypeBool IsTypeOf (const char *type)
 
static vtkAbstractMapperSafeDownCast (vtkObjectBase *o)
 
static vtkDataArrayGetScalars (vtkDataSet *input, int scalarMode, int arrayAccessMode, int arrayId, const char *arrayName, int &cellFlag)
 Internal helper function for getting the active scalars.
 
static vtkAbstractArrayGetAbstractScalars (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.
 
static vtkUnsignedCharArrayGetGhostArray (vtkDataSet *input, int scalarMode, unsigned char &ghostsToSkip)
 Returns the ghost array associated with the corresponding scalar mode, if present.
 
- Static Public Member Functions inherited from vtkAlgorithm
static vtkAlgorithmNew ()
 
static vtkTypeBool IsTypeOf (const char *type)
 
static vtkAlgorithmSafeDownCast (vtkObjectBase *o)
 
static vtkInformationIntegerKeyINPUT_IS_OPTIONAL ()
 Keys used to specify input port requirements.
 
static vtkInformationIntegerKeyINPUT_IS_REPEATABLE ()
 
static vtkInformationInformationVectorKeyINPUT_REQUIRED_FIELDS ()
 
static vtkInformationStringVectorKeyINPUT_REQUIRED_DATA_TYPE ()
 
static vtkInformationInformationVectorKeyINPUT_ARRAYS_TO_PROCESS ()
 
static vtkInformationIntegerKeyINPUT_PORT ()
 
static vtkInformationIntegerKeyINPUT_CONNECTION ()
 
static vtkInformationIntegerKeyCAN_PRODUCE_SUB_EXTENT ()
 This key tells the executive that a particular output port is capable of producing an arbitrary subextent of the whole extent.
 
static vtkInformationIntegerKeyCAN_HANDLE_PIECE_REQUEST ()
 Key that tells the pipeline that a particular algorithm can or cannot handle piece request.
 
static vtkInformationIntegerKeyABORTED ()
 
static void SetDefaultExecutivePrototype (vtkExecutive *proto)
 If the DefaultExecutivePrototype is set, a copy of it is created in CreateDefaultExecutive() using NewInstance().
 
- Static Public Member Functions inherited from vtkObject
static vtkObjectNew ()
 Create an object with Debug turned off, modified time initialized to zero, and reference counting on.
 
static void BreakOnError ()
 This method is called when vtkErrorMacro executes.
 
static void SetGlobalWarningDisplay (vtkTypeBool val)
 This is a global flag that controls whether any debug, warning or error messages are displayed.
 
static void GlobalWarningDisplayOn ()
 This is a global flag that controls whether any debug, warning or error messages are displayed.
 
static void GlobalWarningDisplayOff ()
 This is a global flag that controls whether any debug, warning or error messages are displayed.
 
static vtkTypeBool GetGlobalWarningDisplay ()
 This is a global flag that controls whether any debug, warning or error messages are displayed.
 
- Static Public Member Functions inherited from vtkObjectBase
static vtkTypeBool IsTypeOf (const char *name)
 Return 1 if this class type is the same type of (or a subclass of) the named class.
 
static vtkIdType GetNumberOfGenerationsFromBaseType (const char *name)
 Given a the name of a base class of this class type, return the distance of inheritance between this class type and the named class (how many generations of inheritance are there between this class and the named class).
 
static vtkObjectBaseNew ()
 Create an object with Debug turned off, modified time initialized to zero, and reference counting on.
 
static void SetMemkindDirectory (const char *directoryname)
 The name of a directory, ideally mounted -o dax, to memory map an extended memory space within.
 
static bool GetUsingMemkind ()
 A global state flag that controls whether vtkObjects are constructed in the usual way (the default) or within the extended memory space.
 

Protected Member Functions

virtual vtkObjectBaseNewInstanceInternal () const
 
 vtkPolyDataMapper2D ()
 
 ~vtkPolyDataMapper2D () override
 
int FillInputPortInformation (int, vtkInformation *) override
 Fill the input port information objects for this algorithm.
 
- Protected Member Functions inherited from vtkMapper2D
virtual vtkObjectBaseNewInstanceInternal () const
 
 vtkMapper2D ()=default
 
 ~vtkMapper2D () override=default
 
- Protected Member Functions inherited from vtkAbstractMapper
virtual vtkObjectBaseNewInstanceInternal () const
 
 vtkAbstractMapper ()
 
 ~vtkAbstractMapper () override
 
- Protected Member Functions inherited from vtkAlgorithm
virtual vtkObjectBaseNewInstanceInternal () const
 
 vtkAlgorithm ()
 
 ~vtkAlgorithm () override
 
bool CheckUpstreamAbort ()
 Checks to see if an upstream filter has been aborted.
 
virtual int FillInputPortInformation (int port, vtkInformation *info)
 Fill the input port information objects for this algorithm.
 
virtual int FillOutputPortInformation (int port, vtkInformation *info)
 Fill the output port information objects for this algorithm.
 
virtual void SetNumberOfInputPorts (int n)
 Set the number of input ports used by the algorithm.
 
virtual void SetNumberOfOutputPorts (int n)
 Set the number of output ports provided by the algorithm.
 
int InputPortIndexInRange (int index, const char *action)
 
int OutputPortIndexInRange (int index, const char *action)
 
int GetInputArrayAssociation (int idx, vtkInformationVector **inputVector)
 Get the association of the actual data array for the input array specified by idx, this is only reasonable during the REQUEST_DATA pass.
 
vtkInformationGetInputArrayFieldInformation (int idx, vtkInformationVector **inputVector)
 This method takes in an index (as specified in SetInputArrayToProcess) and a pipeline information vector.
 
virtual vtkExecutiveCreateDefaultExecutive ()
 Create a default executive.
 
void ReportReferences (vtkGarbageCollector *) override
 
virtual void SetNthInputConnection (int port, int index, vtkAlgorithmOutput *input)
 Replace the Nth connection on the given input port.
 
virtual void SetNumberOfInputConnections (int port, int n)
 Set the number of input connections on the given input port.
 
void SetInputDataInternal (int port, vtkDataObject *input)
 These methods are used by subclasses to implement methods to set data objects directly as input.
 
void AddInputDataInternal (int port, vtkDataObject *input)
 
int GetInputArrayAssociation (int idx, int connection, vtkInformationVector **inputVector)
 Filters that have multiple connections on one port can use this signature.
 
int GetInputArrayAssociation (int idx, vtkDataObject *input)
 Filters that have multiple connections on one port can use this signature.
 
vtkDataArrayGetInputArrayToProcess (int idx, vtkInformationVector **inputVector)
 Get the actual data array for the input array specified by idx, this is only reasonable during the REQUEST_DATA pass.
 
vtkDataArrayGetInputArrayToProcess (int idx, vtkInformationVector **inputVector, int &association)
 Get the actual data array for the input array specified by idx, this is only reasonable during the REQUEST_DATA pass.
 
vtkDataArrayGetInputArrayToProcess (int idx, int connection, vtkInformationVector **inputVector)
 Filters that have multiple connections on one port can use this signature.
 
vtkDataArrayGetInputArrayToProcess (int idx, int connection, vtkInformationVector **inputVector, int &association)
 Filters that have multiple connections on one port can use this signature.
 
vtkDataArrayGetInputArrayToProcess (int idx, vtkDataObject *input)
 Filters that have multiple connections on one port can use this signature.
 
vtkDataArrayGetInputArrayToProcess (int idx, vtkDataObject *input, int &association)
 Filters that have multiple connections on one port can use this signature.
 
vtkAbstractArrayGetInputAbstractArrayToProcess (int idx, vtkInformationVector **inputVector)
 Get the actual data array for the input array specified by idx, this is only reasonable during the REQUEST_DATA pass.
 
vtkAbstractArrayGetInputAbstractArrayToProcess (int idx, vtkInformationVector **inputVector, int &association)
 Get the actual data array for the input array specified by idx, this is only reasonable during the REQUEST_DATA pass.
 
vtkAbstractArrayGetInputAbstractArrayToProcess (int idx, int connection, vtkInformationVector **inputVector)
 Filters that have multiple connections on one port can use this signature.
 
vtkAbstractArrayGetInputAbstractArrayToProcess (int idx, int connection, vtkInformationVector **inputVector, int &association)
 Filters that have multiple connections on one port can use this signature.
 
vtkAbstractArrayGetInputAbstractArrayToProcess (int idx, vtkDataObject *input)
 Filters that have multiple connections on one port can use this signature.
 
vtkAbstractArrayGetInputAbstractArrayToProcess (int idx, vtkDataObject *input, int &association)
 Filters that have multiple connections on one port can use this signature.
 
virtual void SetErrorCode (unsigned long)
 The error code contains a possible error that occurred while reading or writing the file.
 
- Protected Member Functions inherited from vtkObject
 vtkObject ()
 
 ~vtkObject () override
 
void RegisterInternal (vtkObjectBase *, vtkTypeBool check) override
 
void UnRegisterInternal (vtkObjectBase *, vtkTypeBool check) override
 
void InternalGrabFocus (vtkCommand *mouseEvents, vtkCommand *keypressEvents=nullptr)
 These methods allow a command to exclusively grab all events.
 
void InternalReleaseFocus ()
 These methods allow a command to exclusively grab all events.
 
- Protected Member Functions inherited from vtkObjectBase
 vtkObjectBase ()
 
virtual ~vtkObjectBase ()
 
virtual void RegisterInternal (vtkObjectBase *, vtkTypeBool check)
 
virtual void UnRegisterInternal (vtkObjectBase *, vtkTypeBool check)
 
virtual void ReportReferences (vtkGarbageCollector *)
 
virtual void ObjectFinalize ()
 
 vtkObjectBase (const vtkObjectBase &)
 
void operator= (const vtkObjectBase &)
 

Protected Attributes

vtkUnsignedCharArrayColors
 
vtkScalarsToColorsLookupTable
 
vtkTypeBool ScalarVisibility
 
vtkTimeStamp BuildTime
 
double ScalarRange [2]
 
vtkTypeBool UseLookupTableScalarRange
 
int ColorMode
 
int ScalarMode
 
vtkCoordinateTransformCoordinate
 
bool TransformCoordinateUseDouble
 
int ArrayId
 
char ArrayName [256]
 
int ArrayComponent
 
int ArrayAccessMode
 
- Protected Attributes inherited from vtkAbstractMapper
vtkTimerLogTimer
 
double TimeToDraw
 
vtkWindowLastWindow
 
vtkPlaneCollectionClippingPlanes
 
- Protected Attributes inherited from vtkAlgorithm
vtkTimeStamp LastAbortCheckTime
 
vtkInformationInformation
 
double Progress
 
char * ProgressText
 
vtkProgressObserverProgressObserver
 
unsigned long ErrorCode
 The error code contains a possible error that occurred while reading or writing the file.
 
- Protected Attributes inherited from vtkObject
bool Debug
 
vtkTimeStamp MTime
 
vtkSubjectHelper * SubjectHelper
 
std::string ObjectName
 
- Protected Attributes inherited from vtkObjectBase
std::atomic< int32_t > ReferenceCount
 
vtkWeakPointerBase ** WeakPointers
 

Additional Inherited Members

- Public Attributes inherited from vtkAlgorithm
std::atomic< vtkTypeBoolAbortExecute
 
- Static Protected Member Functions inherited from vtkAlgorithm
static vtkInformationIntegerKeyPORT_REQUIREMENTS_FILLED ()
 
- Static Protected Member Functions inherited from vtkObjectBase
static vtkMallocingFunction GetCurrentMallocFunction ()
 
static vtkReallocingFunction GetCurrentReallocFunction ()
 
static vtkFreeingFunction GetCurrentFreeFunction ()
 
static vtkFreeingFunction GetAlternateFreeFunction ()
 
- Static Protected Attributes inherited from vtkAlgorithm
static vtkTimeStamp LastAbortTime
 
static vtkExecutiveDefaultExecutivePrototype
 

Detailed Description

draw vtkPolyData onto the image plane

vtkPolyDataMapper2D is a mapper that renders 3D polygonal data (vtkPolyData) onto the 2D image plane (i.e., the renderer's viewport). By default, the 3D data is transformed into 2D data by ignoring the z-coordinate of the 3D points in vtkPolyData, and taking the x-y values as local display values (i.e., pixel coordinates). Alternatively, you can provide a vtkCoordinate object that will transform the data into local display coordinates (use the vtkCoordinate::SetCoordinateSystem() methods to indicate which coordinate system you are transforming the data from).

See also
vtkMapper2D vtkActor2D
Examples:
vtkPolyDataMapper2D (Examples)
Online Examples:

Tests:
vtkPolyDataMapper2D (Tests)

Definition at line 149 of file vtkPolyDataMapper2D.h.

Member Typedef Documentation

◆ Superclass

Definition at line 152 of file vtkPolyDataMapper2D.h.

Constructor & Destructor Documentation

◆ vtkPolyDataMapper2D()

vtkPolyDataMapper2D::vtkPolyDataMapper2D ( )
protected

◆ ~vtkPolyDataMapper2D()

vtkPolyDataMapper2D::~vtkPolyDataMapper2D ( )
overrideprotected

Member Function Documentation

◆ IsTypeOf()

static vtkTypeBool vtkPolyDataMapper2D::IsTypeOf ( const char *  type)
static

◆ IsA()

virtual vtkTypeBool vtkPolyDataMapper2D::IsA ( const char *  name)
virtual

Return 1 if this class is the same type of (or a subclass of) the named class.

Returns 0 otherwise. This method works in combination with vtkTypeMacro found in vtkSetGet.h.

Reimplemented from vtkMapper2D.

Reimplemented in vtkOpenGLES30PolyDataMapper2D, and vtkOpenGLPolyDataMapper2D.

◆ SafeDownCast()

static vtkPolyDataMapper2D * vtkPolyDataMapper2D::SafeDownCast ( vtkObjectBase o)
static

◆ NewInstanceInternal()

virtual vtkObjectBase * vtkPolyDataMapper2D::NewInstanceInternal ( ) const
protectedvirtual

Reimplemented from vtkMapper2D.

Reimplemented in vtkOpenGLES30PolyDataMapper2D, and vtkOpenGLPolyDataMapper2D.

◆ NewInstance()

vtkPolyDataMapper2D * vtkPolyDataMapper2D::NewInstance ( ) const

◆ New()

static vtkPolyDataMapper2D * vtkPolyDataMapper2D::New ( )
static

◆ PrintSelf()

void vtkPolyDataMapper2D::PrintSelf ( ostream &  os,
vtkIndent  indent 
)
overridevirtual

Methods invoked by print to print information about the object including superclasses.

Typically not called by the user (use Print() instead) but used in the hierarchical print process to combine the output of several classes.

Reimplemented from vtkMapper2D.

◆ SetInputData()

void vtkPolyDataMapper2D::SetInputData ( vtkPolyData in)

Set the input to the mapper.

◆ GetInput()

vtkPolyData * vtkPolyDataMapper2D::GetInput ( )

Set the input to the mapper.

◆ SetLookupTable()

void vtkPolyDataMapper2D::SetLookupTable ( vtkScalarsToColors lut)

Specify a lookup table for the mapper to use.

◆ GetLookupTable()

vtkScalarsToColors * vtkPolyDataMapper2D::GetLookupTable ( )

Specify a lookup table for the mapper to use.

◆ CreateDefaultLookupTable()

virtual void vtkPolyDataMapper2D::CreateDefaultLookupTable ( )
virtual

Create default lookup table.

Generally used to create one when none is available with the scalar data.

◆ SetScalarVisibility()

virtual void vtkPolyDataMapper2D::SetScalarVisibility ( vtkTypeBool  )
virtual

Turn on/off flag to control whether scalar data is used to color objects.

◆ GetScalarVisibility()

virtual vtkTypeBool vtkPolyDataMapper2D::GetScalarVisibility ( )
virtual

Turn on/off flag to control whether scalar data is used to color objects.

◆ ScalarVisibilityOn()

virtual void vtkPolyDataMapper2D::ScalarVisibilityOn ( )
virtual

Turn on/off flag to control whether scalar data is used to color objects.

◆ ScalarVisibilityOff()

virtual void vtkPolyDataMapper2D::ScalarVisibilityOff ( )
virtual

Turn on/off flag to control whether scalar data is used to color objects.

◆ SetColorMode()

virtual void vtkPolyDataMapper2D::SetColorMode ( int  )
virtual

Control how the scalar data is mapped to colors.

By default (ColorModeToDefault), unsigned char scalars are treated as colors, and NOT mapped through the lookup table, while everything else is. ColorModeToDirectScalar extends ColorModeToDefault such that all integer types are treated as colors with values in the range 0-255 and floating types are treated as colors with values in the range 0.0-1.0. Setting ColorModeToMapScalars means that all scalar data will be mapped through the lookup table. (Note that for multi-component scalars, the particular component to use for mapping can be specified using the ColorByArrayComponent() method.)

◆ GetColorMode()

virtual int vtkPolyDataMapper2D::GetColorMode ( )
virtual

Control how the scalar data is mapped to colors.

By default (ColorModeToDefault), unsigned char scalars are treated as colors, and NOT mapped through the lookup table, while everything else is. ColorModeToDirectScalar extends ColorModeToDefault such that all integer types are treated as colors with values in the range 0-255 and floating types are treated as colors with values in the range 0.0-1.0. Setting ColorModeToMapScalars means that all scalar data will be mapped through the lookup table. (Note that for multi-component scalars, the particular component to use for mapping can be specified using the ColorByArrayComponent() method.)

◆ SetColorModeToDefault()

void vtkPolyDataMapper2D::SetColorModeToDefault ( )

Control how the scalar data is mapped to colors.

By default (ColorModeToDefault), unsigned char scalars are treated as colors, and NOT mapped through the lookup table, while everything else is. ColorModeToDirectScalar extends ColorModeToDefault such that all integer types are treated as colors with values in the range 0-255 and floating types are treated as colors with values in the range 0.0-1.0. Setting ColorModeToMapScalars means that all scalar data will be mapped through the lookup table. (Note that for multi-component scalars, the particular component to use for mapping can be specified using the ColorByArrayComponent() method.)

◆ SetColorModeToMapScalars()

void vtkPolyDataMapper2D::SetColorModeToMapScalars ( )

Control how the scalar data is mapped to colors.

By default (ColorModeToDefault), unsigned char scalars are treated as colors, and NOT mapped through the lookup table, while everything else is. ColorModeToDirectScalar extends ColorModeToDefault such that all integer types are treated as colors with values in the range 0-255 and floating types are treated as colors with values in the range 0.0-1.0. Setting ColorModeToMapScalars means that all scalar data will be mapped through the lookup table. (Note that for multi-component scalars, the particular component to use for mapping can be specified using the ColorByArrayComponent() method.)

◆ SetColorModeToDirectScalars()

void vtkPolyDataMapper2D::SetColorModeToDirectScalars ( )

Control how the scalar data is mapped to colors.

By default (ColorModeToDefault), unsigned char scalars are treated as colors, and NOT mapped through the lookup table, while everything else is. ColorModeToDirectScalar extends ColorModeToDefault such that all integer types are treated as colors with values in the range 0-255 and floating types are treated as colors with values in the range 0.0-1.0. Setting ColorModeToMapScalars means that all scalar data will be mapped through the lookup table. (Note that for multi-component scalars, the particular component to use for mapping can be specified using the ColorByArrayComponent() method.)

◆ GetColorModeAsString()

const char * vtkPolyDataMapper2D::GetColorModeAsString ( )

Return the method of coloring scalar data.

◆ SetUseLookupTableScalarRange()

virtual void vtkPolyDataMapper2D::SetUseLookupTableScalarRange ( vtkTypeBool  )
virtual

Control whether the mapper sets the lookuptable range based on its own ScalarRange, or whether it will use the LookupTable ScalarRange regardless of it's own setting.

By default the Mapper is allowed to set the LookupTable range, but users who are sharing LookupTables between mappers/actors will probably wish to force the mapper to use the LookupTable unchanged.

◆ GetUseLookupTableScalarRange()

virtual vtkTypeBool vtkPolyDataMapper2D::GetUseLookupTableScalarRange ( )
virtual

Control whether the mapper sets the lookuptable range based on its own ScalarRange, or whether it will use the LookupTable ScalarRange regardless of it's own setting.

By default the Mapper is allowed to set the LookupTable range, but users who are sharing LookupTables between mappers/actors will probably wish to force the mapper to use the LookupTable unchanged.

◆ UseLookupTableScalarRangeOn()

virtual void vtkPolyDataMapper2D::UseLookupTableScalarRangeOn ( )
virtual

Control whether the mapper sets the lookuptable range based on its own ScalarRange, or whether it will use the LookupTable ScalarRange regardless of it's own setting.

By default the Mapper is allowed to set the LookupTable range, but users who are sharing LookupTables between mappers/actors will probably wish to force the mapper to use the LookupTable unchanged.

◆ UseLookupTableScalarRangeOff()

virtual void vtkPolyDataMapper2D::UseLookupTableScalarRangeOff ( )
virtual

Control whether the mapper sets the lookuptable range based on its own ScalarRange, or whether it will use the LookupTable ScalarRange regardless of it's own setting.

By default the Mapper is allowed to set the LookupTable range, but users who are sharing LookupTables between mappers/actors will probably wish to force the mapper to use the LookupTable unchanged.

◆ SetScalarRange() [1/2]

virtual void vtkPolyDataMapper2D::SetScalarRange ( double  ,
double   
)
virtual

Specify range in terms of scalar minimum and maximum (smin,smax).

These values are used to map scalars into lookup table. Has no effect when UseLookupTableScalarRange is true.

◆ SetScalarRange() [2/2]

void vtkPolyDataMapper2D::SetScalarRange ( double  [2])

Specify range in terms of scalar minimum and maximum (smin,smax).

These values are used to map scalars into lookup table. Has no effect when UseLookupTableScalarRange is true.

◆ GetScalarRange() [1/2]

virtual double * vtkPolyDataMapper2D::GetScalarRange ( )
virtual

Specify range in terms of scalar minimum and maximum (smin,smax).

These values are used to map scalars into lookup table. Has no effect when UseLookupTableScalarRange is true.

◆ GetScalarRange() [2/2]

virtual void vtkPolyDataMapper2D::GetScalarRange ( double  data[2])
virtual

Specify range in terms of scalar minimum and maximum (smin,smax).

These values are used to map scalars into lookup table. Has no effect when UseLookupTableScalarRange is true.

◆ SetScalarMode()

virtual void vtkPolyDataMapper2D::SetScalarMode ( int  )
virtual

Control how the filter works with scalar point data and cell attribute data.

By default (ScalarModeToDefault), the filter will use point data, and if no point data is available, then cell data is used. Alternatively you can explicitly set the filter to use point data (ScalarModeToUsePointData) or cell data (ScalarModeToUseCellData). You can also choose to get the scalars from an array in point field data (ScalarModeToUsePointFieldData) or cell field data (ScalarModeToUseCellFieldData). If scalars are coming from a field data array, you must call ColorByArrayComponent before you call GetColors.

◆ GetScalarMode()

virtual int vtkPolyDataMapper2D::GetScalarMode ( )
virtual

Control how the filter works with scalar point data and cell attribute data.

By default (ScalarModeToDefault), the filter will use point data, and if no point data is available, then cell data is used. Alternatively you can explicitly set the filter to use point data (ScalarModeToUsePointData) or cell data (ScalarModeToUseCellData). You can also choose to get the scalars from an array in point field data (ScalarModeToUsePointFieldData) or cell field data (ScalarModeToUseCellFieldData). If scalars are coming from a field data array, you must call ColorByArrayComponent before you call GetColors.

◆ SetScalarModeToDefault()

void vtkPolyDataMapper2D::SetScalarModeToDefault ( )
inline

Control how the filter works with scalar point data and cell attribute data.

By default (ScalarModeToDefault), the filter will use point data, and if no point data is available, then cell data is used. Alternatively you can explicitly set the filter to use point data (ScalarModeToUsePointData) or cell data (ScalarModeToUseCellData). You can also choose to get the scalars from an array in point field data (ScalarModeToUsePointFieldData) or cell field data (ScalarModeToUseCellFieldData). If scalars are coming from a field data array, you must call ColorByArrayComponent before you call GetColors.

Definition at line 252 of file vtkPolyDataMapper2D.h.

◆ SetScalarModeToUsePointData()

void vtkPolyDataMapper2D::SetScalarModeToUsePointData ( )
inline

Control how the filter works with scalar point data and cell attribute data.

By default (ScalarModeToDefault), the filter will use point data, and if no point data is available, then cell data is used. Alternatively you can explicitly set the filter to use point data (ScalarModeToUsePointData) or cell data (ScalarModeToUseCellData). You can also choose to get the scalars from an array in point field data (ScalarModeToUsePointFieldData) or cell field data (ScalarModeToUseCellFieldData). If scalars are coming from a field data array, you must call ColorByArrayComponent before you call GetColors.

Definition at line 253 of file vtkPolyDataMapper2D.h.

◆ SetScalarModeToUseCellData()

void vtkPolyDataMapper2D::SetScalarModeToUseCellData ( )
inline

Control how the filter works with scalar point data and cell attribute data.

By default (ScalarModeToDefault), the filter will use point data, and if no point data is available, then cell data is used. Alternatively you can explicitly set the filter to use point data (ScalarModeToUsePointData) or cell data (ScalarModeToUseCellData). You can also choose to get the scalars from an array in point field data (ScalarModeToUsePointFieldData) or cell field data (ScalarModeToUseCellFieldData). If scalars are coming from a field data array, you must call ColorByArrayComponent before you call GetColors.

Definition at line 254 of file vtkPolyDataMapper2D.h.

◆ SetScalarModeToUsePointFieldData()

void vtkPolyDataMapper2D::SetScalarModeToUsePointFieldData ( )
inline

Control how the filter works with scalar point data and cell attribute data.

By default (ScalarModeToDefault), the filter will use point data, and if no point data is available, then cell data is used. Alternatively you can explicitly set the filter to use point data (ScalarModeToUsePointData) or cell data (ScalarModeToUseCellData). You can also choose to get the scalars from an array in point field data (ScalarModeToUsePointFieldData) or cell field data (ScalarModeToUseCellFieldData). If scalars are coming from a field data array, you must call ColorByArrayComponent before you call GetColors.

Definition at line 255 of file vtkPolyDataMapper2D.h.

◆ SetScalarModeToUseCellFieldData()

void vtkPolyDataMapper2D::SetScalarModeToUseCellFieldData ( )
inline

Control how the filter works with scalar point data and cell attribute data.

By default (ScalarModeToDefault), the filter will use point data, and if no point data is available, then cell data is used. Alternatively you can explicitly set the filter to use point data (ScalarModeToUsePointData) or cell data (ScalarModeToUseCellData). You can also choose to get the scalars from an array in point field data (ScalarModeToUsePointFieldData) or cell field data (ScalarModeToUseCellFieldData). If scalars are coming from a field data array, you must call ColorByArrayComponent before you call GetColors.

Definition at line 259 of file vtkPolyDataMapper2D.h.

◆ ColorByArrayComponent() [1/2]

void vtkPolyDataMapper2D::ColorByArrayComponent ( int  arrayNum,
int  component 
)

Choose which component of which field data array to color by.

◆ ColorByArrayComponent() [2/2]

void vtkPolyDataMapper2D::ColorByArrayComponent ( const char *  arrayName,
int  component 
)

Choose which component of which field data array to color by.

◆ GetArrayName()

const char * vtkPolyDataMapper2D::GetArrayName ( )
inline

Get the array name or number and component to color by.

Definition at line 276 of file vtkPolyDataMapper2D.h.

◆ GetArrayId()

int vtkPolyDataMapper2D::GetArrayId ( )
inline

Definition at line 277 of file vtkPolyDataMapper2D.h.

◆ GetArrayAccessMode()

int vtkPolyDataMapper2D::GetArrayAccessMode ( )
inline

Definition at line 278 of file vtkPolyDataMapper2D.h.

◆ GetArrayComponent()

int vtkPolyDataMapper2D::GetArrayComponent ( )
inline

Definition at line 279 of file vtkPolyDataMapper2D.h.

◆ GetMTime()

vtkMTimeType vtkPolyDataMapper2D::GetMTime ( )
overridevirtual

Overload standard modified time function.

If lookup table is modified, then this object is modified as well.

Reimplemented from vtkAbstractMapper.

◆ SetTransformCoordinate()

virtual void vtkPolyDataMapper2D::SetTransformCoordinate ( vtkCoordinate )
virtual

Specify a vtkCoordinate object to be used to transform the vtkPolyData point coordinates.

By default (no vtkCoordinate specified), the point coordinates are taken as viewport coordinates (pixels in the viewport into which the mapper is rendering).

◆ GetTransformCoordinate()

virtual vtkCoordinate * vtkPolyDataMapper2D::GetTransformCoordinate ( )
virtual

Specify a vtkCoordinate object to be used to transform the vtkPolyData point coordinates.

By default (no vtkCoordinate specified), the point coordinates are taken as viewport coordinates (pixels in the viewport into which the mapper is rendering).

◆ GetTransformCoordinateUseDouble()

virtual bool vtkPolyDataMapper2D::GetTransformCoordinateUseDouble ( )
virtual

Specify whether or not rounding to integers the transformed points when TransformCoordinate is set.

By default, it does not use double precision.

◆ SetTransformCoordinateUseDouble()

virtual void vtkPolyDataMapper2D::SetTransformCoordinateUseDouble ( bool  )
virtual

Specify whether or not rounding to integers the transformed points when TransformCoordinate is set.

By default, it does not use double precision.

◆ TransformCoordinateUseDoubleOn()

virtual void vtkPolyDataMapper2D::TransformCoordinateUseDoubleOn ( )
virtual

Specify whether or not rounding to integers the transformed points when TransformCoordinate is set.

By default, it does not use double precision.

◆ TransformCoordinateUseDoubleOff()

virtual void vtkPolyDataMapper2D::TransformCoordinateUseDoubleOff ( )
virtual

Specify whether or not rounding to integers the transformed points when TransformCoordinate is set.

By default, it does not use double precision.

◆ MapScalars()

vtkUnsignedCharArray * vtkPolyDataMapper2D::MapScalars ( double  alpha)

Map the scalars (if there are any scalars and ScalarVisibility is on) through the lookup table, returning an unsigned char RGBA array.

This is typically done as part of the rendering process. The alpha parameter allows the blending of the scalars with an additional alpha (typically which comes from a vtkActor, etc.)

◆ ShallowCopy()

void vtkPolyDataMapper2D::ShallowCopy ( vtkAbstractMapper m)
overridevirtual

Make a shallow copy of this mapper.

Reimplemented from vtkAbstractMapper.

◆ FillInputPortInformation()

int vtkPolyDataMapper2D::FillInputPortInformation ( int  port,
vtkInformation info 
)
overrideprotectedvirtual

Fill the input port information objects for this algorithm.

This is invoked by the first call to GetInputPortInformation for each port so subclasses can specify what they can handle.

Reimplemented from vtkAlgorithm.

Member Data Documentation

◆ Colors

vtkUnsignedCharArray* vtkPolyDataMapper2D::Colors
protected

Definition at line 328 of file vtkPolyDataMapper2D.h.

◆ LookupTable

vtkScalarsToColors* vtkPolyDataMapper2D::LookupTable
protected

Definition at line 330 of file vtkPolyDataMapper2D.h.

◆ ScalarVisibility

vtkTypeBool vtkPolyDataMapper2D::ScalarVisibility
protected

Definition at line 331 of file vtkPolyDataMapper2D.h.

◆ BuildTime

vtkTimeStamp vtkPolyDataMapper2D::BuildTime
protected

Definition at line 332 of file vtkPolyDataMapper2D.h.

◆ ScalarRange

double vtkPolyDataMapper2D::ScalarRange[2]
protected

Definition at line 333 of file vtkPolyDataMapper2D.h.

◆ UseLookupTableScalarRange

vtkTypeBool vtkPolyDataMapper2D::UseLookupTableScalarRange
protected

Definition at line 334 of file vtkPolyDataMapper2D.h.

◆ ColorMode

int vtkPolyDataMapper2D::ColorMode
protected

Definition at line 335 of file vtkPolyDataMapper2D.h.

◆ ScalarMode

int vtkPolyDataMapper2D::ScalarMode
protected

Definition at line 336 of file vtkPolyDataMapper2D.h.

◆ TransformCoordinate

vtkCoordinate* vtkPolyDataMapper2D::TransformCoordinate
protected

Definition at line 338 of file vtkPolyDataMapper2D.h.

◆ TransformCoordinateUseDouble

bool vtkPolyDataMapper2D::TransformCoordinateUseDouble
protected

Definition at line 339 of file vtkPolyDataMapper2D.h.

◆ ArrayId

int vtkPolyDataMapper2D::ArrayId
protected

Definition at line 342 of file vtkPolyDataMapper2D.h.

◆ ArrayName

char vtkPolyDataMapper2D::ArrayName[256]
protected

Definition at line 343 of file vtkPolyDataMapper2D.h.

◆ ArrayComponent

int vtkPolyDataMapper2D::ArrayComponent
protected

Definition at line 344 of file vtkPolyDataMapper2D.h.

◆ ArrayAccessMode

int vtkPolyDataMapper2D::ArrayAccessMode
protected

Definition at line 345 of file vtkPolyDataMapper2D.h.


The documentation for this class was generated from the following file: