Area

java.lang.Object
- rescuecore2.worldmodel.AbstractEntity
- - rescuecore2.standard.entities.StandardEntity
  - - rescuecore2.standard.entities.Area

All Implemented Interfaces:

Entity

Direct Known Subclasses:

Building, Road
```
public abstract class Area
extends StandardEntity
```
The Area object.

Constructor Summary

Constructors
Modifier	Constructor and Description
`protected`	`Area(Area other)` Area copy constructor.
`protected`	`Area(EntityID id)` Construct a subclass of Area with entirely undefined property values.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`int[]`	`getApexList()` Get the list of apexes for this area.
`java.util.List<EntityID>`	`getBlockades()` Get the blockades in this area.
`EntityRefListProperty`	`getBlockadesProperty()` Get the blockades property.
`java.util.List<Edge>`	`getEdges()` Get the edges of this area.
`EdgeListProperty`	`getEdgesProperty()` Get the edges property.
`Edge`	`getEdgeTo(EntityID neighbour)` Get the edge that crosses to a particular neighbour.
`Pair<java.lang.Integer,java.lang.Integer>`	`getLocation(WorldModel<? extends StandardEntity> world)` Get the location of this entity.
`java.util.List<EntityID>`	`getNeighbours()` Get the neighbours of this area.
`Property`	`getProperty(java.lang.String urn)` Get a property by urn.
`java.awt.Shape`	`getShape()` Get this area as a Java Shape object.
`int`	`getX()` Get the X coordinate.
`IntProperty`	`getXProperty()` Get the X property.
`int`	`getY()` Get the Y coordinate.
`IntProperty`	`getYProperty()` Get the Y property.
`boolean`	`isBlockadesDefined()` Find out if the blockades property has been defined.
`boolean`	`isEdgesDefined()` Find out if the edges property has been defined.
`boolean`	`isXDefined()` Find out if the X property has been defined.
`boolean`	`isYDefined()` Find out if the Y property has been defined.
`void`	`setBlockades(java.util.List<EntityID> blockades)` Set the blockades in this area.
`void`	`setEdges(java.util.List<Edge> edges)` Set the edges.
`void`	`setX(int x)` Set the X coordinate.
`void`	`setY(int y)` Set the Y coordinate.
`void`	`undefineBlockades()` Undefine the blockades property.
`void`	`undefineEdges()` Undefine the edges property.
`void`	`undefineX()` Undefine the X property.
`void`	`undefineY()` Undefine the Y property.

Methods inherited from class rescuecore2.standard.entities.StandardEntity
getStandardURN, getURN

Methods inherited from class rescuecore2.worldmodel.AbstractEntity
addEntityListener, copy, copyImpl, equals, firePropertyChanged, getEntityName, getFullDescription, getID, getProperties, hashCode, read, registerProperties, removeEntityListener, toString, write

Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait

- Constructor Detail
  - Area
```
protected Area(EntityID id)
```
    Construct a subclass of Area with entirely undefined property values.
    
    Parameters:
    
    id - The ID of this entity.
  - Area
```
protected Area(Area other)
```
    Area copy constructor.
    
    Parameters:
    
    other - The Area to copy.
- Method Detail
  - getLocation
```
public Pair<java.lang.Integer,java.lang.Integer> getLocation(WorldModel<? extends StandardEntity> world)
```
    Description copied from class: StandardEntity
    
    Get the location of this entity.
    
    Overrides:
    
    getLocation in class StandardEntity
    
    Parameters:
    
    world - The world model to look up for entity references.
    
    Returns:
    
    The coordinates of this entity, or null if the location cannot be determined.
  - getProperty
```
public Property getProperty(java.lang.String urn)
```
    Description copied from interface: Entity
    
    Get a property by urn.
    
    Specified by:
    
    getProperty in interface Entity
    
    Overrides:
    
    getProperty in class AbstractEntity
    
    Parameters:
    
    urn - The urn to look up.
    
    Returns:
    
    The property with the given urn or null if no such property exists.
  - getXProperty
