Documentation for vtkPlane

vtkPlane - perform various plane computations

Description:

vtkPlane provides methods for various plane computations. These include projecting points onto a plane, evaluating the plane equation, and returning plane normal. vtkPlane is a concrete implementation of the abstract class vtkImplicitFunction.

Methods:

	static vtkPlane *New ()
	const char *GetClassName ()
	void PrintSelf (unknown & ,vtkIndent )
	void vtkPlane ()
	float EvaluateFunction (float )
	void EvaluateGradient (float ,float )
	void SetNormal (float ,float ,float )
	void SetNormal (float *)
	float *GetNormal ()
	void SetOrigin (float ,float ,float )
	void SetOrigin (float *)
	float *GetOrigin ()
	static void ProjectPoint (float ,float ,float ,float )
	static float Evaluate (float ,float ,float )
	static float DistanceToPlane (float ,float ,float )
	static int IntersectWithLine (float ,float ,float ,float ,float & ,float )

Detailed Method Descriptions:

Set/get plane normal. Plane is defined by point and normal.

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

Set/get point through which plane passes. Plane is defined by point and normal.

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

Quick evaluation of plane equation n(x-origin)=0.

static float Evaluate (float ,float ,float )

Return the distance of a point x to a plane defined by n(x-p0) = 0. The normal n[3] must be magnitude=1.

static float DistanceToPlane (float ,float ,float )

Given a line defined by the two points p1,p2; and a plane defined by the normal n and point p0, compute an intersection. The parametric coordinate along the line is returned in t, and the coordinates of intersection are returned in x. A zero is returned if the plane and line are parallel.

static int IntersectWithLine (float ,float ,float ,float ,float & ,float )