ImageEnvironment

A factory of shapes compatible with this environment.

Add a GlobalReaction to the Environment.

Add a Layer to the Environment.

This method allows to add a new node to this environment in a specific position. The environment is responsible to call the right method of the simulation in order to ensure that the reaction is properly scheduled. The function returns true if the node is added to the environment.

Adds an obstacle to this environment.

Add a terminator indicating whether the simulation should be considered finished.

Computes the farthest position reachable by a node towards a desiredPosition, avoiding node overlapping. If no node is located in between, desiredPosition is returned. Otherwise, the first position where the node collides with someone else is returned. For collision purposes, hitboxes are used: each node is given a circular hitbox of radius equal to its shape's radius (shapeless nodes can't cause overlapping). The client can specify a different radius for the hitbox of the moving node.

Computes the farthest position reachable by a node towards a desiredPosition, avoiding node overlapping. If no node is located in between, desiredPosition is returned. Otherwise, the first position where the node collides with someone else is returned. For collision purposes, hitboxes are used: each node is given a circular hitbox of radius equal to its shape's radius (shapeless nodes can't cause overlapping). The client can specify a different radius for the hitbox of the moving node.

The number of dimensions of this environment.

Measures the distance between two nodes (n1, n2) in the environment.

Get the Environment's GlobalReactions.

Gets the heading of a node as a direction vector.

Return the Incarnation used to initialize the entities of this Environment, if it has been set.

Get the Layer associate to the given molecule. If no Layer is associated with the given molecule, return null.

Return all the Layers in this Environment.

Returns the current LinkingRule.

Given a node, this method returns its neighborhood.

Allows to access a Node in this Environment known its id. Depending on the implementation, this method may or not be optimized (namely, id could run in constant or linear time with the number of nodes).

Returns the number of Nodes currently in the Environment.

Returns all the Nodes that exist in current Environment.

Gets all nodes whose shape.intersect is true for the given shape.

Given a node this method returns a list of all the surroundings nodes within the given range. Note that this method (depending on the implementation) might be not optimized, and it's consequently much better to use Environment.getNeighborhood and filter the neighborhood if you are sure that all the nodes within the range are connected to the center.

A list of all the obstacles in this environment.

Given a point and a range, retrieves all the obstacles within.

This method allows to know which are the smallest coordinates represented. Return an array of length dimensions containing the smallest coordinates for each dimension.

Create a position corresponding to the origin of this environment.

Calculates the position of a node.

Gets the shape of a node relatively to its position and heading in the environment.

A factory of shapes compatible with this environment.

Return the current Simulation, if present, or throws an IllegalStateException otherwise.

Return the current Simulation, if present, or null otherwise.

The size of the environment as an array of length getDimensions(). This method must return distance measured with the same unit used by the positions. No non-euclidean distance metrics are allowed.

This method returns the size of the environment as an array of length .getDimensions. This method must return distance measured with the same unit used for measuring distances. It may or may not return the same result of .getSize.

Checks whether there is at least an obstacle intersecting the line connecting start and end.

Return true if all the terminators are true.

Given the coordinates of the point, returns a Position compatible with this environment.

Creates a new Euclidean2DPosition.

Creates an euclidean position from the given coordinates.

This method moves a node in the environment toward some direction. If node move is unsupported, it does nothing. Subclasses may override this method if they want to change the way a node moves towards some direction. The current implementation internally calls {@link #moveNodeToPosition(Node, Position2D)}, as such, overriding that method may suffice.

Moves the node to the farthestPositionReachable towards the desired newPosition. If the node is shapeless, it is simply moved to newPosition.

This method must calculate the ABSOLUTE next allowed position given the current position and the position in which the node wants to move. For example, if your node is in position 2,3, wants to move to 3,4 but the next allowed position (because, e.g., of physical obstacles) is 2.5,3.5, the result must be a Position containing coordinates 2.5,3.5.

Returns a random element of the Iterable using the provided randomGenerator.

Remove a GlobalReaction from the Environment.

This method allows to remove a node. If node removal is unsupported, it does nothing.

Removes an obstacle from this environment.

Sets the heading of a node.

Returns the current LinkingRule.

Return the current Simulation, if present, or throws an IllegalStateException otherwise.

Fisher–Yates shuffle algorithm using a RandomGenerator. More information on Wikipedia.

Returns the EnvironmentSubscriptionMonitor of this Environment.

A function that maps an Environment to its surrogate class (EnvironmentSurrogate). Use the toSuitablePositionSurrogate strategy for PositionSurrogate mapping.

A function that maps an Environment to its surrogate class (EnvironmentSurrogate).

Converts an Environment to a EnvironmentSurrogate.