abstract class specifies interface to map data to graphics primitives More...

#include <vtkMapper.h>

Inheritance diagram for vtkMapper:

Collaboration diagram for vtkMapper:

Public Types
typedef vtkAbstractMapper3D	Superclass

Public Types inherited from vtkAbstractMapper3D
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.

vtkMapper *	NewInstance () const

void	PrintSelf (ostream &os, vtkIndent indent) override
	Methods invoked by print to print information about the object including superclasses.

void	ShallowCopy (vtkAbstractMapper *m) override
	Make a shallow copy of this mapper.

vtkMTimeType	GetMTime () override
	Overload standard modified time function.

virtual void	Render (vtkRenderer ren, vtkActor a)=0
	Method initiates the mapping process.

void	ReleaseGraphicsResources (vtkWindow *) override
	Release any graphics resources that are being consumed by this mapper.

virtual void	CreateDefaultLookupTable ()
	Create default lookup table.

const char *	GetColorModeAsString ()
	Return the method of coloring scalar data.

virtual void	SetScalarMode (int)
	Control how the filter works with scalar point data and cell attribute data.

virtual int	GetScalarMode ()

void	SetScalarModeToDefault ()

void	SetScalarModeToUsePointData ()

void	SetScalarModeToUseCellData ()

void	SetScalarModeToUsePointFieldData ()

void	SetScalarModeToUseCellFieldData ()

void	SetScalarModeToUseFieldData ()

virtual void	SetFieldDataTupleId (vtkIdType)

virtual vtkIdType	GetFieldDataTupleId ()

virtual char *	GetArrayName ()
	Set/Get the array name or number and component to color by.

virtual void	SetArrayName (const char *)

virtual int	GetArrayId ()

virtual void	SetArrayId (int)

virtual int	GetArrayAccessMode ()

virtual void	SetArrayAccessMode (int)

virtual int	GetArrayComponent ()

virtual void	SetArrayComponent (int)

const char *	GetScalarModeAsString ()
	Return the method for obtaining scalar data.

double *	GetBounds () override
	Return bounding box (array of six doubles) of data expressed as (xmin,xmax, ymin,ymax, zmin,zmax).

void	GetBounds (double bounds[6]) override
	Get the bounds for this mapper as (Xmin,Xmax,Ymin,Ymax,Zmin,Zmax).

void	SetRenderTime (double time)
	This instance variable is used by vtkLODActor to determine which mapper to use.

virtual double	GetRenderTime ()

vtkDataSet *	GetInput ()
	Get the input as a vtkDataSet.

vtkDataSet *	GetInputAsDataSet ()
	Get the input to this mapper as a vtkDataSet, instead of as a more specialized data type that the subclass may return from GetInput().

virtual bool	GetSupportsSelection ()
	WARNING: INTERNAL METHOD - NOT INTENDED FOR GENERAL USE DO NOT USE THIS METHOD OUTSIDE OF THE RENDERING PROCESS Used by vtkHardwareSelector to determine if the prop supports hardware selection.

virtual void	ProcessSelectorPixelBuffers (vtkHardwareSelector , std::vector< unsigned int > &, vtkProp )
	allows a mapper to update a selections color buffers Called from a prop which in turn is called from the selector

virtual int	CanUseTextureMapForColoring (vtkDataObject *input)
	Returns if we can use texture maps for scalar coloring.

void	ClearColorArrays ()
	Call to force a rebuild of color result arrays on next MapScalars.

vtkUnsignedCharArray *	GetColorMapColors ()
	Provide read access to the color array.

vtkFloatArray *	GetColorCoordinates ()
	Provide read access to the color texture coordinate array.

vtkImageData *	GetColorTextureMap ()
	Provide read access to the color texture array.


void	SetLookupTable (vtkScalarsToColors *lut)
	Specify a lookup table for the mapper to use.

vtkScalarsToColors *	GetLookupTable ()
	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	SetStatic (vtkTypeBool)
	Turn on/off flag to control whether the mapper's data is static.

virtual vtkTypeBool	GetStatic ()
	Turn on/off flag to control whether the mapper's data is static.

virtual void	StaticOn ()
	Turn on/off flag to control whether the mapper's data is static.

virtual void	StaticOff ()
	Turn on/off flag to control whether the mapper's data is static.


virtual void	SetColorMode (int)
	default (ColorModeToDefault), unsigned char scalars are treated as colors, and NOT mapped through the lookup table, while everything else is.

virtual int	GetColorMode ()
	default (ColorModeToDefault), unsigned char scalars are treated as colors, and NOT mapped through the lookup table, while everything else is.

