draw vtkPolyData onto the image plane More...

#include <vtkPolyDataMapper2D.h>

Inheritance diagram for vtkPolyDataMapper2D:

Collaboration diagram for vtkPolyDataMapper2D:

Public Types
typedef vtkMapper2D	Superclass

Public Types inherited from vtkMapper2D
typedef vtkAbstractMapper	Superclass

Public Types inherited from vtkAbstractMapper
typedef vtkAlgorithm	Superclass

Public Types inherited from vtkAlgorithm
typedef vtkObject	Superclass

enum	DesiredOutputPrecision { SINGLE_PRECISION, DOUBLE_PRECISION, DEFAULT_PRECISION }

Public Types inherited from vtkObject
typedef vtkObjectBase	Superclass

Public Member Functions
virtual int	IsA (const char *type)

vtkPolyDataMapper2D *	NewInstance () const

void	PrintSelf (ostream &os, vtkIndent indent)

virtual void	CreateDefaultLookupTable ()

const char *	GetColorModeAsString ()

virtual unsigned long	GetMTime ()

vtkUnsignedCharArray *	MapScalars (double alpha)

void	ShallowCopy (vtkAbstractMapper *m)


void	SetInputData (vtkPolyData *in)

vtkPolyData *	GetInput ()


void	SetLookupTable (vtkScalarsToColors *lut)

vtkScalarsToColors *	GetLookupTable ()


virtual void	SetScalarVisibility (int)

virtual int	GetScalarVisibility ()

virtual void	ScalarVisibilityOn ()

virtual void	ScalarVisibilityOff ()


virtual void	SetColorMode (int)

virtual int	GetColorMode ()

void	SetColorModeToDefault ()

void	SetColorModeToMapScalars ()

void	SetColorModeToDirectScalars ()


virtual void	SetUseLookupTableScalarRange (int)

virtual int	GetUseLookupTableScalarRange ()

virtual void	UseLookupTableScalarRangeOn ()

virtual void	UseLookupTableScalarRangeOff ()


virtual void	SetScalarRange (double, double)

void	SetScalarRange (double[2])

virtual double *	GetScalarRange ()

virtual void	GetScalarRange (double data[2])


virtual void	SetScalarMode (int)

virtual int	GetScalarMode ()

void	SetScalarModeToDefault ()

void	SetScalarModeToUsePointData ()

void	SetScalarModeToUseCellData ()

void	SetScalarModeToUsePointFieldData ()

void	SetScalarModeToUseCellFieldData ()


void	ColorByArrayComponent (int arrayNum, int component)

void	ColorByArrayComponent (char *arrayName, int component)


char *	GetArrayName ()

int	GetArrayId ()

int	GetArrayAccessMode ()

int	GetArrayComponent ()


virtual void	SetTransformCoordinate (vtkCoordinate *)

virtual vtkCoordinate *	GetTransformCoordinate ()


virtual bool	GetTransformCoordinateUseDouble ()

virtual void	SetTransformCoordinateUseDouble (bool)

virtual void	TransformCoordinateUseDoubleOn ()

virtual void	TransformCoordinateUseDoubleOff ()

Public Member Functions inherited from vtkMapper2D
vtkMapper2D *	NewInstance () const

virtual void	RenderOverlay (vtkViewport , vtkActor2D )

virtual void	RenderOpaqueGeometry (vtkViewport , vtkActor2D )

virtual void	RenderTranslucentPolygonalGeometry (vtkViewport , vtkActor2D )

virtual int	HasTranslucentPolygonalGeometry ()

Public Member Functions inherited from vtkAbstractMapper
vtkAbstractMapper *	NewInstance () const

virtual void	ReleaseGraphicsResources (vtkWindow *)

void	SetClippingPlanes (vtkPlanes *planes)

void	ShallowCopy (vtkAbstractMapper *m)

virtual double	GetTimeToDraw ()

void	AddClippingPlane (vtkPlane *plane)

void	RemoveClippingPlane (vtkPlane *plane)

void	RemoveAllClippingPlanes ()

virtual void	SetClippingPlanes (vtkPlaneCollection *)

virtual vtkPlaneCollection *	GetClippingPlanes ()

Public Member Functions inherited from vtkAlgorithm
vtkAlgorithm *	NewInstance () const

int	HasExecutive ()

vtkExecutive *	GetExecutive ()

virtual void	SetExecutive (vtkExecutive *executive)

virtual int	ModifyRequest (vtkInformation *request, int when)

vtkInformation *	GetInputPortInformation (int port)

vtkInformation *	GetOutputPortInformation (int port)

int	GetNumberOfInputPorts ()

int	GetNumberOfOutputPorts ()

void	UpdateProgress (double amount)

vtkInformation *	GetInputArrayInformation (int idx)

void	RemoveAllInputs ()

vtkDataObject *	GetOutputDataObject (int port)

virtual void	RemoveInputConnection (int port, vtkAlgorithmOutput *input)

virtual void	RemoveInputConnection (int port, int idx)

virtual void	RemoveAllInputConnections (int port)

int	GetNumberOfInputConnections (int port)

int	GetTotalNumberOfInputConnections ()

vtkAlgorithmOutput *	GetInputConnection (int port, int index)

vtkAlgorithm *	GetInputAlgorithm (int port, int index, int &algPort)

vtkAlgorithm *	GetInputAlgorithm (int port, int index)

vtkExecutive *	GetInputExecutive (int port, int index)

vtkInformation *	GetInputInformation (int port, int index)

vtkInformation *	GetOutputInformation (int port)

virtual void	UpdateInformation ()

virtual void	UpdateDataObject ()

virtual void	PropagateUpdateExtent ()

virtual void	UpdateWholeExtent ()

void	ConvertTotalInputToPortConnection (int ind, int &port, int &conn)

int	SetUpdateExtentToWholeExtent (int port)

int	SetUpdateExtentToWholeExtent ()

void	SetUpdateExtent (int port, int extent[6])

virtual int	ProcessRequest (vtkInformation request, vtkInformationVector inInfo, vtkInformationVector outInfo)

int	ProcessRequest (vtkInformation request, vtkCollection inInfo, vtkInformationVector *outInfo)

virtual int	ComputePipelineMTime (vtkInformation request, vtkInformationVector inInfoVec, vtkInformationVector outInfoVec, int requestFromOutputPort, unsigned long *mtime)

virtual vtkInformation *	GetInformation ()

virtual void	SetInformation (vtkInformation *)

virtual void	Register (vtkObjectBase *o)

virtual void	UnRegister (vtkObjectBase *o)

virtual void	SetAbortExecute (int)

virtual int	GetAbortExecute ()

virtual void	AbortExecuteOn ()

virtual void	AbortExecuteOff ()

virtual void	SetProgress (double)

virtual double	GetProgress ()

void	SetProgressText (const char *ptext)

virtual char *	GetProgressText ()

virtual unsigned long	GetErrorCode ()

virtual void	SetInputArrayToProcess (int idx, int port, int connection, int fieldAssociation, const char *name)

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)

vtkDataObject *	GetInputDataObject (int port, int connection)

virtual void	SetInputConnection (int port, vtkAlgorithmOutput *input)

virtual void	SetInputConnection (vtkAlgorithmOutput *input)

virtual void	AddInputConnection (int port, vtkAlgorithmOutput *input)

virtual void	AddInputConnection (vtkAlgorithmOutput *input)

virtual void	SetInputDataObject (int port, vtkDataObject *data)

virtual void	SetInputDataObject (vtkDataObject *data)

virtual void	AddInputDataObject (int port, vtkDataObject *data)

virtual void	AddInputDataObject (vtkDataObject *data)

vtkAlgorithmOutput *	GetOutputPort (int index)

vtkAlgorithmOutput *	GetOutputPort ()

vtkAlgorithm *	GetInputAlgorithm ()

vtkExecutive *	GetInputExecutive ()

vtkInformation *	GetInputInformation ()

virtual void	Update (int port)

virtual void	Update ()

virtual void	SetReleaseDataFlag (int)

virtual int	GetReleaseDataFlag ()

void	ReleaseDataFlagOn ()

void	ReleaseDataFlagOff ()

int	UpdateExtentIsEmpty (vtkInformation pinfo, vtkDataObject output)

int	UpdateExtentIsEmpty (vtkInformation *pinfo, int extentType)

void	SetUpdateExtent (int port, int piece, int numPieces, int ghostLevel)

void	SetUpdateExtent (int piece, int numPieces, int ghostLevel)

void	SetUpdateExtent (int extent[6])

int *	GetUpdateExtent ()

int *	GetUpdateExtent (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 ()

int	GetUpdatePiece (int port)

int	GetUpdateNumberOfPieces ()

int	GetUpdateNumberOfPieces (int port)

int	GetUpdateGhostLevel ()

int	GetUpdateGhostLevel (int port)

void	SetProgressObserver (vtkProgressObserver *)

virtual vtkProgressObserver *	GetProgressObserver ()

Public Member Functions inherited from vtkObject
vtkObject *	NewInstance () const

virtual void	DebugOn ()

virtual void	DebugOff ()

bool	GetDebug ()

void	SetDebug (bool debugFlag)

virtual void	Modified ()

unsigned long	AddObserver (unsigned long event, vtkCommand *, float priority=0.0f)

unsigned long	AddObserver (const char event, vtkCommand , float priority=0.0f)

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

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)

int	InvokeEvent (unsigned long event, void *callData)

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

virtual void	Delete ()

virtual void	FastDelete ()

void	Print (ostream &os)

void	SetReferenceCount (int)

void	PrintRevisions (ostream &)

virtual void	PrintHeader (ostream &os, vtkIndent indent)

virtual void	PrintTrailer (ostream &os, vtkIndent indent)

int	GetReferenceCount ()

Static Public Member Functions
static int	IsTypeOf (const char *type)

static vtkPolyDataMapper2D *	SafeDownCast (vtkObjectBase *o)

static vtkPolyDataMapper2D *	New ()

Static Public Member Functions inherited from vtkMapper2D
static int	IsTypeOf (const char *type)

static vtkMapper2D *	SafeDownCast (vtkObjectBase *o)

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

static vtkAbstractMapper *	SafeDownCast (vtkObjectBase *o)

static vtkDataArray *	GetScalars (vtkDataSet input, int scalarMode, int arrayAccessMode, int arrayId, const char arrayName, int &cellFlag)

static vtkAbstractArray *	GetAbstractScalars (vtkDataSet input, int scalarMode, int arrayAccessMode, int arrayId, const char arrayName, int &cellFlag)

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

static int	IsTypeOf (const char *type)

static vtkAlgorithm *	SafeDownCast (vtkObjectBase *o)

static vtkInformationIntegerKey *	INPUT_IS_OPTIONAL ()

static vtkInformationIntegerKey *	INPUT_IS_REPEATABLE ()

static vtkInformationInformationVectorKey *	INPUT_REQUIRED_FIELDS ()

static vtkInformationStringVectorKey *	INPUT_REQUIRED_DATA_TYPE ()

static vtkInformationInformationVectorKey *	INPUT_ARRAYS_TO_PROCESS ()

static vtkInformationIntegerKey *	INPUT_PORT ()

static vtkInformationIntegerKey *	INPUT_CONNECTION ()

static vtkInformationIntegerKey *	CAN_PRODUCE_SUB_EXTENT ()

static vtkInformationIntegerKey *	CAN_HANDLE_PIECE_REQUEST ()

static void	SetDefaultExecutivePrototype (vtkExecutive *proto)

Static Public Member Functions inherited from vtkObject
static int	IsTypeOf (const char *type)

static vtkObject *	SafeDownCast (vtkObjectBase *o)

static vtkObject *	New ()

static void	BreakOnError ()

static void	SetGlobalWarningDisplay (int val)

static void	GlobalWarningDisplayOn ()

static void	GlobalWarningDisplayOff ()

static int	GetGlobalWarningDisplay ()

Static Public Member Functions inherited from vtkObjectBase
static int	IsTypeOf (const char *name)

static vtkObjectBase *	New ()

Protected Member Functions
virtual vtkObjectBase *	NewInstanceInternal () const

	vtkPolyDataMapper2D ()

	~vtkPolyDataMapper2D ()

