vtkBSPIntersections Class Reference

Perform calculations (mostly intersection calculations) on regions of a 3D binary spatial partitioning. More...

#include <vtkBSPIntersections.h>

Inheritance diagram for vtkBSPIntersections:

Collaboration diagram for vtkBSPIntersections:

Public Types
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.
vtkBSPIntersections *	NewInstance () const
void	PrintSelf (ostream &os, vtkIndent indent) override
	Methods invoked by print to print information about the object including superclasses.
void	SetCuts (vtkBSPCuts *cuts)
	Define the binary spatial partitioning.
virtual vtkBSPCuts *	GetCuts ()
int	GetBounds (double *bounds)
	Get the bounds of the whole space (xmin, xmax, ymin, ymax, zmin, zmax) Return 0 if OK, 1 on error.
int	GetNumberOfRegions ()
	The number of regions in the binary spatial partitioning.
int	GetRegionBounds (int regionID, double bounds[6])
	Get the spatial bounds of a particular region Return 0 if OK, 1 on error.
int	GetRegionDataBounds (int regionID, double bounds[6])
	Get the bounds of the data within the k-d tree region, possibly smaller than the bounds of the region.
int	IntersectsSphere2 (int regionId, double x, double y, double z, double rSquared)
	Determine whether a region of the spatial decomposition intersects a sphere, given the center of the sphere and the square of it's radius.
int	IntersectsSphere2 (int *ids, int len, double x, double y, double z, double rSquared)
	Compute a list of the Ids of all regions that intersect the specified sphere.
int	IntersectsCell (int regionId, vtkCell *cell, int cellRegion=-1)
	Determine whether a region of the spatial decomposition intersects the given cell.
int	IntersectsCell (int *ids, int len, vtkCell *cell, int cellRegion=-1)
	Compute a list of the Ids of all regions that intersect the given cell.
virtual int	GetComputeIntersectionsUsingDataBounds ()
	When computing the intersection of k-d tree regions with other objects, we use the spatial bounds of the region.
void	SetComputeIntersectionsUsingDataBounds (int c)
void	ComputeIntersectionsUsingDataBoundsOn ()
void	ComputeIntersectionsUsingDataBoundsOff ()
int	IntersectsBox (int regionId, double *x)
	Determine whether a region of the spatial decomposition intersects an axis aligned box.
int	IntersectsBox (int regionId, double x0, double x1, double y0, double y1, double z0, double z1)
	Determine whether a region of the spatial decomposition intersects an axis aligned box.
int	IntersectsBox (int *ids, int len, double *x)
	Compute a list of the Ids of all regions that intersect the specified axis aligned box.
int	IntersectsBox (int *ids, int len, double x0, double x1, double y0, double y1, double z0, double z1)
	Compute a list of the Ids of all regions that intersect the specified axis aligned box.
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 vtkBSPIntersections *	SafeDownCast (vtkObjectBase *o)
static vtkBSPIntersections *	New ()
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 Types
enum	{ XDIM = 0 , YDIM = 1 , ZDIM = 2 }

Protected Member Functions
virtual vtkObjectBase *	NewInstanceInternal () const
	vtkBSPIntersections ()
	~vtkBSPIntersections () override
virtual vtkMTimeType	GetRegionListBuildTime ()
int	BuildRegionList ()
vtkKdNode **	GetRegionList ()
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 &)

Protected Attributes
double	CellBoundsCache [6]
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

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 calculations (mostly intersection calculations) on regions of a 3D binary spatial partitioning.

Given an axis aligned binary spatial partitioning described by a vtkBSPCuts object, perform intersection queries on various geometric entities with regions of the spatial partitioning.

See also

vtkBSPCuts vtkKdTree

Definition at line 31 of file vtkBSPIntersections.h.

Member Typedef Documentation

Superclass

typedef vtkObject vtkBSPIntersections::Superclass

Definition at line 34 of file vtkBSPIntersections.h.

Member Enumeration Documentation

anonymous enum

anonymous enum

protected

Enumerator
XDIM
YDIM
ZDIM

Definition at line 152 of file vtkBSPIntersections.h.

Constructor & Destructor Documentation

vtkBSPIntersections()

vtkBSPIntersections::vtkBSPIntersections ( )

protected

~vtkBSPIntersections()

vtkBSPIntersections::~vtkBSPIntersections ( )

overrideprotected

Member Function Documentation

IsTypeOf()

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

static

IsA()

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

SafeDownCast()

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

static

NewInstanceInternal()

virtual vtkObjectBase * vtkBSPIntersections::NewInstanceInternal ( ) const

protectedvirtual

NewInstance()

vtkBSPIntersections * vtkBSPIntersections::NewInstance

(

)

const

PrintSelf()

void vtkBSPIntersections::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 vtkObjectBase.

New()

static vtkBSPIntersections * vtkBSPIntersections::New ( )

static

SetCuts()

void vtkBSPIntersections::SetCuts

(

vtkBSPCuts *

cuts

)

Define the binary spatial partitioning.

GetCuts()

virtual vtkBSPCuts * vtkBSPIntersections::GetCuts ( )

virtual

GetBounds()

int vtkBSPIntersections::GetBounds

(

double *

bounds

)

Get the bounds of the whole space (xmin, xmax, ymin, ymax, zmin, zmax) Return 0 if OK, 1 on error.

GetNumberOfRegions()

int vtkBSPIntersections::GetNumberOfRegions

(

)

The number of regions in the binary spatial partitioning.

GetRegionBounds()

int vtkBSPIntersections::GetRegionBounds	(	int	regionID,
		double	bounds[6]
	)

Get the spatial bounds of a particular region Return 0 if OK, 1 on error.

GetRegionDataBounds()

int vtkBSPIntersections::GetRegionDataBounds	(	int	regionID,
		double	bounds[6]
	)

Get the bounds of the data within the k-d tree region, possibly smaller than the bounds of the region.

Return 0 if OK, 1 on error.

IntersectsBox() [1/4]

int vtkBSPIntersections::IntersectsBox	(	int	regionId,
		double *	x
	)

Determine whether a region of the spatial decomposition intersects an axis aligned box.

IntersectsBox() [2/4]

int vtkBSPIntersections::IntersectsBox	(	int	regionId,
		double	x0,
		double	x1,
		double	y0,
		double	y1,
		double	z0,
		double	z1
	)

Determine whether a region of the spatial decomposition intersects an axis aligned box.

IntersectsBox() [3/4]

int vtkBSPIntersections::IntersectsBox	(	int *	ids,
		int	len,
		double *	x
	)

Compute a list of the Ids of all regions that intersect the specified axis aligned box.

Returns: the number of ids in the list.

IntersectsBox() [4/4]

int vtkBSPIntersections::IntersectsBox	(	int *	ids,
		int	len,
		double	x0,
		double	x1,
		double	y0,
		double	y1,
		double	z0,
		double	z1
	)

Compute a list of the Ids of all regions that intersect the specified axis aligned box.

Returns: the number of ids in the list.

IntersectsSphere2() [1/2]

int vtkBSPIntersections::IntersectsSphere2	(	int	regionId,
		double	x,
		double	y,
		double	z,
		double	rSquared
	)

Determine whether a region of the spatial decomposition intersects a sphere, given the center of the sphere and the square of it's radius.

IntersectsSphere2() [2/2]

int vtkBSPIntersections::IntersectsSphere2	(	int *	ids,
		int	len,
		double	x,
		double	y,
		double	z,
		double	rSquared
	)

Compute a list of the Ids of all regions that intersect the specified sphere.

The sphere is given by it's center and the square of it's radius. Returns: the number of ids in the list.

IntersectsCell() [1/2]

int vtkBSPIntersections::IntersectsCell	(	int	regionId,
		vtkCell *	cell,
		int	cellRegion = -1
	)

Determine whether a region of the spatial decomposition intersects the given cell.

If you already know the region that the cell centroid lies in, provide that as the last argument to make the computation quicker.

IntersectsCell() [2/2]

int vtkBSPIntersections::IntersectsCell	(	int *	ids,
		int	len,
		vtkCell *	cell,
		int	cellRegion = -1
	)

Compute a list of the Ids of all regions that intersect the given cell.

If you already know the region that the cell centroid lies in, provide that as the last argument to make the computation quicker. Returns the number of regions the cell intersects.

GetComputeIntersectionsUsingDataBounds()

virtual int vtkBSPIntersections::GetComputeIntersectionsUsingDataBounds ( )

virtual

When computing the intersection of k-d tree regions with other objects, we use the spatial bounds of the region.

To use the tighter bound of the bounding box of the data within the region, set this variable ON. (Specifying data bounds in the vtkBSPCuts object is optional. If data bounds were not specified, this option has no meaning.)

SetComputeIntersectionsUsingDataBounds()

void vtkBSPIntersections::SetComputeIntersectionsUsingDataBounds

(

int

c

)

ComputeIntersectionsUsingDataBoundsOn()

void vtkBSPIntersections::ComputeIntersectionsUsingDataBoundsOn

(

)

ComputeIntersectionsUsingDataBoundsOff()

void vtkBSPIntersections::ComputeIntersectionsUsingDataBoundsOff

(

)

GetRegionListBuildTime()

virtual vtkMTimeType vtkBSPIntersections::GetRegionListBuildTime ( )

protectedvirtual

BuildRegionList()

int vtkBSPIntersections::BuildRegionList ( )

protected

GetRegionList()

vtkKdNode ** vtkBSPIntersections::GetRegionList ( )

inlineprotected

Definition at line 148 of file vtkBSPIntersections.h.

Member Data Documentation

CellBoundsCache

double vtkBSPIntersections::CellBoundsCache[6]

protected

Definition at line 150 of file vtkBSPIntersections.h.

---

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

• Common/DataModel/vtkBSPIntersections.h