Main Page   Class Hierarchy   Alphabetical List   Compound List   File List   Compound Members   File Members   Related Pages  

vtkPolyDataMapper2D Class Reference

draw vtkPolyData onto the image plane. More...

#include <vtkPolyDataMapper2D.h>

Inheritance diagram for vtkPolyDataMapper2D:

Inheritance graph
[legend]
Collaboration diagram for vtkPolyDataMapper2D:

Collaboration graph
[legend]
List of all members.

Public Methods

virtual const char * GetClassName ()
virtual int IsA (const char *type)
void PrintSelf (ostream &os, vtkIndent indent)
virtual void SetInput (vtkPolyData *)
virtual vtkPolyDataGetInput ()
void SetLookupTable (vtkScalarsToColors *lut)
vtkScalarsToColorsGetLookupTable ()
virtual void CreateDefaultLookupTable ()
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 SetColorModeToLuminance ()
const char * GetColorModeAsString ()
virtual void SetScalarRange (float, float)
void SetScalarRange (float[2])
virtual float * GetScalarRange ()
virtual void GetScalarRange (float data[2])
vtkScalarsGetColors ()
virtual unsigned long GetMTime ()
virtual void SetTransformCoordinate (vtkCoordinate *)
virtual vtkCoordinateGetTransformCoordinate ()
void ShallowCopy (vtkPolyDataMapper2D *m)

Static Public Methods

int IsTypeOf (const char *type)
vtkPolyDataMapper2D * SafeDownCast (vtkObject *o)
vtkPolyDataMapper2D * New ()

Protected Methods

 vtkPolyDataMapper2D ()
 ~vtkPolyDataMapper2D ()
 vtkPolyDataMapper2D (const vtkPolyDataMapper2D &)
void operator= (const vtkPolyDataMapper2D &)

Protected Attributes

vtkPolyDataInput
vtkScalarsColors
vtkScalarsToColorsLookupTable
int ScalarVisibility
vtkTimeStamp BuildTime
float ScalarRange [2]
int ColorMode
vtkCoordinateTransformCoordinate

Detailed Description

draw vtkPolyData onto the image plane.

Date:
2000/12/10 20:09:13
Revision:
1.21

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)

Definition at line 73 of file vtkPolyDataMapper2D.h.


Constructor & Destructor Documentation

vtkPolyDataMapper2D::vtkPolyDataMapper2D   [protected]
 

vtkPolyDataMapper2D::~vtkPolyDataMapper2D   [protected]
 

vtkPolyDataMapper2D::vtkPolyDataMapper2D const vtkPolyDataMapper2D &    [inline, protected]
 

Definition at line 144 of file vtkPolyDataMapper2D.h.


Member Function Documentation

virtual const char* vtkPolyDataMapper2D::GetClassName   [virtual]
 

Return the class name as a string. This method is defined in all subclasses of vtkObject with the vtkTypeMacro found in vtkSetGet.h.

Reimplemented from vtkMapper2D.

Reimplemented in vtkMesaPolyDataMapper2D, vtkOpenGLPolyDataMapper2D, vtkWin32PolyDataMapper2D, and vtkXPolyDataMapper2D.

int vtkPolyDataMapper2D::IsTypeOf const char *    type [static]
 

Return 1 if this class type 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 vtkMesaPolyDataMapper2D, vtkOpenGLPolyDataMapper2D, vtkWin32PolyDataMapper2D, and vtkXPolyDataMapper2D.