virtual int	FillInputPortInformation (int, vtkInformation *)

Protected Member Functions inherited from vtkMapper2D
	vtkMapper2D ()

	~vtkMapper2D ()

Protected Member Functions inherited from vtkAbstractMapper
	vtkAbstractMapper ()

	~vtkAbstractMapper ()

Protected Member Functions inherited from vtkAlgorithm
	vtkAlgorithm ()

	~vtkAlgorithm ()

virtual int	FillOutputPortInformation (int port, vtkInformation *info)

virtual void	SetNumberOfInputPorts (int n)

virtual void	SetNumberOfOutputPorts (int n)

int	InputPortIndexInRange (int index, const char *action)

int	OutputPortIndexInRange (int index, const char *action)

int	GetInputArrayAssociation (int idx, vtkInformationVector **inputVector)

virtual vtkExecutive *	CreateDefaultExecutive ()

virtual void	ReportReferences (vtkGarbageCollector *)

virtual void	SetNumberOfInputConnections (int port, int n)

int	GetInputArrayAssociation (int idx, int connection, vtkInformationVector **inputVector)

int	GetInputArrayAssociation (int idx, vtkDataObject *input)

vtkDataArray *	GetInputArrayToProcess (int idx, vtkInformationVector **inputVector)

vtkDataArray *	GetInputArrayToProcess (int idx, vtkInformationVector **inputVector, int &association)

vtkDataArray *	GetInputArrayToProcess (int idx, int connection, vtkInformationVector **inputVector)

vtkDataArray *	GetInputArrayToProcess (int idx, int connection, vtkInformationVector **inputVector, int &association)

vtkDataArray *	GetInputArrayToProcess (int idx, vtkDataObject *input)

vtkDataArray *	GetInputArrayToProcess (int idx, vtkDataObject *input, int &association)

vtkAbstractArray *	GetInputAbstractArrayToProcess (int idx, vtkInformationVector **inputVector)

vtkAbstractArray *	GetInputAbstractArrayToProcess (int idx, vtkInformationVector **inputVector, int &association)

vtkAbstractArray *	GetInputAbstractArrayToProcess (int idx, int connection, vtkInformationVector **inputVector)

vtkAbstractArray *	GetInputAbstractArrayToProcess (int idx, int connection, vtkInformationVector **inputVector, int &association)

vtkAbstractArray *	GetInputAbstractArrayToProcess (int idx, vtkDataObject *input)

vtkAbstractArray *	GetInputAbstractArrayToProcess (int idx, vtkDataObject *input, int &association)

vtkInformation *	GetInputArrayFieldInformation (int idx, vtkInformationVector **inputVector)

virtual void	SetNthInputConnection (int port, int index, vtkAlgorithmOutput *input)

void	SetInputDataInternal (int port, vtkDataObject *input)

void	AddInputDataInternal (int port, vtkDataObject *input)

virtual void	SetErrorCode (unsigned long)

Protected Member Functions inherited from vtkObject
	vtkObject ()

virtual	~vtkObject ()

virtual void	RegisterInternal (vtkObjectBase *, int check)

virtual void	UnRegisterInternal (vtkObjectBase *, int check)

void	InternalGrabFocus (vtkCommand mouseEvents, vtkCommand keypressEvents=NULL)

void	InternalReleaseFocus ()

Protected Member Functions inherited from vtkObjectBase
	vtkObjectBase ()

virtual	~vtkObjectBase ()

virtual void	CollectRevisions (ostream &)

	vtkObjectBase (const vtkObjectBase &)

void	operator= (const vtkObjectBase &)

Protected Attributes
vtkUnsignedCharArray *	Colors

vtkScalarsToColors *	LookupTable

int	ScalarVisibility

vtkTimeStamp	BuildTime

double	ScalarRange [2]

int	UseLookupTableScalarRange

int	ColorMode

int	ScalarMode

vtkCoordinate *	TransformCoordinate

bool	TransformCoordinateUseDouble

int	ArrayId

char	ArrayName [256]

int	ArrayComponent

int	ArrayAccessMode

Protected Attributes inherited from vtkAbstractMapper
vtkTimerLog *	Timer

