FreeMat

- Main Page
- Related Pages

vtkTextureMapToPlane

Section: Visualization Toolkit Graphics Classes

# Usage

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.

To create an instance of class vtkTextureMapToPlane, simply invoke its constructor as follows

      obj = vtkTextureMapToPlane

# Methods

The class vtkTextureMapToPlane has several methods that can be used. They are listed below. Note that the documentation is translated automatically from the VTK sources, and may not be completely intelligible. When in doubt, consult the VTK website. In the methods listed below, `obj` is an instance of the vtkTextureMapToPlane class.

- `string = obj.GetClassName ()`
- `int = obj.IsA (string name)`
- `vtkTextureMapToPlane = obj.NewInstance ()`
- `vtkTextureMapToPlane = obj.SafeDownCast (vtkObject o)`
- `obj.SetOrigin (double , double , double )` - Specify a point defining the origin of the plane. Used in conjunction with the Point1 and Point2 ivars to specify a map plane.
- `obj.SetOrigin (double a[3])` - Specify a point defining the origin of the plane. Used in conjunction with the Point1 and Point2 ivars to specify a map plane.
- `double = obj. GetOrigin ()` - Specify a point defining the origin of the plane. Used in conjunction with the Point1 and Point2 ivars to specify a map plane.
- `obj.SetPoint1 (double , double , double )` - Specify a point defining the first axis of the plane.
- `obj.SetPoint1 (double a[3])` - Specify a point defining the first axis of the plane.
- `double = obj. GetPoint1 ()` - Specify a point defining the first axis of the plane.
- `obj.SetPoint2 (double , double , double )` - Specify a point defining the second axis of the plane.
- `obj.SetPoint2 (double a[3])` - Specify a point defining the second axis of the plane.
- `double = obj. GetPoint2 ()` - Specify a point defining the second axis of the plane.
- `obj.SetNormal (double , double , double )` - 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.
- `obj.SetNormal (double a[3])` - 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.
- `double = obj. GetNormal ()` - 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.
- `obj.SetSRange (double , double )` - Specify s-coordinate range for texture s-t coordinate pair.
- `obj.SetSRange (double a[2])` - Specify s-coordinate range for texture s-t coordinate pair.
- `double = obj. GetSRange ()` - Specify s-coordinate range for texture s-t coordinate pair.
- `obj.SetTRange (double , double )` - Specify t-coordinate range for texture s-t coordinate pair.
- `obj.SetTRange (double a[2])` - Specify t-coordinate range for texture s-t coordinate pair.
- `double = obj. GetTRange ()` - Specify t-coordinate range for texture s-t coordinate pair.
- `obj.SetAutomaticPlaneGeneration (int )` - Turn on/off automatic plane generation.
- `int = obj.GetAutomaticPlaneGeneration ()` - Turn on/off automatic plane generation.
- `obj.AutomaticPlaneGenerationOn ()` - Turn on/off automatic plane generation.
- `obj.AutomaticPlaneGenerationOff ()` - Turn on/off automatic plane generation.