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

vtkWarpScalar Class Reference

deform geometry with scalar data. More...

#include <vtkWarpScalar.h>

Inheritance diagram for vtkWarpScalar:

Inheritance graph
[legend]
Collaboration diagram for vtkWarpScalar:

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 SetScaleFactor (float)
virtual float GetScaleFactor ()
virtual void SetUseNormal (int)
virtual int GetUseNormal ()
virtual void UseNormalOn ()
virtual void UseNormalOff ()
virtual void SetNormal (float, float, float)
virtual void SetNormal (float[3])
virtual float * GetNormal ()
virtual void GetNormal (float data[3])
virtual void SetXYPlane (int)
virtual int GetXYPlane ()
virtual void XYPlaneOn ()
virtual void XYPlaneOff ()

Static Public Methods

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

Protected Methods

 vtkWarpScalar ()
 ~vtkWarpScalar ()
void Execute ()
float * DataNormal (vtkIdType id, vtkDataArray *normals=NULL)
float * InstanceNormal (vtkIdType id, vtkDataArray *normals=NULL)
float * ZNormal (vtkIdType id, vtkDataArray *normals=NULL)

Protected Attributes

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

Detailed Description

deform geometry with scalar data.

Date:
2001/10/11 13:37:21
Revision:
1.34

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 76 of file vtkWarpScalar.h.


Constructor & Destructor Documentation

vtkWarpScalar::vtkWarpScalar   [protected]
 

vtkWarpScalar::~vtkWarpScalar   [inline, protected]
 

Definition at line 116 of file vtkWarpScalar.h.


Member Function Documentation

vtkWarpScalar* vtkWarpScalar::New   [static]
 

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

Reimplemented from vtkPointSetSource.

virtual const char* vtkWarpScalar::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 vtkPointSetToPointSetFilter.

int vtkWarpScalar::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 vtkPointSetToPointSetFilter.

virtual int vtkWarpScalar::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 vtkPointSetToPointSetFilter.

vtkWarpScalar* vtkWarpScalar::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 vtkPointSetToPointSetFilter.

void vtkWarpScalar::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 vtkSource.

virtual void vtkWarpScalar::SetScaleFactor float    [virtual]
 

Specify value to scale displacement.

virtual float 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 float   ,
float   ,
float   
[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 float   [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 float* 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 float    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.

void vtkWarpScalar::Execute   [protected, virtual]
 

This method is the old style execute method

Reimplemented from vtkSource.

float* vtkWarpScalar::DataNormal vtkIdType    id,
vtkDataArray   normals = NULL
[protected]
 

float* vtkWarpScalar::InstanceNormal vtkIdType    id,
vtkDataArray   normals = NULL
[protected]
 

float* vtkWarpScalar::ZNormal vtkIdType    id,
vtkDataArray   normals = NULL
[protected]
 


Member Data Documentation

float vtkWarpScalar::ScaleFactor [protected]
 

Definition at line 120 of file vtkWarpScalar.h.

int vtkWarpScalar::UseNormal [protected]
 

Definition at line 121 of file vtkWarpScalar.h.

float vtkWarpScalar::Normal[3] [protected]
 

Definition at line 122 of file vtkWarpScalar.h.

int vtkWarpScalar::XYPlane [protected]
 

Definition at line 123 of file vtkWarpScalar.h.

float*(vtkWarpScalar::* vtkWarpScalar::PointNormal)(vtkIdType id, vtkDataArray *normals) [protected]
 


The documentation for this class was generated from the following file:
Generated on Thu Mar 28 14:47:25 2002 for VTK by doxygen1.2.11.1 written by Dimitri van Heesch, © 1997-2001