VTK
Public Types | Public Member Functions | Static Public Member Functions | Protected Member Functions | Protected Attributes | List of all members
vtkMapper Class Referenceabstract

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

#include <vtkMapper.h>

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

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 int IsA (const char *type)
 Return 1 if this class is the same type of (or a subclass of) the named class. More...
 
vtkMapperNewInstance () const
 
void PrintSelf (ostream &os, vtkIndent indent) override
 Methods invoked by print to print information about the object including superclasses. More...
 
void ShallowCopy (vtkAbstractMapper *m)
 Make a shallow copy of this mapper. More...
 
vtkMTimeType GetMTime () override
 Overload standard modified time function. More...
 
virtual void Render (vtkRenderer *ren, vtkActor *a)=0
 Method initiates the mapping process. More...
 
void ReleaseGraphicsResources (vtkWindow *) override
 Release any graphics resources that are being consumed by this mapper. More...
 
virtual void CreateDefaultLookupTable ()
 Create default lookup table. More...
 
const char * GetColorModeAsString ()
 Return the method of coloring scalar data. More...
 
virtual void SetScalarMode (int)
 Control how the filter works with scalar point data and cell attribute data. More...
 
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. More...
 
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. More...
 
doubleGetBounds () override
 Return bounding box (array of six doubles) of data expressed as (xmin,xmax, ymin,ymax, zmin,zmax). More...
 
void GetBounds (double bounds[6]) override
 Get the bounds for this mapper as (Xmin,Xmax,Ymin,Ymax,Zmin,Zmax). More...
 
void SetRenderTime (double time)
 This instance variable is used by vtkLODActor to determine which mapper to use. More...
 
virtual double GetRenderTime ()
 
vtkDataSetGetInput ()
 Get the input as a vtkDataSet. More...
 
vtkDataSetGetInputAsDataSet ()
 Get the input to this mapper as a vtkDataSet, instead of as a more specialized data type that the subclass may return from GetInput(). More...
 
virtual bool GetIsOpaque ()
 Returns if the mapper does not expect to have translucent geometry. More...
 
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. More...
 
virtual int CanUseTextureMapForColoring (vtkDataObject *input)
 Returns if we can use texture maps for scalar coloring. More...
 
void ClearColorArrays ()
 Call to force a rebuild of color result arrays on next MapScalars. More...
 
vtkUnsignedCharArrayGetColorMapColors ()
 Provide read access to the color array. More...
 
vtkFloatArrayGetColorCoordinates ()
 Provide read access to the color texture coordinate array. More...
 
vtkImageDataGetColorTextureMap ()
 Provide read access to the color texture array. More...
 
void SetLookupTable (vtkScalarsToColors *lut)
 Specify a lookup table for the mapper to use. More...
 
vtkScalarsToColorsGetLookupTable ()
 Specify a lookup table for the mapper to use. More...
 
virtual void SetScalarVisibility (vtkTypeBool)
 Turn on/off flag to control whether scalar data is used to color objects. More...
 
virtual vtkTypeBool GetScalarVisibility ()
 Turn on/off flag to control whether scalar data is used to color objects. More...
 
virtual void ScalarVisibilityOn ()
 Turn on/off flag to control whether scalar data is used to color objects. More...
 
virtual void ScalarVisibilityOff ()
 Turn on/off flag to control whether scalar data is used to color objects. More...
 
virtual void SetStatic (vtkTypeBool)
 Turn on/off flag to control whether the mapper's data is static. More...
 
virtual vtkTypeBool GetStatic ()
 Turn on/off flag to control whether the mapper's data is static. More...
 
virtual void StaticOn ()
 Turn on/off flag to control whether the mapper's data is static. More...
 
virtual void StaticOff ()
 Turn on/off flag to control whether the mapper's data is static. More...
 
virtual void SetColorMode (int)
 default (ColorModeToDefault), unsigned char scalars are treated as colors, and NOT mapped through the lookup table, while everything else is. More...
 
virtual int GetColorMode ()
 default (ColorModeToDefault), unsigned char scalars are treated as colors, and NOT mapped through the lookup table, while everything else is. More...
 
void SetColorModeToDefault ()
 default (ColorModeToDefault), unsigned char scalars are treated as colors, and NOT mapped through the lookup table, while everything else is. More...
 
void SetColorModeToMapScalars ()
 default (ColorModeToDefault), unsigned char scalars are treated as colors, and NOT mapped through the lookup table, while everything else is. More...
 
void SetColorModeToDirectScalars ()
 default (ColorModeToDefault), unsigned char scalars are treated as colors, and NOT mapped through the lookup table, while everything else is. More...
 
virtual void SetInterpolateScalarsBeforeMapping (vtkTypeBool)
 By default, vertex color is used to map colors to a surface. More...
 
virtual vtkTypeBool GetInterpolateScalarsBeforeMapping ()
 By default, vertex color is used to map colors to a surface. More...
 
virtual void InterpolateScalarsBeforeMappingOn ()
 By default, vertex color is used to map colors to a surface. More...
 
virtual void InterpolateScalarsBeforeMappingOff ()
 By default, vertex color is used to map colors to a surface. More...
 
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. More...
 
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. More...
 
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. More...
 
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. More...
 
virtual void SetScalarRange (double, double)
 Specify range in terms of scalar minimum and maximum (smin,smax). More...
 
void SetScalarRange (double[2])
 Specify range in terms of scalar minimum and maximum (smin,smax). More...
 
virtual doubleGetScalarRange ()
 Specify range in terms of scalar minimum and maximum (smin,smax). More...
 
virtual void GetScalarRange (double data[2])
 Specify range in terms of scalar minimum and maximum (smin,smax). More...
 
void SelectColorArray (int arrayNum)
 When ScalarMode is set to UsePointFieldData or UseCellFieldData, you can specify which array to use for coloring using these methods. More...
 
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. More...
 
void ColorByArrayComponent (int arrayNum, int component)
 Legacy: These methods used to be used to specify the array component. More...
 
void ColorByArrayComponent (const char *arrayName, int component)
 Legacy: These methods used to be used to specify the array component. More...
 
