io.jbotsim.contrib.obstacle.core

Interface Obstacle

All Known Subinterfaces:

ObstacleDrawable

All Known Implementing Classes:

CircleObstacle, CircleObstacleDrawable, LinesObstacle, LinesObstacleDrawable, RectangularFacetObstacle, RectangularFacetObstacleDrawable

public interface Obstacle

Interface for all the obstacles (3D obstacles and 2D obstacles)

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

Method Detail

obstructLink

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

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

Point pointAtMinimumDistance(Node node)

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

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