VTK
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Pages
Public Types | Public Member Functions | Static Public Member Functions | Protected Member Functions | Protected Attributes | List of all members
vtkWarpScalar Class Reference

deform geometry with scalar data More...

#include <vtkWarpScalar.h>

Inherits vtkPointSetAlgorithm.

Public Types

typedef vtkPointSetAlgorithm Superclass
 

Public Member Functions

virtual int IsA (const char *type)
 
vtkWarpScalarNewInstance () const
 
void PrintSelf (ostream &os, vtkIndent indent)
 
int FillInputPortInformation (int port, vtkInformation *info)
 
virtual void SetScaleFactor (double)
 
virtual double GetScaleFactor ()
 
virtual void SetUseNormal (int)
 
virtual int GetUseNormal ()
 
virtual void UseNormalOn ()
 
virtual void UseNormalOff ()
 
virtual void SetNormal (double, double, double)
 
virtual void SetNormal (double[3])
 
virtual double * GetNormal ()
 
virtual void GetNormal (double data[3])
 
virtual void SetXYPlane (int)
 
virtual int GetXYPlane ()
 
virtual void XYPlaneOn ()
 
virtual void XYPlaneOff ()
 

Static Public Member Functions

static vtkWarpScalarNew ()
 
static int IsTypeOf (const char *type)
 
static vtkWarpScalarSafeDownCast (vtkObjectBase *o)
 

Protected Member Functions

virtual vtkObjectBase * NewInstanceInternal () const
 
 vtkWarpScalar ()
 
 ~vtkWarpScalar ()
 
int RequestDataObject (vtkInformation *request, vtkInformationVector **inputVector, vtkInformationVector *outputVector)
 
int RequestData (vtkInformation *, vtkInformationVector **, vtkInformationVector *)
 
double * DataNormal (vtkIdType id, vtkDataArray *normals=NULL)
 
double * InstanceNormal (vtkIdType id, vtkDataArray *normals=NULL)
 
double * ZNormal (vtkIdType id, vtkDataArray *normals=NULL)
 

Protected Attributes

double ScaleFactor
 
int UseNormal
 
double Normal [3]
 
int XYPlane
 
double *(vtkWarpScalar::* PointNormal )(vtkIdType id, vtkDataArray *normals)
 

Detailed Description

deform geometry with scalar data

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.

Examples:
vtkWarpScalar (Examples)
Tests:
vtkWarpScalar (Tests)

Definition at line 51 of file vtkWarpScalar.h.

Member Typedef Documentation

typedef vtkPointSetAlgorithm vtkWarpScalar::Superclass

Definition at line 55 of file vtkWarpScalar.h.

Constructor & Destructor Documentation

vtkWarpScalar::vtkWarpScalar ( )
protected
vtkWarpScalar::~vtkWarpScalar ( )
protected

Member Function Documentation

static vtkWarpScalar* vtkWarpScalar::New ( )
static
static int vtkWarpScalar::IsTypeOf ( const char *  type)
static
virtual int vtkWarpScalar::IsA ( const char *  type)
virtual
static vtkWarpScalar* vtkWarpScalar::SafeDownCast ( vtkObjectBase *  o)
static
virtual vtkObjectBase* vtkWarpScalar::NewInstanceInternal ( ) const
protectedvirtual
vtkWarpScalar* vtkWarpScalar::NewInstance ( ) const
void vtkWarpScalar::PrintSelf ( ostream &  os,
vtkIndent  indent 
)
virtual void vtkWarpScalar::SetScaleFactor ( double  )
virtual

Specify value to scale displacement.

virtual double vtkWarpScalar::GetScaleFactor ( )
virtual

Specify value to scale displacement.

virtual void vtkWarpScalar::SetUseNormal ( int  )
virtual

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

virtual int vtkWarpScalar::GetUseNormal ( )
virtual

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

virtual void vtkWarpScalar::UseNormalOn ( )
virtual

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

virtual void vtkWarpScalar::UseNormalOff ( )
virtual

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

virtual void vtkWarpScalar::SetNormal ( double  ,
double  ,
double   
)
virtual

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

virtual void vtkWarpScalar::SetNormal ( double  [3])
virtual

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

virtual double* vtkWarpScalar::GetNormal ( )
virtual

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

virtual void vtkWarpScalar::GetNormal ( double  data[3])
virtual

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

virtual void vtkWarpScalar::SetXYPlane ( int  )
virtual

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.

virtual int vtkWarpScalar::GetXYPlane ( )
virtual

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.

virtual void vtkWarpScalar::XYPlaneOn ( )
virtual

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.

virtual void vtkWarpScalar::XYPlaneOff ( )
virtual

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.

int vtkWarpScalar::FillInputPortInformation ( int  port,
vtkInformation *  info 
)
int vtkWarpScalar::RequestDataObject ( vtkInformation *  request,
vtkInformationVector **  inputVector,
vtkInformationVector *  outputVector 
)
protected
int vtkWarpScalar::RequestData ( vtkInformation *  ,
vtkInformationVector **  ,
vtkInformationVector *   
)
protected
double* vtkWarpScalar::DataNormal ( vtkIdType  id,
vtkDataArray *  normals = NULL 
)
protected
double* vtkWarpScalar::InstanceNormal ( vtkIdType  id,
vtkDataArray *  normals = NULL 
)
protected
double* vtkWarpScalar::ZNormal ( vtkIdType  id,
vtkDataArray *  normals = NULL 
)
protected

Member Data Documentation

double vtkWarpScalar::ScaleFactor
protected

Definition at line 102 of file vtkWarpScalar.h.

int vtkWarpScalar::UseNormal
protected

Definition at line 103 of file vtkWarpScalar.h.

double vtkWarpScalar::Normal[3]
protected

Definition at line 104 of file vtkWarpScalar.h.

int vtkWarpScalar::XYPlane
protected

Definition at line 105 of file vtkWarpScalar.h.

double*(vtkWarpScalar::* vtkWarpScalar::PointNormal)(vtkIdType id, vtkDataArray *normals)
protected

Definition at line 108 of file vtkWarpScalar.h.


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