virtual int vtkPolyDataMapper2D::IsA const char *    type [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 vtkMesaPolyDataMapper2D, vtkOpenGLPolyDataMapper2D, vtkWin32PolyDataMapper2D, and vtkXPolyDataMapper2D.

vtkPolyDataMapper2D* vtkPolyDataMapper2D::SafeDownCast vtkObject   o [static]
 

Will cast the supplied object to vtkObject* is this is a safe operation (i.e., a safe downcast); otherwise NULL is returned. This method is defined in all subclasses of vtkObject with the vtkTypeMacro found in vtkSetGet.h.

Reimplemented from vtkMapper2D.

Reimplemented in vtkMesaPolyDataMapper2D, vtkOpenGLPolyDataMapper2D, vtkWin32PolyDataMapper2D, and vtkXPolyDataMapper2D.

vtkPolyDataMapper2D* vtkPolyDataMapper2D::New   [static]
 

Instantiate object with no start, end, or progress methods.

Reimplemented from vtkMapper2D.

Reimplemented in vtkMesaPolyDataMapper2D, vtkOpenGLPolyDataMapper2D, vtkWin32PolyDataMapper2D, and vtkXPolyDataMapper2D.

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.

virtual void vtkPolyDataMapper2D::SetInput vtkPolyData   [virtual]
 

Set the input to the mapper.

virtual vtkPolyData* vtkPolyDataMapper2D::GetInput   [virtual]
 

void vtkPolyDataMapper2D::SetLookupTable vtkScalarsToColors   lut
 

Specify a lookup table for the mapper to use.

vtkScalarsToColors* vtkPolyDataMapper2D::GetLookupTable  
 

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]
 

virtual void vtkPolyDataMapper2D::ScalarVisibilityOn   [virtual]
 

virtual void vtkPolyDataMapper2D::ScalarVisibilityOff   [virtual]
 

virtual void vtkPolyDataMapper2D::SetColorMode int    [virtual]
 

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

virtual int vtkPolyDataMapper2D::GetColorMode   [virtual]
 

void vtkPolyDataMapper2D::SetColorModeToDefault   [inline]
 

Definition at line 109 of file vtkPolyDataMapper2D.h.

void vtkPolyDataMapper2D::SetColorModeToMapScalars   [inline]
 

Definition at line 111 of file vtkPolyDataMapper2D.h.

void vtkPolyDataMapper2D::SetColorModeToLuminance   [inline]
 

Definition at line 113 of file vtkPolyDataMapper2D.h.

const char* vtkPolyDataMapper2D::GetColorModeAsString void   
 

virtual void vtkPolyDataMapper2D::SetScalarRange float   ,
float   
[virtual]
 

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

void vtkPolyDataMapper2D::SetScalarRange float   [2]
 

virtual float* vtkPolyDataMapper2D::GetScalarRange   [virtual]
 

virtual void vtkPolyDataMapper2D::GetScalarRange float    data[2] [virtual]
 

vtkScalars* vtkPolyDataMapper2D::GetColors  
 

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.

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

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]
 

void vtkPolyDataMapper2D::ShallowCopy vtkPolyDataMapper2D *    m
 

Make a shallow copy of this mapper.

void vtkPolyDataMapper2D::operator= const vtkPolyDataMapper2D &    [inline, protected]
 

Definition at line 145 of file vtkPolyDataMapper2D.h.


Member Data Documentation

vtkPolyData* vtkPolyDataMapper2D::Input [protected]
 

Definition at line 147 of file vtkPolyDataMapper2D.h.

vtkScalars* vtkPolyDataMapper2D::Colors [protected]
 

Definition at line 148 of file vtkPolyDataMapper2D.h.

vtkScalarsToColors* vtkPolyDataMapper2D::LookupTable [protected]
 

Definition at line 149 of file vtkPolyDataMapper2D.h.

int vtkPolyDataMapper2D::ScalarVisibility [protected]
 

Definition at line 150 of file vtkPolyDataMapper2D.h.

vtkTimeStamp vtkPolyDataMapper2D::BuildTime [protected]
 

Definition at line 151 of file vtkPolyDataMapper2D.h.

float vtkPolyDataMapper2D::ScalarRange[2] [protected]
 

Definition at line 152 of file vtkPolyDataMapper2D.h.

int vtkPolyDataMapper2D::ColorMode [protected]
 

Definition at line 153 of file vtkPolyDataMapper2D.h.

vtkCoordinate* vtkPolyDataMapper2D::TransformCoordinate [protected]
 

Definition at line 155 of file vtkPolyDataMapper2D.h.


The documentation for this class was generated from the following file:
Generated on Wed Nov 21 12:57:43 2001 for VTK by doxygen1.2.11.1 written by Dimitri van Heesch, © 1997-2001