vtkPlane Class Reference

perform various plane computations More...

#include <vtkPlane.h>

Inheritance diagram for vtkPlane:

Collaboration diagram for vtkPlane:

Public Types
typedef vtkImplicitFunction	Superclass
Public Types inherited from vtkImplicitFunction
typedef vtkObject	Superclass
Public Types inherited from vtkObject
typedef vtkObjectBase	Superclass

Public Member Functions
virtual int	IsA (const char *type)
vtkPlane *	NewInstance () const
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])
Public Member Functions inherited from vtkImplicitFunction
vtkImplicitFunction *	NewInstance () const
unsigned long	GetMTime ()
double	FunctionValue (const double x[3])
double	FunctionValue (double x, double y, double z)
void	FunctionGradient (const double x[3], double g[3])
double *	FunctionGradient (const double x[3])
double *	FunctionGradient (double x, double y, double z)
virtual void	SetTransform (vtkAbstractTransform *)
virtual void	SetTransform (const double elements[16])
virtual vtkAbstractTransform *	GetTransform ()
double	EvaluateFunction (double x, double y, double z)
Public Member Functions inherited from vtkObject
vtkObject *	NewInstance () const
virtual void	DebugOn ()
virtual void	DebugOff ()
bool	GetDebug ()
void	SetDebug (bool debugFlag)
virtual void	Modified ()
unsigned long	AddObserver (unsigned long event, vtkCommand *, float priority=0.0f)
unsigned long	AddObserver (const char *event, vtkCommand *, float priority=0.0f)
vtkCommand *	GetCommand (unsigned long tag)
void	RemoveObserver (vtkCommand *)
void	RemoveObservers (unsigned long event, vtkCommand *)
void	RemoveObservers (const char *event, vtkCommand *)
int	HasObserver (unsigned long event, vtkCommand *)
int	HasObserver (const char *event, vtkCommand *)
void	RemoveObserver (unsigned long tag)
void	RemoveObservers (unsigned long event)
void	RemoveObservers (const char *event)
void	RemoveAllObservers ()
int	HasObserver (unsigned long event)
int	HasObserver (const char *event)
template<class U , class T >
unsigned long	AddObserver (unsigned long event, U observer, void(T::*callback)(), float priority=0.0f)
template<class U , class T >
unsigned long	AddObserver (unsigned long event, U observer, void(T::*callback)(vtkObject *, unsigned long, void *), float priority=0.0f)
template<class U , class T >
unsigned long	AddObserver (unsigned long event, U observer, bool(T::*callback)(vtkObject *, unsigned long, void *), float priority=0.0f)
int	InvokeEvent (unsigned long event, void *callData)
int	InvokeEvent (const char *event, void *callData)
int	InvokeEvent (unsigned long event)
int	InvokeEvent (const char *event)
Public Member Functions inherited from vtkObjectBase
const char *	GetClassName () const
virtual void	Delete ()
virtual void	FastDelete ()
void	Print (ostream &os)
virtual void	Register (vtkObjectBase *o)
virtual void	UnRegister (vtkObjectBase *o)
void	SetReferenceCount (int)
void	PrintRevisions (ostream &)
virtual void	PrintHeader (ostream &os, vtkIndent indent)
virtual void	PrintTrailer (ostream &os, vtkIndent indent)
int	GetReferenceCount ()

Static Public Member Functions
static vtkPlane *	New ()
static int	IsTypeOf (const char *type)
static vtkPlane *	SafeDownCast (vtkObjectBase *o)
static double	Evaluate (double normal[3], double origin[3], double x[3])
Static Public Member Functions inherited from vtkImplicitFunction
static int	IsTypeOf (const char *type)
static vtkImplicitFunction *	SafeDownCast (vtkObjectBase *o)
Static Public Member Functions inherited from vtkObject
static int	IsTypeOf (const char *type)
static vtkObject *	SafeDownCast (vtkObjectBase *o)
static vtkObject *	New ()
static void	BreakOnError ()
static void	SetGlobalWarningDisplay (int val)
static void	GlobalWarningDisplayOn ()
static void	GlobalWarningDisplayOff ()
static int	GetGlobalWarningDisplay ()
Static Public Member Functions inherited from vtkObjectBase
static int	IsTypeOf (const char *name)
static vtkObjectBase *	New ()

Protected Member Functions
virtual vtkObjectBase *	NewInstanceInternal () const
	vtkPlane ()
	~vtkPlane ()
Protected Member Functions inherited from vtkImplicitFunction
	vtkImplicitFunction ()
	~vtkImplicitFunction ()
Protected Member Functions inherited from vtkObject
	vtkObject ()
virtual	~vtkObject ()
virtual void	RegisterInternal (vtkObjectBase *, int check)
virtual void	UnRegisterInternal (vtkObjectBase *, int check)
void	InternalGrabFocus (vtkCommand *mouseEvents, vtkCommand *keypressEvents=NULL)
void	InternalReleaseFocus ()
Protected Member Functions inherited from vtkObjectBase
	vtkObjectBase ()
virtual	~vtkObjectBase ()
virtual void	CollectRevisions (ostream &)
virtual void	ReportReferences (vtkGarbageCollector *)
	vtkObjectBase (const vtkObjectBase &)
void	operator= (const vtkObjectBase &)

Protected Attributes
double	Normal [3]
double	Origin [3]
Protected Attributes inherited from vtkImplicitFunction
vtkAbstractTransform *	Transform
double	ReturnValue [3]
Protected Attributes inherited from vtkObject
bool	Debug
vtkTimeStamp	MTime
vtkSubjectHelper *	SubjectHelper
Protected Attributes inherited from vtkObjectBase
vtkAtomicInt32	ReferenceCount
vtkWeakPointerBase **	WeakPointers
static void	ProjectPoint (double x[3], double origin[3], double normal[3], double xproj[3])
void	ProjectPoint (double x[3], double xproj[3])
static void	ProjectVector (double v[3], double origin[3], double normal[3], double vproj[3])
void	ProjectVector (double v[3], double vproj[3])
static void	GeneralizedProjectPoint (double x[3], double origin[3], double normal[3], double xproj[3])
void	GeneralizedProjectPoint (double x[3], double xproj[3])
static double	DistanceToPlane (double x[3], double n[3], double p0[3])
double	DistanceToPlane (double x[3])
static int	IntersectWithLine (double p1[3], double p2[3], double n[3], double p0[3], double &t, double x[3])
int	IntersectWithLine (double p1[3], double p2[3], double &t, double x[3])

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.

Examples:

vtkPlane (Examples)

Tests:

vtkPlane (Tests)

Definition at line 36 of file vtkPlane.h.

Member Typedef Documentation

typedef vtkImplicitFunction vtkPlane::Superclass

Definition at line 42 of file vtkPlane.h.

Constructor & Destructor Documentation

vtkPlane::vtkPlane ( )

protected

vtkPlane::~vtkPlane ( )

inlineprotected

Definition at line 123 of file vtkPlane.h.

Member Function Documentation

static vtkPlane* vtkPlane::New ( )

static

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

static int vtkPlane::IsTypeOf ( const char *  type )

static

virtual int vtkPlane::IsA ( const char *  name )

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 vtkTypeMacro found in vtkSetGet.h.

Reimplemented from vtkImplicitFunction.

static vtkPlane* vtkPlane::SafeDownCast ( vtkObjectBase *  o )

static

virtual vtkObjectBase* vtkPlane::NewInstanceInternal ( ) const

protectedvirtual

Reimplemented from vtkImplicitFunction.

vtkPlane* vtkPlane::NewInstance

(

)

const

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].

Definition at line 48 of file vtkPlane.h.

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.

static 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::ProjectPoint	(	double	x[3],
		double	xproj[3]
	)

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.

static void vtkPlane::ProjectVector ( double  v[3], double  origin[3], double  normal[3], double  vproj[3]  )

static

Project a vector v onto plane defined by origin and normal. The projected vector is returned in vproj.

void vtkPlane::ProjectVector	(	double	v[3],
		double	vproj[3]
	)

Project a vector v onto plane defined by origin and normal. The projected vector is returned in vproj.

static 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.

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

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]  )

inlinestatic

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

Definition at line 133 of file vtkPlane.h.

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

inlinestatic

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 140 of file vtkPlane.h.

double vtkPlane::DistanceToPlane

(

double

x[3]

)

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 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.

int vtkPlane::IntersectWithLine	(	double	p1[3],
		double	p2[3],
		double &	t,
		double	x[3]
	)

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 125 of file vtkPlane.h.

double vtkPlane::Origin[3]

protected

Definition at line 126 of file vtkPlane.h.

---

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

• dox/Common/DataModel/vtkPlane.h