void	SetColorModeToDefault ()
	default (ColorModeToDefault), unsigned char scalars are treated as colors, and NOT mapped through the lookup table, while everything else is.

void	SetColorModeToMapScalars ()
	default (ColorModeToDefault), unsigned char scalars are treated as colors, and NOT mapped through the lookup table, while everything else is.

void	SetColorModeToDirectScalars ()
	default (ColorModeToDefault), unsigned char scalars are treated as colors, and NOT mapped through the lookup table, while everything else is.


virtual void	SetInterpolateScalarsBeforeMapping (vtkTypeBool)
	By default, vertex color is used to map colors to a surface.

virtual vtkTypeBool	GetInterpolateScalarsBeforeMapping ()
	By default, vertex color is used to map colors to a surface.

virtual void	InterpolateScalarsBeforeMappingOn ()
	By default, vertex color is used to map colors to a surface.

virtual void	InterpolateScalarsBeforeMappingOff ()
	By default, vertex color is used to map colors to a surface.


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).


void	SelectColorArray (int arrayNum)
	When ScalarMode is set to UsePointFieldData or UseCellFieldData, you can specify which array to use for coloring using these methods.

void	SelectColorArray (const char *arrayName)
	When ScalarMode is set to UsePointFieldData or UseCellFieldData, you can specify which array to use for coloring using these methods.


void	ColorByArrayComponent (int arrayNum, int component)
	Legacy: These methods used to be used to specify the array component.

void	ColorByArrayComponent (const char *arrayName, int component)
	Legacy: These methods used to be used to specify the array component.


void	SetRelativeCoincidentTopologyPolygonOffsetParameters (double factor, double units)
	Used to set the polygon offset values relative to the global Used when ResolveCoincidentTopology is set to PolygonOffset.

void	GetRelativeCoincidentTopologyPolygonOffsetParameters (double &factor, double &units)
	Used to set the polygon offset values relative to the global Used when ResolveCoincidentTopology is set to PolygonOffset.


void	SetRelativeCoincidentTopologyLineOffsetParameters (double factor, double units)
	Used to set the line offset values relative to the global Used when ResolveCoincidentTopology is set to PolygonOffset.

void	GetRelativeCoincidentTopologyLineOffsetParameters (double &factor, double &units)
	Used to set the line offset values relative to the global Used when ResolveCoincidentTopology is set to PolygonOffset.


void	SetRelativeCoincidentTopologyPointOffsetParameter (double units)
	Used to set the point offset value relative to the global Used when ResolveCoincidentTopology is set to PolygonOffset.

void	GetRelativeCoincidentTopologyPointOffsetParameter (double &units)
	Used to set the point offset value relative to the global Used when ResolveCoincidentTopology is set to PolygonOffset.


void	GetCoincidentTopologyPolygonOffsetParameters (double &factor, double &units)
	Get the net parameters for handling coincident topology obtained by summing the global values with the relative values.

void	GetCoincidentTopologyLineOffsetParameters (double &factor, double &units)
	Get the net parameters for handling coincident topology obtained by summing the global values with the relative values.

void	GetCoincidentTopologyPointOffsetParameter (double &units)
	Get the net parameters for handling coincident topology obtained by summing the global values with the relative values.


virtual vtkUnsignedCharArray *	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.

virtual vtkUnsignedCharArray *	MapScalars (double alpha, int &cellFlag)
	Map the scalars (if there are any scalars and ScalarVisibility is on) through the lookup table, returning an unsigned char RGBA array.

virtual vtkUnsignedCharArray *	MapScalars (vtkDataSet *input, double alpha)
	Map the scalars (if there are any scalars and ScalarVisibility is on) through the lookup table, returning an unsigned char RGBA array.

virtual vtkUnsignedCharArray *	MapScalars (vtkDataSet *input, double alpha, int &cellFlag)
	Map the scalars (if there are any scalars and ScalarVisibility is on) through the lookup table, returning an unsigned char RGBA array.


virtual bool	HasOpaqueGeometry ()
	Some introspection on the type of data the mapper will render used by props to determine if they should invoke the mapper on a specific rendering pass.

virtual bool	HasTranslucentPolygonalGeometry ()
	Some introspection on the type of data the mapper will render used by props to determine if they should invoke the mapper on a specific rendering pass.


virtual vtkSelection *	GetSelection ()
	Set/Get selection used to display particular points or cells in a second pass.

virtual void	SetSelection (vtkSelection *)
	Set/Get selection used to display particular points or cells in a second pass.

Public Member Functions inherited from vtkAbstractMapper3D
virtual vtkTypeBool	IsA (const char *type)
	Return 1 if this class is the same type of (or a subclass of) the named class.

