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 Types inherited from vtkObject
typedef vtkObjectBase	Superclass

Public Member Functions
virtual int	IsA (const char *type)

vtkBSPIntersections *	NewInstance () const

void	PrintSelf (ostream &os, vtkIndent indent)

void	SetCuts (vtkBSPCuts *cuts)

virtual vtkBSPCuts *	GetCuts ()

int	GetBounds (double *bounds)

int	GetNumberOfRegions ()

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

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

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

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

virtual int	GetComputeIntersectionsUsingDataBounds ()

void	SetComputeIntersectionsUsingDataBounds (int c)

void	ComputeIntersectionsUsingDataBoundsOn ()

void	ComputeIntersectionsUsingDataBoundsOff ()


int	IntersectsBox (int regionId, double *x)

int	IntersectsBox (int regionId, double xmin, double xmax, double ymin, double ymax, double zmin, double zmax)


int	IntersectsBox (int ids, int len, double x)

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


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


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

Public Member Functions inherited from vtkObject
vtkObject *	NewInstance () const

virtual void	DebugOn ()

virtual void	DebugOff ()

bool	GetDebug ()

void	SetDebug (bool debugFlag)

virtual void	Modified ()

virtual unsigned long	GetMTime ()

unsigned long	AddObserver (unsigned long event, vtkCommand *, float priority=0.0f)

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 )

int	HasObserver (unsigned long event, vtkCommand *)

int	HasObserver (const char event, vtkCommand )

void	RemoveObserver (unsigned long tag)

void	RemoveObservers (unsigned long event)

void	RemoveObservers (const char *event)

void	RemoveAllObservers ()

int	HasObserver (unsigned long event)

int	HasObserver (const char *event)

template<class U , class T >
unsigned long	AddObserver (unsigned long event, U observer, void(T::*callback)(), float priority=0.0f)

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)

int	InvokeEvent (unsigned long event, void *callData)

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

virtual void	Delete ()

virtual void	FastDelete ()

void	Print (ostream &os)

virtual void	Register (vtkObjectBase *o)

virtual void	UnRegister (vtkObjectBase *o)

void	SetReferenceCount (int)

void	PrintRevisions (ostream &)

virtual void	PrintHeader (ostream &os, vtkIndent indent)

virtual void	PrintTrailer (ostream &os, vtkIndent indent)

int	GetReferenceCount ()

Static Public Member Functions
static int	IsTypeOf (const char *type)

static vtkBSPIntersections *	SafeDownCast (vtkObjectBase *o)

static vtkBSPIntersections *	New ()

Static Public Member Functions inherited from vtkObject
static int	IsTypeOf (const char *type)

static vtkObject *	SafeDownCast (vtkObjectBase *o)

static vtkObject *	New ()

static void	BreakOnError ()

static void	SetGlobalWarningDisplay (int val)

static void	GlobalWarningDisplayOn ()

static void	GlobalWarningDisplayOff ()

static int	GetGlobalWarningDisplay ()

Static Public Member Functions inherited from vtkObjectBase
static int	IsTypeOf (const char *name)

static vtkObjectBase *	New ()

Protected Types
enum	{ XDIM = 0, YDIM = 1, ZDIM = 2 }

Protected Member Functions
virtual vtkObjectBase *	NewInstanceInternal () const

	vtkBSPIntersections ()

	~vtkBSPIntersections ()

virtual unsigned long	GetRegionListBuildTime ()

int	BuildRegionList ()

vtkKdNode **	GetRegionList ()

Protected Member Functions inherited from vtkObject
	vtkObject ()

virtual	~vtkObject ()

virtual void	RegisterInternal (vtkObjectBase *, int check)

virtual void	UnRegisterInternal (vtkObjectBase *, int check)

void	InternalGrabFocus (vtkCommand mouseEvents, vtkCommand keypressEvents=NULL)

void	InternalReleaseFocus ()

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

Protected Attributes inherited from vtkObject
bool	Debug

vtkTimeStamp	MTime

vtkSubjectHelper *	SubjectHelper

Protected Attributes inherited from vtkObjectBase
vtkAtomicInt32	ReferenceCount

vtkWeakPointerBase **	WeakPointers

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 44 of file vtkBSPIntersections.h.

Member Typedef Documentation

typedef vtkObject vtkBSPIntersections::Superclass

Definition at line 47 of file vtkBSPIntersections.h.

Member Enumeration Documentation

anonymous enum

protected

Enumerator
XDIM
YDIM
ZDIM

Definition at line 146 of file vtkBSPIntersections.h.

Constructor & Destructor Documentation

vtkBSPIntersections::vtkBSPIntersections ( )

protected

vtkBSPIntersections::~vtkBSPIntersections ( )

protected

Member Function Documentation

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

static

virtual int 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 vtkObject.

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

static

virtual vtkObjectBase* vtkBSPIntersections::NewInstanceInternal ( ) const

protectedvirtual

Reimplemented from vtkObject.

vtkBSPIntersections* vtkBSPIntersections::NewInstance ( ) const

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

virtual

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

static vtkBSPIntersections* vtkBSPIntersections::New ( )

static

void vtkBSPIntersections::SetCuts ( vtkBSPCuts * cuts )

Define the binary spatial partitioning.

virtual vtkBSPCuts* vtkBSPIntersections::GetCuts ( )

virtual

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.

int vtkBSPIntersections::GetNumberOfRegions ( )

The number of regions in the binary spatial partitioning

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

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

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.

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

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

int vtkBSPIntersections::IntersectsBox	(	int	regionId,
		double	xmin,
		double	xmax,
		double	ymin,
		double	ymax,
		double	zmin,
		double	zmax
	)

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

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.

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.

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.

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.

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.

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

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

void vtkBSPIntersections::SetComputeIntersectionsUsingDataBounds ( int c )

void vtkBSPIntersections::ComputeIntersectionsUsingDataBoundsOn ( )

void vtkBSPIntersections::ComputeIntersectionsUsingDataBoundsOff ( )

virtual unsigned long vtkBSPIntersections::GetRegionListBuildTime ( )

protectedvirtual

int vtkBSPIntersections::BuildRegionList ( )

protected

vtkKdNode** vtkBSPIntersections::GetRegionList ( )

inlineprotected

Definition at line 141 of file vtkBSPIntersections.h.

Member Data Documentation

double vtkBSPIntersections::CellBoundsCache[6]

protected

Definition at line 143 of file vtkBSPIntersections.h.

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

/home/boeckb/code/depot/group-kitware/vtk/build-release/Utilities/Doxygen/dox/Common/DataModel/vtkBSPIntersections.h

Public Types

Public Member Functions

Static Public Member Functions

Protected Types

Protected Member Functions

Protected Attributes

Detailed Description

Member Typedef Documentation

Member Enumeration Documentation

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation