Class Actor

java.lang.Object
  extended by Actor

public class Actor
extends java.lang.Object

An Actor is an entity with a color and direction that can act.
The API of this class is testable on the AP CS A and AB exams.

Constructor Summary
Actor()
          Constructs a blue actor that is facing north.
 
Method Summary
 void act()
          Reverses the direction of this actor.
 java.awt.Color getColor()
          Gets the color of this actor.
 int getDirection()
          Gets the current direction of this actor.
 info.gridworld.grid.Grid<Actor> getGrid()
          Gets the grid in which this actor is located.
 info.gridworld.grid.Location getLocation()
          Gets the location of this actor.
 void moveTo(info.gridworld.grid.Location newLocation)
          Moves this actor to a new location.
 void putSelfInGrid(info.gridworld.grid.Grid<Actor> gr, info.gridworld.grid.Location loc)
          Puts this actor into a grid.
 void removeSelfFromGrid()
          Removes this actor from its grid.
 void setColor(java.awt.Color newColor)
          Sets the color of this actor.
 void setDirection(int newDirection)
          Sets the current direction of this actor.
 java.lang.String toString()
          Creates a string that describes this actor.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Constructor Detail

Actor

public Actor()
Constructs a blue actor that is facing north.

Method Detail

act

public void act()
Reverses the direction of this actor. Override this method in subclasses of Actor to define types of actors with different behavior

getColor

public java.awt.Color getColor()
Gets the color of this actor.

Returns:
the color of this actor

getDirection

public int getDirection()
Gets the current direction of this actor.

Returns:
the direction of this actor, an angle between 0 and 359 degrees

getGrid

public info.gridworld.grid.Grid<Actor> getGrid()
Gets the grid in which this actor is located.

Returns:
the grid of this actor, or null if this actor is not contained in a grid

getLocation

public info.gridworld.grid.Location getLocation()
Gets the location of this actor.

Returns:
the location of this actor, or null if this actor is not contained in a grid

moveTo

public void moveTo(info.gridworld.grid.Location newLocation)
Moves this actor to a new location. If there is another actor at the given location, it is removed.
Precondition: (1) This actor is contained in a grid (2) newLocation is valid in the grid of this actor

Parameters:
newLocation - the new location

putSelfInGrid

public void putSelfInGrid(info.gridworld.grid.Grid<Actor> gr,
                          info.gridworld.grid.Location loc)
Puts this actor into a grid. If there is another actor at the given location, it is removed.
Precondition: (1) This actor is not contained in a grid (2) loc is valid in gr

Parameters:
gr - the grid into which this actor should be placed
loc - the location into which the actor should be placed

removeSelfFromGrid

public void removeSelfFromGrid()
Removes this actor from its grid.
Precondition: This actor is contained in a grid

setColor

public void setColor(java.awt.Color newColor)
Sets the color of this actor.

Parameters:
newColor - the new color

setDirection

public void setDirection(int newDirection)
Sets the current direction of this actor.

Parameters:
newDirection - the new direction. The direction of this actor is set to the angle between 0 and 359 degrees that is equivalent to newDirection.

toString

public java.lang.String toString()
Creates a string that describes this actor.

Overrides:
toString in class java.lang.Object
Returns:
a string with the location, direction, and color of this actor