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

vtkPlane *	NewInstance () const

void	PrintSelf (ostream &os, vtkIndent indent) override
	Methods invoked by print to print information about the object including superclasses.

void	EvaluateGradient (double x[3], double g[3]) override
	Evaluate function gradient at point x[3].

void	Push (double distance)
	Translate the plane in the direction of the normal by the distance specified.


void	EvaluateFunction (vtkDataArray input, vtkDataArray output) override
	Evaluate plane equation for point x[3].

double	EvaluateFunction (double x[3]) override
	Evaluate plane equation for point x[3].

virtual double	EvaluateFunction (double x[3])=0
	Evaluate plane equation for point x[3].

virtual void	EvaluateFunction (vtkDataArray input, vtkDataArray output)
	Evaluate plane equation for point x[3].

virtual double	EvaluateFunction (double x, double y, double z)
	Evaluate plane equation for point x[3].


virtual void	SetNormal (double, double, double)
	Set/get plane normal.

virtual void	SetNormal (double[3])
	Set/get plane normal.

virtual double *	GetNormal ()
	Set/get plane normal.

virtual void	GetNormal (double data[3])
	Set/get plane normal.


virtual void	SetOrigin (double, double, double)
	Set/get point through which plane passes.

virtual void	SetOrigin (double[3])
	Set/get point through which plane passes.

virtual double *	GetOrigin ()
	Set/get point through which plane passes.

virtual void	GetOrigin (double data[3])
	Set/get point through which plane passes.

Public Member Functions inherited from vtkImplicitFunction
virtual vtkTypeBool	IsA (const char *type)
	Return 1 if this class is the same type of (or a subclass of) the named class.

vtkImplicitFunction *	NewInstance () const

void	PrintSelf (ostream &os, vtkIndent indent) override
	Methods invoked by print to print information about the object including superclasses.

vtkMTimeType	GetMTime () override
	Overload standard modified time function.

virtual void	EvaluateGradient (double x[3], double g[3])=0
	Evaluate function gradient at position x-y-z and pass back vector.

virtual void	FunctionValue (vtkDataArray input, vtkDataArray output)
	Evaluate function at position x-y-z and return value.

double	FunctionValue (const double x[3])
	Evaluate function at position x-y-z and return value.

double	FunctionValue (double x, double y, double z)
	Evaluate function at position x-y-z and return value.

void	FunctionGradient (const double x[3], double g[3])
	Evaluate function gradient at position x-y-z and pass back vector.

double *	FunctionGradient (const double x[3])
	Evaluate function gradient at position x-y-z and pass back vector.

double *	FunctionGradient (double x, double y, double z)
	Evaluate function gradient at position x-y-z and pass back vector.

virtual void	SetTransform (vtkAbstractTransform *)
	Set/Get a transformation to apply to input points before executing the implicit function.

virtual void	SetTransform (const double elements[16])
	Set/Get a transformation to apply to input points before executing the implicit function.

virtual vtkAbstractTransform *	GetTransform ()
	Set/Get a transformation to apply to input points before executing the implicit function.

Public Member Functions inherited from vtkObject
	vtkBaseTypeMacro (vtkObject, vtkObjectBase)

virtual void	DebugOn ()
	Turn debugging output on.

virtual void	DebugOff ()
	Turn debugging output off.

bool	GetDebug ()
	Get the value of the debug flag.

void	SetDebug (bool debugFlag)
	Set the value of the debug flag.

virtual void	Modified ()
	Update the modification time for this object.

virtual vtkMTimeType	GetMTime ()
	Return this object's modified time.

void	PrintSelf (ostream &os, vtkIndent indent) override
	Methods invoked by print to print information about the object including superclasses.

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.

unsigned long	AddObserver (const char event, vtkCommand , float priority=0.0f)
	Allow people to add/remove/invoke observers (callbacks) to any VTK object.

vtkCommand *	GetCommand (unsigned long tag)
	Allow people to add/remove/invoke observers (callbacks) to any VTK object.

void	RemoveObserver (vtkCommand *)
	Allow people to add/remove/invoke observers (callbacks) to any VTK object.

void	RemoveObservers (unsigned long event, vtkCommand *)
	Allow people to add/remove/invoke observers (callbacks) to any VTK object.

void	RemoveObservers (const char event, vtkCommand )
	Allow people to add/remove/invoke observers (callbacks) to any VTK object.

vtkTypeBool	HasObserver (unsigned long event, vtkCommand *)
	Allow people to add/remove/invoke observers (callbacks) to any VTK object.

vtkTypeBool	HasObserver (const char event, vtkCommand )
	Allow people to add/remove/invoke observers (callbacks) to any VTK object.

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.

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.

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.

int	InvokeEvent (unsigned long event, void *callData)
	This method invokes an event and return whether the event was aborted or not.

int	InvokeEvent (const char event, void callData)
	This method invokes an event and return whether the event was aborted or not.

Public Member Functions inherited from vtkObjectBase
const char *	GetClassName () const
	Return the class name as a string.

virtual vtkTypeBool	IsA (const char *name)
	Return 1 if this class is the same type of (or a subclass of) the named class.

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

virtual void	Delete ()
	Delete a VTK object.

virtual void	FastDelete ()
	Delete a reference to this object.

void	InitializeObjectBase ()

void	Print (ostream &os)
	Print an object to an ostream.

virtual void	Register (vtkObjectBase *o)
	Increase the reference count (mark as used by another object).

virtual void	UnRegister (vtkObjectBase *o)
	Decrease the reference count (release by another object).

int	GetReferenceCount ()
	Return the current reference count of this object.

void	SetReferenceCount (int)
	Sets the reference count.

bool	GetIsInMemkind () const
	A local state flag that remembers whether this object lives in the normal or extended memory space.

virtual void	PrintHeader (ostream &os, vtkIndent indent)
	Methods invoked by print to print information about the object including superclasses.

virtual void	PrintTrailer (ostream &os, vtkIndent indent)
	Methods invoked by print to print information about the object including superclasses.

Static Public Member Functions
static vtkPlane *	New ()
	Construct plane passing through origin and normal to z-axis.

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.


static bool	ComputeBestFittingPlane (vtkPoints pts, double origin, double *normal)
	Given a set of points calculate the best-fitting origin and normal for the plane.

Static Public Member Functions inherited from vtkImplicitFunction
static vtkTypeBool	IsTypeOf (const char *type)

static vtkImplicitFunction *	SafeDownCast (vtkObjectBase *o)

Static Public Member Functions inherited from vtkObject
static vtkObject *	New ()
	Create an object with Debug turned off, modified time initialized to zero, and reference counting on.

static void	BreakOnError ()
	This method is called when vtkErrorMacro executes.

static void	SetGlobalWarningDisplay (int val)
	This is a global flag that controls whether any debug, warning or error messages are displayed.

static void	GlobalWarningDisplayOn ()
	This is a global flag that controls whether any debug, warning or error messages are displayed.

static void	GlobalWarningDisplayOff ()
	This is a global flag that controls whether any debug, warning or error messages are displayed.

static int	GetGlobalWarningDisplay ()
	This is a global flag that controls whether any debug, warning or error messages are displayed.

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.

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

static vtkObjectBase *	New ()
	Create an object with Debug turned off, modified time initialized to zero, and reference counting on.

static void	SetMemkindDirectory (const char *directoryname)
	The name of a directory, ideally mounted -o dax, to memory map an extended memory space within.

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.

Protected Member Functions
virtual vtkObjectBase *	NewInstanceInternal () const

	vtkPlane ()

	~vtkPlane () override=default

Protected Member Functions inherited from vtkImplicitFunction
virtual vtkObjectBase *	NewInstanceInternal () const

	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=nullptr)
	These methods allow a command to exclusively grab all events.

void	InternalReleaseFocus ()
	These methods allow a command to exclusively grab all events.

Protected Member Functions inherited from vtkObjectBase
	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]

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

void	ProjectPoint (const double x[3], double xproj[3])
	Project a point x onto plane defined by origin and normal.

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.

void	ProjectVector (const double v[3], double vproj[3])
	Project a vector v onto plane defined by origin and normal.

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.

void	GeneralizedProjectPoint (const double x[3], double xproj[3])
	Project a point x onto plane defined by origin and normal.

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.

double	DistanceToPlane (double x[3])
	Return the distance of a point x to a plane defined by n(x-p0) = 0.

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.

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.

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

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

Additional Inherited Members
Static Protected Member Functions inherited from vtkObjectBase
static vtkMallocingFunction	GetCurrentMallocFunction ()

static vtkReallocingFunction	GetCurrentReallocFunction ()

static vtkFreeingFunction	GetCurrentFreeFunction ()

static vtkFreeingFunction	GetAlternateFreeFunction ()

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.

Online Examples:

ContoursFromPolyData

VoxelsOnBoundary

SolidClip

PolyDataContourToImageData

PBR_Skybox

ProjectPointPlane

ClipUnstructuredGridWithPlane

ClipUnstructuredGridWithPlane2

CutStructuredGrid

DataSetSurface

Definition at line 142 of file vtkPlane.h.

Member Typedef Documentation

◆ Superclass

typedef vtkImplicitFunction vtkPlane::Superclass

Definition at line 150 of file vtkPlane.h.

Constructor & Destructor Documentation

◆ vtkPlane()

vtkPlane::vtkPlane ( )

protected

◆ ~vtkPlane()

vtkPlane::~vtkPlane ( )

overrideprotecteddefault

Member Function Documentation

◆ New()

static vtkPlane * vtkPlane::New ( )

static

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

◆ IsTypeOf()

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

static

◆ IsA()

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

◆ SafeDownCast()

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

static

◆ NewInstanceInternal()

virtual vtkObjectBase * vtkPlane::NewInstanceInternal ( ) const

protectedvirtual

Reimplemented from vtkImplicitFunction.

◆ NewInstance()

vtkPlane * vtkPlane::NewInstance ( ) const

◆ PrintSelf()

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.

◆ EvaluateFunction() [1/5]

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

overridevirtual

Evaluate plane equation for point x[3].

Reimplemented from vtkImplicitFunction.

◆ EvaluateFunction() [2/5]

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

overridevirtual

Evaluate plane equation for point x[3].

Implements vtkImplicitFunction.

◆ EvaluateGradient()

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

overridevirtual

Evaluate function gradient at point x[3].

Implements vtkImplicitFunction.