Documentation for vtkPlaneSource

vtkPlaneSource - create an array of quadrilaterals located in a plane

Description:

vtkPlaneSource creates an m x n array of quadrilaterals arranged as a regular tiling in a plane. The plane is defined by specifying an origin point, and then two other points that, together with the origin, define two axes for the plane. These axes do not have to be orthogonal - so you can create a parallelogram. (The axes must not be parallel.) By default, the plane is centered at the origin and perpendicular to the z-axis, with width and height of length 1. The resolution of the plane (i.e., number of subdivisions) is controlled by the ivars XResolution and YResolution. There are three conveience methods that allow you to easily move the plane. The first, SetNormal(), allows you to specify the plane normal. The effect of this method is to rotate the plane around the center of the plane, aligning the plane normal with the specified normal. The second, SetCenter(), translates the center of the plane to the specified center point. The third method, Push(), allows you to translate the plane along the plane normal by the distance specified. (Negative Push values translate the plane in the negative normal direction.) Note that the SetNormal(), SetCenter() and Push() methods modify the Origin, Point1, and/or Point2 ivars.

Caveats:

The normal to the plane will point in the direction of the cross product of the first axis (Origin->Point1) with the second (Origin->Point2). This also affects the normals to the generated polygons.

Methods:

	void vtkPlaneSource ()
	void PrintSelf (unknown & ,vtkIndent )
	const char *GetClassName ()
	static vtkPlaneSource *New ()
	void SetXResolution (int )
	int GetXResolution ()
	void SetYResolution (int )
	int GetYResolution ()
	void SetResolution (const int ,const int )
	void GetResolution (int & ,int &)
	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 SetCenter (float ,float ,float )
	void SetCenter (float )
	float *GetCenter ()
	void SetNormal (float ,float ,float )
	void SetNormal (float )
	float *GetNormal ()
	void Push (float )
	void Execute ()
	int UpdatePlane (float ,float )

Detailed Method Descriptions:

Construct plane perpendicular to z-axis, resolution 1x1, width and height 1.0, and centered at the origin.

static vtkPlaneSource *New ()

Specify the resolution of the plane along the first axes.

	void SetXResolution (int )
	int GetXResolution ()

Specify the resolution of the plane along the second axes.

	void SetYResolution (int )
	int GetYResolution ()

Set the number of x-y subdivisions in the plane.

	void SetResolution (const int ,const int )
	void GetResolution (int & ,int &)

Specify a point defining the origin of the 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 ()

Set/Get the center of the plane. Works in conjunction with the plane normal to position the plane. Don't use this method to define the plane. Instead, use it to move the plane to a new center point.

	void SetCenter (float ,float ,float )
	void SetCenter (float )
	float *GetCenter ()

Set/Get the plane normal. Works in conjunction with the plane center to orient the plane. Don't use this method to define the plane. Instead, use it to rotate the plane around the current center point.

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

Translate the plane in the direction of the normal by the distance specified. Negative values move the plane in the opposite direction.

void Push (float )