void SetRelativeCoincidentTopologyPolygonOffsetParameters (double factor, double units)
 Used to set the polygon offset values relative to the global Used when ResolveCoincidentTopology is set to PolygonOffset. More...
 
void GetRelativeCoincidentTopologyPolygonOffsetParameters (double &factor, double &units)
 Used to set the polygon offset values relative to the global Used when ResolveCoincidentTopology is set to PolygonOffset. More...
 
void SetRelativeCoincidentTopologyLineOffsetParameters (double factor, double units)
 Used to set the line offset values relative to the global Used when ResolveCoincidentTopology is set to PolygonOffset. More...
 
void GetRelativeCoincidentTopologyLineOffsetParameters (double &factor, double &units)
 Used to set the line offset values relative to the global Used when ResolveCoincidentTopology is set to PolygonOffset. More...
 
void SetRelativeCoincidentTopologyPointOffsetParameter (double units)
 Used to set the point offset value relative to the global Used when ResolveCoincidentTopology is set to PolygonOffset. More...
 
void GetRelativeCoincidentTopologyPointOffsetParameter (double &units)
 Used to set the point offset value relative to the global Used when ResolveCoincidentTopology is set to PolygonOffset. More...
 
void GetCoincidentTopologyPolygonOffsetParameters (double &factor, double &units)
 Get the net parameters for handling coincident topology obtained by summing the global values with the relative values. More...
 
void GetCoincidentTopologyLineOffsetParameters (double &factor, double &units)
 Get the net parameters for handling coincident topology obtained by summing the global values with the relative values. More...
 
void GetCoincidentTopologyPointOffsetParameter (double &units)
 Get the net parameters for handling coincident topology obtained by summing the global values with the relative values. More...
 
virtual 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. More...
 
virtual vtkUnsignedCharArrayMapScalars (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. More...
 
virtual vtkUnsignedCharArrayMapScalars (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. More...
 
virtual vtkUnsignedCharArrayMapScalars (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. More...
 
- Public Member Functions inherited from vtkAbstractMapper3D
vtkAbstractMapper3DNewInstance () const
 
double GetLength ()
 Return the diagonal length of this mappers bounding box. More...
 
virtual int 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. More...
 
virtual int 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. More...
 
void GetClippingPlaneInDataCoords (vtkMatrix4x4 *propMatrix, int i, double planeEquation[4])
 Get the ith clipping plane as a homogeneous plane equation. More...
 
doubleGetCenter ()
 Return the Center of this mapper's data. More...
 
void GetCenter (double center[3])
 Return the Center of this mapper's data. More...
 
- Public Member Functions inherited from vtkAbstractMapper
vtkAbstractMapperNewInstance () const
 
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. More...
 
void ShallowCopy (vtkAbstractMapper *m)
 Make a shallow copy of this mapper. More...
 
int GetNumberOfClippingPlanes ()
 Get the number of clipping planes. More...
 
virtual double GetTimeToDraw ()
 Get the time required to draw the geometry last time it was rendered. More...
 
void AddClippingPlane (vtkPlane *plane)
 Specify clipping planes to be applied when the data is mapped (at most 6 clipping planes can be specified). More...
 
void RemoveClippingPlane (vtkPlane *plane)
 Specify clipping planes to be applied when the data is mapped (at most 6 clipping planes can be specified). More...
 
void RemoveAllClippingPlanes ()
 Specify clipping planes to be applied when the data is mapped (at most 6 clipping planes can be specified). More...
 
virtual void SetClippingPlanes (vtkPlaneCollection *)
 Get/Set the vtkPlaneCollection which specifies the clipping planes. More...
 
virtual vtkPlaneCollectionGetClippingPlanes ()
 Get/Set the vtkPlaneCollection which specifies the clipping planes. More...
 
- Public Member Functions inherited from vtkAlgorithm
vtkAlgorithmNewInstance () const
 
int HasExecutive ()
 Check whether this algorithm has an assigned executive. More...
 
vtkExecutiveGetExecutive ()
 Get this algorithm's executive. More...
 
virtual void SetExecutive (vtkExecutive *executive)
 Set this algorithm's executive. More...
 
virtual int ProcessRequest (vtkInformation *request, vtkInformationVector **inInfo, vtkInformationVector *outInfo)
 Upstream/Downstream requests form the generalized interface through which executives invoke a algorithm's functionality. More...
 
int ProcessRequest (vtkInformation *request, vtkCollection *inInfo, vtkInformationVector *outInfo)
 Version of ProcessRequest() that is wrapped. More...
 
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. More...
 
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. More...
 
vtkInformationGetInputPortInformation (int port)
 Get the information object associated with an input port. More...
 
vtkInformationGetOutputPortInformation (int port)
 Get the information object associated with an output port. More...
 
int GetNumberOfInputPorts ()
 Get the number of input ports used by the algorithm. More...
 
int GetNumberOfOutputPorts ()
 Get the number of output ports provided by the algorithm. More...
 
void UpdateProgress (double amount)
 Update the progress of the process object. More...
 
virtual void SetInputArrayToProcess (int idx, int port, int connection, const char *fieldAssociation, const char *attributeTypeorName)
 String based versions of SetInputArrayToProcess(). More...
 
vtkInformationGetInputArrayInformation (int idx)
 Get the info object for the specified input array to this algorithm. More...
 
void RemoveAllInputs ()
 Remove all the input data. More...
 
vtkDataObjectGetOutputDataObject (int port)
 Get the data object that will contain the algorithm output for the given port. More...
 
vtkDataObjectGetInputDataObject (int port, int connection)
 Get the data object that will contain the algorithm input for the given port and given connection. More...
 
virtual void RemoveInputConnection (int port, vtkAlgorithmOutput *input)
 Remove a connection from the given input port index. More...
 
virtual void RemoveInputConnection (int port, int idx)
 Remove a connection given by index idx. More...
 
virtual void RemoveAllInputConnections (int port)
 Removes all input connections. More...
 
virtual void SetInputDataObject (int port, vtkDataObject *data)
 Sets the data-object as an input on the given port index. More...
 
virtual void SetInputDataObject (vtkDataObject *data)
 
virtual void AddInputDataObject (int port, vtkDataObject *data)
 Add the data-object as an input to this given port. More...
 
virtual void AddInputDataObject (vtkDataObject *data)
 
vtkAlgorithmOutputGetOutputPort (int index)
 Get a proxy object corresponding to the given output port of this algorithm. More...
 
vtkAlgorithmOutputGetOutputPort ()
 
int GetNumberOfInputConnections (int port)
 Get the number of inputs currently connected to a port. More...
 
int GetTotalNumberOfInputConnections ()
 Get the total number of inputs for this algorithm. More...
 
vtkAlgorithmOutputGetInputConnection (int port, int index)
 Get the algorithm output port connected to an input port. More...
 
vtkAlgorithmGetInputAlgorithm (int port, int index, int &algPort)
 Returns the algorithm and the output port index of that algorithm connected to a port-index pair. More...
 
vtkAlgorithmGetInputAlgorithm (int port, int index)
 Returns the algorithm connected to a port-index pair. More...
 
vtkAlgorithmGetInputAlgorithm ()
 Equivalent to GetInputAlgorithm(0, 0). More...
 
vtkExecutiveGetInputExecutive (int port, int index)
 Returns the executive associated with a particular input connection. More...
 
vtkExecutiveGetInputExecutive ()
 Equivalent to GetInputExecutive(0, 0) More...
 
vtkInformationGetInputInformation (int port, int index)
 Return the information object that is associated with a particular input connection. More...
 
vtkInformationGetInputInformation ()
 Equivalent to GetInputInformation(0, 0) More...
 
vtkInformationGetOutputInformation (int port)
 Return the information object that is associated with a particular output port. More...
 
virtual int 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). More...
 
virtual int Update (vtkInformation *requests)
 Convenience method to update an algorithm after passing requests to its first output port. More...
 
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. More...
 
virtual int UpdateExtent (const int extents[6])
 Convenience method to update an algorithm after passing requests to its first output port. More...
 
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. More...
 
virtual void UpdateInformation ()
 Bring the algorithm's information up-to-date. More...
 
virtual void UpdateDataObject ()
 Create output object(s). More...
 
virtual void PropagateUpdateExtent ()
 Propagate meta-data upstream. More...
 
virtual void UpdateWholeExtent ()
 Bring this algorithm's outputs up-to-date. More...
 
void ConvertTotalInputToPortConnection (int ind, int &port, int &conn)
 Convenience routine to convert from a linear ordering of input connections to a port/connection pair. More...
 
virtual vtkInformationGetInformation ()
 Set/Get the information object associated with this algorithm. More...
 
virtual void SetInformation (vtkInformation *)
 Set/Get the information object associated with this algorithm. More...
 
void Register (vtkObjectBase *o) override
 Participate in garbage collection. More...
 
void UnRegister (vtkObjectBase *o) override
 Participate in garbage collection. More...
 
virtual void SetAbortExecute (vtkTypeBool)
 Set/Get the AbortExecute flag for the process object. More...
 
virtual vtkTypeBool GetAbortExecute ()
 Set/Get the AbortExecute flag for the process object. More...
 
virtual void AbortExecuteOn ()
 Set/Get the AbortExecute flag for the process object. More...
 
virtual void AbortExecuteOff ()
 Set/Get the AbortExecute flag for the process object. More...
 
virtual void SetProgress (double)
 Set/Get the execution progress of a process object. More...
 
virtual double GetProgress ()
 Set/Get the execution progress of a process object. More...
 
void SetProgressText (const char *ptext)
 Set the current text message associated with the progress state. More...
 
virtual char * GetProgressText ()
 Set the current text message associated with the progress state. More...
 
virtual unsigned long GetErrorCode ()
 The error code contains a possible error that occurred while reading or writing the file. More...
 
virtual void SetInputArrayToProcess (int idx, int port, int connection, int fieldAssociation, const char *name)
 Set the input data arrays that this algorithm will process. More...
 
virtual void SetInputArrayToProcess (int idx, int port, int connection, int fieldAssociation, int fieldAttributeType)
 Set the input data arrays that this algorithm will process. More...
 
virtual void SetInputArrayToProcess (int idx, vtkInformation *info)
 Set the input data arrays that this algorithm will process. More...
 
virtual void SetInputConnection (int port, vtkAlgorithmOutput *input)
 Set the connection for the given input port index. More...
 
virtual void SetInputConnection (vtkAlgorithmOutput *input)
 Set the connection for the given input port index. More...
 
virtual void AddInputConnection (int port, vtkAlgorithmOutput *input)
 Add a connection to the given input port index. More...
 
virtual void AddInputConnection (vtkAlgorithmOutput *input)
 Add a connection to the given input port index. More...
 
virtual void Update (int port)
 Bring this algorithm's outputs up-to-date. More...
 
virtual void Update ()
 Bring this algorithm's outputs up-to-date. More...
 
virtual void SetReleaseDataFlag (int)
 Turn release data flag on or off for all output ports. More...
 
virtual int GetReleaseDataFlag ()
 Turn release data flag on or off for all output ports. More...
 
void ReleaseDataFlagOn ()
 Turn release data flag on or off for all output ports. More...
 
void ReleaseDataFlagOff ()
 Turn release data flag on or off for all output ports. More...
 
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. More...
 
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. More...
 
intGetUpdateExtent ()
 These functions return the update extent for output ports that use 3D extents. More...
 
intGetUpdateExtent (int port)
 These functions return the update extent for output ports that use 3D extents. More...
 
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. More...
 
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. More...
 
void GetUpdateExtent (int extent[6])
 These functions return the update extent for output ports that use 3D extents. More...
 
void GetUpdateExtent (int port, int extent[6])
 These functions return the update extent for output ports that use 3D extents. More...
 
int GetUpdatePiece ()
 These functions return the update extent for output ports that use piece extents. More...
 
int GetUpdatePiece (int port)
 These functions return the update extent for output ports that use piece extents. More...
 
int GetUpdateNumberOfPieces ()
 These functions return the update extent for output ports that use piece extents. More...
 
int GetUpdateNumberOfPieces (int port)
 These functions return the update extent for output ports that use piece extents. More...
 
int GetUpdateGhostLevel ()
 These functions return the update extent for output ports that use piece extents. More...
 
int GetUpdateGhostLevel (int port)
 These functions return the update extent for output ports that use piece extents. More...
 
void SetProgressObserver (vtkProgressObserver *)
 If an ProgressObserver is set, the algorithm will report progress through it rather than directly. More...
 
virtual vtkProgressObserverGetProgressObserver ()
 If an ProgressObserver is set, the algorithm will report progress through it rather than directly. More...
 
- Public Member Functions inherited from vtkObject
 vtkBaseTypeMacro (vtkObject, vtkObjectBase)
 
virtual void DebugOn ()
 Turn debugging output on. More...
 
virtual void DebugOff ()
 Turn debugging output off. More...
 
bool GetDebug ()
 Get the value of the debug flag. More...
 
void SetDebug (bool debugFlag)
 Set the value of the debug flag. More...
 
virtual void Modified ()
 Update the modification time for this object. More...
 
void RemoveObserver (unsigned long tag)
 
void RemoveObservers (unsigned long event)
 
void RemoveObservers (const char *event)
 
void RemoveAllObservers ()
 
int HasObserver (unsigned long event)
 
int 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. More...
 
unsigned long AddObserver (const char *event, vtkCommand *, float priority=0.0f)
 Allow people to add/remove/invoke observers (callbacks) to any VTK object. More...
 
vtkCommandGetCommand (unsigned long tag)
 Allow people to add/remove/invoke observers (callbacks) to any VTK object. More...
 
void RemoveObserver (vtkCommand *)
 Allow people to add/remove/invoke observers (callbacks) to any VTK object. More...
 
void RemoveObservers (unsigned long event, vtkCommand *)
 Allow people to add/remove/invoke observers (callbacks) to any VTK object. More...
 
void RemoveObservers (const char *event, vtkCommand *)
 Allow people to add/remove/invoke observers (callbacks) to any VTK object. More...
 
int HasObserver (unsigned long event, vtkCommand *)
 Allow people to add/remove/invoke observers (callbacks) to any VTK object. More...
 
int HasObserver (const char *event, vtkCommand *)
 Allow people to add/remove/invoke observers (callbacks) to any VTK object. More...
 
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. More...
 
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. More...
 
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. More...
 
int InvokeEvent (unsigned long event, void *callData)
 This method invokes an event and return whether the event was aborted or not. More...
 
int InvokeEvent (const char *event, void *callData)
 This method invokes an event and return whether the event was aborted or not. More...
 
- Public Member Functions inherited from vtkObjectBase
const char * GetClassName () const
 Return the class name as a string. More...
 
virtual void Delete ()
 Delete a VTK object. More...
 
virtual void FastDelete ()
 Delete a reference to this object. More...
 
void InitializeObjectBase ()
 
void Print (ostream &os)
 Print an object to an ostream. More...
 
int GetReferenceCount ()
 Return the current reference count of this object. More...
 
void SetReferenceCount (int)
 Sets the reference count. More...
 
void PrintRevisions (ostream &)
 Legacy. More...
 
virtual void PrintHeader (ostream &os, vtkIndent indent)
 Methods invoked by print to print information about the object including superclasses. More...
 
virtual void PrintTrailer (ostream &os, vtkIndent indent)
 Methods invoked by print to print information about the object including superclasses. More...
 

Static Public Member Functions

static int IsTypeOf (const char *type)
 
static vtkMapperSafeDownCast (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). More...
 
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). More...
 
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). More...
 
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). More...
 
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). More...
 
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). More...
 