double	TimeToDraw

vtkWindow *	LastWindow

vtkPlaneCollection *	ClippingPlanes

Protected Attributes inherited from vtkAlgorithm
vtkInformation *	Information

double	Progress

char *	ProgressText

vtkProgressObserver *	ProgressObserver

unsigned long	ErrorCode

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
int	AbortExecute

Static Protected Member Functions inherited from vtkAlgorithm
static vtkInformationIntegerKey *	PORT_REQUIREMENTS_FILLED ()

Static Protected Attributes inherited from vtkAlgorithm
static vtkExecutive *	DefaultExecutivePrototype

Detailed Description

draw vtkPolyData onto the image plane

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

See also: vtkMapper2D vtkActor2D

Examples:: vtkPolyDataMapper2D (Examples)

Tests:: vtkPolyDataMapper2D (Tests)

Definition at line 50 of file vtkPolyDataMapper2D.h.

Member Typedef Documentation

typedef vtkMapper2D vtkPolyDataMapper2D::Superclass

Definition at line 53 of file vtkPolyDataMapper2D.h.

Constructor & Destructor Documentation

vtkPolyDataMapper2D::vtkPolyDataMapper2D ( )

protected

vtkPolyDataMapper2D::~vtkPolyDataMapper2D ( )

protected

Member Function Documentation

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

static

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

virtual

Return 1 if this class is the same type of (or a subclass of) the named class. Returns 0 otherwise. This method works in combination with vtkTypeMacro found in vtkSetGet.h.

Reimplemented from vtkMapper2D.

Reimplemented in vtkOpenGLPolyDataMapper2D, and vtkOpenGLPolyDataMapper2D.

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

static

virtual vtkObjectBase* vtkPolyDataMapper2D::NewInstanceInternal ( ) const

protectedvirtual

Reimplemented from vtkMapper2D.

Reimplemented in vtkOpenGLPolyDataMapper2D, and vtkOpenGLPolyDataMapper2D.

vtkPolyDataMapper2D* vtkPolyDataMapper2D::NewInstance ( ) const

static vtkPolyDataMapper2D* vtkPolyDataMapper2D::New ( )

static

void vtkPolyDataMapper2D::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 vtkMapper2D.

Reimplemented in vtkOpenGLPolyDataMapper2D, and vtkOpenGLPolyDataMapper2D.

void vtkPolyDataMapper2D::SetInputData ( vtkPolyData * in )

Set the input to the mapper.

vtkPolyData* vtkPolyDataMapper2D::GetInput ( )

Set the input to the mapper.

void vtkPolyDataMapper2D::SetLookupTable ( vtkScalarsToColors * lut )

Specify a lookup table for the mapper to use.

vtkScalarsToColors* vtkPolyDataMapper2D::GetLookupTable ( )

Specify a lookup table for the mapper to use.

virtual void vtkPolyDataMapper2D::CreateDefaultLookupTable ( )

virtual

Create default lookup table. Generally used to create one when none is available with the scalar data.

virtual void vtkPolyDataMapper2D::SetScalarVisibility ( int )

virtual

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

virtual int vtkPolyDataMapper2D::GetScalarVisibility ( )

virtual

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

virtual void vtkPolyDataMapper2D::ScalarVisibilityOn ( )

virtual

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

virtual void vtkPolyDataMapper2D::ScalarVisibilityOff ( )

virtual

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

virtual void vtkPolyDataMapper2D::SetColorMode ( int )

virtual

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

virtual int vtkPolyDataMapper2D::GetColorMode ( )

virtual

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

void vtkPolyDataMapper2D::SetColorModeToDefault ( )

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

void vtkPolyDataMapper2D::SetColorModeToMapScalars ( )

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

void vtkPolyDataMapper2D::SetColorModeToDirectScalars ( )

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

const char* vtkPolyDataMapper2D::GetColorModeAsString ( )

Return the method of coloring scalar data.

virtual void vtkPolyDataMapper2D::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.

virtual int vtkPolyDataMapper2D::GetUseLookupTableScalarRange ( )

virtual

Control whether the mapper sets the lookuptable range based on its own ScalarRange, or whether it will use the LookupTable ScalarRange regardless of it's own setting. By default the Mapper is allowed to set the LookupTable range, but users who are sharing LookupTables between mappers/actors will probably wish to force the mapper to use the LookupTable unchanged.

virtual void vtkPolyDataMapper2D::UseLookupTableScalarRangeOn ( )

virtual

Control whether the mapper sets the lookuptable range based on its own ScalarRange, or whether it will use the LookupTable ScalarRange regardless of it's own setting. By default the Mapper is allowed to set the LookupTable range, but users who are sharing LookupTables between mappers/actors will probably wish to force the mapper to use the LookupTable unchanged.

virtual void vtkPolyDataMapper2D::UseLookupTableScalarRangeOff ( )

virtual

Control whether the mapper sets the lookuptable range based on its own ScalarRange, or whether it will use the LookupTable ScalarRange regardless of it's own setting. By default the Mapper is allowed to set the LookupTable range, but users who are sharing LookupTables between mappers/actors will probably wish to force the mapper to use the LookupTable unchanged.

virtual void vtkPolyDataMapper2D::SetScalarRange	(	double	,
		double
	)

virtual

Specify range in terms of scalar minimum and maximum (smin,smax). These values are used to map scalars into lookup table. Has no effect when UseLookupTableScalarRange is true.

void vtkPolyDataMapper2D::SetScalarRange ( double [2] )

Specify range in terms of scalar minimum and maximum (smin,smax). These values are used to map scalars into lookup table. Has no effect when UseLookupTableScalarRange is true.

virtual double* vtkPolyDataMapper2D::GetScalarRange ( )

virtual

Specify range in terms of scalar minimum and maximum (smin,smax). These values are used to map scalars into lookup table. Has no effect when UseLookupTableScalarRange is true.

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

virtual

Specify range in terms of scalar minimum and maximum (smin,smax). These values are used to map scalars into lookup table. Has no effect when UseLookupTableScalarRange is true.

virtual void vtkPolyDataMapper2D::SetScalarMode ( int )

virtual

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

virtual int vtkPolyDataMapper2D::GetScalarMode ( )

virtual

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

void vtkPolyDataMapper2D::SetScalarModeToDefault ( )

inline

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

Definition at line 135 of file vtkPolyDataMapper2D.h.

void vtkPolyDataMapper2D::SetScalarModeToUsePointData ( )

inline

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

Definition at line 137 of file vtkPolyDataMapper2D.h.

void vtkPolyDataMapper2D::SetScalarModeToUseCellData ( )

inline

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

Definition at line 139 of file vtkPolyDataMapper2D.h.

void vtkPolyDataMapper2D::SetScalarModeToUsePointFieldData ( )

inline

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

Definition at line 141 of file vtkPolyDataMapper2D.h.

void vtkPolyDataMapper2D::SetScalarModeToUseCellFieldData ( )

inline

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

Definition at line 143 of file vtkPolyDataMapper2D.h.

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

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

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

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

char* vtkPolyDataMapper2D::GetArrayName ( )

inline

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

Definition at line 155 of file vtkPolyDataMapper2D.h.

int vtkPolyDataMapper2D::GetArrayId ( )

inline

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

Definition at line 156 of file vtkPolyDataMapper2D.h.

int vtkPolyDataMapper2D::GetArrayAccessMode ( )

inline

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

Definition at line 157 of file vtkPolyDataMapper2D.h.

int vtkPolyDataMapper2D::GetArrayComponent ( )

inline

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

Definition at line 158 of file vtkPolyDataMapper2D.h.

virtual unsigned long vtkPolyDataMapper2D::GetMTime ( )

virtual

Overload standard modified time function. If lookup table is modified, then this object is modified as well.

Reimplemented from vtkAbstractMapper.

virtual void vtkPolyDataMapper2D::SetTransformCoordinate ( vtkCoordinate * )

virtual

Specify a vtkCoordinate object to be used to transform the vtkPolyData point coordinates. By default (no vtkCoordinate specified), the point coordinates are taken as local display coordinates.

virtual vtkCoordinate* vtkPolyDataMapper2D::GetTransformCoordinate ( )

virtual

Specify a vtkCoordinate object to be used to transform the vtkPolyData point coordinates. By default (no vtkCoordinate specified), the point coordinates are taken as local display coordinates.

virtual bool vtkPolyDataMapper2D::GetTransformCoordinateUseDouble ( )

virtual

Specify whether or not rounding to integers the transformed points when TransformCoordinate is set. By default, it does not use double precision.

virtual void vtkPolyDataMapper2D::SetTransformCoordinateUseDouble ( bool )

virtual

Specify whether or not rounding to integers the transformed points when TransformCoordinate is set. By default, it does not use double precision.

virtual void vtkPolyDataMapper2D::TransformCoordinateUseDoubleOn ( )

virtual

Specify whether or not rounding to integers the transformed points when TransformCoordinate is set. By default, it does not use double precision.

virtual void vtkPolyDataMapper2D::TransformCoordinateUseDoubleOff ( )

virtual

Specify whether or not rounding to integers the transformed points when TransformCoordinate is set. By default, it does not use double precision.

vtkUnsignedCharArray* vtkPolyDataMapper2D::MapScalars ( double alpha )

Map the scalars (if there are any scalars and ScalarVisibility is on) through the lookup table, returning an unsigned char RGBA array. This is typically done as part of the rendering process. The alpha parameter allows the blending of the scalars with an additional alpha (typically which comes from a vtkActor, etc.)

void vtkPolyDataMapper2D::ShallowCopy ( vtkAbstractMapper * m )

Make a shallow copy of this mapper.

virtual int vtkPolyDataMapper2D::FillInputPortInformation	(	int	port,
		vtkInformation *	info
	)

protectedvirtual

Fill the input port information objects for this algorithm. This is invoked by the first call to GetInputPortInformation for each port so subclasses can specify what they can handle.

Reimplemented from vtkAlgorithm.

Member Data Documentation

vtkUnsignedCharArray* vtkPolyDataMapper2D::Colors

protected

Definition at line 199 of file vtkPolyDataMapper2D.h.

vtkScalarsToColors* vtkPolyDataMapper2D::LookupTable

protected

Definition at line 201 of file vtkPolyDataMapper2D.h.

int vtkPolyDataMapper2D::ScalarVisibility

protected

Definition at line 202 of file vtkPolyDataMapper2D.h.

vtkTimeStamp vtkPolyDataMapper2D::BuildTime

protected

Definition at line 203 of file vtkPolyDataMapper2D.h.

double vtkPolyDataMapper2D::ScalarRange[2]

protected

Definition at line 204 of file vtkPolyDataMapper2D.h.

int vtkPolyDataMapper2D::UseLookupTableScalarRange

protected

Definition at line 205 of file vtkPolyDataMapper2D.h.

int vtkPolyDataMapper2D::ColorMode

protected

Definition at line 206 of file vtkPolyDataMapper2D.h.

int vtkPolyDataMapper2D::ScalarMode

protected

Definition at line 207 of file vtkPolyDataMapper2D.h.

vtkCoordinate* vtkPolyDataMapper2D::TransformCoordinate

protected

Definition at line 209 of file vtkPolyDataMapper2D.h.

bool vtkPolyDataMapper2D::TransformCoordinateUseDouble

protected

Definition at line 210 of file vtkPolyDataMapper2D.h.

int vtkPolyDataMapper2D::ArrayId

protected

Definition at line 213 of file vtkPolyDataMapper2D.h.

char vtkPolyDataMapper2D::ArrayName[256]

protected

Definition at line 214 of file vtkPolyDataMapper2D.h.

int vtkPolyDataMapper2D::ArrayComponent

protected

Definition at line 215 of file vtkPolyDataMapper2D.h.

int vtkPolyDataMapper2D::ArrayAccessMode

protected

Definition at line 216 of file vtkPolyDataMapper2D.h.

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

/home/boeckb/code/depot/group-kitware/vtk/build-release/Utilities/Doxygen/dox/Rendering/Core/vtkPolyDataMapper2D.h

Public Types

Public Member Functions

Static Public Member Functions

Protected Member Functions

Protected Attributes

Additional Inherited Members

Detailed Description

Member Typedef Documentation

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation