vtkTextureMapToPlane Class Reference

#include <vtkTextureMapToPlane.h>

Inheritance diagram for vtkTextureMapToPlane:

Inheritance graph
[legend]
Collaboration diagram for vtkTextureMapToPlane:

Collaboration graph
[legend]

List of all members.


Detailed Description

generate texture coordinates by mapping points to plane

vtkTextureMapToPlane is a filter that generates 2D texture coordinates by mapping input dataset points onto a plane. The plane can either be user specified or generated automatically. (A least squares method is used to generate the plane automatically.)

There are two ways you can specify the plane. The first is to provide a plane normal. In this case the points are projected to a plane, and the points are then mapped into the user specified s-t coordinate range. For more control, you can specify a plane with three points: an origin and two points defining the two axes of the plane. (This is compatible with the vtkPlaneSource.) Using the second method, the SRange and TRange vectors are ignored, since the presumption is that the user does not want to scale the texture coordinates; and you can adjust the origin and axes points to achieve the texture coordinate scaling you need. Note also that using the three point method the axes do not have to be orthogonal.

See also:
vtkPlaneSource vtkTextureMapToCylinder vtkTextureMapToSphere vtkThresholdTextureCoords
Examples:
vtkTextureMapToPlane (Examples)
Tests:
vtkTextureMapToPlane (Tests)

Definition at line 50 of file vtkTextureMapToPlane.h.


Public Types

typedef vtkDataSetAlgorithm Superclass

Public Member Functions

virtual const char * GetClassName ()
virtual int IsA (const char *type)
void PrintSelf (ostream &os, vtkIndent indent)
virtual void SetOrigin (double, double, double)
virtual void SetOrigin (double[3])
virtual double * GetOrigin ()
virtual void GetOrigin (double data[3])
virtual void SetPoint1 (double, double, double)
virtual void SetPoint1 (double[3])
virtual double * GetPoint1 ()
virtual void GetPoint1 (double data[3])
virtual void SetPoint2 (double, double, double)
virtual void SetPoint2 (double[3])
virtual double * GetPoint2 ()
virtual void GetPoint2 (double data[3])
virtual void SetNormal (double, double, double)
virtual void SetNormal (double[3])
virtual double * GetNormal ()
virtual void GetNormal (double data[3])
virtual void SetSRange (double, double)
void SetSRange (double[2])
virtual double * GetSRange ()
virtual void GetSRange (double data[2])
virtual void SetTRange (double, double)
void SetTRange (double[2])
virtual double * GetTRange ()
virtual void GetTRange (double data[2])
virtual void SetAutomaticPlaneGeneration (int)
virtual int GetAutomaticPlaneGeneration ()
virtual void AutomaticPlaneGenerationOn ()
virtual void AutomaticPlaneGenerationOff ()

Static Public Member Functions

static int IsTypeOf (const char *type)
static vtkTextureMapToPlaneSafeDownCast (vtkObject *o)
static vtkTextureMapToPlaneNew ()

Protected Member Functions

 vtkTextureMapToPlane ()
 ~vtkTextureMapToPlane ()
int RequestData (vtkInformation *, vtkInformationVector **, vtkInformationVector *)
void ComputeNormal (vtkDataSet *output)

Protected Attributes

double Origin [3]
double Point1 [3]
double Point2 [3]
double Normal [3]
double SRange [2]
double TRange [2]
int AutomaticPlaneGeneration

Member Typedef Documentation

Reimplemented from vtkDataSetAlgorithm.

Definition at line 53 of file vtkTextureMapToPlane.h.


Constructor & Destructor Documentation

vtkTextureMapToPlane::vtkTextureMapToPlane (  )  [protected]

vtkTextureMapToPlane::~vtkTextureMapToPlane (  )  [inline, protected]

Definition at line 108 of file vtkTextureMapToPlane.h.


Member Function Documentation

virtual const char* vtkTextureMapToPlane::GetClassName (  )  [virtual]

Reimplemented from vtkDataSetAlgorithm.

static int vtkTextureMapToPlane::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 vtkTypeMacro found in vtkSetGet.h.

Reimplemented from vtkDataSetAlgorithm.

virtual int vtkTextureMapToPlane::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 vtkTypeMacro found in vtkSetGet.h.

Reimplemented from vtkDataSetAlgorithm.

static vtkTextureMapToPlane* vtkTextureMapToPlane::SafeDownCast ( vtkObject o  )  [static]

Reimplemented from vtkDataSetAlgorithm.

void vtkTextureMapToPlane::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 vtkDataSetAlgorithm.

static vtkTextureMapToPlane* vtkTextureMapToPlane::New (  )  [static]

Construct with s,t range=(0,1) and automatic plane generation turned on.

Reimplemented from vtkDataSetAlgorithm.

virtual void vtkTextureMapToPlane::SetOrigin ( double  ,
double  ,
double   
) [virtual]

Specify a point defining the origin of the plane. Used in conjunction with the Point1 and Point2 ivars to specify a map plane.

virtual void vtkTextureMapToPlane::SetOrigin ( double  [3]  )  [virtual]

Specify a point defining the origin of the plane. Used in conjunction with the Point1 and Point2 ivars to specify a map plane.

virtual double* vtkTextureMapToPlane::GetOrigin (  )  [virtual]

Specify a point defining the origin of the plane. Used in conjunction with the Point1 and Point2 ivars to specify a map plane.

