aima.core.util.math.geom

Class CartesianPlot2D

java.lang.Object

aima.core.util.math.geom.CartesianPlot2D

public class CartesianPlot2D
extends java.lang.Object

This class is a simple implementation of a Cartesian plot.
It uses a IGroupParser that generates a set of IGeometric2D.

Author:

Arno von Borries, Jan Phillip Kretzschmar, Andreas Walscheid

Constructor Summary

Constructors

Constructor and Description
CartesianPlot2D(IGroupParser parser)

Method Summary

Modifier and Type	Method and Description
java.util.Iterator<Rect2D>	getBoundaries()
java.util.Iterator<IGeometric2D>	getShapes()
boolean	isEmpty() Checks whether the plot does not contain any elements.
boolean	isPointInsideBorderShape(Point2D point) Checks whether the given point is on any of the shapes of the plot.
boolean	isPointInsideShape(Point2D point) Checks whether the given point is inside any of the shapes of the plot.
void	loadMap(java.io.InputStream input, java.lang.String groupID) Loads a map input into this Cartesian plot.
Point2D	randomPoint() Calculates a random point that is somewhere inside one of the shapes of the plot or on a border of a shape.
double	rayCast(Ray2D ray) Calculates the length of a ray until it intersects with a shape. As this class uses the set maximum ray range to speed up this ray casting, this function may return Double.POSITIVE_INFINITY for a ray that intersects with an obstacle that is further away than the rayRange from the given starting point.
void	setRayRange(double rayRange) Sets the maximum length of a rayCast after which Double.POSITIVE_INFINITY may be returned.
void	setShapes(java.util.ArrayList<IGeometric2D> shapes) Sets the set of shapes of the plot.

Methods inherited from class java.lang.Object

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

Constructor Detail

CartesianPlot2D

public CartesianPlot2D(IGroupParser parser)

Parameters:

parser - a file parser which implements IGroupParser. This parser is used to load a map file.

Method Detail

setRayRange

public void setRayRange(double rayRange)

Sets the maximum length of a rayCast after which Double.POSITIVE_INFINITY may be returned.

Parameters:

rayRange - the maximum non zero positive length, that the ray can reliably have. This parameter is used to speed up rayCast. Set this to Double.POSITIVE_INFINITY if you like waiting.

setShapes

public void setShapes(java.util.ArrayList<IGeometric2D> shapes)

Sets the set of shapes of the plot.

Parameters:

shapes - the set of shapes to be set.

loadMap

public void loadMap(java.io.InputStream input,
                    java.lang.String groupID)
             throws java.lang.Exception

Loads a map input into this Cartesian plot.

Parameters:

input - the stream containing the data.

groupID - the identification for the group of elements that will be loaded.

Throws:

java.lang.Exception - thrown if the input does not contain the group.

java.lang.Exception - thrown by the parser when it encounters an error in the input.

getShapes

public java.util.Iterator<IGeometric2D> getShapes()

Returns:

an iterator over the shapes.

getBoundaries

public java.util.Iterator<Rect2D> getBoundaries()

Returns:

an iterator over the boundaries of the shapes.

isEmpty

public boolean isEmpty()

Checks whether the plot does not contain any elements.

Returns:

true if the plot contains no element.

randomPoint

public Point2D randomPoint()

Calculates a random point that is somewhere inside one of the shapes of the plot or on a border of a shape.

Returns:

a point on a shape within the plot.

rayCast

public double rayCast(Ray2D ray)

Calculates the length of a ray until it intersects with a shape.
As this class uses the set maximum ray range to speed up this ray casting,
this function may return Double.POSITIVE_INFINITY for a ray that intersects with an obstacle that is further away than the rayRange from the given starting point.

Parameters:

ray - the ray to be used for ray casting.

Returns:

the length of the ray.

isPointInsideBorderShape

public boolean isPointInsideBorderShape(Point2D point)

Checks whether the given point is on any of the shapes of the plot.

Parameters:

point - the point to be tested.

Returns:

true if the point is on any of the shapes.

isPointInsideShape

public boolean isPointInsideShape(Point2D point)

Checks whether the given point is inside any of the shapes of the plot.

Parameters:

point - the point to be tested.

Returns:

true if the point is in any of the shapes (excluding their borders).