rescuecore2.standard.entities

Class StandardWorldModel

java.lang.Object

rescuecore2.worldmodel.AbstractWorldModel<T>

rescuecore2.worldmodel.DefaultWorldModel<StandardEntity>

rescuecore2.standard.entities.StandardWorldModel

All Implemented Interfaces:

java.lang.Iterable<StandardEntity>, WorldModel<StandardEntity>

Direct Known Subclasses:

CollapseWorldModel

public class StandardWorldModel
extends DefaultWorldModel<StandardEntity>

A wrapper around a WorldModel that indexes Entities by location.

Constructor Summary

Constructors

Constructor and Description
StandardWorldModel() Create a StandardWorldModel.

Method Summary

Modifier and Type	Method and Description
static StandardWorldModel	createStandardWorldModel(WorldModel<? extends Entity> existing) Create a StandardWorldModel that wraps an existing world model.
java.awt.geom.Rectangle2D	getBounds() Get the world bounds.
int	getDistance(EntityID first, EntityID second) Get the distance between two entities.
int	getDistance(StandardEntity first, StandardEntity second) Get the distance between two entities.
java.util.Collection<StandardEntity>	getEntitiesOfType(StandardEntityURN... urns) Get all entities of a set of types.
java.util.Collection<StandardEntity>	getEntitiesOfType(StandardEntityURN urn) Get all entities of a particular type.
java.util.Collection<StandardEntity>	getObjectsInRange(EntityID entity, int range) Get objects within a certain range of an entity.
java.util.Collection<StandardEntity>	getObjectsInRange(int x, int y, int range) Get objects within a certain range of a location.
java.util.Collection<StandardEntity>	getObjectsInRange(StandardEntity entity, int range) Get objects within a certain range of an entity.
java.util.Collection<StandardEntity>	getObjectsInRectangle(int x1, int y1, int x2, int y2) Get objects inside a given rectangle.
Pair<Pair<java.lang.Integer,java.lang.Integer>,Pair<java.lang.Integer,java.lang.Integer>>	getWorldBounds() Get the world bounds.
void	index() Re-index the world model.
void	indexClass(StandardEntityURN... urns) Tell this index to remember a certain class of entities.
void	merge(ChangeSet changeSet) Merge a set of changes into this world.

Methods inherited from class rescuecore2.worldmodel.DefaultWorldModel

addEntityImpl, create, getAllEntities, getEntity, iterator, removeAllEntities, removeEntity

Methods inherited from class rescuecore2.worldmodel.AbstractWorldModel

addEntities, addEntity, addWorldModelListener, fireEntityAdded, fireEntityRemoved, isAllowed, merge, registerAllowedClass, removeEntity, removeWorldModelListener

Methods inherited from class java.lang.Object

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

Methods inherited from interface java.lang.Iterable

forEach, spliterator

Constructor Detail

StandardWorldModel

public StandardWorldModel()

Create a StandardWorldModel.

Method Detail

merge

public void merge(ChangeSet changeSet)

Description copied from interface: WorldModel

Merge a set of changes into this world. If the ChangeSet specifies that a property has become undefined then the existing property WILL become undefined. This behaviour is different to the WorldModel.merge(Collection) method because an undefined value inside a ChangeSet means that the property value has become undefined, whereas in the other version of merge an undefined property means there is no value for that property.

Specified by:

merge in interface WorldModel<StandardEntity>

Overrides:

merge in class AbstractWorldModel<StandardEntity>

Parameters:

changeSet - The set of changes to merge into this world model.

indexClass

public void indexClass(StandardEntityURN... urns)

Tell this index to remember a certain class of entities.

Parameters:

urns - The type URNs to remember.

index

public void index()

Re-index the world model.

getObjectsInRange

public java.util.Collection<StandardEntity> getObjectsInRange(EntityID entity,
                                                              int range)

Get objects within a certain range of an entity.

Parameters:

entity - The entity to centre the search on.

range - The range to look up.

Returns:

A collection of StandardEntitys that are within range.

getObjectsInRange

public java.util.Collection<StandardEntity> getObjectsInRange(StandardEntity entity,
                                                              int range)

Get objects within a certain range of an entity.

Parameters:

entity - The entity to centre the search on.

range - The range to look up.

Returns:

A collection of StandardEntitys that are within range.

getObjectsInRange

public java.util.Collection<StandardEntity> getObjectsInRange(int x,
                                                              int y,
                                                              int range)

Get objects within a certain range of a location.

Parameters:

x - The x coordinate of the location.

y - The y coordinate of the location.

range - The range to look up.

Returns:

A collection of StandardEntitys that are within range.

getObjectsInRectangle

public java.util.Collection<StandardEntity> getObjectsInRectangle(int x1,
                                                                  int y1,
                                                                  int x2,
                                                                  int y2)

Get objects inside a given rectangle.

Parameters:

x1 - The x coordinate of the top left corner.

y1 - The y coordinate of the top left corner.

x2 - The x coordinate of the bottom right corner.

y2 - The y coordinate of the bottom right corner.

Returns:

A collection of StandardEntitys that are inside the rectangle.

getEntitiesOfType

public java.util.Collection<StandardEntity> getEntitiesOfType(StandardEntityURN urn)

Get all entities of a particular type.

Parameters:

urn - The type urn to look up.

Returns:

A new Collection of entities of the specified type.

getEntitiesOfType

public java.util.Collection<StandardEntity> getEntitiesOfType(StandardEntityURN... urns)

Get all entities of a set of types.

Parameters:

urns - The type urns to look up.

Returns:

A new Collection of entities of the specified types.

getDistance

public int getDistance(EntityID first,
                       EntityID second)

Get the distance between two entities.

Parameters:

first - The ID of the first entity.

second - The ID of the second entity.

Returns:

The distance between the two entities. A negative value indicates that one or both objects either doesn't exist or could not be located.

getDistance

public int getDistance(StandardEntity first,
                       StandardEntity second)

Get the distance between two entities.

Parameters:

first - The first entity.

second - The second entity.

Returns:

The distance between the two entities. A negative value indicates that one or both objects could not be located.

getBounds

public java.awt.geom.Rectangle2D getBounds()

Get the world bounds.

Returns:

A Rectangle2D describing the bounds of the world.

getWorldBounds

public Pair<Pair<java.lang.Integer,java.lang.Integer>,Pair<java.lang.Integer,java.lang.Integer>> getWorldBounds()

Get the world bounds.

Returns:

A pair of coordinates for the top left and bottom right corners.

createStandardWorldModel

public static StandardWorldModel createStandardWorldModel(WorldModel<? extends Entity> existing)

Create a StandardWorldModel that wraps an existing world model. If the existing model is already a StandardWorldModel then it will be returned directly, otherwise a new StandardWorldModel will be created that contains all the entities in the existing model that are instances of StandardEntity. Changes to the existing world model will be reflected in the returned StandardWorldModel.

Parameters:

existing - The existing world model to wrap. This may be null.

Returns:

The existing world model if it is an instance of StandardWorldModel; a new model otherwise.