generate oriented bounding box (OBB) tree More...

#include <vtkOBBTree.h>

Inheritance diagram for vtkOBBTree:

Collaboration diagram for vtkOBBTree:

Public Types
typedef vtkAbstractCellLocator	Superclass

Public Types inherited from vtkAbstractCellLocator
typedef vtkLocator	Superclass

Public Types inherited from vtkLocator
typedef vtkObject	Superclass

Public Types inherited from vtkObject
typedef vtkObjectBase	Superclass

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

vtkOBBTree *	NewInstance () const

void	PrintSelf (ostream &os, vtkIndent indent)

int	InsideOrOutside (const double point[3])

int	LineIntersectsNode (vtkOBBNode *pA, double b0[3], double b1[3])

void	GenerateRepresentation (int level, vtkPolyData *pd)


int	IntersectWithLine (const double a0[3], const double a1[3], vtkPoints points, vtkIdList cellIds)


int	IntersectWithLine (double a0[3], double a1[3], double tol, double &t, double x[3], double pcoords[3], int &subId, vtkIdType &cellId, vtkGenericCell *cell)


void	ComputeOBB (vtkDataSet *input, double corner[3], double max[3], double mid[3], double min[3], double size[3])


int	DisjointOBBNodes (vtkOBBNode nodeA, vtkOBBNode nodeB, vtkMatrix4x4 *XformBtoA)


int	TriangleIntersectsNode (vtkOBBNode pA, double p0[3], double p1[3], double p2[3], vtkMatrix4x4 XformBtoA)


int	IntersectWithOBBTree (vtkOBBTree OBBTreeB, vtkMatrix4x4 XformBtoA, int(function)(vtkOBBNode nodeA, vtkOBBNode nodeB, vtkMatrix4x4 Xform, void arg), void data_arg)


void	FreeSearchStructure ()

void	BuildLocator ()

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

virtual void	FindCellsWithinBounds (double bbox, vtkIdList cells)

virtual vtkIdType	FindCell (double x[3])

virtual bool	InsideCellBounds (double x[3], vtkIdType cell_ID)

virtual void	SetNumberOfCellsPerNode (int)

virtual int	GetNumberOfCellsPerNode ()

virtual void	SetCacheCellBounds (int)

virtual int	GetCacheCellBounds ()

virtual void	CacheCellBoundsOn ()

virtual void	CacheCellBoundsOff ()

virtual void	SetRetainCellLists (int)

virtual int	GetRetainCellLists ()

virtual void	RetainCellListsOn ()

virtual void	RetainCellListsOff ()

virtual void	SetLazyEvaluation (int)

virtual int	GetLazyEvaluation ()

virtual void	LazyEvaluationOn ()

virtual void	LazyEvaluationOff ()

virtual void	SetUseExistingSearchStructure (int)

virtual int	GetUseExistingSearchStructure ()

virtual void	UseExistingSearchStructureOn ()

virtual void	UseExistingSearchStructureOff ()

virtual int	IntersectWithLine (double p1[3], double p2[3], double tol, double &t, double x[3], double pcoords[3], int &subId)

virtual int	IntersectWithLine (double p1[3], double p2[3], double tol, double &t, double x[3], double pcoords[3], int &subId, vtkIdType &cellId)

virtual void	FindClosestPoint (double x[3], double closestPoint[3], vtkIdType &cellId, int &subId, double &dist2)

virtual void	FindClosestPoint (double x[3], double closestPoint[3], vtkGenericCell *cell, vtkIdType &cellId, int &subId, double &dist2)

virtual vtkIdType	FindClosestPointWithinRadius (double x[3], double radius, double closestPoint[3], vtkIdType &cellId, int &subId, double &dist2)

virtual vtkIdType	FindClosestPointWithinRadius (double x[3], double radius, double closestPoint[3], vtkGenericCell *cell, vtkIdType &cellId, int &subId, double &dist2)

virtual vtkIdType	FindClosestPointWithinRadius (double x[3], double radius, double closestPoint[3], vtkGenericCell *cell, vtkIdType &cellId, int &subId, double &dist2, int &inside)

virtual void	FindCellsAlongLine (double p1[3], double p2[3], double tolerance, vtkIdList *cells)

virtual vtkIdType	FindCell (double x[3], double tol2, vtkGenericCell GenCell, double pcoords[3], double weights)

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

virtual void	Update ()

virtual void	Initialize ()

virtual void	SetDataSet (vtkDataSet *)

virtual vtkDataSet *	GetDataSet ()

virtual void	SetMaxLevel (int)

virtual int	GetMaxLevel ()

virtual int	GetLevel ()

virtual void	SetAutomatic (int)

virtual int	GetAutomatic ()

virtual void	AutomaticOn ()

virtual void	AutomaticOff ()

virtual void	SetTolerance (double)

virtual double	GetTolerance ()

virtual unsigned long	GetBuildTime ()

virtual void	Register (vtkObjectBase *o)

virtual void	UnRegister (vtkObjectBase *o)

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)

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 vtkOBBTree *	SafeDownCast (vtkObjectBase *o)

static vtkOBBTree *	New ()


