VTK
Public Types | Public Member Functions | Static Public Member Functions | Protected Member Functions | Protected Attributes | Static 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)
 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 ()
 Overload standard modified time function. More...
 
virtual void Render (vtkRenderer *ren, vtkActor *a)=0
 Method initiates the mapping process. More...
 
virtual void ReleaseGraphicsResources (vtkWindow *)
 Release any graphics resources that are being consumed by this mapper. More...
 
void SetLookupTable (vtkScalarsToColors *lut)
 Specify a lookup table for the mapper to use. More...
 
vtkScalarsToColorsGetLookupTable ()
 
virtual void CreateDefaultLookupTable ()
 Create default lookup table. More...
 
virtual void SetScalarVisibility (int)
 Turn on/off flag to control whether scalar data is used to color objects. More...
 
virtual int GetScalarVisibility ()
 
virtual void ScalarVisibilityOn ()
 
virtual void ScalarVisibilityOff ()
 
virtual void SetStatic (int)
 Turn on/off flag to control whether the mapper's data is static. More...
 
virtual int GetStatic ()
 
virtual void StaticOn ()
 
virtual void StaticOff ()
 
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 ()
 
void SetColorModeToDefault ()
 
void SetColorModeToMapScalars ()
 
void SetColorModeToDirectScalars ()
 
const char * GetColorModeAsString ()
 Return the method of coloring scalar data. More...
 
virtual void SetInterpolateScalarsBeforeMapping (int)
 By default, vertex color is used to map colors to a surface. More...
 
virtual int GetInterpolateScalarsBeforeMapping ()
 
virtual void InterpolateScalarsBeforeMappingOn ()
 
virtual void InterpolateScalarsBeforeMappingOff ()
 
virtual void SetUseLookupTableScalarRange (int)
 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 int GetUseLookupTableScalarRange ()
 
virtual void UseLookupTableScalarRangeOn ()
 
virtual void UseLookupTableScalarRangeOff ()
 
virtual void SetScalarRange (double, double)
 Specify range in terms of scalar minimum and maximum (smin,smax). More...
 
void SetScalarRange (double[2])
 
virtual doubleGetScalarRange ()
 
virtual void GetScalarRange (double data[2])
 
virtual void SetImmediateModeRendering (int)
 Turn on/off flag to control whether data is rendered using immediate mode or note. More...
 
virtual int GetImmediateModeRendering ()
 
virtual void ImmediateModeRenderingOn ()
 
virtual void ImmediateModeRenderingOff ()
 
virtual int GetForceCompileOnly ()
 Force compile only mode in case display lists are used (ImmediateModeRendering is false). More...
 
void SetForceCompileOnly (int value)
 
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 ()
 
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)
 
virtual void SetFieldDataTupleId (vtkIdType)
 
virtual vtkIdType GetFieldDataTupleId ()
 
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)
 
char * GetArrayName ()
 Get the array name or number and component to color by. More...
 
int GetArrayId ()
 
int GetArrayAccessMode ()
 
int GetArrayComponent ()
 
const char * GetScalarModeAsString ()
 Return the method for obtaining scalar data. 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)
 
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)
 
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)
 
void GetCoincidentTopologyPolygonOffsetParameters (double &factor, double &units)
 Get the net paramters for handlig coincident topology obtained by summing the global values with the relative values. More...
 
void GetCoincidentTopologyLineOffsetParameters (double &factor, double &units)
 
void GetCoincidentTopologyPointOffsetParameter (double &units)
 
virtual doubleGetBounds ()
 Return bounding box (array of six doubles) of data expressed as (xmin,xmax, ymin,ymax, zmin,zmax). More...
 
virtual void GetBounds (double bounds[6])
 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 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)
 
virtual vtkUnsignedCharArrayMapScalars (vtkDataSet *input, double alpha)
 
virtual vtkUnsignedCharArrayMapScalars (vtkDataSet *input, double alpha, int &cellFlag)
 
virtual void SetScalarMaterialMode (int)
 Set/Get the light-model color mode. More...
 
virtual int GetScalarMaterialMode ()
 
void SetScalarMaterialModeToDefault ()
 
void SetScalarMaterialModeToAmbient ()
 
void SetScalarMaterialModeToDiffuse ()
 
void SetScalarMaterialModeToAmbientAndDiffuse ()
 
const char * GetScalarMaterialModeAsString ()
 Return the light-model color mode. 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 UseInvertibleColorFor (vtkDataObject *input, int scalarMode, int arrayAccessMode, int arrayId, const char *arrayName, int arrayComponent, double *scalarRange)
 Used internally by vtkValuePass. More...
 
void UseInvertibleColorFor (int scalarMode, int arrayAccessMode, int arrayId, const char *arrayName, int arrayComponent, double *scalarRange)
 
void ClearInvertibleColor ()
 Used internally by vtkValuePass. 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...
 
- Public Member Functions inherited from vtkAbstractMapper3D
vtkAbstractMapper3DNewInstance () const
 
doubleGetCenter ()
 Return the Center of this mapper's data. More...
 
void GetCenter (double center[3])
 
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...
 
int GetNumberOfClippingPlanes ()
 Get the number of clipping planes. More...
 
- Public Member Functions inherited from vtkAbstractMapper
vtkAbstractMapperNewInstance () const
 
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)
 
void RemoveAllClippingPlanes ()
 
virtual void SetClippingPlanes (vtkPlaneCollection *)
 Get/Set the vtkPlaneCollection which specifies the clipping planes. More...
 
virtual vtkPlaneCollectionGetClippingPlanes ()
 
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...
 
- 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...
 
virtual vtkInformationGetInformation ()
 Set/Get the information object associated with this algorithm. More...
 
virtual void SetInformation (vtkInformation *)
 
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 Register (vtkObjectBase *o) override
 Participate in garbage collection. More...
 
void UnRegister (vtkObjectBase *o) override
 Decrease the reference count (release by another object). More...
 
virtual void SetAbortExecute (int)
 Set/Get the AbortExecute flag for the process object. More...
 
virtual int GetAbortExecute ()
 
virtual void AbortExecuteOn ()
 
virtual void AbortExecuteOff ()
 
virtual void SetProgress (double)
 Set/Get the execution progress of a process object. More...
 
virtual double GetProgress ()
 
void UpdateProgress (double amount)
 Update the progress of the process object. More...
 
void SetProgressText (const char *ptext)
 Set the current text message associated with the progress state. More...
 
virtual char * GetProgressText ()
 
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)
 
virtual void SetInputArrayToProcess (int idx, vtkInformation *info)
 
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 SetInputConnection (int port, vtkAlgorithmOutput *input)
 Set the connection for the given input port index. More...
 
virtual void SetInputConnection (vtkAlgorithmOutput *input)
 
virtual void AddInputConnection (int port, vtkAlgorithmOutput *input)
 Add a connection to the given input port index. More...
 
virtual void AddInputConnection (vtkAlgorithmOutput *input)
 
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 void Update (int port)
 Bring this algorithm's outputs up-to-date. More...
 
virtual void Update ()
 
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]=0)
 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]=0)
 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 void SetReleaseDataFlag (int)
 Turn release data flag on or off for all output ports. More...
 
virtual int GetReleaseDataFlag ()
 
void ReleaseDataFlagOn ()
 
void ReleaseDataFlagOff ()
 
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)
 
int SetUpdateExtentToWholeExtent (int port)
 If the whole output extent is required, this method can be called to set the output update extent to the whole extent. More...
 
int SetUpdateExtentToWholeExtent ()
 Convenience function equivalent to SetUpdateExtentToWholeExtent(0) This method assumes that the whole extent is known (that UpdateInformation has been called). More...
 
void SetUpdateExtent (int port, int piece, int numPieces, int ghostLevel)
 Set the output update extent in terms of piece and ghost levels. More...
 
void SetUpdateExtent (int piece, int numPieces, int ghostLevel)
 Convenience function equivalent to SetUpdateExtent(0, piece, numPieces, ghostLevel) More...
 
void SetUpdateExtent (int port, int extent[6])
 Set the output update extent for data objects that use 3D extents. More...
 
void SetUpdateExtent (int extent[6])
 Convenience function equivalent to SetUpdateExtent(0, extent) More...
 
intGetUpdateExtent ()
 These functions return the update extent for output ports that use 3D extents. More...
 
intGetUpdateExtent (int port)
 
void GetUpdateExtent (int &x0, int &x1, int &y0, int &y1, int &z0, int &z1)
 
void GetUpdateExtent (int port, int &x0, int &x1, int &y0, int &y1, int &z0, int &z1)
 
void GetUpdateExtent (int extent[6])
 
void GetUpdateExtent (int port, int extent[6])
 
int GetUpdatePiece ()
 These functions return the update extent for output ports that use piece extents. More...
 
int GetUpdatePiece (int port)
 
int GetUpdateNumberOfPieces ()
 
int GetUpdateNumberOfPieces (int port)
 
int GetUpdateGhostLevel ()
 
int GetUpdateGhostLevel (int port)
 
void SetProgressObserver (vtkProgressObserver *)
 If an ProgressObserver is set, the algorithm will report progress through it rather than directly. More...
 
virtual vtkProgressObserverGetProgressObserver ()
 
- 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...
 
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)
 
vtkCommandGetCommand (unsigned long tag)
 
void RemoveObserver (vtkCommand *)
 
void RemoveObservers (unsigned long event, vtkCommand *)
 
void RemoveObservers (const char *event, vtkCommand *)
 
int HasObserver (unsigned long event, vtkCommand *)
 
int HasObserver (const char *event, vtkCommand *)
 
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)
 
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)
 
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)
 
int InvokeEvent (unsigned long event)
 
int InvokeEvent (const char *event)
 
- 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...
 
virtual void PrintHeader (ostream &os, vtkIndent indent)
 
virtual void PrintTrailer (ostream &os, vtkIndent indent)
 
int GetReferenceCount ()
 Return the current reference count of this object. More...
 
void SetReferenceCount (int)
 Sets the reference count. More...
 
void PrintRevisions (ostream &)
 Legacy. More...
 

Static Public Member Functions

static int IsTypeOf (const char *type)
 
static vtkMapperSafeDownCast (vtkObjectBase *o)
 
static void SetGlobalImmediateModeRendering (int val)
 Turn on/off flag to control whether data is rendered using immediate mode or note. More...
 
static void GlobalImmediateModeRenderingOn ()
 
static void GlobalImmediateModeRenderingOff ()
 
static int GetGlobalImmediateModeRendering ()
 
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 ()
 
static void SetResolveCoincidentTopologyToDefault ()
 
static void SetResolveCoincidentTopologyToOff ()
 
static void SetResolveCoincidentTopologyToPolygonOffset ()
 
static void SetResolveCoincidentTopologyToShiftZBuffer ()
 
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)
 
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)
 
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)
 
static void SetResolveCoincidentTopologyPolygonOffsetFaces (int faces)
 Used when ResolveCoincidentTopology is set to PolygonOffset. More...
 
static int GetResolveCoincidentTopologyPolygonOffsetFaces ()
 
static void SetResolveCoincidentTopologyZShift (double val)
 Used to set the z-shift if ResolveCoincidentTopology is set to ShiftZBuffer. More...
 
static double GetResolveCoincidentTopologyZShift ()
 
static void ValueToColor (double value, double min, double scale, unsigned char *color)
 Convert a floating point value to an RGB triplet. More...
 
static void ColorToValue (unsigned char *color, double min, double scale, double &value)
 Convert an RGB triplet to a floating point value. 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 ()
 
static void GlobalWarningDisplayOff ()
 
static int GetGlobalWarningDisplay ()
 
- 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 ()
 
void MapScalarsToTexture (vtkAbstractArray *scalars, double alpha)
 
void AcquireInvertibleLookupTable ()
 
- Protected Member Functions inherited from vtkAbstractMapper3D
 vtkAbstractMapper3D ()
 
 ~vtkAbstractMapper3D ()
 
- Protected Member Functions inherited from vtkAbstractMapper
 vtkAbstractMapper ()
 
 ~vtkAbstractMapper ()
 
- 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...
 
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)
 
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)
 
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)
 
vtkDataArrayGetInputArrayToProcess (int idx, vtkDataObject *input)
 
vtkDataArrayGetInputArrayToProcess (int idx, vtkDataObject *input, int &association)
 
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)
 
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)
 
vtkAbstractArrayGetInputAbstractArrayToProcess (int idx, vtkDataObject *input)
 
vtkAbstractArrayGetInputAbstractArrayToProcess (int idx, vtkDataObject *input, int &association)
 
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...
 
virtual void SetErrorCode (unsigned long)
 The error code contains a possible error that occurred while reading or writing the file. 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)
 
- 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=NULL)
 These methods allow a command to exclusively grab all events. More...
 
void InternalReleaseFocus ()
 
- Protected Member Functions inherited from vtkObjectBase
 vtkObjectBase ()
 
virtual ~vtkObjectBase ()
 
virtual void CollectRevisions (ostream &)
 
 vtkObjectBase (const vtkObjectBase &)
 
