Documentation for vtkTextureMapToPlane

vtkTextureMapToPlane - generate texture coordinates by mapping points to plane

Description:

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:

vtkTextureMapToBox vtkPlaneSource vtkTextureMapToCylinder vtkTextureMapToSphere vtkThresholdTextureCoords

Methods:

	void vtkTextureMapToPlane ()
	const char *GetClassName ()
	void PrintSelf (unknown & ,vtkIndent )
	static vtkTextureMapToPlane *New ()
	void SetOrigin (float ,float ,float )
	void SetOrigin (float *)
	float *GetOrigin ()
	void SetPoint1 (float ,float ,float )
	void SetPoint1 (float *)
	float *GetPoint1 ()
	void SetPoint2 (float ,float ,float )
	void SetPoint2 (float *)
	float *GetPoint2 ()
	void SetNormal (float ,float ,float )
	void SetNormal (float *)
	float *GetNormal ()
	void SetSRange (float ,float )
	void SetSRange (float *)
	float *GetSRange ()
	void SetTRange (float ,float )
	void SetTRange (float *)
	float *GetTRange ()
	void SetAutomaticPlaneGeneration (int )
	int GetAutomaticPlaneGeneration ()
	void AutomaticPlaneGenerationOn ()
	void AutomaticPlaneGenerationOff ()
	void Execute ()
	void ComputeNormal ()

Detailed Method Descriptions:

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

static vtkTextureMapToPlane *New ()

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

	void SetOrigin (float ,float ,float )
	void SetOrigin (float *)
	float *GetOrigin ()

Specify a point defining the first axis of the plane.

	void SetPoint1 (float ,float ,float )
	void SetPoint1 (float *)
	float *GetPoint1 ()

Specify a point defining the second axis of the plane.

	void SetPoint2 (float ,float ,float )
	void SetPoint2 (float *)
	float *GetPoint2 ()

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.

	void SetNormal (float ,float ,float )
	void SetNormal (float *)
	float *GetNormal ()

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

	void SetSRange (float ,float )
	void SetSRange (float *)
	float *GetSRange ()

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

	void SetTRange (float ,float )
	void SetTRange (float *)
	float *GetTRange ()

Turn on/off automatic plane generation.

	void SetAutomaticPlaneGeneration (int )
	int GetAutomaticPlaneGeneration ()
	void AutomaticPlaneGenerationOn ()
	void AutomaticPlaneGenerationOff ()