Octree node constituting incremental octree (in support of both point location and point insertion) More...

#include <vtkIncrementalOctreeNode.h>

Inheritance diagram for vtkIncrementalOctreeNode:

Collaboration diagram for vtkIncrementalOctreeNode:

Public Types
typedef vtkObject	Superclass

Public Types inherited from vtkObject
typedef vtkObjectBase	Superclass

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

vtkIncrementalOctreeNode *	NewInstance () const

void	PrintSelf (ostream &os, vtkIndent indent)

void	DeleteChildNodes ()

void	GetBounds (double bounds[6]) const

int	IsLeaf ()

int	GetChildIndex (const double point[3])

vtkIncrementalOctreeNode *	GetChild (int i)

int	ContainsPoint (const double pnt[3])

int	ContainsPointByData (const double pnt[3])

void	ExportAllPointIdsByInsertion (vtkIdList *idList)

void	ExportAllPointIdsByDirectSet (vtkIdType pntIdx, vtkIdList idList)


virtual int	GetNumberOfPoints ()


virtual vtkIdList *	GetPointIdSet ()


void	SetBounds (double x1, double x2, double y1, double y2, double z1, double z2)


virtual double *	GetMinBounds ()

virtual void	GetMinBounds (double &, double &, double &)

virtual void	GetMinBounds (double[3])


virtual double *	GetMaxBounds ()

virtual void	GetMaxBounds (double &, double &, double &)

virtual void	GetMaxBounds (double[3])


double *	GetMinDataBounds ()


double *	GetMaxDataBounds ()


int	InsertPoint (vtkPoints points, const double newPnt[3], int maxPts, vtkIdType pntId, int ptMode)


double	GetDistance2ToInnerBoundary (const double point[3], vtkIncrementalOctreeNode *rootNode)


double	GetDistance2ToBoundary (const double point[3], vtkIncrementalOctreeNode *rootNode, int checkData)


double	GetDistance2ToBoundary (const double point[3], double closest[3], vtkIncrementalOctreeNode *rootNode, int checkData)

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

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

	vtkIncrementalOctreeNode ()

	~vtkIncrementalOctreeNode ()

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

Additional Inherited Members
Protected Attributes inherited from vtkObject
bool	Debug

vtkTimeStamp	MTime

vtkSubjectHelper *	SubjectHelper

Protected Attributes inherited from vtkObjectBase
vtkAtomicInt32	ReferenceCount

vtkWeakPointerBase **	WeakPointers

Detailed Description

Octree node constituting incremental octree (in support of both point location and point insertion)

Octree nodes serve as spatial sub-division primitives to build the search structure of an incremental octree in a recursive top-down manner. The hierarchy takes the form of a tree-like representation by which a parent node contains eight mutually non-overlapping child nodes. Each child is assigned with an axis-aligned rectangular volume (Spatial Bounding Box) and the eight children together cover exactly the same region as governed by their parent. The eight child nodes / octants are ordered as

{ (xBBoxMin, xBBoxMid] & (yBBoxMin, yBBoxMid] & (zBBoxMin, zBBoxMid] }, { (xBBoxMid, xBBoxMax] & (yBBoxMin, yBBoxMid] & (zBBoxMin, zBBoxMid] }, { (xBBoxMin, xBBoxMid] & (yBBoxMid, yBBoxMax] & (zBBoxMin, zBBoxMid] }, { (xBBoxMid, xBBoxMax] & (yBBoxMid, yBBoxMax] & (zBBoxMin, zBBoxMid] }, { (xBBoxMin, xBBoxMid] & (yBBoxMin, yBBoxMid] & (zBBoxMid, zBBoxMax] }, { (xBBoxMid, xBBoxMax] & (yBBoxMin, yBBoxMid] & (zBBoxMid, zBBoxMax] }, { (xBBoxMin, xBBoxMid] & (yBBoxMid, yBBoxMax] & (zBBoxMid, zBBoxMax] }, { (xBBoxMid, xBBoxMax] & (yBBoxMid, yBBoxMax] & (zBBoxMid, zBBoxMax] },

where { xrange & yRange & zRange } defines the region of each 3D octant. In addition, the points falling within and registered, by means of point indices, in the parent node are distributed to the child nodes for delegated maintenance. In fact, only leaf nodes, i.e., those without any descendants, actually store point indices while each node, regardless of a leaf or non- leaf node, keeps a dynamically updated Data Bounding Box of the inhabitant points, if any. Given a maximum number of points per leaf node, an octree is initialized with an empty leaf node that is then recursively sub-divided, but only on demand as points are incrementally inserted, to construct a populated tree.

Please note that this octree node class is able to handle a large number of EXACTLY duplicate points that is greater than the specified maximum number of points per leaf node. In other words, as an exception, a leaf node may maintain an arbitrary number of exactly duplicate points to deal with possible extreme cases.

See also: vtkIncrementalOctreePointLocator

Definition at line 67 of file vtkIncrementalOctreeNode.h.

Member Typedef Documentation

typedef vtkObject vtkIncrementalOctreeNode::Superclass

Definition at line 70 of file vtkIncrementalOctreeNode.h.

Constructor & Destructor Documentation

vtkIncrementalOctreeNode::vtkIncrementalOctreeNode ( )

protected

vtkIncrementalOctreeNode::~vtkIncrementalOctreeNode ( )

protected

Member Function Documentation

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

static

virtual int vtkIncrementalOctreeNode::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 vtkIncrementalOctreeNode* vtkIncrementalOctreeNode::SafeDownCast ( vtkObjectBase * o )

static

virtual vtkObjectBase* vtkIncrementalOctreeNode::NewInstanceInternal ( ) const

protectedvirtual

Reimplemented from vtkObject.

vtkIncrementalOctreeNode* vtkIncrementalOctreeNode::NewInstance ( ) const

void vtkIncrementalOctreeNode::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 vtkIncrementalOctreeNode* vtkIncrementalOctreeNode::New ( )

static

virtual int vtkIncrementalOctreeNode::GetNumberOfPoints ( )

virtual

Get the number of points inside or under this node.

virtual vtkIdList* vtkIncrementalOctreeNode::GetPointIdSet ( )

virtual

Get the list of point indices, NULL for a non-leaf node.

void vtkIncrementalOctreeNode::DeleteChildNodes ( )

Delete the eight child nodes.

void vtkIncrementalOctreeNode::SetBounds	(	double	x1,
		double	x2,
		double	y1,
		double	y2,
		double	z1,
		double	z2
	)

Set the spatial bounding box of the node. This function sets a default data bounding box.

void vtkIncrementalOctreeNode::GetBounds ( double bounds[6] ) const

Get the spatial bounding box of the node. The values are returned via an array in order of: x_min, x_max, y_min, y_max, z_min, z_max.

virtual double* vtkIncrementalOctreeNode::GetMinBounds ( )

virtual

Get access to MinBounds. Do not free this pointer.

virtual void vtkIncrementalOctreeNode::GetMinBounds	(	double &	,
		double &	,
		double &
	)

virtual

Get access to MinBounds. Do not free this pointer.

virtual void vtkIncrementalOctreeNode::GetMinBounds ( double [3] )

virtual

Get access to MinBounds. Do not free this pointer.

virtual double* vtkIncrementalOctreeNode::GetMaxBounds ( )

virtual

Get access to MaxBounds. Do not free this pointer.

virtual void vtkIncrementalOctreeNode::GetMaxBounds	(	double &	,
		double &	,
		double &
	)

virtual

Get access to MaxBounds. Do not free this pointer.

virtual void vtkIncrementalOctreeNode::GetMaxBounds ( double [3] )

virtual

Get access to MaxBounds. Do not free this pointer.

double* vtkIncrementalOctreeNode::GetMinDataBounds ( )

inline

Get access to MinDataBounds. Note that MinDataBounds is not valid until point insertion.

Definition at line 112 of file vtkIncrementalOctreeNode.h.

double* vtkIncrementalOctreeNode::GetMaxDataBounds ( )

inline

Get access to MaxDataBounds. Note that MaxDataBounds is not valid until point insertion.

Definition at line 119 of file vtkIncrementalOctreeNode.h.

int vtkIncrementalOctreeNode::IsLeaf ( )

inline

Determine whether or not this node is a leaf.

Definition at line 124 of file vtkIncrementalOctreeNode.h.

int vtkIncrementalOctreeNode::GetChildIndex ( const double point[3] )

inline

Determine which specific child / octant contains a given point. Note that the point is assumed to be inside this node and no checking is performed on the inside issue.

Definition at line 344 of file vtkIncrementalOctreeNode.h.

vtkIncrementalOctreeNode* vtkIncrementalOctreeNode::GetChild ( int i )

inline

Get quick access to a child of this node. Note that this node is assumed to be a non-leaf one and no checking is performed on the node type.

Definition at line 134 of file vtkIncrementalOctreeNode.h.

int vtkIncrementalOctreeNode::ContainsPoint ( const double pnt[3] )

inline

A point is in a node if and only if MinBounds[i] < p[i] <= MaxBounds[i], which allows a node to be divided into eight non-overlapping children.

Definition at line 353 of file vtkIncrementalOctreeNode.h.

int vtkIncrementalOctreeNode::ContainsPointByData ( const double pnt[3] )

inline

A point is in a node, in terms of data, if and only if MinDataBounds[i] <= p[i] <= MaxDataBounds[i].

Definition at line 364 of file vtkIncrementalOctreeNode.h.

int vtkIncrementalOctreeNode::InsertPoint	(	vtkPoints *	points,
		const double	newPnt[3],
		int	maxPts,
		vtkIdType *	pntId,
		int	ptMode
	)

This function is called after a successful point-insertion check and only applies to a leaf node. Prior to a call to this function, the octree should have been retrieved top-down to find the specific leaf node in which this new point (newPt) will be inserted. The actual index of the new point (to be inserted to points) is stored in pntId. Argument ptMode specifies whether the point is not inserted at all but instead only the point index is provided upon 0, the point is inserted via vtkPoints:: InsertPoint() upon 1, or it is inserted via vtkPoints::InsertNextPoint() upon 2. For case 0, pntId needs to be specified. For cases 1 and 2, the actual point index is returned via pntId. Note that this function always returns 1 to indicate the success of point insertion.

double vtkIncrementalOctreeNode::GetDistance2ToInnerBoundary	(	const double	point[3],
		vtkIncrementalOctreeNode *	rootNode
	)

Given a point inside this node, get the minimum squared distance to all inner boundaries. An inner boundary is a node's face that is shared by another non-root node.

double vtkIncrementalOctreeNode::GetDistance2ToBoundary	(	const double	point[3],
		vtkIncrementalOctreeNode *	rootNode,
		int	checkData
	)

Compute the minimum squared distance from a point to this node, with all six boundaries considered. The data bounding box is checked if checkData is non-zero.

double vtkIncrementalOctreeNode::GetDistance2ToBoundary	(	const double	point[3],
		double	closest[3],
		vtkIncrementalOctreeNode *	rootNode,
		int	checkData
	)

Compute the minimum squared distance from a point to this node, with all six boundaries considered. The data bounding box is checked if checkData is non-zero. The closest on-boundary point is returned via closest.

void vtkIncrementalOctreeNode::ExportAllPointIdsByInsertion ( vtkIdList * idList )

Export all the indices of the points (contained in or under this node) by inserting them to an allocated vtkIdList via vtkIdList::InsertNextId().

void vtkIncrementalOctreeNode::ExportAllPointIdsByDirectSet	(	vtkIdType *	pntIdx,
		vtkIdList *	idList
	)

Export all the indices of the points (contained in or under this node) by directly setting them in an allocated vtkIdList object. pntIdx indicates the starting location (in terms of vtkIdList) from which new point indices are added to vtkIdList by vtkIdList::SetId().

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/vtkIncrementalOctreeNode.h

Public Types

Public Member Functions

Static Public Member Functions

Protected Member Functions

Additional Inherited Members

Detailed Description

Member Typedef Documentation

Constructor & Destructor Documentation

Member Function Documentation