static void	ComputeOBB (vtkPoints *pts, double corner[3], double max[3], double mid[3], double min[3], double size[3])

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

static vtkAbstractCellLocator *	SafeDownCast (vtkObjectBase *o)

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

static vtkLocator *	SafeDownCast (vtkObjectBase *o)

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 Member Functions
virtual vtkObjectBase *	NewInstanceInternal () const

	vtkOBBTree ()

	~vtkOBBTree ()

void	ComputeOBB (vtkIdList *cells, double corner[3], double max[3], double mid[3], double min[3], double size[3])

void	BuildTree (vtkIdList cells, vtkOBBNode parent, int level)

void	DeleteTree (vtkOBBNode *OBBptr)

void	GeneratePolygons (vtkOBBNode OBBptr, int level, int repLevel, vtkPoints pts, vtkCellArray *polys)

Protected Member Functions inherited from vtkAbstractCellLocator
	vtkAbstractCellLocator ()

	~vtkAbstractCellLocator ()

virtual bool	StoreCellBounds ()

virtual void	FreeCellBounds ()

Protected Member Functions inherited from vtkLocator
virtual void	ReportReferences (vtkGarbageCollector *)

	vtkLocator ()

	~vtkLocator ()

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

	vtkObjectBase (const vtkObjectBase &)

void	operator= (const vtkObjectBase &)

Protected Attributes
vtkOBBNode *	Tree

vtkPoints *	PointsList

int *	InsertedPoints

int	OBBCount

Protected Attributes inherited from vtkAbstractCellLocator
int	NumberOfCellsPerNode

int	RetainCellLists

int	CacheCellBounds

int	LazyEvaluation

int	UseExistingSearchStructure

vtkGenericCell *	GenericCell

double(*	CellBounds )[6]

Protected Attributes inherited from vtkLocator
vtkDataSet *	DataSet

int	Automatic

double	Tolerance

int	MaxLevel

int	Level

vtkTimeStamp	BuildTime

Protected Attributes inherited from vtkObject
bool	Debug

vtkTimeStamp	MTime

vtkSubjectHelper *	SubjectHelper

Protected Attributes inherited from vtkObjectBase
vtkAtomicInt32	ReferenceCount

vtkWeakPointerBase **	WeakPointers

Detailed Description

generate oriented bounding box (OBB) tree

vtkOBBTree is an object to generate oriented bounding box (OBB) trees. An oriented bounding box is a bounding box that does not necessarily line up along coordinate axes. The OBB tree is a hierarchical tree structure of such boxes, where deeper levels of OBB confine smaller regions of space.

To build the OBB, a recursive, top-down process is used. First, the root OBB is constructed by finding the mean and covariance matrix of the cells (and their points) that define the dataset. The eigenvectors of the covariance matrix are extracted, giving a set of three orthogonal vectors that define the tightest-fitting OBB. To create the two children OBB's, a split plane is found that (approximately) divides the number cells in half. These are then assigned to the children OBB's. This process then continues until the MaxLevel ivar limits the recursion, or no split plane can be found.

A good reference for OBB-trees is Gottschalk & Manocha in Proceedings of Siggraph `96.

Warning: Since this algorithms works from a list of cells, the OBB tree will only bound the "geometry" attached to the cells if the convex hull of the cells bounds the geometry.; Long, skinny cells (i.e., cells with poor aspect ratio) may cause unsatisfactory results. This is due to the fact that this is a top-down implementation of the OBB tree, requiring that one or more complete cells are contained in each OBB. This requirement makes it hard to find good split planes during the recursion process. A bottom-up implementation would go a long way to correcting this problem.

See also: vtkLocator vtkCellLocator vtkPointLocator

Tests:: vtkOBBTree (Tests)

Definition at line 87 of file vtkOBBTree.h.

Member Typedef Documentation

typedef vtkAbstractCellLocator vtkOBBTree::Superclass

Definition at line 90 of file vtkOBBTree.h.

Constructor & Destructor Documentation

vtkOBBTree::vtkOBBTree ( )

protected

vtkOBBTree::~vtkOBBTree ( )

protected

Member Function Documentation

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

static

virtual int vtkOBBTree::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 vtkAbstractCellLocator.

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

static

virtual vtkObjectBase* vtkOBBTree::NewInstanceInternal ( ) const

protectedvirtual

Reimplemented from vtkAbstractCellLocator.

vtkOBBTree* vtkOBBTree::NewInstance ( ) const

void vtkOBBTree::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 vtkAbstractCellLocator.

static vtkOBBTree* vtkOBBTree::New ( )

static

Construct with automatic computation of divisions, averaging 25 cells per octant.

int vtkOBBTree::IntersectWithLine	(	const double	a0[3],
		const double	a1[3],
		vtkPoints *	points,
		vtkIdList *	cellIds
	)

virtual

Take the passed line segment and intersect it with the data set. This method assumes that the data set is a vtkPolyData that describes a closed surface, and the intersection points that are returned in 'points' alternate between entrance points and exit points. The return value of the function is 0 if no intersections were found, -1 if point 'a0' lies inside the closed surface, or +1 if point 'a0' lies outside the closed surface. Either 'points' or 'cellIds' can be set to NULL if you don't want to receive that information.

Reimplemented from vtkAbstractCellLocator.

int vtkOBBTree::IntersectWithLine	(	double	a0[3],
		double	a1[3],
		double	tol,
		double &	t,
		double	x[3],
		double	pcoords[3],
		int &	subId,
		vtkIdType &	cellId,
		vtkGenericCell *	cell
	)

virtual

Return the first intersection of the specified line segment with the OBB tree, as well as information about the cell which the line segment intersected.

Reimplemented from vtkAbstractCellLocator.

static void vtkOBBTree::ComputeOBB	(	vtkPoints *	pts,
		double	corner[3],
		double	max[3],
		double	mid[3],
		double	min[3],
		double	size[3]
	)

static

Compute an OBB from the list of points given. Return the corner point and the three axes defining the orientation of the OBB. Also return a sorted list of relative "sizes" of axes for comparison purposes.

void vtkOBBTree::ComputeOBB	(	vtkDataSet *	input,
		double	corner[3],
		double	max[3],
		double	mid[3],
		double	min[3],
		double	size[3]
	)

Compute an OBB for the input dataset using the cells in the data. Return the corner point and the three axes defining the orientation of the OBB. Also return a sorted list of relative "sizes" of axes for comparison purposes.

int vtkOBBTree::InsideOrOutside ( const double point[3] )

Determine whether a point is inside or outside the data used to build this OBB tree. The data must be a closed surface vtkPolyData data set. The return value is +1 if outside, -1 if inside, and 0 if undecided.

int vtkOBBTree::DisjointOBBNodes	(	vtkOBBNode *	nodeA,
		vtkOBBNode *	nodeB,
		vtkMatrix4x4 *	XformBtoA
	)

Returns true if nodeB and nodeA are disjoint after optional transformation of nodeB with matrix XformBtoA

int vtkOBBTree::LineIntersectsNode	(	vtkOBBNode *	pA,
		double	b0[3],
		double	b1[3]
	)

Returns true if line intersects node.

int vtkOBBTree::TriangleIntersectsNode	(	vtkOBBNode *	pA,
		double	p0[3],
		double	p1[3],
		double	p2[3],
		vtkMatrix4x4 *	XformBtoA
	)

Returns true if triangle (optionally transformed) intersects node.

int vtkOBBTree::IntersectWithOBBTree	(	vtkOBBTree *	OBBTreeB,
		vtkMatrix4x4 *	XformBtoA,
		int()(vtkOBBNode nodeA, vtkOBBNode nodeB, vtkMatrix4x4 Xform, void *arg)	function,
		void *	data_arg
	)

For each intersecting leaf node pair, call function. OBBTreeB is optionally transformed by XformBtoA before testing.

void vtkOBBTree::FreeSearchStructure ( )

virtual

Satisfy locator's abstract interface, see vtkLocator.

Implements vtkLocator.

void vtkOBBTree::BuildLocator ( )

virtual

Satisfy locator's abstract interface, see vtkLocator.

Implements vtkLocator.

void vtkOBBTree::GenerateRepresentation	(	int	level,
		vtkPolyData *	pd
	)

virtual

Create polygonal representation for OBB tree at specified level. If level < 0, then the leaf OBB nodes will be gathered. The aspect ratio (ar) and line diameter (d) are used to control the building of the representation. If a OBB node edge ratio's are greater than ar, then the dimension of the OBB is collapsed (OBB->plane->line). A "line" OBB will be represented either as two crossed polygons, or as a line, depending on the relative diameter of the OBB compared to the diameter (d).

Implements vtkLocator.

void vtkOBBTree::ComputeOBB	(	vtkIdList *	cells,
		double	corner[3],
		double	max[3],
		double	mid[3],
		double	min[3],
		double	size[3]
	)

protected

void vtkOBBTree::BuildTree	(	vtkIdList *	cells,
		vtkOBBNode *	parent,
		int	level
	)

protected

void vtkOBBTree::DeleteTree ( vtkOBBNode * OBBptr )

protected

void vtkOBBTree::GeneratePolygons	(	vtkOBBNode *	OBBptr,
		int	level,
		int	repLevel,
		vtkPoints *	pts,
		vtkCellArray *	polys
	)

protected

Member Data Documentation

vtkOBBNode* vtkOBBTree::Tree

protected

Definition at line 203 of file vtkOBBTree.h.

vtkPoints* vtkOBBTree::PointsList

protected

Definition at line 205 of file vtkOBBTree.h.

int* vtkOBBTree::InsertedPoints

protected

Definition at line 206 of file vtkOBBTree.h.

int vtkOBBTree::OBBCount

protected

Definition at line 207 of file vtkOBBTree.h.

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

/home/boeckb/code/depot/group-kitware/vtk/build-release/Utilities/Doxygen/dox/Filters/General/vtkOBBTree.h

Public Types

Public Member Functions

Static Public Member Functions

Protected Member Functions

Protected Attributes

Detailed Description

Member Typedef Documentation

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation