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:

[legend]

Collaboration diagram for vtkPlanesIntersection:

[legend]

Public Member Functions
virtual vtkTypeBool	IsA (const char *type)
	Standard methods for instantiation, type information, and printing. More...

vtkPlanesIntersection *	NewInstance () const

void	PrintSelf (ostream &os, vtkIndent indent) override
	Standard methods for instantiation, type information, and printing. More...

void	SetRegionVertices (vtkPoints *pts)
	It helps if you know the vertices of the convex region. More...

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

Public Member Functions inherited from vtkPlanes
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...

vtkPlanes *	NewInstance () const
	Standard methods for instantiation, type information, and printing. 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...

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

static vtkPlanesIntersection *	Convert3DCell (vtkCell *cell)
	Another convenience function provided by this class, returns the vtkPlanesIntersection object representing a 3D cell. More...

Static Public Member Functions inherited from vtkPlanes
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...

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

Protected Member Functions
virtual vtkObjectBase *	NewInstanceInternal () const
	Standard methods for instantiation, type information, and printing. More...

	vtkPlanesIntersection ()

	~vtkPlanesIntersection () override

Protected Member Functions inherited from vtkPlanes
	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 &)

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

Additional Inherited Members
Public Types inherited from vtkPlanes
typedef vtkImplicitFunction	Superclass
	Standard methods for instantiation, type information, and printing. More...

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

Protected Attributes inherited from vtkObjectBase
vtkAtomicInt32	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 spacial 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.

Tests:: vtkPlanesIntersection (Tests)

Definition at line 55 of file vtkPlanesIntersection.h.

Constructor & Destructor Documentation

vtkPlanesIntersection::vtkPlanesIntersection ( )

protected

vtkPlanesIntersection::~vtkPlanesIntersection ( )

overrideprotected

Member Function Documentation

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

static

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

virtual

Standard methods for instantiation, type information, and printing.

Reimplemented from vtkPlanes.

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

static

virtual vtkObjectBase* vtkPlanesIntersection::NewInstanceInternal ( ) const

protectedvirtual

Standard methods for instantiation, type information, and printing.

Reimplemented from vtkPlanes.

vtkPlanesIntersection* vtkPlanesIntersection::NewInstance ( ) const

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

overridevirtual

Standard methods for instantiation, type information, and printing.

Reimplemented from vtkPlanes.

static vtkPlanesIntersection* vtkPlanesIntersection::New ( )

static

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.

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

int vtkPlanesIntersection::GetNumberOfRegionVertices ( )

int vtkPlanesIntersection::GetNumRegionVertices ( )

inline

Definition at line 74 of file vtkPlanesIntersection.h.

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

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.

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.

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.

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

staticprotected

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

staticprotected

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

staticprotected

static int vtkPlanesIntersection::GoodNormal ( double * n )

staticprotected

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

staticprotected

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

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

Public Member Functions

Static Public Member Functions

Protected Member Functions

Static Protected Member Functions

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation