Class Dir

java.lang.Object

Dir

public class Dir
extends java.lang.Object

This class represents a compass direction, i.e. N, E, S, W

Constructor Summary

Constructors

Constructor and Description
Dir(char dir) Construct a Dir object.

Method Summary

Modifier and Type	Method and Description
char	getMoveTowards(Pos mypos, Pos target) Returns a "move" (i.e.
char	moveToFace(char dir)
static Dir	read(java.util.Scanner sc) Read a Dir object (as N,E,S,W) from Scanner.
Pos	stepFrom(Pos p) Returns the position resulting from one step in this direction from position p.
java.lang.String	toString() Represents the direction as one of the strings "N", "E", "S", or "W".
Dir	turn(char move) Returns the direction you would be heading after making "move" from the current direction.

Methods inherited from class java.lang.Object

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

Constructor Detail

Dir

public Dir(char dir)

Construct a Dir object.

Parameters:

dir - The direction as character N, E, S or W.

Method Detail

read

public static Dir read(java.util.Scanner sc)

Read a Dir object (as N,E,S,W) from Scanner.

Parameters:

sc - The scanner the direction character is read from.

stepFrom

public Pos stepFrom(Pos p)

Returns the position resulting from one step in this direction from position p.

Parameters:

p - The point that the one step starts from.

getMoveTowards

public char getMoveTowards(Pos mypos,
                           Pos target)

Returns a "move" (i.e. L=left, R=right, F=forwards, B=backwards) that gets you closer to the target.

Parameters:

mypos - The position you're currently at.

target - The position you'd like to get to.

Returns:

a "move" (i.e. L=left, R=right, F=forwards, B=backwards) that you could make given your current direction (this) and position (mypos) that would get you closer to the target.

moveToFace

public char moveToFace(char dir)

turn

public Dir turn(char move)

Returns the direction you would be heading after making "move" from the current direction.

Parameters:

move - One of L=left, R=right, F=forwards, B=backwards.

toString

public java.lang.String toString()

Represents the direction as one of the strings "N", "E", "S", or "W".

Overrides:

toString in class java.lang.Object