com.bergerkiller.bukkit.common.collections.octree

Class DoubleOctree<T>

java.lang.Object

com.bergerkiller.bukkit.common.collections.octree.DoubleOctree<T>

Type Parameters:

T - The value type of the DoubleOctree

All Implemented Interfaces:

DoubleOctreeIterable<T>, Iterable<T>

public class DoubleOctree<T>
extends Object
implements DoubleOctreeIterable<T>

Wraps the Octree to store data at double x/y/z coordinates, instead of int. This is done by giving each 1x1x1 area a linked list of entries stored there. If a lot of values are stored inside single 1x1x1 areas, this container is not recommended.

Within 1x1x1 blocks, when iterating the elements, the sorting of the elements will be ascending. First sorted by x-coordinate, then by y-coordinate, then by z-coordinate.

The block coordinate of a coordinate is the Double floor value.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	DoubleOctree.Entry<T> Immutable entry in a Double Octree.

Constructor Summary

Constructors

Constructor and Description
DoubleOctree()

Method Summary

Modifier and Type	Method and Description
void	add(double x, double y, double z, T value) Adds a new entry at the specified coordinates
void	addEntry(DoubleOctree.Entry<? extends T> value) Puts a new entry into this tree.
DoubleOctreeIterable<T>	block(IntVector3 block) Gets a view of the contents of this tree that lay inside a single 1x1x1 block area.
void	clear() Clears all the contents of this Double Octree, freeing all memory associated with it.
boolean	contains(double x, double y, double z, Object value) Checks whether a value is stored at the coordinates specified.
boolean	containsEntry(DoubleOctree.Entry<?> entry) Checks whether the value stored at the coordinates of an entry, match the value of the entry.
DoubleOctreeIterable<T>	cuboid(IntVector3 min, IntVector3 max) Gets a view of the contents of this tree that lay inside a cuboid area.
Collection<T>	get(double x, double y, double z) Gets the values stored at the specified coordinates.
DoubleOctreeIterator<T>	iterator()
boolean	move(double oldX, double oldY, double oldZ, T value, double newX, double newY, double newZ) Moves an entry from the old position to a new position as efficiently as possible.
boolean	move(double oldX, double oldY, double oldZ, T oldValue, double newX, double newY, double newZ, T newValue) Moves an entry from the old position to a new position as efficiently as possible.
boolean	moveEntry(DoubleOctree.Entry<? extends T> oldEntry, DoubleOctree.Entry<? extends T> newEntry) Moves an entry from the old position to a new position as efficiently as possible.
boolean	remove(double x, double y, double z, Object value) Removes an entry stored at the coordinates specified, returning the entry that was removed.
boolean	removeEntry(DoubleOctree.Entry<?> entry) Removes an entry stored inside this octree.
Collection<T>	values() Gets an unmodifiable view of all the values inside this tree

Methods inherited from class java.lang.Object

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

Methods inherited from interface java.lang.Iterable

forEach, spliterator

Constructor Detail

DoubleOctree

public DoubleOctree()

Method Detail

clear

public void clear()

Clears all the contents of this Double Octree, freeing all memory associated with it.

iterator

public DoubleOctreeIterator<T> iterator()

Specified by:

iterator in interface DoubleOctreeIterable<T>

Specified by:

iterator in interface Iterable<T>

values

public Collection<T> values()

Gets an unmodifiable view of all the values inside this tree

Returns:

values

cuboid

public DoubleOctreeIterable<T> cuboid(IntVector3 min,
                                      IntVector3 max)

Gets a view of the contents of this tree that lay inside a cuboid area. The maximum coordinate includes all values inside that block of values. If this is {1,2,3} then this will includes coordinates such as {1.2, 2.99, 3.0}.

Parameters:

min - coordinates of the cuboid (inclusive)

max - coordinates of the cuboid (inclusive)

Returns:

iterable

block

public DoubleOctreeIterable<T> block(IntVector3 block)

Gets a view of the contents of this tree that lay inside a single 1x1x1 block area. The maximum coordinate includes all values inside that block of values. If this is {1,2,3} then this will includes coordinates such as {1.2, 2.99, 3.0}.

Parameters:

block - coordinate

Returns:

iterable

contains

public boolean contains(double x,
                        double y,
                        double z,
                        Object value)

Checks whether a value is stored at the coordinates specified.

Parameters:

x - The X-coordinate

y - The Y-coordinate

z - The Z-coordinate

value - The value expected to be stored here

Returns:

True if a value is stored at the coordinates, False if not

get

public Collection<T> get(double x,
                         double y,
                         double z)

Gets the values stored at the specified coordinates.

Parameters:

x - The X-coordinate

y - The Y-coordinate

z - The Z-coordinate

Returns:

Values stored at these coordinates

add

public void add(double x,
                double y,
                double z,
                T value)

Adds a new entry at the specified coordinates

Parameters:

x - The X-coordinate

y - The Y-coordinate

z - The Z-coordinate

value - The value to store

remove

public boolean remove(double x,
                      double y,
                      double z,
                      Object value)

Removes an entry stored at the coordinates specified, returning the entry that was removed.

Parameters:

x - The X-coordinate

y - The Y-coordinate

z - The Z-coordinate

value - The value of the entry to remove

Returns:

True if an entry was found and removed, False otherwise

move

public boolean move(double oldX,
                    double oldY,
                    double oldZ,
                    T oldValue,
                    double newX,
                    double newY,
                    double newZ,
                    T newValue)

Moves an entry from the old position to a new position as efficiently as possible. The lookup is optimized in several ways to speed this up:

• If the position is unchanged, only the value is updated
• If the old and new position are in the same 1x1x1 block, chain lookup is only done once
• Traversing the underlying tree is done while excluding regions that contain neither old nor new entry

Parameters:

oldX - The X-coordinate of the old position

oldY - The Y-coordinate of the old position

oldZ - The Z-coordinate of the old position

oldValue - The value stored at the old position

newX - The X-coordinate of the desired new position

newY - The Y-coordinate of the desired new position

newZ - The Z-coordinate of the desired new position

newValue - The value to store at the new position

Returns:

True if the old value was found and moved, False otherwise

See Also:

#moveEntry(Entry, Entry)}

move

public boolean move(double oldX,
                    double oldY,
                    double oldZ,
                    T value,
                    double newX,
                    double newY,
                    double newZ)

Moves an entry from the old position to a new position as efficiently as possible. The lookup is optimized in several ways to speed this up:

• If the position is unchanged, only the value is updated
• If the old and new position are in the same 1x1x1 block, chain lookup is only done once
• Traversing the underlying tree is done while excluding regions that contain neither old nor new entry

Parameters:

oldX - The X-coordinate of the old position

oldY - The Y-coordinate of the old position

oldZ - The Z-coordinate of the old position

value - The value stored at the old position that will be moved to a new position

newX - The X-coordinate of the desired new position

newY - The Y-coordinate of the desired new position

newZ - The Z-coordinate of the desired new position

Returns:

True if the old value was found and moved, False otherwise

See Also:

#moveEntry(Entry, Entry)}

containsEntry

public boolean containsEntry(DoubleOctree.Entry<?> entry)

Checks whether the value stored at the coordinates of an entry, match the value of the entry. The Object.equals(Object) method is used to perform the final check. If the value of the entry and of what is stored are both null, the two are assumed equal.

Parameters:

entry - The entry to find

Returns:

True if the entry specified is contained, False if not

addEntry

public void addEntry(DoubleOctree.Entry<? extends T> value)

Puts a new entry into this tree. The entry can be reused for other uses to reduce the memory footprint, since it is immutable.

Parameters:

value -

removeEntry

public boolean removeEntry(DoubleOctree.Entry<?> entry)

Removes an entry stored inside this octree.

Parameters:

entry - The entry to remove

Returns:

True if an entry was found and removed, False otherwise

moveEntry

public boolean moveEntry(DoubleOctree.Entry<? extends T> oldEntry,
                         DoubleOctree.Entry<? extends T> newEntry)

Moves an entry from the old position to a new position as efficiently as possible. The lookup is optimized in several ways to speed this up:

• If the position is unchanged, only the value is updated
• If the old and new position are in the same 1x1x1 block, chain lookup is only done once
• Traversing the underlying tree is done while excluding regions that contain neither old nor new entry

Parameters:

oldEntry - to replace, null to only add a new entry

newEntry - to replace oldEntry with, null to remove the old entry

Returns:

the result of the move, which will be SUCCESS if the tree was changed