Module org.arakhne.afc.gis.giscore

Package org.arakhne.afc.gis.tree

Class WeakGISTreeSet<P extends GISPrimitive>

java.lang.Object

org.arakhne.afc.gis.tree.AbstractGISTreeSet<P,WeakGISTreeSetNode<P>>

org.arakhne.afc.gis.tree.WeakGISTreeSet<P>

Type Parameters:

P - is the type of the user data inside the node.

All Implemented Interfaces:

Iterable<P>, Collection<P>, Set<P>, GISSet<P>, GISTreeSet<P,WeakGISTreeSetNode<P>>, GISTreeSetNodeFactory<P,WeakGISTreeSetNode<P>>

public class WeakGISTreeSet<P extends GISPrimitive>
extends AbstractGISTreeSet<P,WeakGISTreeSetNode<P>>
implements GISTreeSetNodeFactory<P,WeakGISTreeSetNode<P>>

This class describes a quad tree that contains weak references on GIS primitives.

Since:

14.0

Version:

17.0 2020-01-04 14:41:53

Author:

Stéphane GALLAND

See Also:

GISPrimitive

Maven Group Id:

org.arakhne.afc.gis

Maven Artifact Id:

giscore

Field Summary

Fields inherited from class org.arakhne.afc.gis.tree.AbstractGISTreeSet

worldBounds

Constructor Summary

Constructors

Constructor	Description
WeakGISTreeSet()	Create an empty tree.
WeakGISTreeSet(double boundsX, double boundsY, double boundsWidth, double boundsHeight)	Constructor.
WeakGISTreeSet(Rectangle2afp<?,?,?,?,?,?> bounds)	Constructor.

Method Summary

Modifier and Type	Method	Description
boolean	add(P elt)
GISTreeSetNodeFactory<P,WeakGISTreeSetNode<P>>	getNodeFactory()	Replies the node factory used by this tree.
WeakGISTreeSetNode<P>	newNode(IcosepQuadTreeNode.IcosepQuadTreeZone zone, double boundsX, double boundsY, double boundsWidth, double boundsHeight)	Create a root node with the given element inside.
WeakGISTreeSetNode<P>	newRootNode(P element)	Create a root node with the given element inside.
WeakGISTreeSetNode<P>	newRootNode(P element, double boundsX, double boundsY, double boundsWidth, double boundsHeight)	Create a root node with the given element inside.
void	setNodeFactory(GISTreeSetNodeFactory<P,WeakGISTreeSetNode<P>> factory)	Set the node factory used by this tree.

Methods inherited from class org.arakhne.afc.gis.tree.AbstractGISTreeSet

addAll, boundsIterator, clear, computeSize, contains, containsAll, extractClassFrom, get, get, get, getElementType, getTree, getTreeNodeAt, indexOf, isEmpty, isTypeRecomputedAfterRemoval, iterator, iterator, iterator, nodeIterator, remove, removeAll, retainAll, setTypeRecomputedAfterRemoval, size, slowContains, toArray, toArray, toIterable, toIterable, toString, updateComponentType, updateComponentType

Methods inherited from class java.lang.Object

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

Methods inherited from interface java.util.Collection

parallelStream, removeIf, stream, toArray

Methods inherited from interface java.lang.Iterable

forEach

Methods inherited from interface java.util.Set

equals, hashCode, spliterator

Constructor Detail

WeakGISTreeSet

public WeakGISTreeSet()

Create an empty tree.

WeakGISTreeSet

public WeakGISTreeSet(Rectangle2afp<?,?,?,?,?,?> bounds)

Constructor.

Parameters:

bounds - are the bounds of the scene stored inside this tree.

WeakGISTreeSet

public WeakGISTreeSet(double boundsX,
                      double boundsY,
                      double boundsWidth,
                      double boundsHeight)

Constructor.

Parameters:

boundsX - is the bounds of the scene.

boundsY - is the bounds of the scene.

boundsWidth - is the bounds of the scene.

boundsHeight - is the bounds of the scene.

Method Detail

add

public final boolean add(P elt)

Specified by:

add in interface Collection<P extends GISPrimitive>

Specified by:

add in interface Set<P extends GISPrimitive>

getNodeFactory

@Pure
public GISTreeSetNodeFactory<P,WeakGISTreeSetNode<P>> getNodeFactory()

Description copied from interface: GISTreeSet

Replies the node factory used by this tree.

Specified by:

getNodeFactory in interface GISTreeSet<P extends GISPrimitive,WeakGISTreeSetNode<P extends GISPrimitive>>

Specified by:

getNodeFactory in class AbstractGISTreeSet<P extends GISPrimitive,WeakGISTreeSetNode<P extends GISPrimitive>>

Returns:

the factory

setNodeFactory

public void setNodeFactory(GISTreeSetNodeFactory<P,WeakGISTreeSetNode<P>> factory)

Description copied from interface: GISTreeSet

Set the node factory used by this tree.

Specified by:

setNodeFactory in interface GISTreeSet<P extends GISPrimitive,WeakGISTreeSetNode<P extends GISPrimitive>>

Specified by:

setNodeFactory in class AbstractGISTreeSet<P extends GISPrimitive,WeakGISTreeSetNode<P extends GISPrimitive>>

Parameters:

factory - the factory.

newNode

@Pure
public WeakGISTreeSetNode<P> newNode(IcosepQuadTreeNode.IcosepQuadTreeZone zone,
                                     double boundsX,
                                     double boundsY,
                                     double boundsWidth,
                                     double boundsHeight)

Description copied from interface: GISTreeSetNodeFactory

Create a root node with the given element inside.

Specified by:

newNode in interface GISTreeSetNodeFactory<P extends GISPrimitive,WeakGISTreeSetNode<P extends GISPrimitive>>

Parameters:

zone - is the zone enclosed by this node.

boundsX - is the bounds of the scene.

boundsY - is the bounds of the scene.

boundsWidth - is the bounds of the scene.

boundsHeight - is the bounds of the scene.

Returns:

the node

newRootNode

@Pure
public WeakGISTreeSetNode<P> newRootNode(P element)

Description copied from interface: GISTreeSetNodeFactory

Create a root node with the given element inside.

Specified by:

newRootNode in interface GISTreeSetNodeFactory<P extends GISPrimitive,WeakGISTreeSetNode<P extends GISPrimitive>>

Parameters:

element - is the element to initially put inside the node.

Returns:

the node

newRootNode

public WeakGISTreeSetNode<P> newRootNode(P element,
                                         double boundsX,
                                         double boundsY,
                                         double boundsWidth,
                                         double boundsHeight)

Description copied from interface: GISTreeSetNodeFactory

Create a root node with the given element inside.

Specified by:

newRootNode in interface GISTreeSetNodeFactory<P extends GISPrimitive,WeakGISTreeSetNode<P extends GISPrimitive>>

Parameters:

element - is the element to initially put inside the node.

boundsX - is the bounds of the scene.

boundsY - is the bounds of the scene.

boundsWidth - is the bounds of the scene.

boundsHeight - is the bounds of the scene.

Returns:

the node