io.jbotsim.contrib.obstacle.shapes2d

Class LinesObstacle

java.lang.Object

io.jbotsim.contrib.obstacle.shapes2d.LinesObstacle

All Implemented Interfaces:

Obstacle

Direct Known Subclasses:

LinesObstacleDrawable

public class LinesObstacle
extends Object
implements Obstacle

Field Summary

Fields

Modifier and Type	Field and Description
protected List<Point>	points

Constructor Summary

Constructors

Constructor and Description
LinesObstacle(List<Point> points)

Method Summary

Modifier and Type	Method and Description
boolean	obstructLink(Node node1, Node node2) This function is automatically call by the obstacleDetector to known if the obstacle obstructs the link between node1 and node2
Point	pointAtMinimumDistance(Node node) This function return the Point on the obstacle which is at the minimum distance from the given node

Methods inherited from class java.lang.Object

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

Field Detail

points

protected List<Point> points

Constructor Detail

LinesObstacle

public LinesObstacle(List<Point> points)

Method Detail

obstructLink

public boolean obstructLink(Node node1,
                            Node node2)

Description copied from interface: Obstacle

This function is automatically call by the obstacleDetector to known if the obstacle obstructs the link between node1 and node2

Specified by:

obstructLink in interface Obstacle

Parameters:

node1 - First node of the link

node2 - Second node of the link

Returns:

true if the obstacle obstructs the link false if not

pointAtMinimumDistance

public Point pointAtMinimumDistance(Node node)

Description copied from interface: Obstacle

This function return the Point on the obstacle which is at the minimum distance from the given node

Specified by:

pointAtMinimumDistance in interface Obstacle

Parameters:

node - The node which you want to know the point on the obstacle which is at the minimum distance from it

Returns:

The point on the obstacle which is at the minimum distance from the node