Documentation for vtkPolyDataMapper2D

vtkPolyDataMapper2D - draw vtkPolyData onto image plane

Description:

vtkPolyDataMapper2D is a mapper that renders 3D polygonal data (vtkPolyData) onto the 2D image plane (i.e., the renderer's viewport). The 3D data is transformed into 2D data by ignoring the z-coordinate of the 3D points in vtkPolyData.

See Also:

vtkMapper2D vtkActor2D

Methods:

	void vtkPolyDataMapper2D ()
	void vtkPolyDataMapper2D ()
	const char *GetClassName ()
	static vtkPolyDataMapper2D *New ()
	void PrintSelf (unknown & ,vtkIndent )
	void Render (vtkViewport * ,vtkActor2D *)
	void SetInput (vtkPolyData *)
	vtkPolyData *GetInput ()
	void SetLookupTable (vtkLookupTable *)
	vtkLookupTable *GetLookupTable ()
	void CreateDefaultLookupTable ()
	void SetScalarVisibility (int )
	int GetScalarVisibility ()
	void ScalarVisibilityOn ()
	void ScalarVisibilityOff ()
	void SetColorMode (int )
	int GetColorMode ()
	void SetColorModeToDefault ()
	void SetColorModeToMapScalars ()
	void SetColorModeToLuminance ()
	char *GetColorModeAsString ()
	void SetScalarRange (float ,float )
	void SetScalarRange (float *)
	float *GetScalarRange ()
	vtkScalars *GetColors ()
	unsigned long GetMTime ()
	void SetLookupTable (vtkLookupTable &)

Detailed Method Descriptions:

Draw the polydata to the screen. This function is implemented in the device dependent subclasses.

void Render (vtkViewport * ,vtkActor2D *)

Set the input to the mapper.

	void SetInput (vtkPolyData *)
	vtkPolyData *GetInput ()

Specify a lookup table for the mapper to use.

	void SetLookupTable (vtkLookupTable *)
	vtkLookupTable *GetLookupTable ()

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

void CreateDefaultLookupTable ()

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

	void SetScalarVisibility (int )
	int GetScalarVisibility ()
	void ScalarVisibilityOn ()
	void ScalarVisibilityOff ()

Control how the scalar data is mapped to colors. By default (ColorModeToDefault), scalars that are unsigned char types are treated as colors, and NOT mapped through the lookup table, while everything else is. Setting ColorModeToMapScalars means that all scalar data will be mapped through the lookup table. Setting ColorModeToLuminance means that scalars will be converted to luminance (gray values) using the luminance equation . (The ColorMode ivar is used with vtkScalars to map scalar data to colors. See vtkScalars::InitColorTraversal() for more information.)

	void SetColorMode (int )
	int GetColorMode ()
	void SetColorModeToDefault ()
	void SetColorModeToMapScalars ()
	void SetColorModeToLuminance ()
	char *GetColorModeAsString ()

Specify range in terms of scalar minimum and maximum (smin,smax). These values are used to map scalars into lookup table.

	void SetScalarRange (float ,float )
	void SetScalarRange (float *)
	float *GetScalarRange ()

Calculate and return the colors for the input. After invoking this method, use GetColor() on the scalar to get the scalar values. This method may return NULL if no color information is available.

vtkScalars *GetColors ()

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

unsigned long GetMTime ()

Obsolete methods for legacy compatability. Do not use.

void SetLookupTable (vtkLookupTable &)