```
public IntProperty getXProperty()
```
    Get the X property.
    
    Returns:
    
    The X property.
  - getX
```
public int getX()
```
    Get the X coordinate.
    
    Returns:
    
    The X coordinate.
  - setX
```
public void setX(int x)
```
    Set the X coordinate.
    
    Parameters:
    
    x - The new X coordinate.
  - isXDefined
```
public boolean isXDefined()
```
    Find out if the X property has been defined.
    
    Returns:
    
    True if the X property has been defined, false otherwise.
  - undefineX
```
public void undefineX()
```
    Undefine the X property.
  - getYProperty
```
public IntProperty getYProperty()
```
    Get the Y property.
    
    Returns:
    
    The Y property.
  - getY
```
public int getY()
```
    Get the Y coordinate.
    
    Returns:
    
    The Y coordinate.
  - setY
```
public void setY(int y)
```
    Set the Y coordinate.
    
    Parameters:
    
    y - The new y coordinate.
  - isYDefined
```
public boolean isYDefined()
```
    Find out if the Y property has been defined.
    
    Returns:
    
    True if the Y property has been defined, false otherwise.
  - undefineY
```
public void undefineY()
```
    Undefine the Y property.
  - getEdgesProperty
```
public EdgeListProperty getEdgesProperty()
```
    Get the edges property.
    
    Returns:
    
    The edges property.
  - getEdges
```
public java.util.List<Edge> getEdges()
```
    Get the edges of this area.
    
    Returns:
    
    The edges.
  - setEdges
```
public void setEdges(java.util.List<Edge> edges)
```
    Set the edges.
    
    Parameters:
    
    edges - The new edges.
  - isEdgesDefined
```
public boolean isEdgesDefined()
```
    Find out if the edges property has been defined.
    
    Returns:
    
    True if the edges property has been defined, false otherwise.
  - undefineEdges
```
public void undefineEdges()
```
    Undefine the edges property.
  - getBlockadesProperty
```
public EntityRefListProperty getBlockadesProperty()
```
    Get the blockades property.
    
    Returns:
    
    The blockades property.
  - getBlockades
```
public java.util.List<EntityID> getBlockades()
```
    Get the blockades in this area.
    
    Returns:
    
    The blockades.
  - setBlockades
```
public void setBlockades(java.util.List<EntityID> blockades)
```
    Set the blockades in this area.
    
    Parameters:
    
    blockades - The new blockades.
  - isBlockadesDefined
```
public boolean isBlockadesDefined()
```
    Find out if the blockades property has been defined.
    
    Returns:
    
    True if the blockades property has been defined, false otherwise.
  - undefineBlockades
```
public void undefineBlockades()
```
    Undefine the blockades property.
  - getNeighbours
```
public java.util.List<EntityID> getNeighbours()
```
    Get the neighbours of this area.
    
    Returns:
    
    The neighbours.
  - getEdgeTo
```
public Edge getEdgeTo(EntityID neighbour)
```
    Get the edge that crosses to a particular neighbour.
    
    Parameters:
    
    neighbour - The neighbour ID.
    
    Returns:
    
    The edge that crosses to the given neighbour, or null if no edges border that neighbour.
  - getApexList
```
public int[] getApexList()
```
    Get the list of apexes for this area.
    
    Returns:
    
    The list of apexes.
  - getShape
```
public java.awt.Shape getShape()
```
    Get this area as a Java Shape object.
    
    Returns:
    
    A Shape describing this area.

Class Area

Constructor Summary

Method Summary

Methods inherited from class rescuecore2.standard.entities.StandardEntity

Methods inherited from class rescuecore2.worldmodel.AbstractEntity

Methods inherited from class java.lang.Object

Constructor Detail

Area

Area

Method Detail

getLocation

getProperty

getXProperty

getX

setX

isXDefined

undefineX

getYProperty

getY

setY

isYDefined

undefineY

getEdgesProperty

getEdges

setEdges

isEdgesDefined

undefineEdges

getBlockadesProperty

getBlockades

setBlockades

isBlockadesDefined

undefineBlockades

getNeighbours

getEdgeTo

getApexList

getShape