Documentation for vtkWarpScalar

vtkWarpScalar - deform geometry with scalar data

Super Class: vtkPointSetToPointSetFilter

Description:

vtkWarpScalar is a filter that modifies point coordinates by moving points along point normals by the scalar amount times the scale factor. Useful for creating carpet or x-y-z plots. If normals are not present in data, the Normal instance variable will be used as the direction along which to warp the geometry. If normals are present but you would like to use the Normal instance variable, set the UseNormal boolean to true. If XYPlane boolean is set true, then the z-value is considered to be a scalar value (still scaled by scale factor), and the displacement is along the z-axis. If scalars are also present, these are copied through and can be used to color the surface. Note that the filter passes both its point data and cell data to its output, except for normals, since these are distorted by the warping.

 

Methods:

void vtkWarpScalar ()
static vtkWarpScalar *New ()
const char *GetClassName ()
void PrintSelf (unknown & ,vtkIndent )
void SetScaleFactor (float )
float GetScaleFactor ()
void SetUseNormal (int )
int GetUseNormal ()
void UseNormalOn ()
void UseNormalOff ()
void SetNormal (float ,float ,float )
void SetNormal (float *)
float *GetNormal ()
void SetXYPlane (int )
int GetXYPlane ()
void XYPlaneOn ()
void XYPlaneOff ()
void Execute ()

 

Detailed Method Descriptions:

Specify value to scale displacement.

void SetScaleFactor (float )
float GetScaleFactor ()

Turn on/off use of user specified normal. If on, data normals will be ignored and instance variable Normal will be used instead.

void SetUseNormal (int )
int GetUseNormal ()
void UseNormalOn ()
void UseNormalOff ()

Normal (i.e., direction) along which to warp geometry. Only used if UseNormal boolean set to true or no normals available in data.

void SetNormal (float ,float ,float )
void SetNormal (float *)
float *GetNormal ()

Turn on/off flag specifying that input data is x-y plane. If x-y plane, then the z value is used to warp the surface in the z-axis direction (times the scale factor) and scalars are used to color the surface.

void SetXYPlane (int )
int GetXYPlane ()
void XYPlaneOn ()
void XYPlaneOff ()