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>

Inheritance diagram for vtkWarpScalar:
[legend]
Collaboration diagram for vtkWarpScalar:
[legend]

Public Types

typedef vtkPointSetAlgorithm Superclass
 
- Public Types inherited from vtkPointSetAlgorithm
typedef vtkAlgorithm Superclass
 
- Public Types inherited from vtkAlgorithm
typedef vtkObject Superclass
 
enum  DesiredOutputPrecision { SINGLE_PRECISION, DOUBLE_PRECISION, DEFAULT_PRECISION }
 

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 ()
 
- Public Member Functions inherited from vtkPointSetAlgorithm
vtkPointSetAlgorithmNewInstance () const
 
void PrintSelf (ostream &os, vtkIndent indent)
 
vtkPolyDataGetPolyDataOutput ()
 
vtkStructuredGridGetStructuredGridOutput ()
 
vtkUnstructuredGrid * GetUnstructuredGridOutput ()
 
vtkDataObjectGetInput ()
 
vtkPointSet * GetOutput ()
 
vtkPointSet * GetOutput (int)
 
void SetInputData (vtkDataObject *)
 
void SetInputData (int, vtkDataObject *)
 
void SetInputData (vtkPointSet *)
 
void SetInputData (int, vtkPointSet *)
 
void AddInputData (vtkDataObject *)
 
void AddInputData (vtkPointSet *)
 
void AddInputData (int, vtkPointSet *)
 
void AddInputData (int, vtkDataObject *)
 
virtual int ProcessRequest (vtkInformation *request, vtkInformationVector **inputVector, vtkInformationVector *outputVector)
 
- Public Member Functions inherited from vtkAlgorithm
vtkAlgorithmNewInstance () const
 
void PrintSelf (ostream &os, vtkIndent indent)
 
int HasExecutive ()
 
vtkExecutiveGetExecutive ()
 
virtual void SetExecutive (vtkExecutive *executive)
 
virtual int ModifyRequest (vtkInformation *request, int when)
 
vtkInformation * GetInputPortInformation (int port)
 
vtkInformation * GetOutputPortInformation (int port)
 
int GetNumberOfInputPorts ()
 
int GetNumberOfOutputPorts ()
 
void UpdateProgress (double amount)
 
vtkInformation * GetInputArrayInformation (int idx)
 
void RemoveAllInputs ()
 
vtkDataObjectGetOutputDataObject (int port)
 
virtual void RemoveInputConnection (int port, vtkAlgorithmOutput *input)
 
virtual void RemoveInputConnection (int port, int idx)
 
virtual void RemoveAllInputConnections (int port)
 
int GetNumberOfInputConnections (int port)
 
int GetTotalNumberOfInputConnections ()
 
vtkAlgorithmOutputGetInputConnection (int port, int index)
 
vtkAlgorithmGetInputAlgorithm (int port, int index, int &algPort)
 
vtkAlgorithmGetInputAlgorithm (int port, int index)
 
vtkExecutiveGetInputExecutive (int port, int index)
 
vtkInformation * GetInputInformation (int port, int index)
 
vtkInformation * GetOutputInformation (int port)
 
virtual void UpdateInformation ()
 
virtual void PropagateUpdateExtent ()
 
virtual void UpdateWholeExtent ()
 
void ConvertTotalInputToPortConnection (int ind, int &port, int &conn)
 
virtual double ComputePriority ()
 
int SetUpdateExtentToWholeExtent (int port)
 
int SetUpdateExtentToWholeExtent ()
 
void SetUpdateExtent (int port, int extent[6])
 
int ProcessRequest (vtkInformation *request, vtkCollection *inInfo, vtkInformationVector *outInfo)
 
virtual int ComputePipelineMTime (vtkInformation *request, vtkInformationVector **inInfoVec, vtkInformationVector *outInfoVec, int requestFromOutputPort, unsigned long *mtime)
 
virtual vtkInformation * GetInformation ()
 
virtual void SetInformation (vtkInformation *)
 
virtual void Register (vtkObjectBase *o)
 
virtual void UnRegister (vtkObjectBase *o)
 
virtual void SetAbortExecute (int)
 
virtual int GetAbortExecute ()
 
virtual void AbortExecuteOn ()
 
virtual void AbortExecuteOff ()
 
virtual void SetProgress (double)
 
virtual double GetProgress ()
 
void SetProgressText (const char *ptext)
 
virtual char * GetProgressText ()
 
virtual unsigned long GetErrorCode ()
 
virtual void SetInputArrayToProcess (int idx, int port, int connection, int fieldAssociation, const char *name)
 
virtual void SetInputArrayToProcess (int idx, int port, int connection, int fieldAssociation, int fieldAttributeType)
 
virtual void SetInputArrayToProcess (int idx, vtkInformation *info)
 
virtual void SetInputArrayToProcess (int idx, int port, int connection, const char *fieldAssociation, const char *attributeTypeorName)
 
vtkDataObjectGetInputDataObject (int port, int connection)
 
virtual void SetInputConnection (int port, vtkAlgorithmOutput *input)
 
virtual void SetInputConnection (vtkAlgorithmOutput *input)
 
virtual void AddInputConnection (int port, vtkAlgorithmOutput *input)
 
virtual void AddInputConnection (vtkAlgorithmOutput *input)
 
virtual void SetInputDataObject (int port, vtkDataObject *data)
 
virtual void SetInputDataObject (vtkDataObject *data)
 
virtual void AddInputDataObject (int port, vtkDataObject *data)
 
virtual void AddInputDataObject (vtkDataObject *data)
 
vtkAlgorithmOutputGetOutputPort (int index)
 
vtkAlgorithmOutputGetOutputPort ()
 
vtkAlgorithmGetInputAlgorithm ()
 
vtkExecutiveGetInputExecutive ()
 
vtkInformation * GetInputInformation ()
 
virtual void Update (int port)
 
virtual void Update ()
 
virtual void SetReleaseDataFlag (int)
 
virtual int GetReleaseDataFlag ()
 
void ReleaseDataFlagOn ()
 
void ReleaseDataFlagOff ()
 
int UpdateExtentIsEmpty (vtkInformation *pinfo, vtkDataObject *output)
 
int UpdateExtentIsEmpty (vtkInformation *pinfo, int extentType)
 
void SetUpdateExtent (int port, int piece, int numPieces, int ghostLevel)
 
void SetUpdateExtent (int piece, int numPieces, int ghostLevel)
 
void SetUpdateExtent (int extent[6])
 
int * GetUpdateExtent ()
 
int * GetUpdateExtent (int port)
 
void GetUpdateExtent (int &x0, int &x1, int &y0, int &y1, int &z0, int &z1)
 
void GetUpdateExtent (int port, int &x0, int &x1, int &y0, int &y1, int &z0, int &z1)
 
void GetUpdateExtent (int extent[6])
 
void GetUpdateExtent (int port, int extent[6])
 
int GetUpdatePiece ()
 
int GetUpdatePiece (int port)
 
int GetUpdateNumberOfPieces ()
 
int GetUpdateNumberOfPieces (int port)
 
int GetUpdateGhostLevel ()
 
int GetUpdateGhostLevel (int port)
 

Static Public Member Functions

static vtkWarpScalarNew ()
 
static int IsTypeOf (const char *type)
 
static vtkWarpScalarSafeDownCast (vtkObjectBase *o)
 
- Static Public Member Functions inherited from vtkPointSetAlgorithm
static vtkPointSetAlgorithmNew ()
 
static int IsTypeOf (const char *type)
 
static vtkPointSetAlgorithmSafeDownCast (vtkObjectBase *o)
 
- Static Public Member Functions inherited from vtkAlgorithm
static vtkAlgorithmNew ()
 
static int IsTypeOf (const char *type)
 
static vtkAlgorithmSafeDownCast (vtkObjectBase *o)
 
static void SetDefaultExecutivePrototype (vtkExecutive *proto)
 
static vtkInformationIntegerKey * INPUT_IS_OPTIONAL ()
 
static vtkInformationIntegerKey * INPUT_IS_REPEATABLE ()
 
static
vtkInformationInformationVectorKey * 
INPUT_REQUIRED_FIELDS ()
 
static
vtkInformationStringVectorKey * 
INPUT_REQUIRED_DATA_TYPE ()
 
static
vtkInformationInformationVectorKey * 
INPUT_ARRAYS_TO_PROCESS ()
 
static vtkInformationIntegerKey * INPUT_PORT ()
 
static vtkInformationIntegerKey * INPUT_CONNECTION ()
 
static vtkInformationIntegerKey * PRESERVES_DATASET ()
 
static vtkInformationIntegerKey * PRESERVES_GEOMETRY ()
 
static vtkInformationIntegerKey * PRESERVES_BOUNDS ()
 
static vtkInformationIntegerKey * PRESERVES_TOPOLOGY ()
 
static vtkInformationIntegerKey * PRESERVES_ATTRIBUTES ()
 
static vtkInformationIntegerKey * PRESERVES_RANGES ()
 
static vtkInformationIntegerKey * MANAGES_METAINFORMATION ()
 

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 Member Functions inherited from vtkPointSetAlgorithm
 vtkPointSetAlgorithm ()
 
 ~vtkPointSetAlgorithm ()
 
