vtkWarpScalar Class Reference
#include <vtkWarpScalar.h>
Detailed Description
deform geometry with scalar datavtkWarpScalar 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 50 of file vtkWarpScalar.h.
Public Types | |
| typedef vtkPointSetAlgorithm | Superclass |
Public Member Functions | |
| virtual const char * | GetClassName () |
| virtual int | IsA (const char *type) |
| void | PrintSelf (ostream &os, vtkIndent indent) |
| 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 vtkWarpScalar * | New () |
| static int | IsTypeOf (const char *type) |
| static vtkWarpScalar * | SafeDownCast (vtkObject *o) |
Protected Member Functions | |
| vtkWarpScalar () | |
| ~vtkWarpScalar () | |
| 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) |
Member Typedef Documentation
Constructor & Destructor Documentation
| vtkWarpScalar::vtkWarpScalar | ( | ) | [protected] |
| vtkWarpScalar::~vtkWarpScalar | ( | ) | [protected] |
Member Function Documentation
| static vtkWarpScalar* vtkWarpScalar::New | ( | ) | [static] |
Create an object with Debug turned off, modified time initialized to zero, and reference counting on.
Reimplemented from vtkPointSetAlgorithm.
| virtual const char* vtkWarpScalar::GetClassName | ( | ) | [virtual] |
Reimplemented from vtkPointSetAlgorithm.
| static int vtkWarpScalar::IsTypeOf | ( | const char * | name | ) | [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 vtkTypeRevisionMacro found in vtkSetGet.h.
Reimplemented from vtkPointSetAlgorithm.
| virtual int vtkWarpScalar::IsA | ( | const char * | name | ) | [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 vtkTypeRevisionMacro found in vtkSetGet.h.
Reimplemented from vtkPointSetAlgorithm.
| static vtkWarpScalar* vtkWarpScalar::SafeDownCast | ( | vtkObject * | o | ) | [static] |
Reimplemented from vtkPointSetAlgorithm.
| 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 vtkPointSetAlgorithm.
| 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::RequestData | ( | vtkInformation * | , | |
| vtkInformationVector ** | , | |||
| vtkInformationVector * | ||||
| ) | [protected, virtual] |
This is called by the superclass. This is the method you should override.
Reimplemented from vtkPointSetAlgorithm.
| 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 94 of file vtkWarpScalar.h.
int vtkWarpScalar::UseNormal [protected] |
Definition at line 95 of file vtkWarpScalar.h.
double vtkWarpScalar::Normal[3] [protected] |
Definition at line 96 of file vtkWarpScalar.h.
int vtkWarpScalar::XYPlane [protected] |
Definition at line 97 of file vtkWarpScalar.h.
double*(vtkWarpScalar::* vtkWarpScalar::PointNormal)(vtkIdType id, vtkDataArray *normals) [protected] |
The documentation for this class was generated from the following file:
- dox/Graphics/vtkWarpScalar.h
