VTK
Public Types | Public Member Functions | Static Public Member Functions | Protected Member Functions | Protected Attributes | List of all members
vtkPlane Class Reference

perform various plane computations More...

#include <vtkPlane.h>

Inheritance diagram for vtkPlane:
[legend]
Collaboration diagram for vtkPlane:
[legend]

Public Types

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

Public Member Functions

virtual int IsA (const char *type)
 Return 1 if this class is the same type of (or a subclass of) the named class. More...
 
vtkPlaneNewInstance () const
 
void PrintSelf (ostream &os, vtkIndent indent) override
 Methods invoked by print to print information about the object including superclasses. More...
 
void EvaluateGradient (double x[3], double g[3]) override
 Evaluate function gradient at point x[3]. More...
 
void Push (double distance)
 Translate the plane in the direction of the normal by the distance specified. More...
 
void EvaluateFunction (vtkDataArray *input, vtkDataArray *output) override
 Evaluate function at position x-y-z and return value. More...
 
double EvaluateFunction (double x[3]) override
 Evaluate function at position x-y-z and return value. More...
 
virtual void SetNormal (double, double, double)
 Set/get plane normal. More...
 
virtual void SetNormal (double[3])
 Set/get plane normal. More...
 
virtual doubleGetNormal ()
 Set/get plane normal. More...
 
virtual void GetNormal (double data[3])
 Set/get plane normal. More...
 
virtual void SetOrigin (double, double, double)
 Set/get point through which plane passes. More...
 
virtual void SetOrigin (double[3])
 Set/get point through which plane passes. More...
 
virtual doubleGetOrigin ()
 Set/get point through which plane passes. More...
 
virtual void GetOrigin (double data[3])
 Set/get point through which plane passes. More...
 
- Public Member Functions inherited from vtkImplicitFunction
vtkImplicitFunctionNewInstance () const
 
vtkMTimeType GetMTime () override
 Overload standard modified time function. More...
 
virtual void FunctionValue (vtkDataArray *input, vtkDataArray *output)
 Evaluate function at position x-y-z and return value. More...
 
double FunctionValue (const double x[3])
 Evaluate function at position x-y-z and return value. More...
 
double FunctionValue (double x, double y, double z)
 Evaluate function at position x-y-z and return value. More...
 
void FunctionGradient (const double x[3], double g[3])
 Evaluate function gradient at position x-y-z and pass back vector. More...
 
doubleFunctionGradient (const double x[3])
 Evaluate function gradient at position x-y-z and pass back vector. More...
 
doubleFunctionGradient (double x, double y, double z)
 Evaluate function gradient at position x-y-z and pass back vector. More...
 
virtual void SetTransform (vtkAbstractTransform *)
 Set/Get a transformation to apply to input points before executing the implicit function. More...
 
virtual void SetTransform (const double elements[16])
 Set/Get a transformation to apply to input points before executing the implicit function. More...
 
virtual vtkAbstractTransformGetTransform ()
 Set/Get a transformation to apply to input points before executing the implicit function. More...
 
virtual double EvaluateFunction (double x, double y, double z)
 Evaluate function at position x-y-z and return value. More...
 
- Public Member Functions inherited from vtkObject
 vtkBaseTypeMacro (vtkObject, vtkObjectBase)
 
virtual void DebugOn ()
 Turn debugging output on. More...
 
virtual void DebugOff ()
 Turn debugging output off. More...
 
bool GetDebug ()
 Get the value of the debug flag. More...
 
void SetDebug (bool debugFlag)
 Set the value of the debug flag. More...
 
virtual void Modified ()
 Update the modification time for this object. More...
 
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)
 
int InvokeEvent (unsigned long event)
 
int InvokeEvent (const char *event)
 
unsigned long AddObserver (unsigned long event, vtkCommand *, float priority=0.0f)
 Allow people to add/remove/invoke observers (callbacks) to any VTK object. More...
 
unsigned long AddObserver (const char *event, vtkCommand *, float priority=0.0f)
 Allow people to add/remove/invoke observers (callbacks) to any VTK object. More...
 
vtkCommandGetCommand (unsigned long tag)
 Allow people to add/remove/invoke observers (callbacks) to any VTK object. More...
 
void RemoveObserver (vtkCommand *)
 Allow people to add/remove/invoke observers (callbacks) to any VTK object. More...
 
void RemoveObservers (unsigned long event, vtkCommand *)
 Allow people to add/remove/invoke observers (callbacks) to any VTK object. More...
 
void RemoveObservers (const char *event, vtkCommand *)
 Allow people to add/remove/invoke observers (callbacks) to any VTK object. More...
 
int HasObserver (unsigned long event, vtkCommand *)
 Allow people to add/remove/invoke observers (callbacks) to any VTK object. More...
 
int HasObserver (const char *event, vtkCommand *)
 Allow people to add/remove/invoke observers (callbacks) to any VTK object. More...
 
template<class U , class T >
unsigned long AddObserver (unsigned long event, U observer, void(T::*callback)(), float priority=0.0f)
 Overloads to AddObserver that allow developers to add class member functions as callbacks for events. More...
 
template<class U , class T >
unsigned long AddObserver (unsigned long event, U observer, void(T::*callback)(vtkObject *, unsigned long, void *), float priority=0.0f)
 Overloads to AddObserver that allow developers to add class member functions as callbacks for events. More...
 
template<class U , class T >
unsigned long AddObserver (unsigned long event, U observer, bool(T::*callback)(vtkObject *, unsigned long, void *), float priority=0.0f)
 Allow user to set the AbortFlagOn() with the return value of the callback method. More...
 
int InvokeEvent (unsigned long event, void *callData)
 This method invokes an event and return whether the event was aborted or not. More...
 
int InvokeEvent (const char *event, void *callData)
 This method invokes an event and return whether the event was aborted or not. More...
 
- Public Member Functions inherited from vtkObjectBase
const char * GetClassName () const
 Return the class name as a string. More...
 
virtual void Delete ()
 Delete a VTK object. More...
 
virtual void FastDelete ()
 Delete a reference to this object. More...
 
void InitializeObjectBase ()
 
void Print (ostream &os)
 Print an object to an ostream. More...
 
virtual void Register (vtkObjectBase *o)
 Increase the reference count (mark as used by another object). More...
 
virtual void UnRegister (vtkObjectBase *o)
 Decrease the reference count (release by another object). More...
 
int GetReferenceCount ()
 Return the current reference count of this object. More...
 
void SetReferenceCount (int)
 Sets the reference count. More...
 
void PrintRevisions (ostream &)
 Legacy. More...
 
virtual void PrintHeader (ostream &os, vtkIndent indent)
 Methods invoked by print to print information about the object including superclasses. More...
 
virtual void PrintTrailer (ostream &os, vtkIndent indent)
 Methods invoked by print to print information about the object including superclasses. More...
 

Static Public Member Functions

static vtkPlaneNew ()
 Construct plane passing through origin and normal to z-axis. More...
 
static int IsTypeOf (const char *type)
 
static vtkPlaneSafeDownCast (vtkObjectBase *o)
 
static double Evaluate (double normal[3], double origin[3], double x[3])
 Quick evaluation of plane equation n(x-origin)=0. More...
 
- Static Public Member Functions inherited from vtkImplicitFunction
static int IsTypeOf (const char *type)
 
static vtkImplicitFunctionSafeDownCast (vtkObjectBase *o)
 
- Static Public Member Functions inherited from vtkObject
static vtkObjectNew ()
 Create an object with Debug turned off, modified time initialized to zero, and reference counting on. More...
 
static void BreakOnError ()
 This method is called when vtkErrorMacro executes. More...
 
static void SetGlobalWarningDisplay (int val)
 This is a global flag that controls whether any debug, warning or error messages are displayed. More...
 
static void GlobalWarningDisplayOn ()
 This is a global flag that controls whether any debug, warning or error messages are displayed. More...
 
static void GlobalWarningDisplayOff ()
 This is a global flag that controls whether any debug, warning or error messages are displayed. More...
 
static int GetGlobalWarningDisplay ()
 This is a global flag that controls whether any debug, warning or error messages are displayed. More...
 
- Static Public Member Functions inherited from vtkObjectBase
static vtkTypeBool IsTypeOf (const char *name)
 Return 1 if this class type is the same type of (or a subclass of) the named class. More...
 
static vtkObjectBaseNew ()
 Create an object with Debug turned off, modified time initialized to zero, and reference counting on. More...
 

Protected Member Functions

virtual vtkObjectBaseNewInstanceInternal () const
 
 vtkPlane ()
 
 ~vtkPlane () override
 
- Protected Member Functions inherited from vtkImplicitFunction
 vtkImplicitFunction ()
 
 ~vtkImplicitFunction () override
 
- Protected Member Functions inherited from vtkObject
 vtkObject ()
 
 ~vtkObject () override
 
void RegisterInternal (vtkObjectBase *, vtkTypeBool check) override
 
void UnRegisterInternal (vtkObjectBase *, vtkTypeBool check) override
 
void InternalGrabFocus (vtkCommand *mouseEvents, vtkCommand *keypressEvents=NULL)
 These methods allow a command to exclusively grab all events. More...
 
void InternalReleaseFocus ()
 These methods allow a command to exclusively grab all events. More...
 
- 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
vtkAbstractTransformTransform
 
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])
 Project a point x onto plane defined by origin and normal. More...
 
void ProjectPoint (double x[3], double xproj[3])
 Project a point x onto plane defined by origin and normal. More...
 
static void ProjectVector (double v[3], double origin[3], double normal[3], double vproj[3])
 Project a vector v onto plane defined by origin and normal. More...
 
void ProjectVector (double v[3], double vproj[3])
 Project a vector v onto plane defined by origin and normal. More...
 
static void GeneralizedProjectPoint (double x[3], double origin[3], double normal[3], double xproj[3])
 Project a point x onto plane defined by origin and normal. More...
 
void GeneralizedProjectPoint (double x[3], double xproj[3])
 Project a point x onto plane defined by origin and normal. More...
 
static double DistanceToPlane (double x[3], double n[3], double p0[3])
 Return the distance of a point x to a plane defined by n(x-p0) = 0. More...
 
double DistanceToPlane (double x[3])
 Return the distance of a point x to a plane defined by n(x-p0) = 0. More...
 
static int IntersectWithLine (double p1[3], double p2[3], double n[3], double p0[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. More...
 
int 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. More...
 

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

Member Typedef Documentation

Definition at line 45 of file vtkPlane.h.

Constructor & Destructor Documentation

vtkPlane::vtkPlane ( )
protected
vtkPlane::~vtkPlane ( )
inlineoverrideprotected

Definition at line 149 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 
)
overridevirtual

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.

void vtkPlane::EvaluateFunction ( vtkDataArray input,
vtkDataArray output 
)
overridevirtual

Evaluate function at position x-y-z and return value.

You should generally not call this method directly, you should use FunctionValue() instead. This method must be implemented by any derived class.

Reimplemented from vtkImplicitFunction.

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

Evaluate function at position x-y-z and return value.

You should generally not call this method directly, you should use FunctionValue() instead. This method must be implemented by any derived class.

Implements vtkImplicitFunction.

void vtkPlane::EvaluateGradient ( double  x[3],
double  g[3] 
)
overridevirtual

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 160 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 168 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 151 of file vtkPlane.h.

double vtkPlane::Origin[3]
protected

Definition at line 152 of file vtkPlane.h.


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