vtkPlanesIntersection Class Reference

A vtkPlanesIntersection object is a vtkPlanes object that can compute whether the arbitrary convex region bounded by it's planes intersects an axis-aligned box. More...

#include <vtkPlanesIntersection.h>

Inheritance diagram for vtkPlanesIntersection:

Collaboration diagram for vtkPlanesIntersection:

Public Member Functions
virtual vtkTypeBool	IsA (const char *type)
	Standard methods for instantiation, type information, and printing.
vtkPlanesIntersection *	NewInstance () const
void	PrintSelf (ostream &os, vtkIndent indent) override
	Standard methods for instantiation, type information, and printing.
void	SetRegionVertices (vtkPoints *pts)
	It helps if you know the vertices of the convex region.
void	SetRegionVertices (double *v, int nvertices)
int	GetNumberOfRegionVertices ()
int	GetNumRegionVertices ()
int	GetRegionVertices (double *v, int nvertices)
int	IntersectsRegion (vtkPoints *R)
	Return 1 if the axis aligned box defined by R intersects the region defined by the planes, or 0 otherwise.
Public Member Functions inherited from vtkPlanes
void	EvaluateGradient (double x[3], double n[3]) override
	Evaluate planes gradient.
void	SetFrustumPlanes (double planes[24])
	An alternative method to specify six planes defined by the camera view frustrum.
int	GetNumberOfPlanes ()
	Return the number of planes in the set of planes.
vtkPlane *	GetPlane (int i)
	Create and return a pointer to a vtkPlane object at the ith position.
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.
double	EvaluateFunction (double x[3]) override
	Evaluate plane equations.
virtual double	EvaluateFunction (double x[3])=0
	Evaluate plane equations.
virtual void	EvaluateFunction (vtkDataArray *input, vtkDataArray *output)
	Evaluate plane equations.
virtual double	EvaluateFunction (double x, double y, double z)
	Evaluate plane equations.
virtual void	SetPoints (vtkPoints *)
	Specify a list of points defining points through which the planes pass.
virtual vtkPoints *	GetPoints ()
	Specify a list of points defining points through which the planes pass.
void	SetNormals (vtkDataArray *normals)
	Specify a list of normal vectors for the planes.
virtual vtkDataArray *	GetNormals ()
	Specify a list of normal vectors for the planes.
void	SetBounds (const double bounds[6])
	An alternative method to specify six planes defined by a bounding box.
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.
vtkPlanes *	NewInstance () const
	Standard methods for instantiation, type information, and printing.
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)
vtkTypeBool	InvokeEvent (unsigned long event)
vtkTypeBool	InvokeEvent (const char *event)
std::string	GetObjectDescription () const override
	The object description printed in messages and PrintSelf output.
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.
vtkTypeBool	InvokeEvent (unsigned long event, void *callData)
	This method invokes an event and return whether the event was aborted or not.
vtkTypeBool	InvokeEvent (const char *event, void *callData)
	This method invokes an event and return whether the event was aborted or not.
virtual void	SetObjectName (const std::string &objectName)
	Set/get the name of this object for reporting purposes.
virtual std::string	GetObjectName () const
	Set/get the name of this object for reporting purposes.
Public Member Functions inherited from vtkObjectBase
const char *	GetClassName () const
	Return the class name as a string.
virtual std::string	GetObjectDescription () const
	The object description printed in messages and PrintSelf output.
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.
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.
virtual bool	UsesGarbageCollector () const
	Indicate whether the class uses vtkGarbageCollector or not.

Static Public Member Functions
static vtkTypeBool	IsTypeOf (const char *type)
static vtkPlanesIntersection *	SafeDownCast (vtkObjectBase *o)
static vtkPlanesIntersection *	New ()
static int	PolygonIntersectsBBox (double bounds[6], vtkPoints *pts)
	A convenience function provided by this class, returns 1 if the polygon defined in pts intersects the bounding box defined in bounds, 0 otherwise.
static vtkPlanesIntersection *	Convert3DCell (vtkCell *cell)
	Another convenience function provided by this class, returns the vtkPlanesIntersection object representing a 3D cell.
Static Public Member Functions inherited from vtkPlanes
static vtkPlanes *	New ()
	Standard methods for instantiation, type information, and printing.
static vtkTypeBool	IsTypeOf (const char *type)
	Standard methods for instantiation, type information, and printing.
static vtkPlanes *	SafeDownCast (vtkObjectBase *o)
	Standard methods for instantiation, type information, and printing.
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 (vtkTypeBool 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 vtkTypeBool	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
	Standard methods for instantiation, type information, and printing.
	vtkPlanesIntersection ()
	~vtkPlanesIntersection () override
Protected Member Functions inherited from vtkPlanes
	vtkPlanes ()
	~vtkPlanes () override
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 *)
virtual void	ObjectFinalize ()
	vtkObjectBase (const vtkObjectBase &)
void	operator= (const vtkObjectBase &)

Static Protected Member Functions
static void	ComputeNormal (double *p1, double *p2, double *p3, double normal[3])
static double	EvaluatePlaneEquation (double *x, double *p)
static void	PlaneEquation (double *n, double *x, double *p)
static int	GoodNormal (double *n)
static int	Invert3x3 (double M[3][3])
Static Protected Member Functions inherited from vtkObjectBase
static vtkMallocingFunction	GetCurrentMallocFunction ()
static vtkReallocingFunction	GetCurrentReallocFunction ()
static vtkFreeingFunction	GetCurrentFreeFunction ()
static vtkFreeingFunction	GetAlternateFreeFunction ()

Additional Inherited Members
Public Types inherited from vtkPlanes
typedef vtkImplicitFunction	Superclass
	Standard methods for instantiation, type information, and printing.
Public Types inherited from vtkImplicitFunction
typedef vtkObject	Superclass
Protected Attributes inherited from vtkPlanes
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
std::string	ObjectName
Protected Attributes inherited from vtkObjectBase
std::atomic< int32_t >	ReferenceCount
vtkWeakPointerBase **	WeakPointers

Detailed Description

A vtkPlanesIntersection object is a vtkPlanes object that can compute whether the arbitrary convex region bounded by it's planes intersects an axis-aligned box.

A subclass of vtkPlanes, this class determines whether it intersects an axis aligned box. This is motivated by the need to intersect the axis aligned region of a spatial decomposition of volume data with various other regions. It uses the algorithm from Graphics Gems IV, page 81.

Caveat:

An instance of vtkPlanes can be redefined by changing the planes, but this subclass then will not know if the region vertices are up to date. (Region vertices can be specified in SetRegionVertices or computed by the subclass.) So Delete and recreate if you want to change the set of planes.

Online Examples:

PlanesIntersection

Tests:

vtkPlanesIntersection (Tests)

Definition at line 60 of file vtkPlanesIntersection.h.

Constructor & Destructor Documentation

vtkPlanesIntersection()

vtkPlanesIntersection::vtkPlanesIntersection ( )

protected

~vtkPlanesIntersection()

vtkPlanesIntersection::~vtkPlanesIntersection ( )

overrideprotected

Member Function Documentation

IsTypeOf()

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

static

IsA()

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

virtual

Standard methods for instantiation, type information, and printing.

Reimplemented from vtkPlanes.

SafeDownCast()

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

static

NewInstanceInternal()

virtual vtkObjectBase * vtkPlanesIntersection::NewInstanceInternal ( ) const

protectedvirtual

Standard methods for instantiation, type information, and printing.

Reimplemented from vtkPlanes.

NewInstance()

vtkPlanesIntersection * vtkPlanesIntersection::NewInstance

(

)

const

PrintSelf()

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

overridevirtual

Standard methods for instantiation, type information, and printing.

Reimplemented from vtkPlanes.

New()

static vtkPlanesIntersection * vtkPlanesIntersection::New ( )

static

SetRegionVertices() [1/2]

void vtkPlanesIntersection::SetRegionVertices

(

vtkPoints *

pts

)

It helps if you know the vertices of the convex region.

If you don't, we will calculate them. Region vertices are 3-tuples.

SetRegionVertices() [2/2]

void vtkPlanesIntersection::SetRegionVertices	(	double *	v,
		int	nvertices
	)

GetNumberOfRegionVertices()

int vtkPlanesIntersection::GetNumberOfRegionVertices

(

)

GetNumRegionVertices()

int vtkPlanesIntersection::GetNumRegionVertices ( )

inline

Definition at line 79 of file vtkPlanesIntersection.h.

GetRegionVertices()

int vtkPlanesIntersection::GetRegionVertices	(	double *	v,
		int	nvertices
	)

IntersectsRegion()

int vtkPlanesIntersection::IntersectsRegion

(

vtkPoints *

R

)

Return 1 if the axis aligned box defined by R intersects the region defined by the planes, or 0 otherwise.

PolygonIntersectsBBox()

static int vtkPlanesIntersection::PolygonIntersectsBBox ( double  bounds[6], vtkPoints *  pts  )

static

A convenience function provided by this class, returns 1 if the polygon defined in pts intersects the bounding box defined in bounds, 0 otherwise.

The points must define a planar polygon.

Convert3DCell()

static vtkPlanesIntersection * vtkPlanesIntersection::Convert3DCell ( vtkCell *  cell )

static

Another convenience function provided by this class, returns the vtkPlanesIntersection object representing a 3D cell.

The point IDs for each face must be given in counter-clockwise order from the outside of the cell.

ComputeNormal()

static void vtkPlanesIntersection::ComputeNormal ( double *  p1, double *  p2, double *  p3, double  normal[3]  )

staticprotected

EvaluatePlaneEquation()

static double vtkPlanesIntersection::EvaluatePlaneEquation ( double *  x, double *  p  )

staticprotected

PlaneEquation()

static void vtkPlanesIntersection::PlaneEquation ( double *  n, double *  x, double *  p  )

staticprotected

GoodNormal()

static int vtkPlanesIntersection::GoodNormal ( double *  n )

staticprotected

Invert3x3()

static int vtkPlanesIntersection::Invert3x3 ( double  M[3][3] )

staticprotected

---

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

• Common/DataModel/vtkPlanesIntersection.h