static void SetResolveCoincidentTopologyPolygonOffsetParameters (double factor, double units)
 Used to set the polygon offset scale factor and units. More...
 
static void GetResolveCoincidentTopologyPolygonOffsetParameters (double &factor, double &units)
 Used to set the polygon offset scale factor and units. More...
 
static void SetResolveCoincidentTopologyLineOffsetParameters (double factor, double units)
 Used to set the line offset scale factor and units. More...
 
static void GetResolveCoincidentTopologyLineOffsetParameters (double &factor, double &units)
 Used to set the line offset scale factor and units. More...
 
static void SetResolveCoincidentTopologyPointOffsetParameter (double units)
 Used to set the point offset value Used when ResolveCoincidentTopology is set to PolygonOffset. More...
 
static void GetResolveCoincidentTopologyPointOffsetParameter (double &units)
 Used to set the point offset value Used when ResolveCoincidentTopology is set to PolygonOffset. More...
 
static void SetResolveCoincidentTopologyPolygonOffsetFaces (int faces)
 Used when ResolveCoincidentTopology is set to PolygonOffset. More...
 
static int GetResolveCoincidentTopologyPolygonOffsetFaces ()
 Used when ResolveCoincidentTopology is set to PolygonOffset. More...
 
static void SetResolveCoincidentTopologyZShift (double val)
 Used to set the z-shift if ResolveCoincidentTopology is set to ShiftZBuffer. More...
 
static double GetResolveCoincidentTopologyZShift ()
 Used to set the z-shift if ResolveCoincidentTopology is set to ShiftZBuffer. More...
 
- Static Public Member Functions inherited from vtkAbstractMapper3D
static int IsTypeOf (const char *type)
 
static vtkAbstractMapper3DSafeDownCast (vtkObjectBase *o)
 
- Static Public Member Functions inherited from vtkAbstractMapper
static int 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. More...
 
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. More...
 
- Static Public Member Functions inherited from vtkAlgorithm
static vtkAlgorithmNew ()
 
static int IsTypeOf (const char *type)
 
static vtkAlgorithmSafeDownCast (vtkObjectBase *o)
 
static vtkInformationIntegerKeyINPUT_IS_OPTIONAL ()
 Keys used to specify input port requirements. More...
 
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. More...
 