virtual void vtkTextureMapToPlane::GetOrigin ( double  data[3]  )  [virtual]

Specify a point defining the origin of the plane. Used in conjunction with the Point1 and Point2 ivars to specify a map plane.

virtual void vtkTextureMapToPlane::SetPoint1 ( double  ,
double  ,
double   
) [virtual]

Specify a point defining the first axis of the plane.

virtual void vtkTextureMapToPlane::SetPoint1 ( double  [3]  )  [virtual]

Specify a point defining the first axis of the plane.

virtual double* vtkTextureMapToPlane::GetPoint1 (  )  [virtual]

Specify a point defining the first axis of the plane.

virtual void vtkTextureMapToPlane::GetPoint1 ( double  data[3]  )  [virtual]

Specify a point defining the first axis of the plane.

virtual void vtkTextureMapToPlane::SetPoint2 ( double  ,
double  ,
double   
) [virtual]

Specify a point defining the second axis of the plane.

virtual void vtkTextureMapToPlane::SetPoint2 ( double  [3]  )  [virtual]

Specify a point defining the second axis of the plane.

virtual double* vtkTextureMapToPlane::GetPoint2 (  )  [virtual]

Specify a point defining the second axis of the plane.

virtual void vtkTextureMapToPlane::GetPoint2 ( double  data[3]  )  [virtual]

Specify a point defining the second axis of the plane.

virtual void vtkTextureMapToPlane::SetNormal ( double  ,
double  ,
double   
) [virtual]

Specify plane normal. An alternative way to specify a map plane. Using this method, the object will scale the resulting texture coordinate between the SRange and TRange specified.

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

Specify plane normal. An alternative way to specify a map plane. Using this method, the object will scale the resulting texture coordinate between the SRange and TRange specified.

virtual double* vtkTextureMapToPlane::GetNormal (  )  [virtual]

Specify plane normal. An alternative way to specify a map plane. Using this method, the object will scale the resulting texture coordinate between the SRange and TRange specified.

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

Specify plane normal. An alternative way to specify a map plane. Using this method, the object will scale the resulting texture coordinate between the SRange and TRange specified.

virtual void vtkTextureMapToPlane::SetSRange ( double  ,
double   
) [virtual]

Specify s-coordinate range for texture s-t coordinate pair.

void vtkTextureMapToPlane::SetSRange ( double  [2]  ) 

Specify s-coordinate range for texture s-t coordinate pair.

virtual double* vtkTextureMapToPlane::GetSRange (  )  [virtual]

Specify s-coordinate range for texture s-t coordinate pair.

virtual void vtkTextureMapToPlane::GetSRange ( double  data[2]  )  [virtual]

Specify s-coordinate range for texture s-t coordinate pair.

virtual void vtkTextureMapToPlane::SetTRange ( double  ,
double   
) [virtual]

Specify t-coordinate range for texture s-t coordinate pair.

void vtkTextureMapToPlane::SetTRange ( double  [2]  ) 

Specify t-coordinate range for texture s-t coordinate pair.

virtual double* vtkTextureMapToPlane::GetTRange (  )  [virtual]

Specify t-coordinate range for texture s-t coordinate pair.

virtual void vtkTextureMapToPlane::GetTRange ( double  data[2]  )  [virtual]

Specify t-coordinate range for texture s-t coordinate pair.

virtual void vtkTextureMapToPlane::SetAutomaticPlaneGeneration ( int   )  [virtual]

Turn on/off automatic plane generation.

virtual int vtkTextureMapToPlane::GetAutomaticPlaneGeneration (  )  [virtual]

Turn on/off automatic plane generation.

virtual void vtkTextureMapToPlane::AutomaticPlaneGenerationOn (  )  [virtual]

Turn on/off automatic plane generation.

virtual void vtkTextureMapToPlane::AutomaticPlaneGenerationOff (  )  [virtual]

Turn on/off automatic plane generation.

int vtkTextureMapToPlane::RequestData ( vtkInformation ,
vtkInformationVector **  ,
vtkInformationVector  
) [protected, virtual]

This is called within ProcessRequest when a request asks the algorithm to do its work. This is the method you should override to do whatever the algorithm is designed to do. This happens during the fourth pass in the pipeline execution process.

Reimplemented from vtkDataSetAlgorithm.

void vtkTextureMapToPlane::ComputeNormal ( vtkDataSet output  )  [protected]


Member Data Documentation

double vtkTextureMapToPlane::Origin[3] [protected]

Definition at line 113 of file vtkTextureMapToPlane.h.

double vtkTextureMapToPlane::Point1[3] [protected]

Definition at line 114 of file vtkTextureMapToPlane.h.

double vtkTextureMapToPlane::Point2[3] [protected]

Definition at line 115 of file vtkTextureMapToPlane.h.

double vtkTextureMapToPlane::Normal[3] [protected]

Definition at line 116 of file vtkTextureMapToPlane.h.

double vtkTextureMapToPlane::SRange[2] [protected]

Definition at line 117 of file vtkTextureMapToPlane.h.

double vtkTextureMapToPlane::TRange[2] [protected]

Definition at line 118 of file vtkTextureMapToPlane.h.

Definition at line 119 of file vtkTextureMapToPlane.h.


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

Generated on Mon Sep 27 18:55:39 2010 for VTK by  doxygen 1.5.6