vtkOctreePointLocatorNode Class Reference

#include <vtkOctreePointLocatorNode.h>

Inheritance diagram for vtkOctreePointLocatorNode:

[legend]

Collaboration diagram for vtkOctreePointLocatorNode:

[legend]

List of all members.

---

Detailed Description

Octree node that has 8 children each of equal size.

This class represents a single spatial region in a 3D axis octant partitioning. It is intended to work efficiently with the vtkOctreePointLocator and is not meant for general use. It is assumed the region bounds some set of points. The ordering of the children is (-x,-y,-z),(+x,-y,-z),(-x,+y,-z),(+x,+y,-z),(-x,-y,+z),(+x,-y,+z), (-x,+y,+z),(+x,+y,+z). The portion of the domain assigned to an octant is Min < x <= Max.

See also:

vtkOctreePointLocator

Definition at line 44 of file vtkOctreePointLocatorNode.h.

Public Types
typedef vtkObject	Superclass
Public Member Functions
virtual const char *	GetClassName ()
virtual int	IsA (const char *type)
void	PrintSelf (ostream &os, vtkIndent indent)
void	CreateChildNodes ()
void	DeleteChildNodes ()
vtkOctreePointLocatorNode *	GetChild (int i)
int	IntersectsRegion (vtkPlanesIntersection *pi, int useDataBounds)
int	ContainsPoint (double x, double y, double z, int useDataBounds)
int	GetSubOctantIndex (double *point, int CheckContainment)
void	SetNumberOfPoints (int numberOfPoints)
virtual int	GetNumberOfPoints ()
void	SetBounds (double xMin, double xMax, double yMin, double yMax, double zMin, double zMax)
void	SetBounds (double b[6])
void	GetBounds (double *b) const
void	SetDataBounds (double xMin, double xMax, double yMin, double yMax, double zMin, double zMax)
void	GetDataBounds (double *b) const
virtual double *	GetMinBounds ()
virtual double *	GetMaxBounds ()
void	SetMinBounds (double minBounds[3])
void	SetMaxBounds (double maxBounds[3])
virtual double *	GetMinDataBounds ()
virtual double *	GetMaxDataBounds ()
void	SetMinDataBounds (double minDataBounds[3])
void	SetMaxDataBounds (double maxDataBounds[3])
virtual int	GetID ()
virtual int	GetMinID ()
double	GetDistance2ToBoundary (double x, double y, double z, vtkOctreePointLocatorNode *top, int useDataBounds)
double	GetDistance2ToBoundary (double x, double y, double z, double *boundaryPt, vtkOctreePointLocatorNode *top, int useDataBounds)
double	GetDistance2ToInnerBoundary (double x, double y, double z, vtkOctreePointLocatorNode *top)
void	ComputeOctreeNodeInformation (vtkOctreePointLocatorNode *Parent, int &NextLeafId, int &NextMinId, float *coordinates)
Static Public Member Functions
static int	IsTypeOf (const char *type)
static vtkOctreePointLocatorNode *	SafeDownCast (vtkObject *o)
static vtkOctreePointLocatorNode *	New ()
Protected Member Functions
	vtkOctreePointLocatorNode ()
	~vtkOctreePointLocatorNode ()

---

Member Typedef Documentation

typedef vtkObject vtkOctreePointLocatorNode::Superclass

Reimplemented from vtkObject.

Definition at line 47 of file vtkOctreePointLocatorNode.h.

---

Constructor & Destructor Documentation

vtkOctreePointLocatorNode::vtkOctreePointLocatorNode

(

)

[protected]

vtkOctreePointLocatorNode::~vtkOctreePointLocatorNode

(

)

[protected]

---

Member Function Documentation

virtual const char* vtkOctreePointLocatorNode::GetClassName

(

)

[virtual]

Reimplemented from vtkObject.

static int vtkOctreePointLocatorNode::IsTypeOf