vtkAbstractMapper3D *	NewInstance () const

void	PrintSelf (ostream &os, vtkIndent indent) override
	Methods invoked by print to print information about the object including superclasses.

virtual double *	GetBounds ()=0
	Return bounding box (array of six doubles) of data expressed as (xmin,xmax, ymin,ymax, zmin,zmax).

virtual void	GetBounds (double bounds[6])
	Get the bounds for this mapper as (Xmin,Xmax,Ymin,Ymax,Zmin,Zmax).

double	GetLength ()
	Return the diagonal length of this mappers bounding box.

virtual vtkTypeBool	IsARayCastMapper ()
	Is this a ray cast mapper? A subclass would return 1 if the ray caster is needed to generate an image from this mapper.

virtual vtkTypeBool	IsARenderIntoImageMapper ()
	Is this a "render into image" mapper? A subclass would return 1 if the mapper produces an image by rendering into a software image buffer.

void	GetClippingPlaneInDataCoords (vtkMatrix4x4 *propMatrix, int i, double planeEquation[4])
	Get the ith clipping plane as a homogeneous plane equation.

double *	GetCenter ()
	Return the Center of this mapper's data.

void	GetCenter (double center[3])
	Return the Center of this mapper's data.

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.

vtkAbstractMapper *	NewInstance () 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 vtkPlaneCollection *	GetClippingPlanes ()
	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.

vtkAlgorithm *	NewInstance () const

void	PrintSelf (ostream &os, vtkIndent indent) override
	Methods invoked by print to print information about the object including superclasses.

int	HasExecutive ()
	Check whether this algorithm has an assigned executive.

vtkExecutive *	GetExecutive ()
	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.

vtkInformation *	GetInputPortInformation (int port)
	Get the information object associated with an input port.