static vtkInformationIntegerKeyCAN_HANDLE_PIECE_REQUEST ()
 Key that tells the pipeline that a particular algorithm can or cannot handle piece request. More...
 
static void SetDefaultExecutivePrototype (vtkExecutive *proto)
 If the DefaultExecutivePrototype is set, a copy of it is created in CreateDefaultExecutive() using NewInstance(). More...
 
- 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. More...
 
static void BreakOnError ()
 This method is called when vtkErrorMacro executes. More...
 
static void SetGlobalWarningDisplay (int val)
 This is a global flag that controls whether any debug, warning or error messages are displayed. More...
 
static void GlobalWarningDisplayOn ()
 This is a global flag that controls whether any debug, warning or error messages are displayed. More...
 
static void GlobalWarningDisplayOff ()
 This is a global flag that controls whether any debug, warning or error messages are displayed. More...
 
static int GetGlobalWarningDisplay ()
 This is a global flag that controls whether any debug, warning or error messages are displayed. More...
 
- 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. More...
 
static vtkObjectBaseNew ()
 Create an object with Debug turned off, modified time initialized to zero, and reference counting on. More...
 

Protected Member Functions

virtual vtkObjectBaseNewInstanceInternal () const
 
 vtkMapper ()
 
 ~vtkMapper () override
 
void MapScalarsToTexture (vtkAbstractArray *scalars, double alpha)
 
- Protected Member Functions inherited from vtkAbstractMapper3D
 vtkAbstractMapper3D ()
 
 ~vtkAbstractMapper3D () override
 
- Protected Member Functions inherited from vtkAbstractMapper
 vtkAbstractMapper ()
 
 ~vtkAbstractMapper () override
 
- Protected Member Functions inherited from vtkAlgorithm
 vtkAlgorithm ()
 
 ~vtkAlgorithm () override
 
virtual int FillInputPortInformation (int port, vtkInformation *info)
 Fill the input port information objects for this algorithm. More...
 
virtual int FillOutputPortInformation (int port, vtkInformation *info)
 Fill the output port information objects for this algorithm. More...
 
virtual void SetNumberOfInputPorts (int n)
 Set the number of input ports used by the algorithm. More...
 
virtual void SetNumberOfOutputPorts (int n)
 Set the number of output ports provided by the algorithm. More...
 
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. More...
 
vtkInformationGetInputArrayFieldInformation (int idx, vtkInformationVector **inputVector)
 This method takes in an index (as specified in SetInputArrayToProcess) and a pipeline information vector. More...
 
virtual vtkExecutiveCreateDefaultExecutive ()
 Create a default executive. More...
 
void ReportReferences (vtkGarbageCollector *) override
 
virtual void SetNthInputConnection (int port, int index, vtkAlgorithmOutput *input)
 Replace the Nth connection on the given input port. More...
 
virtual void SetNumberOfInputConnections (int port, int n)
 Set the number of input connections on the given input port. More...
 
void SetInputDataInternal (int port, vtkDataObject *input)
 These methods are used by subclasses to implement methods to set data objects directly as input. More...
 
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. More...
 
int GetInputArrayAssociation (int idx, vtkDataObject *input)
 Filters that have multiple connections on one port can use this signature. More...
 
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. More...
 
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. More...
 
vtkDataArrayGetInputArrayToProcess (int idx, int connection, vtkInformationVector **inputVector)
 Filters that have multiple connections on one port can use this signature. More...
 
vtkDataArrayGetInputArrayToProcess (int idx, int connection, vtkInformationVector **inputVector, int &association)
 Filters that have multiple connections on one port can use this signature. More...
 
vtkDataArrayGetInputArrayToProcess (int idx, vtkDataObject *input)
 Filters that have multiple connections on one port can use this signature. More...
 
vtkDataArrayGetInputArrayToProcess (int idx, vtkDataObject *input, int &association)
 Filters that have multiple connections on one port can use this signature. More...
 
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. More...
 
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. More...
 
vtkAbstractArrayGetInputAbstractArrayToProcess (int idx, int connection, vtkInformationVector **inputVector)
 Filters that have multiple connections on one port can use this signature. More...
 
vtkAbstractArrayGetInputAbstractArrayToProcess (int idx, int connection, vtkInformationVector **inputVector, int &association)
 Filters that have multiple connections on one port can use this signature. More...
 
vtkAbstractArrayGetInputAbstractArrayToProcess (int idx, vtkDataObject *input)
 Filters that have multiple connections on one port can use this signature. More...
 
vtkAbstractArrayGetInputAbstractArrayToProcess (int idx, vtkDataObject *input, int &association)
 Filters that have multiple connections on one port can use this signature. More...
 
virtual void SetErrorCode (unsigned long)
 The error code contains a possible error that occurred while reading or writing the file. More...
 
- 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. More...
 
void InternalReleaseFocus ()
 These methods allow a command to exclusively grab all events. More...
 
- Protected Member Functions inherited from vtkObjectBase
 vtkObjectBase ()
 
virtual ~vtkObjectBase ()
 
virtual void CollectRevisions (ostream &)
 
 vtkObjectBase (const vtkObjectBase &)
 
void operator= (const vtkObjectBase &)
 

Protected Attributes

vtkUnsignedCharArrayColors
 
vtkTypeBool InterpolateScalarsBeforeMapping
 
vtkFloatArrayColorCoordinates
 
vtkImageDataColorTextureMap
 
vtkScalarsToColorsLookupTable
 
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
 
- Protected Attributes inherited from vtkAbstractMapper3D
double Bounds [6]
 
double Center [3]
 
- Protected Attributes inherited from vtkAbstractMapper
vtkTimerLogTimer
 
double TimeToDraw
 
vtkWindowLastWindow
 
vtkPlaneCollectionClippingPlanes
 
- Protected Attributes inherited from vtkAlgorithm
vtkInformationInformation
 
double Progress
 
char * ProgressText
 
vtkProgressObserverProgressObserver
 
unsigned long ErrorCode
 The error code contains a possible error that occurred while reading or writing the file. More...
 
- Protected Attributes inherited from vtkObject
bool Debug
 
vtkTimeStamp MTime
 
vtkSubjectHelper * SubjectHelper
 
- Protected Attributes inherited from vtkObjectBase
vtkAtomicInt32 ReferenceCount
 
vtkWeakPointerBase ** WeakPointers
 

Additional Inherited Members

- Public Attributes inherited from vtkAlgorithm
vtkTypeBool AbortExecute
 
- Static Protected Member Functions inherited from vtkAlgorithm
static vtkInformationIntegerKeyPORT_REQUIREMENTS_FILLED ()
 
- Static Protected Attributes inherited from vtkAlgorithm
static vtkExecutiveDefaultExecutivePrototype
 

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
Examples:
vtkMapper (Examples)
Tests:
vtkMapper (Tests)

Definition at line 83 of file vtkMapper.h.

Member Typedef Documentation

Definition at line 86 of file vtkMapper.h.

Constructor & Destructor Documentation

vtkMapper::vtkMapper ( )
protected
vtkMapper::~vtkMapper ( )
overrideprotected

Member Function Documentation

static int vtkMapper::IsTypeOf ( const char *  type)
static
virtual int vtkMapper::IsA ( const char *  name)
virtual
static vtkMapper* vtkMapper::SafeDownCast ( vtkObjectBase o)
static
virtual vtkObjectBase* vtkMapper::NewInstanceInternal ( ) const
protectedvirtual
vtkMapper* vtkMapper::NewInstance ( ) const
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 vtkSurfaceLICMapper, vtkOpenGLPolyDataMapper, vtkCompositePolyDataMapper2, vtkPolyDataMapper, vtkCompositeSurfaceLICMapper, vtkOpenGLGlyph3DMapper, vtkPointGaussianMapper, vtkOpenGLGlyph3DHelper, vtkOpenGLLabeledContourMapper, vtkOpenGLPointGaussianMapper, vtkOpenGLSphereMapper, and vtkOpenGLStickMapper.

void vtkMapper::ShallowCopy ( vtkAbstractMapper m)

Make a shallow copy of this mapper.

vtkMTimeType vtkMapper::GetMTime ( )
overridevirtual

Overload standard modified time function.

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

Reimplemented from vtkAbstractMapper.

virtual void vtkMapper::Render ( vtkRenderer ren,
vtkActor a 
)
pure virtual
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, vtkOpenGLPolyDataMapper, vtkSurfaceLICMapper, vtkOpenGLGlyph3DHelper, vtkOpenGLGlyph3DMapper, vtkOpenGLLabeledContourMapper, and vtkOpenGLPointGaussianMapper.

Definition at line 111 of file vtkMapper.h.

void vtkMapper::SetLookupTable ( vtkScalarsToColors lut)

Specify a lookup table for the mapper to use.

vtkScalarsToColors* vtkMapper::GetLookupTable ( )

Specify a lookup table for the mapper to use.

virtual void vtkMapper::CreateDefaultLookupTable ( )
virtual

Create default lookup table.

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

virtual void vtkMapper::SetScalarVisibility ( vtkTypeBool  )
virtual

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

virtual vtkTypeBool vtkMapper::GetScalarVisibility ( )
virtual

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

virtual void vtkMapper::ScalarVisibilityOn ( )
virtual

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

virtual void vtkMapper::ScalarVisibilityOff ( )
virtual

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

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.

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.

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.

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.

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

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

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 163 of file vtkMapper.h.

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 165 of file vtkMapper.h.

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 167 of file vtkMapper.h.

const char* vtkMapper::GetColorModeAsString ( )

Return the method of coloring scalar data.

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.

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.

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.

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.

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.

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.

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.

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.

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.

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.

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.

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.

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.

virtual int vtkMapper::GetScalarMode ( )
virtual
void vtkMapper::SetScalarModeToDefault ( )
inline

Definition at line 239 of file vtkMapper.h.

void vtkMapper::SetScalarModeToUsePointData ( )
inline

Definition at line 241 of file vtkMapper.h.

void vtkMapper::SetScalarModeToUseCellData ( )
inline

Definition at line 243 of file vtkMapper.h.

void vtkMapper::SetScalarModeToUsePointFieldData ( )
inline

Definition at line 245 of file vtkMapper.h.

void vtkMapper::SetScalarModeToUseCellFieldData ( )
inline

Definition at line 247 of file vtkMapper.h.

void vtkMapper::SetScalarModeToUseFieldData ( )
inline

Definition at line 249 of file vtkMapper.h.

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.

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.

virtual void vtkMapper::SetFieldDataTupleId ( vtkIdType  )
virtual
virtual vtkIdType vtkMapper::GetFieldDataTupleId ( )
virtual
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.

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.

virtual char* vtkMapper::GetArrayName ( )
virtual

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

virtual void vtkMapper::SetArrayName ( const char *  )
virtual
virtual int vtkMapper::GetArrayId ( )
virtual
virtual void vtkMapper::SetArrayId ( int  )
virtual
virtual int vtkMapper::GetArrayAccessMode ( )
virtual
virtual void vtkMapper::SetArrayAccessMode ( int  )
virtual
virtual int vtkMapper::GetArrayComponent ( )
virtual
virtual void vtkMapper::SetArrayComponent ( int  )
virtual
const char* vtkMapper::GetScalarModeAsString ( )

Return the method for obtaining scalar data.

static void vtkMapper::SetResolveCoincidentTopology ( int  val)
static

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

If not off, there are two methods to choose from. PolygonOffset uses graphics systems calls to shift polygons, lines and points from each other. ShiftZBuffer is a legacy method that used to remap the z-buffer to distinguish vertices, lines, and polygons, but does not always produce acceptable results. You should only use the PolygonOffset method (or none) at this point.

static int vtkMapper::GetResolveCoincidentTopology ( )
static

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

If not off, there are two methods to choose from. PolygonOffset uses graphics systems calls to shift polygons, lines and points from each other. ShiftZBuffer is a legacy method that used to remap the z-buffer to distinguish vertices, lines, and polygons, but does not always produce acceptable results. You should only use the PolygonOffset method (or none) at this point.

static void vtkMapper::SetResolveCoincidentTopologyToDefault ( )
static

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

If not off, there are two methods to choose from. PolygonOffset uses graphics systems calls to shift polygons, lines and points from each other. ShiftZBuffer is a legacy method that used to remap the z-buffer to distinguish vertices, lines, and polygons, but does not always produce acceptable results. You should only use the PolygonOffset method (or none) at this point.

static void vtkMapper::SetResolveCoincidentTopologyToOff ( )
inlinestatic

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

If not off, there are two methods to choose from. PolygonOffset uses graphics systems calls to shift polygons, lines and points from each other. ShiftZBuffer is a legacy method that used to remap the z-buffer to distinguish vertices, lines, and polygons, but does not always produce acceptable results. You should only use the PolygonOffset method (or none) at this point.

Definition at line 313 of file vtkMapper.h.

static void vtkMapper::SetResolveCoincidentTopologyToPolygonOffset ( )
inlinestatic

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

If not off, there are two methods to choose from. PolygonOffset uses graphics systems calls to shift polygons, lines and points from each other. ShiftZBuffer is a legacy method that used to remap the z-buffer to distinguish vertices, lines, and polygons, but does not always produce acceptable results. You should only use the PolygonOffset method (or none) at this point.

Definition at line 315 of file vtkMapper.h.

static void vtkMapper::SetResolveCoincidentTopologyToShiftZBuffer ( )
inlinestatic

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

If not off, there are two methods to choose from. PolygonOffset uses graphics systems calls to shift polygons, lines and points from each other. ShiftZBuffer is a legacy method that used to remap the z-buffer to distinguish vertices, lines, and polygons, but does not always produce acceptable results. You should only use the PolygonOffset method (or none) at this point.

Definition at line 317 of file vtkMapper.h.

static void vtkMapper::SetResolveCoincidentTopologyPolygonOffsetParameters ( double  factor,
double  units 
)
static

Used to set the polygon offset scale factor and units.

Used when ResolveCoincidentTopology is set to PolygonOffset. These are global variables.

static void vtkMapper::GetResolveCoincidentTopologyPolygonOffsetParameters ( double factor,
double units 
)
static

Used to set the polygon offset scale factor and units.

Used when ResolveCoincidentTopology is set to PolygonOffset. These are global variables.

void vtkMapper::SetRelativeCoincidentTopologyPolygonOffsetParameters ( double  factor,
double  units 
)

Used to set the polygon offset values relative to the global Used when ResolveCoincidentTopology is set to PolygonOffset.

void vtkMapper::GetRelativeCoincidentTopologyPolygonOffsetParameters ( double factor,
double units 
)

Used to set the polygon offset values relative to the global Used when ResolveCoincidentTopology is set to PolygonOffset.

static void vtkMapper::SetResolveCoincidentTopologyLineOffsetParameters ( double  factor,
double  units 
)
static

Used to set the line offset scale factor and units.

Used when ResolveCoincidentTopology is set to PolygonOffset. These are global variables.

static void vtkMapper::GetResolveCoincidentTopologyLineOffsetParameters ( double factor,
double units 
)
static

Used to set the line offset scale factor and units.

Used when ResolveCoincidentTopology is set to PolygonOffset. These are global variables.

void vtkMapper::SetRelativeCoincidentTopologyLineOffsetParameters ( double  factor,
double  units 
)

Used to set the line offset values relative to the global Used when ResolveCoincidentTopology is set to PolygonOffset.

void vtkMapper::GetRelativeCoincidentTopologyLineOffsetParameters ( double factor,
double units 
)

Used to set the line offset values relative to the global Used when ResolveCoincidentTopology is set to PolygonOffset.

static void vtkMapper::SetResolveCoincidentTopologyPointOffsetParameter ( double  units)
static

Used to set the point offset value Used when ResolveCoincidentTopology is set to PolygonOffset.

These are global variables.

static void vtkMapper::GetResolveCoincidentTopologyPointOffsetParameter ( double units)
static

Used to set the point offset value Used when ResolveCoincidentTopology is set to PolygonOffset.

These are global variables.

void vtkMapper::SetRelativeCoincidentTopologyPointOffsetParameter ( double  units)

Used to set the point offset value relative to the global Used when ResolveCoincidentTopology is set to PolygonOffset.

void vtkMapper::GetRelativeCoincidentTopologyPointOffsetParameter ( double units)

Used to set the point offset value relative to the global Used when ResolveCoincidentTopology is set to PolygonOffset.

void vtkMapper::GetCoincidentTopologyPolygonOffsetParameters ( double factor,
double units 
)

Get the net parameters for handling coincident topology obtained by summing the global values with the relative values.

void vtkMapper::GetCoincidentTopologyLineOffsetParameters ( double factor,
double units 
)

Get the net parameters for handling coincident topology obtained by summing the global values with the relative values.

void vtkMapper::GetCoincidentTopologyPointOffsetParameter ( double units)

Get the net parameters for handling coincident topology obtained by summing the global values with the relative values.

static void vtkMapper::SetResolveCoincidentTopologyPolygonOffsetFaces ( int  faces)
static

Used when ResolveCoincidentTopology is set to PolygonOffset.

The polygon offset can be applied either to the solid polygonal faces or the lines/vertices. When set (default), the offset is applied to the faces otherwise it is applied to lines and vertices. This is a global variable.

static int vtkMapper::GetResolveCoincidentTopologyPolygonOffsetFaces ( )
static

Used when ResolveCoincidentTopology is set to PolygonOffset.

The polygon offset can be applied either to the solid polygonal faces or the lines/vertices. When set (default), the offset is applied to the faces otherwise it is applied to lines and vertices. This is a global variable.

static void vtkMapper::SetResolveCoincidentTopologyZShift ( double  val)
static

Used to set the z-shift if ResolveCoincidentTopology is set to ShiftZBuffer.

This is a global variable.

static double vtkMapper::GetResolveCoincidentTopologyZShift ( )
static

Used to set the z-shift if ResolveCoincidentTopology is set to ShiftZBuffer.

This is a global variable.

double* vtkMapper::GetBounds ( )
overridevirtual

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

Implements vtkAbstractMapper3D.

Reimplemented in vtkPolyDataMapper.

void vtkMapper::GetBounds ( double  bounds[6])
inlineoverridevirtual

Get the bounds for this mapper as (Xmin,Xmax,Ymin,Ymax,Zmin,Zmax).

Reimplemented from vtkAbstractMapper3D.

Reimplemented in vtkPolyDataMapper.

Definition at line 426 of file vtkMapper.h.

void vtkMapper::SetRenderTime ( double  time)
inline

This instance variable is used by vtkLODActor to determine which mapper to use.

It is an estimate of the time necessary to render. Setting the render time does not modify the mapper.

Definition at line 434 of file vtkMapper.h.

virtual double vtkMapper::GetRenderTime ( )
virtual
vtkDataSet* vtkMapper::GetInput ( )

Get the input as a vtkDataSet.

This method is overridden in the specialized mapper classes to return more specific data types.

vtkDataSet* vtkMapper::GetInputAsDataSet ( )
inline

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

This method is provided for use in the wrapper languages, C++ programmers should use GetInput() instead.

Definition at line 449 of file vtkMapper.h.

virtual vtkUnsignedCharArray* vtkMapper::MapScalars ( double  alpha)
virtual

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

virtual vtkUnsignedCharArray* vtkMapper::MapScalars ( double  alpha,
int cellFlag 
)
virtual

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

virtual vtkUnsignedCharArray* vtkMapper::MapScalars ( vtkDataSet input,
double  alpha 
)
virtual

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

virtual vtkUnsignedCharArray* vtkMapper::MapScalars ( vtkDataSet input,
double  alpha,
int cellFlag 
)
virtual

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

virtual bool vtkMapper::GetIsOpaque ( )
virtual

Returns if the mapper does not expect to have translucent geometry.

This may happen when using ColorMode is set to not map scalars i.e. render the scalar array directly as colors and the scalar array has opacity i.e. alpha component. Default implementation simply returns true. Note that even if this method returns true, an actor may treat the geometry as translucent since a constant translucency is set on the property, for example.

Reimplemented in vtkOpenGLPolyDataMapper, vtkCompositePolyDataMapper2, and vtkOpenGLPointGaussianMapper.

virtual bool vtkMapper::GetSupportsSelection ( )
inlinevirtual

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.

Reimplemented in vtkGlyph3DMapper, vtkMoleculeMapper, vtkPointGaussianMapper, and vtkOpenGLPolyDataMapper.

Definition at line 486 of file vtkMapper.h.

virtual int vtkMapper::CanUseTextureMapForColoring ( vtkDataObject input)
virtual

Returns if we can use texture maps for scalar coloring.

Note this doesn't say we "will" use scalar coloring. It says, if we do use scalar coloring, we will use a texture. When rendering multiblock datasets, if any 2 blocks provide different lookup tables for the scalars, then also we cannot use textures. This case can be handled if required.

Reimplemented in vtkCompositeMapperHelper2.

void vtkMapper::ClearColorArrays ( )

Call to force a rebuild of color result arrays on next MapScalars.

Necessary when using arrays in the case of multiblock data.

vtkUnsignedCharArray* vtkMapper::GetColorMapColors ( )

Provide read access to the color array.

vtkFloatArray* vtkMapper::GetColorCoordinates ( )

Provide read access to the color texture coordinate array.

vtkImageData* vtkMapper::GetColorTextureMap ( )

Provide read access to the color texture array.

void vtkMapper::MapScalarsToTexture ( vtkAbstractArray scalars,
double  alpha 
)
protected

Member Data Documentation

vtkUnsignedCharArray* vtkMapper::Colors
protected

Definition at line 525 of file vtkMapper.h.

vtkTypeBool vtkMapper::InterpolateScalarsBeforeMapping
protected

Definition at line 528 of file vtkMapper.h.

vtkFloatArray* vtkMapper::ColorCoordinates
protected

Definition at line 530 of file vtkMapper.h.

vtkImageData* vtkMapper::ColorTextureMap
protected

Definition at line 532 of file vtkMapper.h.

vtkScalarsToColors* vtkMapper::LookupTable
protected

Definition at line 535 of file vtkMapper.h.

vtkTypeBool vtkMapper::ScalarVisibility
protected

Definition at line 536 of file vtkMapper.h.

vtkTimeStamp vtkMapper::BuildTime
protected

Definition at line 537 of file vtkMapper.h.

double vtkMapper::ScalarRange[2]
protected

Definition at line 538 of file vtkMapper.h.

vtkTypeBool vtkMapper::UseLookupTableScalarRange
protected

Definition at line 539 of file vtkMapper.h.

int vtkMapper::ColorMode
protected

Definition at line 541 of file vtkMapper.h.

int vtkMapper::ScalarMode
protected

Definition at line 542 of file vtkMapper.h.

double vtkMapper::RenderTime
protected

Definition at line 544 of file vtkMapper.h.

int vtkMapper::ArrayId
protected

Definition at line 547 of file vtkMapper.h.

char* vtkMapper::ArrayName
protected

Definition at line 548 of file vtkMapper.h.

int vtkMapper::ArrayComponent
protected

Definition at line 549 of file vtkMapper.h.

int vtkMapper::ArrayAccessMode
protected

Definition at line 550 of file vtkMapper.h.

vtkIdType vtkMapper::FieldDataTupleId
protected

Definition at line 554 of file vtkMapper.h.

vtkTypeBool vtkMapper::Static
protected

Definition at line 556 of file vtkMapper.h.

double vtkMapper::CoincidentPolygonFactor
protected

Definition at line 558 of file vtkMapper.h.

double vtkMapper::CoincidentPolygonOffset
protected

Definition at line 559 of file vtkMapper.h.

double vtkMapper::CoincidentLineFactor
protected

Definition at line 560 of file vtkMapper.h.

double vtkMapper::CoincidentLineOffset
protected

Definition at line 561 of file vtkMapper.h.

double vtkMapper::CoincidentPointOffset
protected

Definition at line 562 of file vtkMapper.h.


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