vtkPlanes Class Reference

implicit function for convex set of planes More...

#include <vtkPlanes.h>

Inheritance diagram for vtkPlanes:

Collaboration diagram for vtkPlanes:

Public Member Functions
void	EvaluateGradient (double x[3], double n[3]) override
	Evaluate planes gradient. More...
void	SetFrustumPlanes (double planes[24])
	An alternative method to specify six planes defined by the camera view frustrum. More...
int	GetNumberOfPlanes ()
	Return the number of planes in the set of planes. More...
vtkPlane *	GetPlane (int i)
	Create and return a pointer to a vtkPlane object at the ith position. More...
void	GetPlane (int i, vtkPlane *plane)
	If i is within the allowable range, mutates the given plane's Normal and Origin to match the vtkPlane object at the ith position. More...
double	EvaluateFunction (double x[3]) override
	Evaluate function at position x-y-z and return value. More...
virtual void	SetPoints (vtkPoints *)
	Specify a list of points defining points through which the planes pass. More...
virtual vtkPoints *	GetPoints ()
	Specify a list of points defining points through which the planes pass. More...
void	SetNormals (vtkDataArray *normals)
	Specify a list of normal vectors for the planes. More...
virtual vtkDataArray *	GetNormals ()
	Specify a list of normal vectors for the planes. More...
void	SetBounds (const double bounds[6])
	An alternative method to specify six planes defined by a bounding box. More...
void	SetBounds (double xmin, double xmax, double ymin, double ymax, double zmin, double zmax)
	An alternative method to specify six planes defined by a bounding box. More...
Public Member Functions inherited from vtkImplicitFunction
vtkImplicitFunction *	NewInstance () 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...
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...
virtual void	EvaluateFunction (vtkDataArray *input, vtkDataArray *output)
	Evaluate function at position x-y-z and return value. 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 ()
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...
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...

Protected Member Functions
	vtkPlanes ()
	~vtkPlanes () 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=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...
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
vtkPoints *	Points
vtkDataArray *	Normals
vtkPlane *	Plane
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
typedef vtkImplicitFunction	Superclass
	Standard methods for instantiation, type information, and printing. More...
static vtkPlanes *	New ()
	Standard methods for instantiation, type information, and printing. More...
static vtkTypeBool	IsTypeOf (const char *type)
	Standard methods for instantiation, type information, and printing. More...
static vtkPlanes *	SafeDownCast (vtkObjectBase *o)
	Standard methods for instantiation, type information, and printing. More...
virtual vtkTypeBool	IsA (const char *type)
	Standard methods for instantiation, type information, and printing. More...
vtkPlanes *	NewInstance () const
	Standard methods for instantiation, type information, and printing. More...
void	PrintSelf (ostream &os, vtkIndent indent) override
	Standard methods for instantiation, type information, and printing. More...
virtual vtkObjectBase *	NewInstanceInternal () const
	Standard methods for instantiation, type information, and printing. More...

Additional Inherited Members
Public Types inherited from vtkImplicitFunction
typedef vtkObject	Superclass
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. 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 vtkObjectBase *	New ()
	Create an object with Debug turned off, modified time initialized to zero, and reference counting on. More...

Detailed Description

implicit function for convex set of planes

vtkPlanes computes the implicit function and function gradient for a set of planes. The planes must define a convex space.

The function value is the intersection (i.e., maximum value) obtained by evaluating the each of the supplied planes. Hence the value is the maximum distance of a point to the convex region defined by the planes. The function gradient is the plane normal at the function value. Note that the normals must point outside of the convex region. Thus, a negative function value means that a point is inside the convex region.

There are several methods to define the set of planes. The most general is to supply an instance of vtkPoints and an instance of vtkDataArray. (The points define a point on the plane, and the normals corresponding plane normals.) Two other specialized ways are to 1) supply six planes defining the view frustrum of a camera, and 2) provide a bounding box.

See also

vtkImplicitBoolean vtkSpheres vtkFrustrumSource vtkCamera

Examples:

vtkPlanes (Examples)

Tests:

vtkPlanes (Tests)

Definition at line 55 of file vtkPlanes.h.

Member Typedef Documentation

typedef vtkImplicitFunction vtkPlanes::Superclass

Standard methods for instantiation, type information, and printing.

Definition at line 63 of file vtkPlanes.h.

Constructor & Destructor Documentation

vtkPlanes::vtkPlanes ( )

protected

vtkPlanes::~vtkPlanes ( )

overrideprotected

Member Function Documentation

static vtkPlanes* vtkPlanes::New ( )

static

Standard methods for instantiation, type information, and printing.

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

static

Standard methods for instantiation, type information, and printing.

virtual vtkTypeBool vtkPlanes::IsA ( const char *  type )

virtual

Standard methods for instantiation, type information, and printing.

Reimplemented from vtkImplicitFunction.

Reimplemented in vtkPlanesIntersection.

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

static

Standard methods for instantiation, type information, and printing.

virtual vtkObjectBase* vtkPlanes::NewInstanceInternal ( ) const

protectedvirtual

Standard methods for instantiation, type information, and printing.

Reimplemented from vtkImplicitFunction.

Reimplemented in vtkPlanesIntersection.

vtkPlanes* vtkPlanes::NewInstance

(

)

const

Standard methods for instantiation, type information, and printing.

void vtkPlanes::PrintSelf ( ostream &  os, vtkIndent  indent  )

overridevirtual

Standard methods for instantiation, type information, and printing.

Reimplemented from vtkImplicitFunction.

Reimplemented in vtkPlanesIntersection.

double vtkPlanes::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 vtkPlanes::EvaluateGradient ( double  x[3], double  n[3]  )

overridevirtual

Evaluate planes gradient.

Implements vtkImplicitFunction.

virtual void vtkPlanes::SetPoints ( vtkPoints *  )

virtual

Specify a list of points defining points through which the planes pass.

virtual vtkPoints* vtkPlanes::GetPoints ( )

virtual

Specify a list of points defining points through which the planes pass.

void vtkPlanes::SetNormals

(

vtkDataArray *

normals

)

Specify a list of normal vectors for the planes.

There is a one-to-one correspondence between plane points and plane normals.

virtual vtkDataArray* vtkPlanes::GetNormals ( )

virtual

Specify a list of normal vectors for the planes.

There is a one-to-one correspondence between plane points and plane normals.

void vtkPlanes::SetFrustumPlanes

(

double

planes[24]

)

An alternative method to specify six planes defined by the camera view frustrum.

See vtkCamera::GetFrustumPlanes() documentation.

void vtkPlanes::SetBounds

(

const double

bounds[6]

)

An alternative method to specify six planes defined by a bounding box.

The bounding box is a six-vector defined as (xmin,xmax,ymin,ymax,zmin,zmax). It defines six planes orthogonal to the x-y-z coordinate axes.

void vtkPlanes::SetBounds	(	double	xmin,
		double	xmax,
		double	ymin,
		double	ymax,
		double	zmin,
		double	zmax
	)

An alternative method to specify six planes defined by a bounding box.

The bounding box is a six-vector defined as (xmin,xmax,ymin,ymax,zmin,zmax). It defines six planes orthogonal to the x-y-z coordinate axes.

int vtkPlanes::GetNumberOfPlanes

(

)

Return the number of planes in the set of planes.

vtkPlane* vtkPlanes::GetPlane

(

int

i

)

Create and return a pointer to a vtkPlane object at the ith position.

Asking for a plane outside the allowable range returns nullptr. This method always returns the same object. Use GetPlane(int i, vtkPlane *plane) instead.

void vtkPlanes::GetPlane	(	int	i,
		vtkPlane *	plane
	)

If i is within the allowable range, mutates the given plane's Normal and Origin to match the vtkPlane object at the ith position.

Does nothing if i is outside the allowable range.

Member Data Documentation

vtkPoints* vtkPlanes::Points

protected

Definition at line 140 of file vtkPlanes.h.

vtkDataArray* vtkPlanes::Normals

protected

Definition at line 141 of file vtkPlanes.h.

vtkPlane* vtkPlanes::Plane

protected

Definition at line 142 of file vtkPlanes.h.

---

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

• /home/demarle/Source/VTK/release/8.2/build/Utilities/Doxygen/dox/Common/DataModel/vtkPlanes.h