Man Page for vtkWarpScalar
Table of Contents

NAME

vtkWarpScalar - deform geometry with scalar data

SYNOPSIS


#include "/opt/vtk-c++/graphics/vtkWarpScalar.h"

class VTK_EXPORT vtkWarpScalar : public vtkPointSetToPointSetFilter

vtkWarpScalar();
static vtkWarpScalar *New() {return new vtkWarpScalar;};
const char *GetClassName() {return "vtkWarpScalar";};
void PrintSelf(ostream& os, vtkIndent indent);
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 GetNormal(float data[3]);
void SetXYPlane(int);
int GetXYPlane();
void XYPlaneOn();
void XYPlaneOff();

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.

SUMMARY

void SetScaleFactor(float)
Specify value to scale displacement.

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

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

void SetXYPlane(int)
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.


Table of Contents