Octree node that has 8 children each of equal size. More...

#include <vtkOctreePointLocatorNode.h>

Inheritance diagram for vtkOctreePointLocatorNode:

Collaboration diagram for vtkOctreePointLocatorNode:

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

vtkOctreePointLocatorNode *	NewInstance () const

void	PrintSelf (ostream &os, vtkIndent indent) override
	Methods invoked by print to print information about the object including superclasses. More...

void	CreateChildNodes ()
	Add the 8 children. More...

void	DeleteChildNodes ()
	Delete the 8 children. More...

vtkOctreePointLocatorNode *	GetChild (int i)
	Get a pointer to the ith child of this node. More...

int	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. More...

vtkTypeBool	ContainsPoint (double x, double y, double z, int useDataBounds)
	Return 1 if this spatial region entirely contains the given point. More...

double	GetDistance2ToBoundary (double x, double y, double z, vtkOctreePointLocatorNode *top, int useDataBounds)
	Calculate the distance squared from any point to the boundary of this region. More...

double	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. More...

double	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. More...

int	GetSubOctantIndex (double *point, int CheckContainment)
	Return the id of the suboctant that a given point is in. More...

void	ComputeOctreeNodeInformation (vtkOctreePointLocatorNode Parent, int &NextLeafId, int &NextMinId, float coordinates)
	Recursive function to compute ID, MinVal, MaxVal, and MinID. More...


void	SetNumberOfPoints (int numberOfPoints)
	Set/Get the number of points contained in this region. More...

virtual int	GetNumberOfPoints ()
	Set/Get the number of points contained in this region. More...


void	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. More...

void	SetBounds (const double b[6])
	Set/Get the bounds of the spatial region represented by this node. More...

void	GetBounds (double *b) const
	Set/Get the bounds of the spatial region represented by this node. More...


void	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. More...

void	GetDataBounds (double *b) const
	Set/Get the bounds of the points contained in this spatial region. More...


virtual double *	GetMinBounds ()
	Get a pointer to the 3 bound minima (xmin, ymin and zmin) or the 3 bound maxima (xmax, ymax, zmax). More...

virtual double *	GetMaxBounds ()
	Get a pointer to the 3 bound minima (xmin, ymin and zmin) or the 3 bound maxima (xmax, ymax, zmax). More...


void	SetMinBounds (double minBounds[3])
	Set the xmin, ymin and zmin value of the bounds of this region. More...


void	SetMaxBounds (double maxBounds[3])
	Set the xmax, ymax and zmax value of the bounds of this region. More...


virtual double *	GetMinDataBounds ()
	Get a pointer to the 3 data bound minima (xmin, ymin and zmin) or the 3 data bound maxima (xmax, ymax, zmax). More...

virtual double *	GetMaxDataBounds ()
	Get a pointer to the 3 data bound minima (xmin, ymin and zmin) or the 3 data bound maxima (xmax, ymax, zmax). More...


void	SetMinDataBounds (double minDataBounds[3])
	Set the xmin, ymin and zmin value of the bounds of this data within this region. More...


void	SetMaxDataBounds (double maxDataBounds[3])
	Set the xmax, ymax and zmax value of the bounds of this data within this region. More...


virtual int	GetID ()
	Get the ID associated with the region described by this node. More...


virtual int	GetMinID ()
	If this node is not a leaf node, there are leaf nodes below it whose regions represent a partitioning of this region. More...

Public Member Functions inherited from vtkObject
	vtkBaseTypeMacro (vtkObject, vtkObjectBase)

virtual void	DebugOn ()
	Turn debugging output on. More...

virtual void	DebugOff ()
	Turn debugging output off. More...

bool	GetDebug ()
	Get the value of the debug flag. More...

void	SetDebug (bool debugFlag)
	Set the value of the debug flag. More...

virtual void	Modified ()
	Update the modification time for this object. More...

virtual vtkMTimeType	GetMTime ()
	Return this object's modified time. More...

void	PrintSelf (ostream &os, vtkIndent indent) override
	Methods invoked by print to print information about the object including superclasses. More...

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)

int	InvokeEvent (unsigned long event)

int	InvokeEvent (const char *event)

unsigned long	AddObserver (unsigned long event, vtkCommand *, float priority=0.0f)
	Allow people to add/remove/invoke observers (callbacks) to any VTK object. More...

unsigned long	AddObserver (const char event, vtkCommand , float priority=0.0f)
	Allow people to add/remove/invoke observers (callbacks) to any VTK object. More...

vtkCommand *	GetCommand (unsigned long tag)
	Allow people to add/remove/invoke observers (callbacks) to any VTK object. More...

void	RemoveObserver (vtkCommand *)
	Allow people to add/remove/invoke observers (callbacks) to any VTK object. More...

void	RemoveObservers (unsigned long event, vtkCommand *)
	Allow people to add/remove/invoke observers (callbacks) to any VTK object. More...

void	RemoveObservers (const char event, vtkCommand )
	Allow people to add/remove/invoke observers (callbacks) to any VTK object. More...

vtkTypeBool	HasObserver (unsigned long event, vtkCommand *)
	Allow people to add/remove/invoke observers (callbacks) to any VTK object. More...

vtkTypeBool	HasObserver (const char event, vtkCommand )
	Allow people to add/remove/invoke observers (callbacks) to any VTK object. More...

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

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

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

int	InvokeEvent (unsigned long event, void *callData)
	This method invokes an event and return whether the event was aborted or not. More...

int	InvokeEvent (const char event, void callData)
	This method invokes an event and return whether the event was aborted or not. More...

Public Member Functions inherited from vtkObjectBase
const char *	GetClassName () const
	Return the class name as a string. More...

virtual vtkTypeBool	IsA (const char *name)
	Return 1 if this class is the same type of (or a subclass of) the named class. More...

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

virtual void	Delete ()
	Delete a VTK object. More...

virtual void	FastDelete ()
	Delete a reference to this object. More...

void	InitializeObjectBase ()

void	Print (ostream &os)
	Print an object to an ostream. More...

virtual void	Register (vtkObjectBase *o)
	Increase the reference count (mark as used by another object). More...

virtual void	UnRegister (vtkObjectBase *o)
	Decrease the reference count (release by another object). More...

int	GetReferenceCount ()
	Return the current reference count of this object. More...

void	SetReferenceCount (int)
	Sets the reference count. More...

bool	GetIsInMemkind () const
	A local state flag that remembers whether this object lives in the normal or extended memory space. More...

virtual void	PrintHeader (ostream &os, vtkIndent indent)
	Methods invoked by print to print information about the object including superclasses. More...

virtual void	PrintTrailer (ostream &os, vtkIndent indent)
	Methods invoked by print to print information about the object including superclasses. More...

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

static vtkOctreePointLocatorNode *	SafeDownCast (vtkObjectBase *o)

static vtkOctreePointLocatorNode *	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. More...

static void	BreakOnError ()
	This method is called when vtkErrorMacro executes. More...

static void	SetGlobalWarningDisplay (int val)
	This is a global flag that controls whether any debug, warning or error messages are displayed. More...

static void	GlobalWarningDisplayOn ()
	This is a global flag that controls whether any debug, warning or error messages are displayed. More...

static void	GlobalWarningDisplayOff ()
	This is a global flag that controls whether any debug, warning or error messages are displayed. More...

static int	GetGlobalWarningDisplay ()
	This is a global flag that controls whether any debug, warning or error messages are displayed. More...

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

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

static vtkObjectBase *	New ()
	Create an object with Debug turned off, modified time initialized to zero, and reference counting on. More...

static void	SetMemkindDirectory (const char *directoryname)
	The name of a directory, ideally mounted -o dax, to memory map an extended memory space within. More...

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

Protected Member Functions
virtual vtkObjectBase *	NewInstanceInternal () const

	vtkOctreePointLocatorNode ()

	~vtkOctreePointLocatorNode () override

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

void	InternalReleaseFocus ()
	These methods allow a command to exclusively grab all events. More...

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

	vtkObjectBase (const vtkObjectBase &)

void	operator= (const vtkObjectBase &)

Additional Inherited Members
Static Protected Member Functions inherited from vtkObjectBase
static vtkMallocingFunction	GetCurrentMallocFunction ()

static vtkReallocingFunction	GetCurrentReallocFunction ()

static vtkFreeingFunction	GetCurrentFreeFunction ()

static vtkFreeingFunction	GetAlternateFreeFunction ()

Protected Attributes inherited from vtkObject
bool	Debug

vtkTimeStamp	MTime

vtkSubjectHelper *	SubjectHelper

Protected Attributes inherited from vtkObjectBase
std::atomic< int32_t >	ReferenceCount

vtkWeakPointerBase **	WeakPointers

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 46 of file vtkOctreePointLocatorNode.h.

Member Typedef Documentation

◆ Superclass

typedef vtkObject vtkOctreePointLocatorNode::Superclass

Definition at line 49 of file vtkOctreePointLocatorNode.h.

Constructor & Destructor Documentation

◆ vtkOctreePointLocatorNode()

vtkOctreePointLocatorNode::vtkOctreePointLocatorNode ( )

protected

◆ ~vtkOctreePointLocatorNode()

vtkOctreePointLocatorNode::~vtkOctreePointLocatorNode ( )

overrideprotected

Member Function Documentation

◆ IsTypeOf()

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

static

◆ IsA()

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

◆ SafeDownCast()

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

static

◆ NewInstanceInternal()

virtual vtkObjectBase * vtkOctreePointLocatorNode::NewInstanceInternal ( ) const

protectedvirtual

◆ NewInstance()

vtkOctreePointLocatorNode * vtkOctreePointLocatorNode::NewInstance ( ) const

◆ PrintSelf()

void vtkOctreePointLocatorNode::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 vtkObject.

◆ New()

static vtkOctreePointLocatorNode * vtkOctreePointLocatorNode::New ( )

static

◆ SetNumberOfPoints()

void vtkOctreePointLocatorNode::SetNumberOfPoints ( int numberOfPoints )

inline

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

Definition at line 58 of file vtkOctreePointLocatorNode.h.

◆ GetNumberOfPoints()

virtual int vtkOctreePointLocatorNode::GetNumberOfPoints ( )

virtual

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

◆ SetBounds() [1/2]

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.

◆ SetBounds() [2/2]

void vtkOctreePointLocatorNode::SetBounds ( const 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 68 of file vtkOctreePointLocatorNode.h.

◆ GetBounds()

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.

◆ SetDataBounds()

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.

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

◆ GetMinBounds()

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.

◆ GetMaxBounds()

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.

◆ SetMinBounds()

void vtkOctreePointLocatorNode::SetMinBounds ( double minBounds[3] )

inline

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

Definition at line 95 of file vtkOctreePointLocatorNode.h.

◆ SetMaxBounds()

void vtkOctreePointLocatorNode::SetMaxBounds ( double maxBounds[3] )

inline

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

Definition at line 107 of file vtkOctreePointLocatorNode.h.

◆ GetMinDataBounds()

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.

◆ GetMaxDataBounds()

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.

◆ SetMinDataBounds()

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 129 of file vtkOctreePointLocatorNode.h.

◆ SetMaxDataBounds()

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 142 of file vtkOctreePointLocatorNode.h.

◆ GetID()

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.

◆ GetMinID()

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 contiguous set. Get the first of the first point's ID that is contained in this node.

◆ CreateChildNodes()

void vtkOctreePointLocatorNode::CreateChildNodes ( )

Add the 8 children.

◆ DeleteChildNodes()

void vtkOctreePointLocatorNode::DeleteChildNodes ( )

Delete the 8 children.

◆ GetChild()

vtkOctreePointLocatorNode * vtkOctreePointLocatorNode::GetChild ( int i )

Get a pointer to the ith child of this node.

◆ IntersectsRegion()

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.

◆ ContainsPoint()

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

◆ GetDistance2ToBoundary() [1/2]

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.

◆ GetDistance2ToBoundary() [2/2]

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.

◆ GetDistance2ToInnerBoundary()

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.

◆ GetSubOctantIndex()

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.

◆ ComputeOctreeNodeInformation()

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:

Common/DataModel/vtkOctreePointLocatorNode.h

Public Types

Public Member Functions

Static Public Member Functions

Protected Member Functions

Additional Inherited Members

Detailed Description

Member Typedef Documentation

◆ Superclass

Constructor & Destructor Documentation

◆ vtkOctreePointLocatorNode()

◆ ~vtkOctreePointLocatorNode()

Member Function Documentation

◆ IsTypeOf()

◆ IsA()

◆ SafeDownCast()

◆ NewInstanceInternal()

◆ NewInstance()

◆ PrintSelf()

◆ New()

◆ SetNumberOfPoints()

◆ GetNumberOfPoints()

◆ SetBounds() [1/2]

◆ SetBounds() [2/2]

◆ GetBounds()

◆ SetDataBounds()

◆ GetDataBounds()

◆ GetMinBounds()

◆ GetMaxBounds()

◆ SetMinBounds()

◆ SetMaxBounds()

◆ GetMinDataBounds()

◆ GetMaxDataBounds()

◆ SetMinDataBounds()

◆ SetMaxDataBounds()

◆ GetID()

◆ GetMinID()

◆ CreateChildNodes()

◆ DeleteChildNodes()

◆ GetChild()

◆ IntersectsRegion()

◆ ContainsPoint()

◆ GetDistance2ToBoundary() [1/2]

◆ GetDistance2ToBoundary() [2/2]

◆ GetDistance2ToInnerBoundary()

◆ GetSubOctantIndex()

◆ ComputeOctreeNodeInformation()