vtkPlane Class Reference

#include <vtkPlane.h>

Inheritance diagram for vtkPlane:

[legend]Collaboration diagram for vtkPlane:

[legend]List of all members.

Detailed Description

perform various plane computations

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.

Created by:

Schroeder, Will

CVS contributions (if > 5%):

Schroeder, Will (45%)
Miller, Jim (23%)
Martin, Ken (22%)
Kelly, Ann (5%)

CVS logs (CVSweb):

.cxx (/Common/vtkPlane.cxx)
.h (/Common/vtkPlane.h)

Examples:: vtkPlane (Examples)

Tests:: vtkPlane (Tests)

Definition at line 48 of file vtkPlane.h.

Public Types

typedef vtkImplicitFunction Superclass

Public Member Functions

virtual const char * GetClassName ()

virtual int IsA (const char *type)

void PrintSelf (ostream &os, vtkIndent indent)

void EvaluateGradient (double x[3], double g[3])

void Push (double distance)

double EvaluateFunction (double x[3])

double EvaluateFunction (double x, double y, double z)

virtual void SetNormal (double, double, double)

virtual void SetNormal (double[3])

virtual double * GetNormal ()

virtual void GetNormal (double data[3])

virtual void SetOrigin (double, double, double)

virtual void SetOrigin (double[3])

virtual double * GetOrigin ()

virtual void GetOrigin (double data[3])

Static Public Member Functions

vtkPlane * New ()

int IsTypeOf (const char *type)

vtkPlane * SafeDownCast (vtkObject *o)

double Evaluate (double normal[3], double origin[3], double x[3])

double DistanceToPlane (double x[3], double n[3], double p0[3])

void ProjectPoint (double x[3], double origin[3], double normal[3], double xproj[3])

void GeneralizedProjectPoint (double x[3], double origin[3], double normal[3], double xproj[3])

int IntersectWithLine (double p1[3], double p2[3], double n[3], double p0[3], double &t, double x[3])

Protected Member Functions

vtkPlane ()

~vtkPlane ()

Protected Attributes

double Normal [3]

double Origin [3]

Member Typedef Documentation

typedef vtkImplicitFunction vtkPlane::Superclass

Reimplemented from vtkImplicitFunction.
Definition at line 54 of file vtkPlane.h.

Constructor & Destructor Documentation

vtkPlane::vtkPlane ( ) [protected]

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

Definition at line 121 of file vtkPlane.h.

Member Function Documentation

vtkPlane* vtkPlane::New ( ) [static]

Construct plane passing through origin and normal to z-axis.
Reimplemented from vtkObject.

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

Reimplemented from vtkImplicitFunction.

int vtkPlane::IsTypeOf ( const char * type ) [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 vtkImplicitFunction.

virtual int vtkPlane::IsA ( const char * type ) [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 vtkImplicitFunction.

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

Reimplemented from vtkImplicitFunction.

void vtkPlane::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 vtkImplicitFunction.

double vtkPlane::EvaluateFunction ( double x[3] ) [virtual]

Evaluate plane equation for point x[3].
Implements vtkImplicitFunction.

double vtkPlane::EvaluateFunction ( double x,

double y,

double z

) [inline]

Evaluate plane equation for point x[3].
Reimplemented from vtkImplicitFunction.
Definition at line 60 of file vtkPlane.h.
References vtkImplicitFunction::EvaluateFunction().

void vtkPlane::EvaluateGradient ( double x[3],

double g[3]

) [virtual]

Evaluate function gradient at point x[3].
Implements vtkImplicitFunction.

virtual void vtkPlane::SetNormal ( double ,

double ,

double

) [virtual]

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

virtual void vtkPlane::SetNormal ( double [3] ) [virtual]

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

virtual double* vtkPlane::GetNormal ( ) [virtual]

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

virtual void vtkPlane::GetNormal ( double data[3] ) [virtual]

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

virtual void vtkPlane::SetOrigin ( double ,

double ,

double

) [virtual]

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

virtual void vtkPlane::SetOrigin ( double [3] ) [virtual]

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

virtual double* vtkPlane::GetOrigin ( ) [virtual]

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

virtual void vtkPlane::GetOrigin ( double data[3] ) [virtual]

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

void vtkPlane::Push ( double distance )

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

void vtkPlane::ProjectPoint ( double x[3],

double origin[3],

double normal[3],

double xproj[3]

) [static]

Project a point x onto plane defined by origin and normal. The projected point is returned in xproj. NOTE : normal assumed to have magnitude 1.

void vtkPlane::GeneralizedProjectPoint ( double x[3],

double origin[3],

double normal[3],

double xproj[3]

) [static]

Project a point x onto plane defined by origin and normal. The projected point is returned in xproj. NOTE : normal does NOT have to have magnitude 1.

double vtkPlane::Evaluate ( double normal[3],

double origin[3],

double x[3]

) [inline, static]

Quick evaluation of plane equation n(x-origin)=0.
Definition at line 131 of file vtkPlane.h.

double vtkPlane::DistanceToPlane ( double x[3],

double n[3],

double p0[3]

) [inline, static]

Return the distance of a point x to a plane defined by n(x-p0) = 0. The normal n[3] must be magnitude=1.
Definition at line 138 of file vtkPlane.h.
References vtkPlaneAbs.

int vtkPlane::IntersectWithLine ( double p1[3],

double p2[3],

double n[3],

double p0[3],

double & t,

double x[3]

) [static]

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 do not intersect between (0<=t<=1). If the plane and line are parallel, zero is returned and t is set to VTK_LARGE_DOUBLE.

Member Data Documentation

double vtkPlane::Normal[3] [protected]

Definition at line 123 of file vtkPlane.h.

double vtkPlane::Origin[3] [protected]

Definition at line 124 of file vtkPlane.h.

The documentation for this class was generated from the following file:

dox/Common/vtkPlane.h


Public Types
typedef vtkImplicitFunction	Superclass
Public Member Functions
virtual const char *	GetClassName ()
virtual int	IsA (const char *type)
void	PrintSelf (ostream &os, vtkIndent indent)
void	EvaluateGradient (double x[3], double g[3])
void	Push (double distance)

double	EvaluateFunction (double x[3])
double	EvaluateFunction (double x, double y, double z)

virtual void	SetNormal (double, double, double)
virtual void	SetNormal (double[3])
virtual double *	GetNormal ()
virtual void	GetNormal (double data[3])

virtual void	SetOrigin (double, double, double)
virtual void	SetOrigin (double[3])
virtual double *	GetOrigin ()
virtual void	GetOrigin (double data[3])
Static Public Member Functions
vtkPlane *	New ()
int	IsTypeOf (const char *type)
vtkPlane *	SafeDownCast (vtkObject *o)
double	Evaluate (double normal[3], double origin[3], double x[3])
double	DistanceToPlane (double x[3], double n[3], double p0[3])

void	ProjectPoint (double x[3], double origin[3], double normal[3], double xproj[3])

void	GeneralizedProjectPoint (double x[3], double origin[3], double normal[3], double xproj[3])

int	IntersectWithLine (double p1[3], double p2[3], double n[3], double p0[3], double &t, double x[3])
Protected Member Functions
	vtkPlane ()
	~vtkPlane ()
Protected Attributes
double	Normal [3]
double	Origin [3]