io.jbotsim.contrib.obstacle.core

Class ObstacleManager

java.lang.Object

io.jbotsim.contrib.obstacle.core.ObstacleManager

Direct Known Subclasses:

ObstacleManagerDrawable

public class ObstacleManager
extends Object

Main class of the plugin used to store (or remove) the obstacles and to register (or unregister) the obstacle's listener.

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	ObstacleManager()

Method Summary

Modifier and Type	Method and Description
static void	addObstacle(Obstacle obstacle, Topology topology) Add the given obstacle into the topology
static void	addObstacleListener(ObstacleListener listener, Topology topology)
static ObstacleDetector	getObstacleDetector(Topology topology)
static ArrayList<Obstacle>	getObstacles(Topology topology) List the obstacles that are present inside the topology
static void	init(Topology topology) Constructor of the class, replace the default class used to check the links by the class that checks if an obstacle prohibit a link.
static void	removeObstacle(Obstacle obstacle, Topology topology) Remove the given obstacle from the topology if the obstacle exist in the topology or do nothing
static void	removeObstacleListener(ObstacleListener listener, Topology topology)

Methods inherited from class java.lang.Object

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

Constructor Detail

ObstacleManager

protected ObstacleManager()

Method Detail

init

public static void init(Topology topology)

Constructor of the class, replace the default class used to check the links by the class that checks if an obstacle prohibit a link.

Parameters:

topology - The Topology that will contains the obstacles.

addObstacle

public static void addObstacle(Obstacle obstacle,
                               Topology topology)

Add the given obstacle into the topology

Parameters:

obstacle - The obstacle that will be added to the topology

topology - The topology

getObstacles

public static ArrayList<Obstacle> getObstacles(Topology topology)

List the obstacles that are present inside the topology

Parameters:

topology - The topology

Returns:

A copy of the list of obstacles

removeObstacle

public static void removeObstacle(Obstacle obstacle,
                                  Topology topology)

Remove the given obstacle from the topology if the obstacle exist in the topology or do nothing

Parameters:

obstacle - The Obstacle that will be removed from the topology

topology - The Topology containing the obstacle

getObstacleDetector

public static ObstacleDetector getObstacleDetector(Topology topology)

addObstacleListener

public static void addObstacleListener(ObstacleListener listener,
                                       Topology topology)

removeObstacleListener

public static void removeObstacleListener(ObstacleListener listener,
                                          Topology topology)