void operator= (const vtkObjectBase &)
 

Protected Attributes

vtkUnsignedCharArrayColors
 
int InterpolateScalarsBeforeMapping
 
vtkFloatArrayColorCoordinates
 
vtkImageDataColorTextureMap
 
bool UseInvertibleColors
 
vtkScalarsToColorsLookupTable
 
int ScalarVisibility
 
vtkTimeStamp BuildTime
 
double ScalarRange [2]
 
int UseLookupTableScalarRange
 
int ImmediateModeRendering
 
int ColorMode
 
int ScalarMode
 
int ScalarMaterialMode
 
double RenderTime
 
int ArrayId
 
char ArrayName [256]
 
int ArrayComponent
 
int ArrayAccessMode
 
vtkIdType FieldDataTupleId
 
int Static
 
int ForceCompileOnly
 
vtkAbstractArrayInvertibleScalars
 
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
 
unsigned long ErrorCode
 
double Progress
 
char * ProgressText
 
vtkProgressObserverProgressObserver
 
- Protected Attributes inherited from vtkObject
bool Debug
 
vtkTimeStamp MTime
 
vtkSubjectHelper * SubjectHelper
 
- Protected Attributes inherited from vtkObjectBase
vtkAtomicInt32 ReferenceCount
 
vtkWeakPointerBase ** WeakPointers
 

Static Protected Attributes

static vtkScalarsToColorsInvertibleLookupTable
 
- Static Protected Attributes inherited from vtkAlgorithm
static vtkExecutiveDefaultExecutivePrototype
 

Additional Inherited Members

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

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 this class is whether to use immediate mode rendering (ImmediateModeRenderingOn) or display list rendering (ImmediateModeRenderingOff). If display lists are used, a data structure is constructed (generally in the rendering library) which can then be rapidly traversed and rendered by the rendering library. The disadvantage of display lists is that they require additionally memory which may affect the performance of the system.

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

Member Typedef Documentation

◆ Superclass

Definition at line 94 of file vtkMapper.h.

Constructor & Destructor Documentation

◆ vtkMapper()

vtkMapper::vtkMapper ( )
protected

◆ ~vtkMapper()

vtkMapper::~vtkMapper ( )
protected

Member Function Documentation

◆ IsTypeOf()

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

◆ IsA()

virtual int vtkMapper::IsA ( const char *  name)
virtual

◆ 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 
)
virtual

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 vtkOpenGLPolyDataMapper, vtkSurfaceLICMapper, vtkOpenGLPolyDataMapper, vtkCompositeSurfaceLICMapper, vtkCompositePolyDataMapper2, vtkPolyDataMapper, vtkOpenGLGlyph3DMapper, vtkOpenGLGlyph3DMapper, vtkPointGaussianMapper, vtkPainterPolyDataMapper, vtkCompositePolyDataMapper2, vtkOpenGLLabeledContourMapper, vtkOpenGLPointGaussianMapper, vtkOpenGLGlyph3DHelper, vtkOpenGLSphereMapper, and vtkOpenGLStickMapper.

◆ ShallowCopy()

void vtkMapper::ShallowCopy ( vtkAbstractMapper m)

Make a shallow copy of this mapper.

◆ GetMTime()

vtkMTimeType vtkMapper::GetMTime ( )
virtual

Overload standard modified time function.

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

Reimplemented from vtkAbstractMapper.

◆ Render()

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

◆ ReleaseGraphicsResources()

virtual void vtkMapper::ReleaseGraphicsResources ( vtkWindow )
inlinevirtual

◆ SetLookupTable()

void vtkMapper::SetLookupTable ( vtkScalarsToColors lut)

Specify a lookup table for the mapper to use.

◆ GetLookupTable()

vtkScalarsToColors* vtkMapper::GetLookupTable ( )

◆ 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 ( int  )
virtual

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

◆ GetScalarVisibility()

virtual int vtkMapper::GetScalarVisibility ( )
virtual

◆ ScalarVisibilityOn()

virtual void vtkMapper::ScalarVisibilityOn ( )
virtual

◆ ScalarVisibilityOff()

virtual void vtkMapper::ScalarVisibilityOff ( )
virtual

◆ SetStatic()

virtual void vtkMapper::SetStatic ( int  )
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 int vtkMapper::GetStatic ( )
virtual

◆ StaticOn()

virtual void vtkMapper::StaticOn ( )
virtual

◆ StaticOff()

virtual void vtkMapper::StaticOff ( )
virtual

◆ 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

◆ SetColorModeToDefault()

void vtkMapper::SetColorModeToDefault ( )
inline

Definition at line 171 of file vtkMapper.h.

◆ SetColorModeToMapScalars()

void vtkMapper::SetColorModeToMapScalars ( )
inline

Definition at line 173 of file vtkMapper.h.

◆ SetColorModeToDirectScalars()

void vtkMapper::SetColorModeToDirectScalars ( )
inline

Definition at line 175 of file vtkMapper.h.

◆ GetColorModeAsString()

const char* vtkMapper::GetColorModeAsString ( )

Return the method of coloring scalar data.

◆ SetInterpolateScalarsBeforeMapping()

virtual void vtkMapper::SetInterpolateScalarsBeforeMapping ( int  )
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 int vtkMapper::GetInterpolateScalarsBeforeMapping ( )
virtual

◆ InterpolateScalarsBeforeMappingOn()

virtual void vtkMapper::InterpolateScalarsBeforeMappingOn ( )
virtual

◆ InterpolateScalarsBeforeMappingOff()

virtual void vtkMapper::InterpolateScalarsBeforeMappingOff ( )
virtual

◆ SetUseLookupTableScalarRange()

virtual void vtkMapper::SetUseLookupTableScalarRange ( int  )
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 int vtkMapper::GetUseLookupTableScalarRange ( )
virtual

◆ UseLookupTableScalarRangeOn()

virtual void vtkMapper::UseLookupTableScalarRangeOn ( )
virtual

◆ UseLookupTableScalarRangeOff()

virtual void vtkMapper::UseLookupTableScalarRangeOff ( )
virtual

◆ 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])

◆ GetScalarRange() [1/2]

virtual double* vtkMapper::GetScalarRange ( )
virtual

◆ GetScalarRange() [2/2]

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

◆ SetImmediateModeRendering()

virtual void vtkMapper::SetImmediateModeRendering ( int  )
virtual

Turn on/off flag to control whether data is rendered using immediate mode or note.

Immediate mode rendering tends to be slower but it can handle larger datasets. The default value is immediate mode off. If you are having problems rendering a large dataset you might want to consider using immediate more rendering.

◆ GetImmediateModeRendering()

virtual int vtkMapper::GetImmediateModeRendering ( )
virtual

◆ ImmediateModeRenderingOn()

virtual void vtkMapper::ImmediateModeRenderingOn ( )
virtual

◆ ImmediateModeRenderingOff()

virtual void vtkMapper::ImmediateModeRenderingOff ( )
virtual

◆ SetGlobalImmediateModeRendering()

static void vtkMapper::SetGlobalImmediateModeRendering ( int  val)
static

Turn on/off flag to control whether data is rendered using immediate mode or note.

Immediate mode rendering tends to be slower but it can handle larger datasets. The default value is immediate mode off. If you are having problems rendering a large dataset you might want to consider using immediate more rendering.

◆ GlobalImmediateModeRenderingOn()

static void vtkMapper::GlobalImmediateModeRenderingOn ( )
inlinestatic

Definition at line 244 of file vtkMapper.h.

◆ GlobalImmediateModeRenderingOff()

static void vtkMapper::GlobalImmediateModeRenderingOff ( )
inlinestatic

Definition at line 246 of file vtkMapper.h.

◆ GetGlobalImmediateModeRendering()

static int vtkMapper::GetGlobalImmediateModeRendering ( )
static

◆ GetForceCompileOnly()

virtual int vtkMapper::GetForceCompileOnly ( )
virtual

Force compile only mode in case display lists are used (ImmediateModeRendering is false).

If ImmediateModeRendering is true, no rendering happens. Changing the value of this flag does not change modified time of the mapper. Initial value is false. This can be used by another rendering class which also uses display lists (call of display lists can be nested but not their creation.) There is no good reason to expose it to wrappers.

◆ SetForceCompileOnly()

void vtkMapper::SetForceCompileOnly ( int  value)

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

◆ SetScalarModeToUsePointData()

void vtkMapper::SetScalarModeToUsePointData ( )
inline

Definition at line 294 of file vtkMapper.h.

◆ SetScalarModeToUseCellData()

void vtkMapper::SetScalarModeToUseCellData ( )
inline

Definition at line 296 of file vtkMapper.h.

◆ SetScalarModeToUsePointFieldData()

void vtkMapper::SetScalarModeToUsePointFieldData ( )
inline

Definition at line 298 of file vtkMapper.h.

◆ SetScalarModeToUseCellFieldData()

void vtkMapper::SetScalarModeToUseCellFieldData ( )
inline

Definition at line 300 of file vtkMapper.h.

◆ SetScalarModeToUseFieldData()

void vtkMapper::SetScalarModeToUseFieldData ( )
inline

Definition at line 302 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)

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

◆ GetArrayName()

char* vtkMapper::GetArrayName ( )
inline

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

Definition at line 338 of file vtkMapper.h.

◆ GetArrayId()

int vtkMapper::GetArrayId ( )
inline

Definition at line 339 of file vtkMapper.h.

◆ GetArrayAccessMode()

int vtkMapper::GetArrayAccessMode ( )
inline

Definition at line 340 of file vtkMapper.h.

◆ GetArrayComponent()

int vtkMapper::GetArrayComponent ( )
inline

Definition at line 341 of file vtkMapper.h.

◆ GetScalarModeAsString()

const char* vtkMapper::GetScalarModeAsString ( )

Return the method for obtaining scalar data.

◆ SetResolveCoincidentTopology()

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, but does not distinguish vertices and lines from one another. ShiftZBuffer remaps the z-buffer to distinguish vertices, lines, and polygons, but does not always produce acceptable results. If you use the ShiftZBuffer approach, you may also want to set the ResolveCoincidentTopologyZShift value. (Note: not all mappers/graphics systems implement this functionality.)

◆ GetResolveCoincidentTopology()

static int vtkMapper::GetResolveCoincidentTopology ( )
static

◆ SetResolveCoincidentTopologyToDefault()

static void vtkMapper::SetResolveCoincidentTopologyToDefault ( )
static

◆ SetResolveCoincidentTopologyToOff()

static void vtkMapper::SetResolveCoincidentTopologyToOff ( )
inlinestatic

Definition at line 364 of file vtkMapper.h.

◆ SetResolveCoincidentTopologyToPolygonOffset()

static void vtkMapper::SetResolveCoincidentTopologyToPolygonOffset ( )
inlinestatic

Definition at line 366 of file vtkMapper.h.

◆ SetResolveCoincidentTopologyToShiftZBuffer()

static void vtkMapper::SetResolveCoincidentTopologyToShiftZBuffer ( )
inlinestatic

Definition at line 368 of file vtkMapper.h.

◆ SetResolveCoincidentTopologyPolygonOffsetParameters()

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.

◆ GetResolveCoincidentTopologyPolygonOffsetParameters()

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

◆ SetRelativeCoincidentTopologyPolygonOffsetParameters()

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.

◆ GetRelativeCoincidentTopologyPolygonOffsetParameters()

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

◆ SetResolveCoincidentTopologyLineOffsetParameters()

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.

◆ GetResolveCoincidentTopologyLineOffsetParameters()

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

◆ SetRelativeCoincidentTopologyLineOffsetParameters()

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.

◆ GetRelativeCoincidentTopologyLineOffsetParameters()

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

◆ SetResolveCoincidentTopologyPointOffsetParameter()

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.

◆ GetResolveCoincidentTopologyPointOffsetParameter()

static void vtkMapper::GetResolveCoincidentTopologyPointOffsetParameter ( double units)
static

◆ SetRelativeCoincidentTopologyPointOffsetParameter()

void vtkMapper::SetRelativeCoincidentTopologyPointOffsetParameter ( double  units)

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

◆ GetRelativeCoincidentTopologyPointOffsetParameter()

void vtkMapper::GetRelativeCoincidentTopologyPointOffsetParameter ( double units)

◆ GetCoincidentTopologyPolygonOffsetParameters()

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

Get the net paramters for handlig coincident topology obtained by summing the global values with the relative values.

◆ GetCoincidentTopologyLineOffsetParameters()

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

◆ GetCoincidentTopologyPointOffsetParameter()

void vtkMapper::GetCoincidentTopologyPointOffsetParameter ( double units)

◆ SetResolveCoincidentTopologyPolygonOffsetFaces()

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.

◆ GetResolveCoincidentTopologyPolygonOffsetFaces()

static int vtkMapper::GetResolveCoincidentTopologyPolygonOffsetFaces ( )
static

◆ SetResolveCoincidentTopologyZShift()

static void vtkMapper::SetResolveCoincidentTopologyZShift ( double  val)
static

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

This is a global variable.

◆ GetResolveCoincidentTopologyZShift()

static double vtkMapper::GetResolveCoincidentTopologyZShift ( )
static

◆ GetBounds() [1/2]

virtual double* vtkMapper::GetBounds ( )
virtual

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

Implements vtkAbstractMapper3D.

Reimplemented in vtkMoleculeMapper, vtkGraphMapper, vtkGlyph3DMapper, vtkPolyDataMapper, vtkPistonMapper, vtkLabeledContourMapper, and vtkCompositePolyDataMapper.

◆ GetBounds() [2/2]

virtual void vtkMapper::GetBounds ( double  bounds[6])
inlinevirtual

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

Reimplemented from vtkAbstractMapper3D.

Reimplemented in vtkMoleculeMapper, vtkGlyph3DMapper, vtkPolyDataMapper, vtkPistonMapper, vtkLabeledContourMapper, and vtkCompositePolyDataMapper.

Definition at line 477 of file vtkMapper.h.

◆ SetRenderTime()

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

◆ GetRenderTime()

virtual double vtkMapper::GetRenderTime ( )
virtual

◆ GetInput()

vtkDataSet* vtkMapper::GetInput ( )

Get the input as a vtkDataSet.

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

◆ GetInputAsDataSet()

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

◆ MapScalars() [1/4]

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

◆ MapScalars() [2/4]

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

◆ MapScalars() [3/4]

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

◆ MapScalars() [4/4]

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

◆ SetScalarMaterialMode()

virtual void vtkMapper::SetScalarMaterialMode ( int  )
virtual

Set/Get the light-model color mode.

◆ GetScalarMaterialMode()

virtual int vtkMapper::GetScalarMaterialMode ( )
virtual

◆ SetScalarMaterialModeToDefault()

void vtkMapper::SetScalarMaterialModeToDefault ( )
inline

Definition at line 527 of file vtkMapper.h.

◆ SetScalarMaterialModeToAmbient()

void vtkMapper::SetScalarMaterialModeToAmbient ( )
inline

Definition at line 529 of file vtkMapper.h.

◆ SetScalarMaterialModeToDiffuse()

void vtkMapper::SetScalarMaterialModeToDiffuse ( )
inline

Definition at line 531 of file vtkMapper.h.

◆ SetScalarMaterialModeToAmbientAndDiffuse()

void vtkMapper::SetScalarMaterialModeToAmbientAndDiffuse ( )
inline

Definition at line 533 of file vtkMapper.h.

◆ GetScalarMaterialModeAsString()

const char* vtkMapper::GetScalarMaterialModeAsString ( )

Return the light-model color mode.

◆ GetIsOpaque()

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 vtkPainterPolyDataMapper, vtkOpenGLPolyDataMapper, vtkCompositeSurfaceLICMapper, vtkCompositePolyDataMapper2, vtkCompositePolyDataMapper2, and vtkOpenGLPointGaussianMapper.

◆ GetSupportsSelection()

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, vtkPainterPolyDataMapper, vtkPistonMapper, and vtkOpenGLPolyDataMapper.

Definition at line 558 of file vtkMapper.h.

◆ CanUseTextureMapForColoring()

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.

◆ UseInvertibleColorFor() [1/2]

void vtkMapper::UseInvertibleColorFor ( vtkDataObject input,
int  scalarMode,
int  arrayAccessMode,
int  arrayId,
const char *  arrayName,
int  arrayComponent,
double scalarRange 
)

Used internally by vtkValuePass.

◆ UseInvertibleColorFor() [2/2]

void vtkMapper::UseInvertibleColorFor ( int  scalarMode,
int  arrayAccessMode,
int  arrayId,
const char *  arrayName,
int  arrayComponent,
double scalarRange 
)

◆ ClearInvertibleColor()

void vtkMapper::ClearInvertibleColor ( )

Used internally by vtkValuePass.

◆ ValueToColor()

static void vtkMapper::ValueToColor ( double  value,
double  min,
double  scale,
unsigned char *  color 
)
static

Convert a floating point value to an RGB triplet.

◆ ColorToValue()

static void vtkMapper::ColorToValue ( unsigned char *  color,
double  min,
double  scale,
double value 
)
static

Convert an RGB triplet to a floating point value.

◆ ClearColorArrays()

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.

◆ GetColorMapColors()

vtkUnsignedCharArray* vtkMapper::GetColorMapColors ( )

Provide read access to the color array.

◆ GetColorCoordinates()

