Class Animal

java.lang.Object

Animal

All Implemented Interfaces:

Agent

Direct Known Subclasses:

Nibbler

public class Animal
extends java.lang.Object
implements Agent

Implements basic spatial elements of an agent.

The expectation is that this would be extended, but it is left non-abstract incase wanted for early model development.

Each animal has an x and y coordinate, plus a neighbourhood which could, for example, represent a perceived area.

Version:

1.0

Author:

Andy Evans

Field Summary

Fields

Modifier and Type	Field and Description
private int	adj Trig result used for laying out the hexagonal neighbourhood.
protected java.util.ArrayList<Agent>	agents Reference to the agent list set up in Model.
private int	neighbourhoodRadius Neighbourhood 'radius'.
private int	opp Trig result used for laying out the hexagonal neighbourhood.
protected Environment	world Reference to the environment set up in Model.
protected int	x Spatial x coordinate.
protected int	y Spatial y coordinate.

Constructor Summary

Constructors

Constructor and Description
Animal(Environment worldIn, java.util.ArrayList<Agent> agentsIn) Constructor.

Method Summary

Modifier and Type	Method and Description
java.awt.Polygon	getNeighbourhood() Gets the hexagonal neighbourhood around the current location.
java.awt.Polygon	getNeighbourhood(int x, int y) Gets a hexagonal neighbourhood around an arbitrary location.
int	getX() Gets the x coordinate.
int	getY() Gets the y coordinate.
void	run() Empty run method.

Methods inherited from class java.lang.Object

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

Field Detail

world

protected Environment world

Reference to the environment set up in Model.

agents

protected java.util.ArrayList<Agent> agents

Reference to the agent list set up in Model.

x

protected int x

Spatial x coordinate.

y

protected int y

Spatial y coordinate.

neighbourhoodRadius

private int neighbourhoodRadius

Neighbourhood 'radius'. At the moment the neighbourhood is a hexagon by default, so this is the longest distance from the centre to the edge.

opp

private int opp

Trig result used for laying out the hexagonal neighbourhood.

adj

private int adj

Trig result used for laying out the hexagonal neighbourhood.

Constructor Detail

Animal

public Animal(Environment worldIn,
              java.util.ArrayList<Agent> agentsIn)

Constructor. Just defaults the x and y to 50 and 50.

Parameters:

worldIn - environment for the model

agentsIn - list of all the agents in the model

Method Detail

run

public void run()

Empty run method.

Specified by:

run in interface Agent

getX

public int getX()

Gets the x coordinate.

Specified by:

getX in interface Agent

Returns:

spatial location x coordinate

getY

public int getY()

Gets the y coordinate.

Specified by:

getY in interface Agent

Returns:

spatial location y coordinate

getNeighbourhood

public java.awt.Polygon getNeighbourhood()

Gets the hexagonal neighbourhood around the current location. The advantage with a Polygon is that you can use Polygon.contains(x,y) to see if other agents etc. fall inside it.

Returns:

neighbourhood as a polygon in the global coordinate system

getNeighbourhood

public java.awt.Polygon getNeighbourhood(int x,
                                         int y)

Gets a hexagonal neighbourhood around an arbitrary location. Can be used, for example, to check future neighbourhoods for suitability before moving to them. The advantage with a Polygon is that you can use Polygon.contains(x,y) to see if other agents etc. fall inside it.

Parameters:

x - the x location in the global coordinate system

y - the y location in the global coordinate system

Returns:

neighbourhood around x,y as a polygon in the global coordinate system