vtkInformation *	GetOutputPortInformation (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	SetProgress (double)
	`SetProgress` is deprecated.

void	UpdateProgress (double amount)
	Update the progress of the process object.

virtual void	SetInputArrayToProcess (int idx, int port, int connection, const char fieldAssociation, const char attributeTypeorName)
	String based versions of SetInputArrayToProcess().

vtkInformation *	GetInputArrayInformation (int idx)
	Get the info object for the specified input array to this algorithm.

void	RemoveAllInputs ()
	Remove all the input data.

vtkDataObject *	GetOutputDataObject (int port)
	Get the data object that will contain the algorithm output for the given port.

vtkDataObject *	GetInputDataObject (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)

vtkAlgorithmOutput *	GetOutputPort (int index)
	Get a proxy object corresponding to the given output port of this algorithm.

vtkAlgorithmOutput *	GetOutputPort ()

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.

vtkAlgorithmOutput *	GetInputConnection (int port, int index)
	Get the algorithm output port connected to an input port.

vtkAlgorithm *	GetInputAlgorithm (int port, int index, int &algPort)
	Returns the algorithm and the output port index of that algorithm connected to a port-index pair.

vtkAlgorithm *	GetInputAlgorithm (int port, int index)
	Returns the algorithm connected to a port-index pair.

vtkAlgorithm *	GetInputAlgorithm ()
	Equivalent to GetInputAlgorithm(0, 0).

vtkExecutive *	GetInputExecutive (int port, int index)
	Returns the executive associated with a particular input connection.

vtkExecutive *	GetInputExecutive ()
	Equivalent to GetInputExecutive(0, 0)

vtkInformation *	GetInputInformation (int port, int index)
	Return the information object that is associated with a particular input connection.

vtkInformation *	GetInputInformation ()
	Equivalent to GetInputInformation(0, 0)

vtkInformation *	GetOutputInformation (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 int	UpdateExtent (const int extents[6])
	Convenience method to update an algorithm after passing requests to its first output port.

virtual 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 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 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.

virtual vtkInformation *	GetInformation ()
	Set/Get the information object associated with this algorithm.

virtual void	SetInformation (vtkInformation *)
	Set/Get the information object associated with this algorithm.

void	Register (vtkObjectBase *o) override
	Participate in garbage collection.

void	UnRegister (vtkObjectBase *o) 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	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.

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	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 void	Update (int port)
	Bring this algorithm's outputs up-to-date.

virtual void	Update ()
	Bring this algorithm's outputs up-to-date.

virtual void	SetReleaseDataFlag (int)
	Turn release data flag on or off for all output ports.

virtual int	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 vtkProgressObserver *	GetProgressObserver ()
	If an ProgressObserver is set, the algorithm will report progress through it rather than directly.

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)

int	InvokeEvent (unsigned long event)

int	InvokeEvent (const char *event)

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.

vtkCommand *	GetCommand (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.

int	InvokeEvent (unsigned long event, void *callData)
	This method invokes an event and return whether the event was aborted or not.

int	InvokeEvent (const char event, void callData)
	This method invokes an event and return whether the event was aborted or not.

Public Member Functions inherited from vtkObjectBase
const char *	GetClassName () const
	Return the class name as a string.

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.

virtual 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 vtkMapper *	SafeDownCast (vtkObjectBase *o)


static void	SetResolveCoincidentTopology (int val)
	Set/Get a global flag that controls whether coincident topology (e.g., a line on top of a polygon) is shifted to avoid z-buffer resolution (and hence rendering problems).

static int	GetResolveCoincidentTopology ()
	Set/Get a global flag that controls whether coincident topology (e.g., a line on top of a polygon) is shifted to avoid z-buffer resolution (and hence rendering problems).

static void	SetResolveCoincidentTopologyToDefault ()
	Set/Get a global flag that controls whether coincident topology (e.g., a line on top of a polygon) is shifted to avoid z-buffer resolution (and hence rendering problems).

static void	SetResolveCoincidentTopologyToOff ()
	Set/Get a global flag that controls whether coincident topology (e.g., a line on top of a polygon) is shifted to avoid z-buffer resolution (and hence rendering problems).

static void	SetResolveCoincidentTopologyToPolygonOffset ()
	Set/Get a global flag that controls whether coincident topology (e.g., a line on top of a polygon) is shifted to avoid z-buffer resolution (and hence rendering problems).

static void	SetResolveCoincidentTopologyToShiftZBuffer ()
	Set/Get a global flag that controls whether coincident topology (e.g., a line on top of a polygon) is shifted to avoid z-buffer resolution (and hence rendering problems).


static void	SetResolveCoincidentTopologyPolygonOffsetParameters (double factor, double units)
	Used to set the polygon offset scale factor and units.

static void	GetResolveCoincidentTopologyPolygonOffsetParameters (double &factor, double &units)
	Used to set the polygon offset scale factor and units.


static void	SetResolveCoincidentTopologyLineOffsetParameters (double factor, double units)
	Used to set the line offset scale factor and units.

static void	GetResolveCoincidentTopologyLineOffsetParameters (double &factor, double &units)
	Used to set the line offset scale factor and units.


static void	SetResolveCoincidentTopologyPointOffsetParameter (double units)
	Used to set the point offset value Used when ResolveCoincidentTopology is set to PolygonOffset.

static void	GetResolveCoincidentTopologyPointOffsetParameter (double &units)
	Used to set the point offset value Used when ResolveCoincidentTopology is set to PolygonOffset.


static void	SetResolveCoincidentTopologyPolygonOffsetFaces (int faces)
	Used when ResolveCoincidentTopology is set to PolygonOffset.

static int	GetResolveCoincidentTopologyPolygonOffsetFaces ()
	Used when ResolveCoincidentTopology is set to PolygonOffset.


static void	SetResolveCoincidentTopologyZShift (double val)
	Used to set the z-shift if ResolveCoincidentTopology is set to ShiftZBuffer.

static double	GetResolveCoincidentTopologyZShift ()
	Used to set the z-shift if ResolveCoincidentTopology is set to ShiftZBuffer.

Static Public Member Functions inherited from vtkAbstractMapper3D
static vtkTypeBool	IsTypeOf (const char *type)

static vtkAbstractMapper3D *	SafeDownCast (vtkObjectBase *o)

Static Public Member Functions inherited from vtkAbstractMapper
static vtkTypeBool	IsTypeOf (const char *type)

static vtkAbstractMapper *	SafeDownCast (vtkObjectBase *o)

static vtkDataArray *	GetScalars (vtkDataSet input, int scalarMode, int arrayAccessMode, int arrayId, const char arrayName, int &cellFlag)
	Internal helper function for getting the active scalars.

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.

Static Public Member Functions inherited from vtkAlgorithm
static vtkAlgorithm *	New ()

static vtkTypeBool	IsTypeOf (const char *type)

static vtkAlgorithm *	SafeDownCast (vtkObjectBase *o)

static vtkInformationIntegerKey *	INPUT_IS_OPTIONAL ()
	Keys used to specify input port requirements.

static vtkInformationIntegerKey *	INPUT_IS_REPEATABLE ()

static vtkInformationInformationVectorKey *	INPUT_REQUIRED_FIELDS ()

static vtkInformationStringVectorKey *	INPUT_REQUIRED_DATA_TYPE ()

static vtkInformationInformationVectorKey *	INPUT_ARRAYS_TO_PROCESS ()

static vtkInformationIntegerKey *	INPUT_PORT ()

static vtkInformationIntegerKey *	INPUT_CONNECTION ()

static vtkInformationIntegerKey *	CAN_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 vtkInformationIntegerKey *	CAN_HANDLE_PIECE_REQUEST ()
	Key that tells the pipeline that a particular algorithm can or cannot handle piece request.

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 vtkObject *	New ()
	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 (int 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 int	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 vtkObjectBase *	New ()
	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 vtkObjectBase *	NewInstanceInternal () const

	vtkMapper ()

	~vtkMapper () override

void	MapScalarsToTexture (vtkAbstractArray *scalars, double alpha)

Protected Member Functions inherited from vtkAbstractMapper3D
virtual vtkObjectBase *	NewInstanceInternal () const

	vtkAbstractMapper3D ()

	~vtkAbstractMapper3D () override=default

Protected Member Functions inherited from vtkAbstractMapper
virtual vtkObjectBase *	NewInstanceInternal () const

	vtkAbstractMapper ()

	~vtkAbstractMapper () override

Protected Member Functions inherited from vtkAlgorithm
virtual vtkObjectBase *	NewInstanceInternal () const

	vtkAlgorithm ()

	~vtkAlgorithm () override

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 assocition of the actual data array for the input array specified by idx, this is only reasonable during the REQUEST_DATA pass.

vtkInformation *	GetInputArrayFieldInformation (int idx, vtkInformationVector **inputVector)
	This method takes in an index (as specified in SetInputArrayToProcess) and a pipeline information vector.

virtual vtkExecutive *	CreateDefaultExecutive ()
	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.

vtkDataArray *	GetInputArrayToProcess (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.

vtkDataArray *	GetInputArrayToProcess (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.

vtkDataArray *	GetInputArrayToProcess (int idx, int connection, vtkInformationVector **inputVector)
	Filters that have multiple connections on one port can use this signature.

vtkDataArray *	GetInputArrayToProcess (int idx, int connection, vtkInformationVector **inputVector, int &association)
	Filters that have multiple connections on one port can use this signature.

vtkDataArray *	GetInputArrayToProcess (int idx, vtkDataObject *input)
	Filters that have multiple connections on one port can use this signature.

vtkDataArray *	GetInputArrayToProcess (int idx, vtkDataObject *input, int &association)
	Filters that have multiple connections on one port can use this signature.

vtkAbstractArray *	GetInputAbstractArrayToProcess (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.

vtkAbstractArray *	GetInputAbstractArrayToProcess (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.

vtkAbstractArray *	GetInputAbstractArrayToProcess (int idx, int connection, vtkInformationVector **inputVector)
	Filters that have multiple connections on one port can use this signature.

vtkAbstractArray *	GetInputAbstractArrayToProcess (int idx, int connection, vtkInformationVector **inputVector, int &association)
	Filters that have multiple connections on one port can use this signature.

vtkAbstractArray *	GetInputAbstractArrayToProcess (int idx, vtkDataObject *input)
	Filters that have multiple connections on one port can use this signature.

vtkAbstractArray *	GetInputAbstractArrayToProcess (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 *)

	vtkObjectBase (const vtkObjectBase &)

void	operator= (const vtkObjectBase &)

Protected Attributes
vtkUnsignedCharArray *	Colors

vtkTypeBool	InterpolateScalarsBeforeMapping

vtkFloatArray *	ColorCoordinates

vtkImageData *	ColorTextureMap

vtkScalarsToColors *	LookupTable

vtkTypeBool	ScalarVisibility

vtkTimeStamp	BuildTime

double	ScalarRange [2]

vtkTypeBool	UseLookupTableScalarRange

int	ColorMode

int	ScalarMode

double	RenderTime

int	ArrayId

char *	ArrayName

int	ArrayComponent

int	ArrayAccessMode

vtkIdType	FieldDataTupleId

vtkTypeBool	Static

double	CoincidentPolygonFactor

double	CoincidentPolygonOffset

double	CoincidentLineFactor

double	CoincidentLineOffset

double	CoincidentPointOffset

vtkSelection *	Selection = nullptr

Protected Attributes inherited from vtkAbstractMapper3D
double	Bounds [6]

double	Center [3]

Protected Attributes inherited from vtkAbstractMapper
vtkTimerLog *	Timer

double	TimeToDraw

vtkWindow *	LastWindow

vtkPlaneCollection *	ClippingPlanes

Protected Attributes inherited from vtkAlgorithm
vtkInformation *	Information

double	Progress

char *	ProgressText

vtkProgressObserver *	ProgressObserver

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

Protected Attributes inherited from vtkObjectBase
std::atomic< int32_t >	ReferenceCount

vtkWeakPointerBase **	WeakPointers

Additional Inherited Members
Public Attributes inherited from vtkAlgorithm
vtkTypeBool	AbortExecute

Static Protected Member Functions inherited from vtkAlgorithm
static vtkInformationIntegerKey *	PORT_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 vtkExecutive *	DefaultExecutivePrototype

Detailed Description

abstract class specifies interface to map data to graphics primitives

vtkMapper is an abstract class to specify interface between data and graphics primitives. Subclasses of vtkMapper map data through a lookuptable and control the creation of rendering primitives that interface to the graphics library. The mapping can be controlled by supplying a lookup table and specifying a scalar range to map data through.

There are several important control mechanisms affecting the behavior of this object. The ScalarVisibility flag controls whether scalar data (if any) controls the color of the associated actor(s) that refer to the mapper. The ScalarMode ivar is used to determine whether scalar point data or cell data is used to color the object. By default, point data scalars are used unless there are none, in which cell scalars are used. Or you can explicitly control whether to use point or cell scalar data. Finally, the mapping of scalars through the lookup table varies depending on the setting of the ColorMode flag. See the documentation for the appropriate methods for an explanation.

Another important feature of the mapper is the ability to shift the z-buffer to resolve coincident topology. For example, if you'd like to draw a mesh with some edges a different color, and the edges lie on the mesh, this feature can be useful to get nice looking lines. (See the ResolveCoincidentTopology-related methods.)

See also: vtkDataSetMapper vtkPolyDataMapper

Online Examples:

TableBasedClipDataSetWithPolyData2

StippledLine

CameraActor

Definition at line 170 of file vtkMapper.h.

Member Typedef Documentation

◆ Superclass

typedef vtkAbstractMapper3D vtkMapper::Superclass

Definition at line 173 of file vtkMapper.h.

Constructor & Destructor Documentation

◆ vtkMapper()

vtkMapper::vtkMapper ( )

protected

◆ ~vtkMapper()

vtkMapper::~vtkMapper ( )

overrideprotected

Member Function Documentation

◆ IsTypeOf()

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

static

◆ IsA()

virtual vtkTypeBool vtkMapper::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 vtkAbstractMapper3D.

Reimplemented in vtkMoleculeMapper, vtkOpenGLMoleculeMapper, vtkCompositePolyDataMapper, vtkDataSetMapper, vtkGlyph3DMapper, vtkGraphMapper, vtkHierarchicalPolyDataMapper, vtkLabeledContourMapper, vtkPointGaussianMapper, vtkPolyDataMapper, vtkCompositeSurfaceLICMapper, vtkSurfaceLICMapper, vtkCompositeMapperHelper2, vtkCompositePolyDataMapper2, vtkOpenGLGlyph3DHelper, vtkOpenGLGlyph3DMapper, vtkOpenGLLabeledContourMapper, vtkOpenGLPointGaussianMapper, vtkOpenGLPolyDataMapper, vtkOpenGLSphereMapper, and vtkOpenGLStickMapper.

◆ SafeDownCast()

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

static

◆ NewInstanceInternal()

virtual vtkObjectBase * vtkMapper::NewInstanceInternal ( ) const

protectedvirtual

◆ NewInstance()

vtkMapper * vtkMapper::NewInstance ( ) const

◆ PrintSelf()

void vtkMapper::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 vtkAbstractMapper3D.

Reimplemented in vtkPointGaussianMapper, vtkPolyDataMapper, vtkCompositeSurfaceLICMapper, vtkSurfaceLICMapper, vtkCompositeMapperHelper2, vtkCompositePolyDataMapper2, vtkOpenGLGlyph3DHelper, vtkOpenGLGlyph3DMapper, vtkOpenGLLabeledContourMapper, vtkOpenGLPointGaussianMapper, vtkOpenGLPolyDataMapper, vtkOpenGLSphereMapper, and vtkOpenGLStickMapper.

◆ ShallowCopy()

void vtkMapper::ShallowCopy ( vtkAbstractMapper * m )

overridevirtual

Make a shallow copy of this mapper.

Reimplemented from vtkAbstractMapper.

Reimplemented in vtkSurfaceLICMapper, vtkPolyDataMapper, and vtkOpenGLPolyDataMapper.

◆ GetMTime()

vtkMTimeType vtkMapper::GetMTime ( )

overridevirtual

Overload standard modified time function.

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

Reimplemented from vtkAbstractMapper.

Reimplemented in vtkCompositePolyDataMapper2.

◆ Render()

virtual void vtkMapper::Render	(	vtkRenderer *	ren,
		vtkActor *	a
	)

pure virtual

Method initiates the mapping process.

Generally sent by the actor as each frame is rendered.

Implemented in vtkMoleculeMapper, vtkOpenGLMoleculeMapper, vtkCompositePolyDataMapper, vtkOpenGLGlyph3DMapper, vtkDataSetMapper, vtkGlyph3DMapper, vtkGraphMapper, vtkLabeledContourMapper, vtkPolyDataMapper, vtkCompositeSurfaceLICMapper, vtkCompositePolyDataMapper2, vtkOpenGLPointGaussianMapper, and vtkOpenGLSphereMapper.

◆ ReleaseGraphicsResources()

void vtkMapper::ReleaseGraphicsResources ( vtkWindow * )

inlineoverridevirtual

Release any graphics resources that are being consumed by this mapper.

The parameter window could be used to determine which graphic resources to release.

Reimplemented from vtkAbstractMapper.

Reimplemented in vtkCompositePolyDataMapper2, vtkOpenGLPointGaussianMapper, vtkOpenGLPolyDataMapper, vtkSurfaceLICMapper, vtkOpenGLLabeledContourMapper, vtkOpenGLGlyph3DHelper, and vtkOpenGLGlyph3DMapper.

Definition at line 198 of file vtkMapper.h.

◆ SetLookupTable()

void vtkMapper::SetLookupTable ( vtkScalarsToColors * lut )

Specify a lookup table for the mapper to use.

◆ GetLookupTable()

vtkScalarsToColors * vtkMapper::GetLookupTable ( )

Specify a lookup table for the mapper to use.

◆ CreateDefaultLookupTable()

virtual void vtkMapper::CreateDefaultLookupTable ( )

virtual

Create default lookup table.

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

◆ SetScalarVisibility()

virtual void vtkMapper::SetScalarVisibility ( vtkTypeBool )

virtual

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

◆ GetScalarVisibility()

virtual vtkTypeBool vtkMapper::GetScalarVisibility ( )

virtual

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

◆ ScalarVisibilityOn()

virtual void vtkMapper::ScalarVisibilityOn ( )

virtual

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

◆ ScalarVisibilityOff()

virtual void vtkMapper::ScalarVisibilityOff ( )

virtual

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

◆ SetStatic()

virtual void vtkMapper::SetStatic ( vtkTypeBool )

virtual

Turn on/off flag to control whether the mapper's data is static.

Static data means that the mapper does not propagate updates down the pipeline, greatly decreasing the time it takes to update many mappers. This should only be used if the data never changes.

◆ GetStatic()

virtual vtkTypeBool vtkMapper::GetStatic ( )

virtual

Turn on/off flag to control whether the mapper's data is static.

Static data means that the mapper does not propagate updates down the pipeline, greatly decreasing the time it takes to update many mappers. This should only be used if the data never changes.

◆ StaticOn()

virtual void vtkMapper::StaticOn ( )

virtual

Turn on/off flag to control whether the mapper's data is static.

Static data means that the mapper does not propagate updates down the pipeline, greatly decreasing the time it takes to update many mappers. This should only be used if the data never changes.

◆ StaticOff()

virtual void vtkMapper::StaticOff ( )

virtual

Turn on/off flag to control whether the mapper's data is static.

Static data means that the mapper does not propagate updates down the pipeline, greatly decreasing the time it takes to update many mappers. This should only be used if the data never changes.

◆ SetColorMode()

virtual void vtkMapper::SetColorMode ( int )

virtual

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 SelectColorArray() method.)

◆ GetColorMode()

virtual int vtkMapper::GetColorMode ( )

virtual

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 SelectColorArray() method.)

◆ SetColorModeToDefault()

void vtkMapper::SetColorModeToDefault ( )

inline

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 SelectColorArray() method.)

Definition at line 250 of file vtkMapper.h.

◆ SetColorModeToMapScalars()

void vtkMapper::SetColorModeToMapScalars ( )

inline

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 SelectColorArray() method.)

Definition at line 251 of file vtkMapper.h.

◆ SetColorModeToDirectScalars()

void vtkMapper::SetColorModeToDirectScalars ( )

inline

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 SelectColorArray() method.)

Definition at line 252 of file vtkMapper.h.

◆ GetColorModeAsString()

const char * vtkMapper::GetColorModeAsString ( )

Return the method of coloring scalar data.

◆ SetInterpolateScalarsBeforeMapping()

virtual void vtkMapper::SetInterpolateScalarsBeforeMapping ( vtkTypeBool )

virtual

By default, vertex color is used to map colors to a surface.

Colors are interpolated after being mapped. This option avoids color interpolation by using a one dimensional texture map for the colors.

◆ GetInterpolateScalarsBeforeMapping()

virtual vtkTypeBool vtkMapper::GetInterpolateScalarsBeforeMapping ( )

virtual

By default, vertex color is used to map colors to a surface.

Colors are interpolated after being mapped. This option avoids color interpolation by using a one dimensional texture map for the colors.

◆ InterpolateScalarsBeforeMappingOn()

virtual void vtkMapper::InterpolateScalarsBeforeMappingOn ( )

virtual

By default, vertex color is used to map colors to a surface.

Colors are interpolated after being mapped. This option avoids color interpolation by using a one dimensional texture map for the colors.

◆ InterpolateScalarsBeforeMappingOff()

virtual void vtkMapper::InterpolateScalarsBeforeMappingOff ( )

virtual

By default, vertex color is used to map colors to a surface.

Colors are interpolated after being mapped. This option avoids color interpolation by using a one dimensional texture map for the colors.

◆ SetUseLookupTableScalarRange()

virtual void vtkMapper::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 vtkMapper::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 vtkMapper::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 vtkMapper::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 vtkMapper::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 vtkMapper::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 * vtkMapper::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 vtkMapper::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 vtkMapper::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 SelectColorArray before you call GetColors.

◆ GetScalarMode()

virtual int vtkMapper::GetScalarMode ( )

virtual

◆ SetScalarModeToDefault()

void vtkMapper::SetScalarModeToDefault ( )

inline

Definition at line 323 of file vtkMapper.h.

◆ SetScalarModeToUsePointData()

void vtkMapper::SetScalarModeToUsePointData ( )

inline

Definition at line 324 of file vtkMapper.h.

◆ SetScalarModeToUseCellData()

void vtkMapper::SetScalarModeToUseCellData ( )

inline

Definition at line 325 of file vtkMapper.h.

◆ SetScalarModeToUsePointFieldData()

void vtkMapper::SetScalarModeToUsePointFieldData ( )

inline

Definition at line 326 of file vtkMapper.h.

◆ SetScalarModeToUseCellFieldData()

void vtkMapper::SetScalarModeToUseCellFieldData ( )

inline

Definition at line 330 of file vtkMapper.h.

◆ SetScalarModeToUseFieldData()

void vtkMapper::SetScalarModeToUseFieldData ( )

inline

Definition at line 334 of file vtkMapper.h.

◆ SelectColorArray() [1/2]

void vtkMapper::SelectColorArray ( int arrayNum )

When ScalarMode is set to UsePointFieldData or UseCellFieldData, you can specify which array to use for coloring using these methods.

The lookup table will decide how to convert vectors to colors.

◆ SelectColorArray() [2/2]

void vtkMapper::SelectColorArray ( const char * arrayName )

When ScalarMode is set to UsePointFieldData or UseCellFieldData, you can specify which array to use for coloring using these methods.

The lookup table will decide how to convert vectors to colors.

◆ SetFieldDataTupleId()

virtual void vtkMapper::SetFieldDataTupleId ( vtkIdType )

virtual

◆ GetFieldDataTupleId()

virtual vtkIdType vtkMapper::GetFieldDataTupleId ( )

virtual

◆ ColorByArrayComponent() [1/2]

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

Legacy: These methods used to be used to specify the array component.

It is better to do this in the lookup table.

◆ ColorByArrayComponent() [2/2]

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

Legacy: These methods used to be used to specify the array component.

It is better to do this in the lookup table.

◆ GetArrayName()

virtual char * vtkMapper::GetArrayName ( )

virtual

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

◆ SetArrayName()

virtual void vtkMapper::SetArrayName ( const char * )

virtual

◆ GetArrayId()

virtual int vtkMapper::GetArrayId ( )

virtual

◆ SetArrayId()

virtual void vtkMapper::SetArrayId ( int )

virtual

◆ GetArrayAccessMode()

virtual int vtkMapper::GetArrayAccessMode ( )

virtual

◆ SetArrayAccessMode()

virtual void vtkMapper::SetArrayAccessMode ( int )

virtual

◆ GetArrayComponent()

virtual int vtkMapper::GetArrayComponent ( )

virtual

◆ SetArrayComponent()

virtual void vtkMapper::SetArrayComponent ( int )

virtual

◆ GetScalarModeAsString()

const char * vtkMapper::GetScalarModeAsString ( )

Return the method for obtaining scalar data.