org.cell2d.space

Interface Area<T extends CellGame,U extends SpaceState<T,U,?>>

Type Parameters:

T - The type of CellGame that uses the SpaceStates that can load this Area

U - The type of SpaceState that can load this Area

All Known Subinterfaces:

BasicArea

All Known Implementing Classes:

TiledArea

public interface Area<T extends CellGame,U extends SpaceState<T,U,?>>

An Area is a pattern of SpaceObjects that can be generated and loaded by a SpaceState on demand. Areas represent environments that can exist within a SpaceState's space. Areas are loaded about a specified origin point, and the positions of an Area's SpaceObjects are changed upon addition to their new SpaceState to be relative to this origin.

See Also:

SpaceObject, SpaceState

Method Summary

Modifier and Type	Method and Description
java.lang.Iterable<SpaceObject>	load(T game, U state) Actions for this Area to take to in order for the specified SpaceState to load it.

Method Detail

load

java.lang.Iterable<SpaceObject> load(T game,
                                     U state)

Actions for this Area to take to in order for the specified SpaceState to load it. This method should involve constructing a set of SpaceObjects for the SpaceState to add to itself. These SpaceObjects should not be added to a SpaceState in the course of this method. The positions of the SpaceObjects will be treated as relative to the origin point about which this Area is being loaded. The SpaceObjects must be returned as an Iterable, such as a List or Set, that contains each SpaceObject exactly once.

Parameters:

game - The CellGame of the SpaceState that is loading this Area

state - The SpaceState that is loading this Area

Returns:

The SpaceObjects for the SpaceState to add to itself