com.bonzaiengine.scene.octree

Class Octree<T>

java.lang.Object

com.bonzaiengine.scene.octree.Octree<T>

All Implemented Interfaces:

IBoundable

public final class Octree<T>
extends java.lang.Object
implements IBoundable

References: Simple and Efficient Traversal Methods for Quadtrees and Octrees http://en.wikipedia.org/wiki/Tree_traversal

Method Summary

Modifier and Type	Method and Description
static <T> Octree<T>	create(IBounds<?> region, int level)
void	createChilds() Create all childs of this Octree (non recursive)
Octree<T>	find(long id)
IBounds<?>	getBounds()
Octree<T>	getChild(int index)
T	getData()
int	getDepth()
long	getId()
int	getLevel()
int	getMaxNumChilds()
Octree<T>	getParent()
Octree<T>	getRoot()
IVolume<?>	getVolume(int bvOptions)
boolean	isCulled()
boolean	isLeaf()
boolean	isRoot()
boolean	isVisible()
java.util.Iterator<Octree<T>>	iterator(OctreeIteratorType type, OctreeFilter<T> filter)
Octree<T>	neighbor(Vec3i sides, boolean create) Find the neighbor of this Octree by on the specified side
void	setCulled(boolean culled)
void	setData(T data)
void	setVisible(boolean visible)
java.lang.String	toString()
void	traverse(OctreeVisitor<T> visitor)
void	traversePreOrder(OctreeVisitor<T> visitor)
Octree<T>	visit(Box region) Visit the Octree englobing the specified region.
Octree<T>	visit(Vec3 position) Visit the Octree englobing the specified position.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Method Detail

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object

createChilds

public void createChilds()

Create all childs of this Octree (non recursive)

find

public Octree<T> find(long id)

visit

public Octree<T> visit(Vec3 position)

Visit the Octree englobing the specified position.
The Octree node will be created, if needed.

Parameters:

position - 3d position visited

Returns:

the Octree containing the 3D point

visit

public Octree<T> visit(Box region)

Visit the Octree englobing the specified region.
The Octree node will be created, if needed.

Parameters:

position - 3d position visited

Returns:

the Octree containing the 3D point

traverse

public void traverse(OctreeVisitor<T> visitor)

traversePreOrder

public void traversePreOrder(OctreeVisitor<T> visitor)

iterator

public java.util.Iterator<Octree<T>> iterator(OctreeIteratorType type,
                                              OctreeFilter<T> filter)

neighbor

public Octree<T> neighbor(Vec3i sides,
                          boolean create)

Find the neighbor of this Octree by on the specified side

Parameters:

sides - sides direction: -1: left 0: same side 1: right

getVolume

public IVolume<?> getVolume(int bvOptions)

Specified by:

getVolume in interface IBoundable

Parameters:

bvOptions - bounding volume options.

Returns:

bounding volume, cast to BoundingBox or BoundingSphere depending on options.

See Also:

VolumeOptions, Box, Sphere, Cylinder, Capsule

getBounds

public IBounds<?> getBounds()

getParent

public Octree<T> getParent()

getRoot

public Octree<T> getRoot()

isRoot

public boolean isRoot()

isLeaf

public boolean isLeaf()

getId

public long getId()

getLevel

public int getLevel()

getDepth

public int getDepth()

getChild

public Octree<T> getChild(int index)

getMaxNumChilds

public int getMaxNumChilds()

isVisible

public boolean isVisible()

setVisible

public void setVisible(boolean visible)

isCulled

public boolean isCulled()

setCulled

public void setCulled(boolean culled)

getData

public T getData()

setData

public void setData(T data)

create

public static <T> Octree<T> create(IBounds<?> region,
                                   int level)