virtual int FillOutputPortInformation (int port, vtkInformation *info)
 
virtual int ExecuteInformation (vtkInformation *, vtkInformationVector **, vtkInformationVector *)
 
virtual int ComputeInputUpdateExtent (vtkInformation *, vtkInformationVector **, vtkInformationVector *)
 
- Protected Member Functions inherited from vtkAlgorithm
 vtkAlgorithm ()
 
 ~vtkAlgorithm ()
 
virtual void SetNumberOfInputPorts (int n)
 
virtual void SetNumberOfOutputPorts (int n)
 
int InputPortIndexInRange (int index, const char *action)
 
int OutputPortIndexInRange (int index, const char *action)
 
int GetInputArrayAssociation (int idx, vtkInformationVector **inputVector)
 
virtual vtkExecutiveCreateDefaultExecutive ()
 
virtual void ReportReferences (vtkGarbageCollector *)
 
virtual void SetNumberOfInputConnections (int port, int n)
 
int GetInputArrayAssociation (int idx, int connection, vtkInformationVector **inputVector)
 
int GetInputArrayAssociation (int idx, vtkDataObject *input)
 
vtkDataArray * GetInputArrayToProcess (int idx, vtkInformationVector **inputVector)
 
vtkDataArray * GetInputArrayToProcess (int idx, vtkInformationVector **inputVector, int &association)
 
vtkDataArray * GetInputArrayToProcess (int idx, int connection, vtkInformationVector **inputVector)
 
vtkDataArray * GetInputArrayToProcess (int idx, int connection, vtkInformationVector **inputVector, int &association)
 
vtkDataArray * GetInputArrayToProcess (int idx, vtkDataObject *input)
 
vtkDataArray * GetInputArrayToProcess (int idx, vtkDataObject *input, int &association)
 
vtkAbstractArray * GetInputAbstractArrayToProcess (int idx, vtkInformationVector **inputVector)
 
vtkAbstractArray * GetInputAbstractArrayToProcess (int idx, vtkInformationVector **inputVector, int &association)
 
vtkAbstractArray * GetInputAbstractArrayToProcess (int idx, int connection, vtkInformationVector **inputVector)
 
vtkAbstractArray * GetInputAbstractArrayToProcess (int idx, int connection, vtkInformationVector **inputVector, int &association)
 
vtkAbstractArray * GetInputAbstractArrayToProcess (int idx, vtkDataObject *input)
 
vtkAbstractArray * GetInputAbstractArrayToProcess (int idx, vtkDataObject *input, int &association)
 
vtkInformation * GetInputArrayFieldInformation (int idx, vtkInformationVector **inputVector)
 
virtual void SetNthInputConnection (int port, int index, vtkAlgorithmOutput *input)
 
void SetInputDataInternal (int port, vtkDataObject *input)
 
void AddInputDataInternal (int port, vtkDataObject *input)
 
virtual void SetErrorCode (unsigned long)
 

Protected Attributes

double ScaleFactor
 
int UseNormal
 
double Normal [3]
 
int XYPlane
 
double *(vtkWarpScalar::* PointNormal )(vtkIdType id, vtkDataArray *normals)
 
- Protected Attributes inherited from vtkAlgorithm
vtkInformation * Information
 
double Progress
 
char * ProgressText
 
unsigned long ErrorCode
 

Additional Inherited Members

- Public Attributes inherited from vtkAlgorithm
int AbortExecute
 
- Static Protected Member Functions inherited from vtkAlgorithm
static vtkInformationIntegerKey * PORT_REQUIREMENTS_FILLED ()
 
- Static Protected Attributes inherited from vtkAlgorithm
static vtkExecutiveDefaultExecutivePrototype
 

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

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

Reimplemented from vtkPointSetAlgorithm.

static vtkWarpScalar* vtkWarpScalar::SafeDownCast ( vtkObjectBase *  o)
static
virtual vtkObjectBase* vtkWarpScalar::NewInstanceInternal ( ) const
protectedvirtual

Reimplemented from vtkPointSetAlgorithm.

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 
)
virtual

Fill the input port information objects for this algorithm. This is invoked by the first call to GetInputPortInformation for each port so subclasses can specify what they can handle.

Reimplemented from vtkPointSetAlgorithm.

int vtkWarpScalar::RequestDataObject ( vtkInformation *  request,
vtkInformationVector **  inputVector,
vtkInformationVector *  outputVector 
)
protectedvirtual

This is called by the superclass. This is the method you should override.

Reimplemented from vtkPointSetAlgorithm.

int vtkWarpScalar::RequestData ( vtkInformation *  ,
vtkInformationVector **  ,
vtkInformationVector *   
)
protectedvirtual

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 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: