vtkTextureMapToCylinder Class Reference

#include <vtkTextureMapToCylinder.h>

Inheritance diagram for vtkTextureMapToCylinder:

[legend]

Collaboration diagram for vtkTextureMapToCylinder:

[legend]

List of all members.

Detailed Description

generate texture coordinates by mapping points to cylinder

vtkTextureMapToCylinder is a filter that generates 2D texture coordinates by mapping input dataset points onto a cylinder. The cylinder can either be user specified or generated automatically. (The cylinder is generated automatically by computing the axis of the cylinder.) Note that the generated texture coordinates for the s-coordinate ranges from (0-1) (corresponding to angle of 0->360 around axis), while the mapping of the t-coordinate is controlled by the projection of points along the axis.

To specify a cylinder manually, you must provide two points that define the axis of the cylinder. The length of the axis will affect the t-coordinates.

A special ivar controls how the s-coordinate is generated. If PreventSeam is set to true, the s-texture varies from 0->1 and then 1->0 (corresponding to angles of 0->180 and 180->360).

Warning:: Since the resulting texture s-coordinate will lie between (0,1), and the origin of the texture coordinates is not user-controllable, you may want to use the class vtkTransformTexture to linearly scale and shift the origin of the texture coordinates.

See also:: vtkTextureMapToPlane vtkTextureMapToSphere vtkTextureMapToBox vtkTransformTexture vtkThresholdTextureCoords

Examples:: vtkTextureMapToCylinder (Examples)

Tests:: vtkTextureMapToCylinder (Tests)

Definition at line 56 of file vtkTextureMapToCylinder.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	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	SetAutomaticCylinderGeneration (int)
virtual int	GetAutomaticCylinderGeneration ()
virtual void	AutomaticCylinderGenerationOn ()
virtual void	AutomaticCylinderGenerationOff ()

virtual void	SetPreventSeam (int)
virtual int	GetPreventSeam ()
virtual void	PreventSeamOn ()
virtual void	PreventSeamOff ()
Static Public Member Functions
static int	IsTypeOf (const char *type)
static vtkTextureMapToCylinder *	SafeDownCast (vtkObject *o)
static vtkTextureMapToCylinder *	New ()
Protected Member Functions
	vtkTextureMapToCylinder ()
	~vtkTextureMapToCylinder ()
int	RequestData (vtkInformation , vtkInformationVector , vtkInformationVector )
Protected Attributes
double	Point1 [3]
double	Point2 [3]
int	AutomaticCylinderGeneration
int	PreventSeam

Member Typedef Documentation

typedef vtkDataSetAlgorithm vtkTextureMapToCylinder::Superclass

Reimplemented from vtkDataSetAlgorithm.

Definition at line 59 of file vtkTextureMapToCylinder.h.

Constructor & Destructor Documentation

vtkTextureMapToCylinder::vtkTextureMapToCylinder ( ) [protected]

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

Definition at line 99 of file vtkTextureMapToCylinder.h.

Member Function Documentation

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

Reimplemented from vtkDataSetAlgorithm.

static int vtkTextureMapToCylinder::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 vtkDataSetAlgorithm.

virtual int vtkTextureMapToCylinder::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 vtkDataSetAlgorithm.

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

Reimplemented from vtkDataSetAlgorithm.

void vtkTextureMapToCylinder::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 vtkTextureMapToCylinder* vtkTextureMapToCylinder::New ( ) [static]

Create object with cylinder axis parallel to z-axis (points (0,0,-0.5) and (0,0,0.5)). The PreventSeam ivar is set to true. The cylinder is automatically generated.

Reimplemented from vtkDataSetAlgorithm.

virtual void vtkTextureMapToCylinder::SetPoint1	(	double	,
		double	,
		double
	)			`[virtual]`

Specify the first point defining the cylinder axis,

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

Specify the first point defining the cylinder axis,

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

Specify the first point defining the cylinder axis,

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

Specify the first point defining the cylinder axis,

virtual void vtkTextureMapToCylinder::SetPoint2	(	double	,
		double	,
		double
	)			`[virtual]`

Specify the second point defining the cylinder axis,

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

Specify the second point defining the cylinder axis,

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

Specify the second point defining the cylinder axis,

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

Specify the second point defining the cylinder axis,

virtual void vtkTextureMapToCylinder::SetAutomaticCylinderGeneration ( int ) [virtual]

Turn on/off automatic cylinder generation. This means it automatically finds the cylinder center and axis.

virtual int vtkTextureMapToCylinder::GetAutomaticCylinderGeneration ( ) [virtual]

Turn on/off automatic cylinder generation. This means it automatically finds the cylinder center and axis.

virtual void vtkTextureMapToCylinder::AutomaticCylinderGenerationOn ( ) [virtual]

Turn on/off automatic cylinder generation. This means it automatically finds the cylinder center and axis.

virtual void vtkTextureMapToCylinder::AutomaticCylinderGenerationOff ( ) [virtual]

Turn on/off automatic cylinder generation. This means it automatically finds the cylinder center and axis.

virtual void vtkTextureMapToCylinder::SetPreventSeam ( int ) [virtual]

Control how the texture coordinates are generated. If PreventSeam is set, the s-coordinate ranges from 0->1 and 1->0 corresponding to the angle variation from 0->180 and 180->0. Otherwise, the s-coordinate ranges from 0->1 from 0->360 degrees.

virtual int vtkTextureMapToCylinder::GetPreventSeam ( ) [virtual]

Control how the texture coordinates are generated. If PreventSeam is set, the s-coordinate ranges from 0->1 and 1->0 corresponding to the angle variation from 0->180 and 180->0. Otherwise, the s-coordinate ranges from 0->1 from 0->360 degrees.

virtual void vtkTextureMapToCylinder::PreventSeamOn ( ) [virtual]

Control how the texture coordinates are generated. If PreventSeam is set, the s-coordinate ranges from 0->1 and 1->0 corresponding to the angle variation from 0->180 and 180->0. Otherwise, the s-coordinate ranges from 0->1 from 0->360 degrees.

virtual void vtkTextureMapToCylinder::PreventSeamOff ( ) [virtual]

Control how the texture coordinates are generated. If PreventSeam is set, the s-coordinate ranges from 0->1 and 1->0 corresponding to the angle variation from 0->180 and 180->0. Otherwise, the s-coordinate ranges from 0->1 from 0->360 degrees.

int vtkTextureMapToCylinder::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.