implicit function for convex set of planes More...

#include <vtkPlanes.h>

Inheritance diagram for vtkPlanes:

Collaboration diagram for vtkPlanes:

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

vtkPlanes *	NewInstance () const

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

double	EvaluateFunction (double x[3]) override
	Evaluate function at position x-y-z and return value. More...

void	EvaluateGradient (double x[3], double n[3]) override
	Evaluate planes gradient. More...

virtual void	SetPoints (vtkPoints *)
	Specify a list of points defining points through which the planes pass. More...

virtual vtkPoints *	GetPoints ()

void	SetNormals (vtkDataArray *normals)
	Specify a list of normal vectors for the planes. More...

virtual vtkDataArray *	GetNormals ()

void	SetFrustumPlanes (double planes[24])
	An alternative method to specify six planes defined by the camera view frustrum. 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)

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

virtual double	EvaluateFunction (double x[3])=0
	Evaluate plane equations. More...

virtual void	EvaluateFunction (vtkDataArray input, vtkDataArray output)
	Evaluate plane equations. More...

virtual double	EvaluateFunction (double x, double y, double z)
	Evaluate plane equations. 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])

double	FunctionValue (double x, double y, double z)

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

double *	FunctionGradient (double x, double y, double z)

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

virtual vtkAbstractTransform *	GetTransform ()

virtual void	EvaluateFunction (vtkDataArray input, vtkDataArray output)

virtual double	EvaluateFunction (double x, double y, double z)

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

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)

vtkCommand *	GetCommand (unsigned long tag)

void	RemoveObserver (vtkCommand *)

void	RemoveObservers (unsigned long event, vtkCommand *)

void	RemoveObservers (const char event, vtkCommand )

vtkTypeBool	HasObserver (unsigned long event, vtkCommand *)

vtkTypeBool	HasObserver (const char event, vtkCommand )

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)

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)

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)

int	InvokeEvent (unsigned long event)

int	InvokeEvent (const char *event)

Public Member Functions inherited from vtkObjectBase
const char *	GetClassName () const
	Return the class name as a string. 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	PrintHeader (ostream &os, vtkIndent indent)

virtual void	PrintTrailer (ostream &os, vtkIndent indent)

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

Static Public Member Functions
static vtkPlanes *	New ()
	Standard methods for instantiation, type information, and printing. More...

static vtkTypeBool	IsTypeOf (const char *type)

static vtkPlanes *	SafeDownCast (vtkObjectBase *o)

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

static void	GlobalWarningDisplayOff ()

static int	GetGlobalWarningDisplay ()

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

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

Protected Member Functions inherited from vtkObjectBase
	vtkObjectBase ()

virtual	~vtkObjectBase ()

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
std::atomic< int32_t >	ReferenceCount

vtkWeakPointerBase **	WeakPointers

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

static vtkReallocingFunction	GetCurrentReallocFunction ()

static vtkFreeingFunction	GetCurrentFreeFunction ()

static vtkFreeingFunction	GetAlternateFreeFunction ()

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

Definition at line 49 of file vtkPlanes.h.

Member Typedef Documentation

◆ Superclass

typedef vtkImplicitFunction vtkPlanes::Superclass

Definition at line 57 of file vtkPlanes.h.

Constructor & Destructor Documentation

◆ vtkPlanes()

vtkPlanes::vtkPlanes ( )

protected

◆ ~vtkPlanes()

vtkPlanes::~vtkPlanes ( )

overrideprotected

Member Function Documentation

◆ New()

static vtkPlanes* vtkPlanes::New ( )

static

Standard methods for instantiation, type information, and printing.

◆ IsTypeOf()

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

static

◆ IsA()

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

Reimplemented in vtkPlanesIntersection.

◆ SafeDownCast()

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

static

◆ NewInstanceInternal()

virtual vtkObjectBase* vtkPlanes::NewInstanceInternal ( ) const

protectedvirtual

Reimplemented from vtkImplicitFunction.

Reimplemented in vtkPlanesIntersection.

◆ NewInstance()

vtkPlanes* vtkPlanes::NewInstance ( ) const

◆ PrintSelf()

void vtkPlanes::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.

Reimplemented in vtkPlanesIntersection.

◆ EvaluateFunction() [1/4]

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.

◆ EvaluateGradient()

void vtkPlanes::EvaluateGradient	(	double	x[3],
		double	n[3]
	)

overridevirtual

Evaluate planes gradient.

Implements vtkImplicitFunction.

◆ SetPoints()

virtual void vtkPlanes::SetPoints ( vtkPoints * )

virtual

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

◆ GetPoints()

virtual vtkPoints* vtkPlanes::GetPoints ( )

virtual

◆ SetNormals()

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.

◆ GetNormals()

virtual vtkDataArray* vtkPlanes::GetNormals ( )

virtual

◆ SetFrustumPlanes()

void vtkPlanes::SetFrustumPlanes ( double planes[24] )

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

See vtkCamera::GetFrustumPlanes() documentation.

◆ SetBounds() [1/2]

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.

◆ SetBounds() [2/2]

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

◆ GetNumberOfPlanes()

int vtkPlanes::GetNumberOfPlanes ( )

Return the number of planes in the set of planes.

◆ GetPlane() [1/2]

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.

◆ GetPlane() [2/2]

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.

◆ EvaluateFunction() [2/4]

virtual double vtkImplicitFunction::EvaluateFunction

Evaluate plane equations.

Return largest value (i.e., an intersection operation between all planes).

◆ EvaluateFunction() [3/4]

virtual void vtkImplicitFunction::EvaluateFunction

Evaluate plane equations.

Return largest value (i.e., an intersection operation between all planes).

◆ EvaluateFunction() [4/4]

virtual double vtkImplicitFunction::EvaluateFunction

inline

Evaluate plane equations.

Return largest value (i.e., an intersection operation between all planes).

Definition at line 123 of file vtkImplicitFunction.h.

Member Data Documentation

◆ Points

vtkPoints* vtkPlanes::Points

protected

Definition at line 132 of file vtkPlanes.h.

◆ Normals

vtkDataArray* vtkPlanes::Normals

protected

Definition at line 133 of file vtkPlanes.h.

◆ Plane

vtkPlane* vtkPlanes::Plane

protected

Definition at line 134 of file vtkPlanes.h.

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

Common/DataModel/vtkPlanes.h

Public Types

Public Member Functions

Static Public Member Functions

Protected Member Functions

Protected Attributes

Additional Inherited Members

Detailed Description

Member Typedef Documentation

◆ Superclass

Constructor & Destructor Documentation

◆ vtkPlanes()

◆ ~vtkPlanes()

Member Function Documentation

◆ New()

◆ IsTypeOf()

◆ IsA()

◆ SafeDownCast()

◆ NewInstanceInternal()

◆ NewInstance()

◆ PrintSelf()

◆ EvaluateFunction() [1/4]

◆ EvaluateGradient()

◆ SetPoints()

◆ GetPoints()

◆ SetNormals()

◆ GetNormals()

◆ SetFrustumPlanes()

◆ SetBounds() [1/2]

◆ SetBounds() [2/2]

◆ GetNumberOfPlanes()

◆ GetPlane() [1/2]

◆ GetPlane() [2/2]

◆ EvaluateFunction() [2/4]

◆ EvaluateFunction() [3/4]

◆ EvaluateFunction() [4/4]

Member Data Documentation

◆ Points

◆ Normals

◆ Plane