vtkFloatArray* vtkMapper::GetColorCoordinates ( )

Provide read access to the color texture coordinate array.

◆ GetColorTextureMap()

vtkImageData* vtkMapper::GetColorTextureMap ( )

Provide read access to the color texture array.

◆ MapScalarsToTexture()

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

◆ AcquireInvertibleLookupTable()

void vtkMapper::AcquireInvertibleLookupTable ( )
protected

Member Data Documentation

◆ Colors

vtkUnsignedCharArray* vtkMapper::Colors
protected

Definition at line 633 of file vtkMapper.h.

◆ InterpolateScalarsBeforeMapping

int vtkMapper::InterpolateScalarsBeforeMapping
protected

Definition at line 636 of file vtkMapper.h.

◆ ColorCoordinates

vtkFloatArray* vtkMapper::ColorCoordinates
protected

Definition at line 638 of file vtkMapper.h.

◆ ColorTextureMap

vtkImageData* vtkMapper::ColorTextureMap
protected

Definition at line 640 of file vtkMapper.h.

◆ UseInvertibleColors

bool vtkMapper::UseInvertibleColors
protected

Definition at line 645 of file vtkMapper.h.

◆ InvertibleLookupTable

vtkScalarsToColors* vtkMapper::InvertibleLookupTable
staticprotected

Definition at line 646 of file vtkMapper.h.

◆ LookupTable

vtkScalarsToColors* vtkMapper::LookupTable
protected

Definition at line 648 of file vtkMapper.h.

◆ ScalarVisibility

int vtkMapper::ScalarVisibility
protected

Definition at line 649 of file vtkMapper.h.

◆ BuildTime

vtkTimeStamp vtkMapper::BuildTime
protected

Definition at line 650 of file vtkMapper.h.

◆ ScalarRange

double vtkMapper::ScalarRange[2]
protected

Definition at line 651 of file vtkMapper.h.

◆ UseLookupTableScalarRange

int vtkMapper::UseLookupTableScalarRange
protected

Definition at line 652 of file vtkMapper.h.

◆ ImmediateModeRendering

int vtkMapper::ImmediateModeRendering
protected

Definition at line 653 of file vtkMapper.h.

◆ ColorMode

int vtkMapper::ColorMode
protected

Definition at line 654 of file vtkMapper.h.

◆ ScalarMode

int vtkMapper::ScalarMode
protected

Definition at line 655 of file vtkMapper.h.

◆ ScalarMaterialMode

int vtkMapper::ScalarMaterialMode
protected

Definition at line 656 of file vtkMapper.h.

◆ RenderTime

double vtkMapper::RenderTime
protected

Definition at line 658 of file vtkMapper.h.

◆ ArrayId

int vtkMapper::ArrayId
protected

Definition at line 661 of file vtkMapper.h.

◆ ArrayName

char vtkMapper::ArrayName[256]
protected

Definition at line 662 of file vtkMapper.h.

◆ ArrayComponent

int vtkMapper::ArrayComponent
protected

Definition at line 663 of file vtkMapper.h.

◆ ArrayAccessMode

int vtkMapper::ArrayAccessMode
protected

Definition at line 664 of file vtkMapper.h.

◆ FieldDataTupleId

vtkIdType vtkMapper::FieldDataTupleId
protected

Definition at line 668 of file vtkMapper.h.

◆ Static

int vtkMapper::Static
protected

Definition at line 670 of file vtkMapper.h.

◆ ForceCompileOnly

int vtkMapper::ForceCompileOnly
protected

Definition at line 672 of file vtkMapper.h.

◆ InvertibleScalars

vtkAbstractArray* vtkMapper::InvertibleScalars
protected

Definition at line 674 of file vtkMapper.h.

◆ CoincidentPolygonFactor

double vtkMapper::CoincidentPolygonFactor
protected

Definition at line 676 of file vtkMapper.h.

◆ CoincidentPolygonOffset

double vtkMapper::CoincidentPolygonOffset
protected

Definition at line 677 of file vtkMapper.h.

◆ CoincidentLineFactor

double vtkMapper::CoincidentLineFactor
protected

Definition at line 678 of file vtkMapper.h.

◆ CoincidentLineOffset

double vtkMapper::CoincidentLineOffset
protected

Definition at line 679 of file vtkMapper.h.

◆ CoincidentPointOffset

double vtkMapper::CoincidentPointOffset
protected

Definition at line 680 of file vtkMapper.h.


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