VTK
9.1.0
|
perform various plane computations More...
#include <vtkPlane.h>
Public Types | |
typedef vtkImplicitFunction | Superclass |
![]() | |
typedef vtkObject | Superclass |
Public Member Functions | |
virtual vtkTypeBool | IsA (const char *type) |
Return 1 if this class is the same type of (or a subclass of) the named class. More... | |
vtkPlane * | NewInstance () 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 plane equation for point x[3]. More... | |
double | EvaluateFunction (double x[3]) override |
Evaluate plane equation for point x[3]. More... | |
virtual double | EvaluateFunction (double x[3])=0 |
Evaluate plane equation for point x[3]. More... | |
virtual void | EvaluateFunction (vtkDataArray *input, vtkDataArray *output) |
Evaluate plane equation for point x[3]. More... | |
virtual double | EvaluateFunction (double x, double y, double z) |
Evaluate plane equation for point x[3]. More... | |
virtual void | SetNormal (double, double, double) |
Set/get plane normal. More... | |
virtual void | SetNormal (double[3]) |
Set/get plane normal. More... | |
virtual double * | GetNormal () |
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 double * | GetOrigin () |
Set/get point through which plane passes. More... | |
virtual void | GetOrigin (double data[3]) |
Set/get point through which plane passes. More... | |
![]() | |
virtual vtkTypeBool | IsA (const char *type) |
Return 1 if this class is the same type of (or a subclass of) the named class. More... | |
vtkImplicitFunction * | NewInstance () const |
void | PrintSelf (ostream &os, vtkIndent indent) override |
Methods invoked by print to print information about the object including superclasses. More... | |
vtkMTimeType | GetMTime () override |
Overload standard modified time function. More... | |
virtual void | EvaluateGradient (double x[3], double g[3])=0 |
Evaluate function gradient at position x-y-z and pass back vector. 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... | |
double * | FunctionGradient (const double x[3]) |
Evaluate function gradient at position x-y-z and pass back vector. More... | |
double * | FunctionGradient (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 vtkAbstractTransform * | GetTransform () |
Set/Get a transformation to apply to input points before executing the implicit function. More... | |
![]() | |
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... | |
virtual vtkMTimeType | GetMTime () |
Return this object's modified time. More... | |
void | PrintSelf (ostream &os, vtkIndent indent) override |
Methods invoked by print to print information about the object including superclasses. More... | |
void | RemoveObserver (unsigned long tag) |
void | RemoveObservers (unsigned long event) |
void | RemoveObservers (const char *event) |
void | RemoveAllObservers () |
vtkTypeBool | HasObserver (unsigned long event) |
vtkTypeBool | 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... | |
vtkCommand * | GetCommand (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... | |
vtkTypeBool | HasObserver (unsigned long event, vtkCommand *) |
Allow people to add/remove/invoke observers (callbacks) to any VTK object. More... | |
vtkTypeBool | 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... | |
![]() | |
const char * | GetClassName () const |
Return the class name as a string. More... | |
virtual vtkTypeBool | IsA (const char *name) |
Return 1 if this class is the same type of (or a subclass of) the named class. More... | |
virtual vtkIdType | GetNumberOfGenerationsFromBase (const char *name) |
Given the name of a base class of this class type, return the distance of inheritance between this class type and the named class (how many generations of inheritance are there between this class and the named class). 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... | |
bool | GetIsInMemkind () const |
A local state flag that remembers whether this object lives in the normal or extended memory space. 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 vtkPlane * | New () |
Construct plane passing through origin and normal to z-axis. More... | |
static vtkTypeBool | IsTypeOf (const char *type) |
static vtkPlane * | SafeDownCast (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 bool | ComputeBestFittingPlane (vtkPoints *pts, double *origin, double *normal) |
Given a set of points calculate the best-fitting origin and normal for the plane. More... | |
![]() | |
static vtkTypeBool | IsTypeOf (const char *type) |
static vtkImplicitFunction * | SafeDownCast (vtkObjectBase *o) |
![]() | |
static vtkObject * | New () |
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 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 vtkIdType | GetNumberOfGenerationsFromBaseType (const char *name) |
Given a the name of a base class of this class type, return the distance of inheritance between this class type and the named class (how many generations of inheritance are there between this class and the named class). More... | |
static vtkObjectBase * | New () |
Create an object with Debug turned off, modified time initialized to zero, and reference counting on. More... | |
static void | SetMemkindDirectory (const char *directoryname) |
The name of a directory, ideally mounted -o dax, to memory map an extended memory space within. More... | |
static bool | GetUsingMemkind () |
A global state flag that controls whether vtkObjects are constructed in the usual way (the default) or within the extended memory space. More... | |
Protected Member Functions | |
virtual vtkObjectBase * | NewInstanceInternal () const |
vtkPlane () | |
~vtkPlane () override=default | |
![]() | |
virtual vtkObjectBase * | NewInstanceInternal () const |
vtkImplicitFunction () | |
~vtkImplicitFunction () override | |
![]() | |
vtkObject () | |
~vtkObject () override | |
void | RegisterInternal (vtkObjectBase *, vtkTypeBool check) override |
void | UnRegisterInternal (vtkObjectBase *, vtkTypeBool check) override |
void | InternalGrabFocus (vtkCommand *mouseEvents, vtkCommand *keypressEvents=nullptr) |
These methods allow a command to exclusively grab all events. More... | |
void | InternalReleaseFocus () |
These methods allow a command to exclusively grab all events. More... | |
![]() | |
vtkObjectBase () | |
virtual | ~vtkObjectBase () |
virtual void | RegisterInternal (vtkObjectBase *, vtkTypeBool check) |
virtual void | UnRegisterInternal (vtkObjectBase *, vtkTypeBool check) |
virtual void | ReportReferences (vtkGarbageCollector *) |
vtkObjectBase (const vtkObjectBase &) | |
void | operator= (const vtkObjectBase &) |
Protected Attributes | |
double | Normal [3] |
double | Origin [3] |
![]() | |
vtkAbstractTransform * | Transform |
double | ReturnValue [3] |
![]() | |
bool | Debug |
vtkTimeStamp | MTime |
vtkSubjectHelper * | SubjectHelper |
![]() | |
std::atomic< int32_t > | ReferenceCount |
vtkWeakPointerBase ** | WeakPointers |
static void | ProjectPoint (const double x[3], const double origin[3], const double normal[3], double xproj[3]) |
Project a point x onto plane defined by origin and normal. More... | |
void | ProjectPoint (const double x[3], double xproj[3]) |
Project a point x onto plane defined by origin and normal. More... | |
static void | ProjectVector (const double v[3], const double origin[3], const double normal[3], double vproj[3]) |
Project a vector v onto plane defined by origin and normal. More... | |
void | ProjectVector (const double v[3], double vproj[3]) |
Project a vector v onto plane defined by origin and normal. More... | |
static void | GeneralizedProjectPoint (const double x[3], const double origin[3], const double normal[3], double xproj[3]) |
Project a point x onto plane defined by origin and normal. More... | |
void | GeneralizedProjectPoint (const 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 (const double p1[3], const 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 (const double p1[3], const 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... | |
static int | IntersectWithFinitePlane (double n[3], double o[3], double pOrigin[3], double px[3], double py[3], double x0[3], double x1[3]) |
Given two planes, one infinite and one finite, defined by the normal n and point o (infinite plane), and the second finite plane1 defined by the three points (pOrigin,px,py), compute a line of intersection (if any). More... | |
int | IntersectWithFinitePlane (double pOrigin[3], double px[3], double py[3], double x0[3], double x1[3]) |
Given two planes, one infinite and one finite, defined by the normal n and point o (infinite plane), and the second finite plane1 defined by the three points (pOrigin,px,py), compute a line of intersection (if any). More... | |
Additional Inherited Members | |
![]() | |
static vtkMallocingFunction | GetCurrentMallocFunction () |
static vtkReallocingFunction | GetCurrentReallocFunction () |
static vtkFreeingFunction | GetCurrentFreeFunction () |
static vtkFreeingFunction | GetAlternateFreeFunction () |
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.
Definition at line 142 of file vtkPlane.h.
Definition at line 150 of file vtkPlane.h.
|
protected |
|
overrideprotecteddefault |
|
static |
Construct plane passing through origin and normal to z-axis.
|
static |
|
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 |
|
protectedvirtual |
Reimplemented from vtkImplicitFunction.
vtkPlane * vtkPlane::NewInstance | ( | ) | const |
|
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.
|
overridevirtual |
Evaluate plane equation for point x[3].
Reimplemented from vtkImplicitFunction.
|
overridevirtual |
Evaluate plane equation for point x[3].
Implements vtkImplicitFunction.
|
overridevirtual |
Evaluate function gradient at point x[3].
Implements vtkImplicitFunction.
|
virtual |
Set/get plane normal.
Plane is defined by point and normal.
|
virtual |
Set/get plane normal.
Plane is defined by point and normal.
|
virtual |
Set/get plane normal.
Plane is defined by point and normal.
|
virtual |
Set/get plane normal.
Plane is defined by point and normal.
|
virtual |
Set/get point through which plane passes.
Plane is defined by point and normal.
|
virtual |
Set/get point through which plane passes.
Plane is defined by point and normal.
|
virtual |
Set/get point through which plane passes.
Plane is defined by point and normal.
|
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 |
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 | ( | const 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 |
Project a vector v onto plane defined by origin and normal.
The projected vector is returned in vproj.
void vtkPlane::ProjectVector | ( | const 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 |
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 | ( | const 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.
|
inlinestatic |
Quick evaluation of plane equation n(x-origin)=0.
Definition at line 292 of file vtkPlane.h.
|
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 299 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 |
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 | ( | const double | p1[3], |
const 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.
|
static |
Given two planes, one infinite and one finite, defined by the normal n and point o (infinite plane), and the second finite plane1 defined by the three points (pOrigin,px,py), compute a line of intersection (if any).
The line of intersection is defined by the return values (x0,x1). If there is no intersection, then zero is returned; otherwise non-zero. There are two variants of this method. The static function operates on the supplied function parameters; the non-static operates on this instance of vtkPlane (and its associated origin and normal).
int vtkPlane::IntersectWithFinitePlane | ( | double | pOrigin[3], |
double | px[3], | ||
double | py[3], | ||
double | x0[3], | ||
double | x1[3] | ||
) |
Given two planes, one infinite and one finite, defined by the normal n and point o (infinite plane), and the second finite plane1 defined by the three points (pOrigin,px,py), compute a line of intersection (if any).
The line of intersection is defined by the return values (x0,x1). If there is no intersection, then zero is returned; otherwise non-zero. There are two variants of this method. The static function operates on the supplied function parameters; the non-static operates on this instance of vtkPlane (and its associated origin and normal).
|
static |
Given a set of points calculate the best-fitting origin and normal for the plane.
The origin will be the centroid of the points. The normal is determined by using the covariance matrix of the points relative to the centroid. Returns true if successful. If not successful the origin will still contain the centroid and the normal will point into z-direction.
|
virtual |
Evaluate plane equation for point x[3].
Implements vtkImplicitFunction.
|
virtual |
Evaluate plane equation for point x[3].
Reimplemented from vtkImplicitFunction.
|
inlinevirtual |
Evaluate plane equation for point x[3].
Reimplemented from vtkImplicitFunction.
Definition at line 142 of file vtkImplicitFunction.h.
|
protected |
Definition at line 283 of file vtkPlane.h.
|
protected |
Definition at line 284 of file vtkPlane.h.