(

const char *

name

)

[static]

Return 1 if this class type 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.

virtual int vtkOctreePointLocatorNode::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 vtkOctreePointLocatorNode* vtkOctreePointLocatorNode::SafeDownCast

(

vtkObject *

o

)

[static]

Reimplemented from vtkObject.

void vtkOctreePointLocatorNode::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 vtkOctreePointLocatorNode* vtkOctreePointLocatorNode::New

(

)

[static]

Create an object with Debug turned off, modified time initialized to zero, and reference counting on.

Reimplemented from vtkObject.

void vtkOctreePointLocatorNode::SetNumberOfPoints

(

int

numberOfPoints

)

[inline]

Set/Get the number of points contained in this region.

Definition at line 54 of file vtkOctreePointLocatorNode.h.

virtual int vtkOctreePointLocatorNode::GetNumberOfPoints

(

)

[virtual]

Set/Get the number of points contained in this region.

void vtkOctreePointLocatorNode::SetBounds	(	double	xMin,
		double	xMax,
		double	yMin,
		double	yMax,
		double	zMin,
		double	zMax
	)

Set/Get the bounds of the spatial region represented by this node. Caller allocates storage for 6-vector in GetBounds.

void vtkOctreePointLocatorNode::SetBounds

(

double

b[6]

)

[inline]

Set/Get the bounds of the spatial region represented by this node. Caller allocates storage for 6-vector in GetBounds.

Definition at line 66 of file vtkOctreePointLocatorNode.h.

void vtkOctreePointLocatorNode::GetBounds

(

double *

b

)

const

Set/Get the bounds of the spatial region represented by this node. Caller allocates storage for 6-vector in GetBounds.

void vtkOctreePointLocatorNode::SetDataBounds	(	double	xMin,
		double	xMax,
		double	yMin,
		double	yMax,
		double	zMin,
		double	zMax
	)

Set/Get the bounds of the points contained in this spatial region. This may be smaller than the bounds of the region itself. Caller allocates storage for 6-vector in GetDataBounds.

void vtkOctreePointLocatorNode::GetDataBounds

(

double *

b

)

const

Set/Get the bounds of the points contained in this spatial region. This may be smaller than the bounds of the region itself. Caller allocates storage for 6-vector in GetDataBounds.

virtual double* vtkOctreePointLocatorNode::GetMinBounds

(

)

[virtual]

Get a pointer to the 3 bound minima (xmin, ymin and zmin) or the 3 bound maxima (xmax, ymax, zmax). Don't free this pointer. BTX

virtual double* vtkOctreePointLocatorNode::GetMaxBounds

(

)

[virtual]

Get a pointer to the 3 bound minima (xmin, ymin and zmin) or the 3 bound maxima (xmax, ymax, zmax). Don't free this pointer. BTX

void vtkOctreePointLocatorNode::SetMinBounds

(

double

minBounds[3]

)

[inline]

Set the xmin, ymin and zmin value of the bounds of this region

Definition at line 92 of file vtkOctreePointLocatorNode.h.

void vtkOctreePointLocatorNode::SetMaxBounds

(

double

maxBounds[3]

)

[inline]

Set the xmax, ymax and zmax value of the bounds of this region

Definition at line 102 of file vtkOctreePointLocatorNode.h.

virtual double* vtkOctreePointLocatorNode::GetMinDataBounds

(

)

[virtual]

Get a pointer to the 3 data bound minima (xmin, ymin and zmin) or the 3 data bound maxima (xmax, ymax, zmax). Don't free this pointer. BTX

virtual double* vtkOctreePointLocatorNode::GetMaxDataBounds

(

)

[virtual]

Get a pointer to the 3 data bound minima (xmin, ymin and zmin) or the 3 data bound maxima (xmax, ymax, zmax). Don't free this pointer. BTX

void vtkOctreePointLocatorNode::SetMinDataBounds

(

double

minDataBounds[3]

)

[inline]

Set the xmin, ymin and zmin value of the bounds of this data within this region.

Definition at line 121 of file vtkOctreePointLocatorNode.h.

void vtkOctreePointLocatorNode::SetMaxDataBounds

(

double

maxDataBounds[3]

)

[inline]

Set the xmax, ymax and zmax value of the bounds of this data within this region.

Definition at line 132 of file vtkOctreePointLocatorNode.h.

virtual int vtkOctreePointLocatorNode::GetID

(

)

[virtual]

Get the ID associated with the region described by this node. If this is not a leaf node, this value should be -1.

virtual int vtkOctreePointLocatorNode::GetMinID

(

)

[virtual]

If this node is not a leaf node, there are leaf nodes below it whose regions represent a partitioning of this region. The IDs of these leaf nodes form a contigous set. Get the first of the first point's ID that is contained in this node.

void vtkOctreePointLocatorNode::CreateChildNodes

(

)

Add the 8 children.

void vtkOctreePointLocatorNode::DeleteChildNodes

(

)

Delete the 8 children.

vtkOctreePointLocatorNode* vtkOctreePointLocatorNode::GetChild

(

int

i

)

Get a pointer to the ith child of this node.

int vtkOctreePointLocatorNode::IntersectsRegion	(	vtkPlanesIntersection *	pi,
		int	useDataBounds
	)

A vtkPlanesIntersection object represents a convex 3D region bounded by planes, and it is capable of computing intersections of boxes with itself. Return 1 if this spatial region intersects the spatial region described by the vtkPlanesIntersection object. Use the possibly smaller bounds of the points within the region if useDataBounds is non-zero.

int vtkOctreePointLocatorNode::ContainsPoint	(	double	x,
		double	y,
		double	z,
		int	useDataBounds
	)

Return 1 if this spatial region entirely contains the given point. Use the possibly smaller bounds of the points within the region if useDataBounds is non-zero.

double vtkOctreePointLocatorNode::GetDistance2ToBoundary	(	double	x,
		double	y,
		double	z,
		vtkOctreePointLocatorNode *	top,
		int	useDataBounds
	)

Calculate the distance squared from any point to the boundary of this region. Use the boundary of the points within the region if useDataBounds is non-zero.

double vtkOctreePointLocatorNode::GetDistance2ToBoundary	(	double	x,
		double	y,
		double	z,
		double *	boundaryPt,
		vtkOctreePointLocatorNode *	top,
		int	useDataBounds
	)

Calculate the distance squared from any point to the boundary of this region. Use the boundary of the points within the region if useDataBounds is non-zero. Set boundaryPt to the point on the boundary.

double vtkOctreePointLocatorNode::GetDistance2ToInnerBoundary	(	double	x,
		double	y,
		double	z,
		vtkOctreePointLocatorNode *	top
	)

Calculate the distance from the specified point (which is required to be inside this spatial region) to an interior boundary. An interior boundary is one that is not also an boundary of the entire space partitioned by the tree of vtkOctreePointLocatorNode's.

int vtkOctreePointLocatorNode::GetSubOctantIndex	(	double *	point,
		int	CheckContainment
	)

Return the id of the suboctant that a given point is in. If CheckContainment is non-zero then it checks whether the point is in the actual bounding box of the suboctant, otherwise it only checks which octant the point is in that is created from the axis-aligned partitioning of the domain at this octant's center.

void vtkOctreePointLocatorNode::ComputeOctreeNodeInformation	(	vtkOctreePointLocatorNode *	Parent,
		int &	NextLeafId,
		int &	NextMinId,
		float *	coordinates
	)

Recursive function to compute ID, MinVal, MaxVal, and MinID. Parent is used for MinVal and MaxVal in the case that no points are in the leaf node.

---

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

• dox/Filtering/vtkOctreePointLocatorNode.h