Module org.arakhne.afc.gis.giscore

Package org.arakhne.afc.gis.tree

Interface GISTreeNode<P extends GISPrimitive,N extends GISTreeNode<P,N>>

Type Parameters:

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

N - is the type of node.

All Superinterfaces:

Comparable<N>, GISTreeBoundedArea, IterableNode<N>, TreeNode<P,N>

All Known Implementing Classes:

AbstractGISTreeSetNode, GISTreeSetNode, WeakGISTreeSetNode

public interface GISTreeNode<P extends GISPrimitive,N extends GISTreeNode<P,N>>
extends TreeNode<P,N>, GISTreeBoundedArea

This interfaces defines a tree node for a GISTreeSet.

Since:

14.0

Version:

17.0 2020-01-04 14:41:53

Author:

Stéphane GALLAND

Maven Group Id:

org.arakhne.afc.gis

Maven Artifact Id:

giscore

Method Summary

Modifier and Type	Method	Description
boolean	contains(Point2D<?,?> point)	Replies if the specified points is inside the bounds of the area covered by this node.
double	distance(double x, double y)	Replies the distance between the specified point and the area covered by this node.
int	getRegion()	Replies the region covered by this node.
boolean	intersects(GeoLocation location)	Replies if the specified rectangle intersects the bounds of the area covered by this node.
boolean	intersects(Rectangle2afp<?,?,?,?,?,?> rect)	Replies if the specified rectangle intersects the bounds of the area covered by this node.

Methods inherited from interface java.lang.Comparable

compareTo

Methods inherited from interface org.arakhne.afc.gis.tree.GISTreeBoundedArea

getAreaBounds, getObjectBounds, isIcosepHeuristicArea

Methods inherited from interface org.arakhne.afc.math.tree.IterableNode

getChildAt, getChildCount, getNotNullChildCount, isLeaf, removeFromParent

Methods inherited from interface org.arakhne.afc.math.tree.TreeNode

addTreeNodeListener, addUserData, addUserData, addUserData, addUserData, children, clear, getAllUserData, getAllUserData, getChildren, getChildren, getDeepNodeCount, getDeepUserDataCount, getDepth, getHeights, getMaxHeight, getMinHeight, getParentNode, getPartitionEnumeration, getUserData, getUserDataAt, getUserDataCount, indexOf, isEmpty, isRoot, isValid, moveTo, removeAllUserData, removeChild, removeDeeplyFromParent, removeTreeNodeListener, removeUserData, removeUserData, removeUserData, setChildAt, setUserData, setUserData, setUserDataAt

Method Detail

getRegion

@Pure
int getRegion()

Replies the region covered by this node.

Returns:

the region covered by this node

intersects

@Pure
boolean intersects(Rectangle2afp<?,?,?,?,?,?> rect)

Replies if the specified rectangle intersects the bounds of the area covered by this node.

Parameters:

rect - the shape

Returns:

true if this node intersects the given rectangle, otherwise false

intersects

@Pure
boolean intersects(GeoLocation location)

Replies if the specified rectangle intersects the bounds of the area covered by this node.

Parameters:

location - the position

Returns:

true if this node intersects the given rectangle, otherwise false

contains

@Pure
boolean contains(Point2D<?,?> point)

Replies if the specified points is inside the bounds of the area covered by this node.

Parameters:

point - the point.

Returns:

true if this node encloses the given point, otherwise false

distance

@Pure
double distance(double x,
                double y)

Replies the distance between the specified point and the area covered by this node. If the point is inside the area, the distance is zero.

This this node has no parent, then this function is assuming that the node encloses the entire system area. It means that the distance to the point is always zero in this case.

Parameters:

x - x coordinate.

y - y coordinate.

Returns:

the distance between the given point and the bounds of this node.