View source for CISC181 S2017 Lab3

===Preliminaries===


* Make a new project with ''n'' = 3 (following [[CISC181_S2017_NewAndroidStudioProject | these ]] instructions)  
* Name your main class "Lab3" (when creating a new module in the instructions above, in the ''Java class name'' field)
* Modify <tt>Lab3.java</tt> by adding your name in a comment before the <tt>Lab3</tt> class body.

===Instructions===

In this lab you will write a simple "Turtle" simulator.  Imagine a turtle as existing in a 2-D grid with rectangular borders as shown below:

[[Image:300px-Turtle_grid.png|300px]]<br>

There are several facts about a turtle:
* It has an integer grid position <tt>(row, column)</tt> (where (0, 0) is the upper-left corner of the rectangle).  The turtle above is at (2, 3)
* It faces in a compass direction: <tt>NORTH</tt>, <tt>SOUTH</tt>, <tt>EAST</tt>, or <tt>WEST</tt>.  The turtle above is facing <tt>NORTH</tt>.
* It can turn, but only to the left (counter-clockwise), and 90 degrees at a time.  If the turtle above turned once, it would be facing <tt>WEST</tt>.  
* It can change its position according to a ''movement pattern'' <tt>(forward, lateral)</tt>.  These must be integers, but each of them can be positive, negative, or zero.  <tt>forward</tt> determines how many squares ahead the turtle would move ''in the direction it is currently facing'', and <tt>lateral</tt> determines how many squares to the left (a negative value) or right (positive) the turtle would move ''relative to the direction it is facing''.  NO TURNING OCCURS.  Also, the turtle cannot make any movement that would land '''outside''' the grid boundaries .  Both turtles below have a movement pattern of <tt>(2, -1)</tt>; the ''blue'' turtle has moved once from its initial position, and the ''red'' turtle has turned once before moving once.

[[Image:300px-Turtle_grid_after_move.png|300px]]<br>

Write a class <tt>Turtle</tt> which stores all relevant information in appropriately named and typed fields, and implements the above behaviors.  To that end, define an enumerated type <tt>Direction</tt> for the compass directions '''outside of the Turtle and Lab3 classes''', and set the grid dimensions with static constants <tt>NUM_ROWS</tt>, <tt>NUM_COLS</tt> (both equal to 10) '''inside the Turtle class'''.  All fields should be <tt>private</tt>.  Your class does not need to be <tt>public</tt>, so please keep it inside <tt>Lab3.java</tt> file, but define it ''above'' the <tt>Lab3</tt> class.

Your class '''must''' have the following public methods that set or change the state of the turtle:

* The default (no-argument) constructor should place the turtle initially at <tt>(NUM_ROWS / 2, NUM_COLS / 2)</tt>, facing <tt>NORTH</tt>, with movement pattern <tt>(1, 0)</tt>
* A 3-argument constructor which sets the turtle's initial position and direction.  The default movement pattern is used
* A 5-argument constructor which is like the 3-argument constructor, but adds the ability to set the movement pattern
* <tt>void turn(int n)</tt>: The turtle executes <tt>n</tt> counter-clockwise 90 degree turns
* <tt>void move(int n)</tt>: The turtle executes its current movement pattern <tt>n</tt> times.  Any attempted movement that would land outside the grid is ignored (but all moves before it happen).
* <tt>void flip(boolean doForward, boolean doLateral)</tt>: Negate forward and/or lateral component of movement pattern.  This changes the movement pattern for all future moves until <tt>flip()</tt> is called again

The class must also have the following public accessor and informational methods:

* <tt>int getRow()</tt>, <tt>int getColumn()</tt>, <tt>Direction getDirection()</tt>
* <tt>int squaresTraveled()</tt>: How many squares has the turtle moved ''forward and laterally'' since it was constructed?  
* <tt>double distanceToHome()</tt>: Euclidean distance from the turtle's current position to its initial position

You may add any "helper" private methods that you need.  

'''Just to be clear, there is no drawing by you in this lab, and no need for arrays.  The pictures above are just for illustration'''

===Testing===

Test the correctness of your implementation in <tt>main()</tt> by constructing <tt>Turtle</tt> objects with different constructors and arguments, calling their methods in different sequences, then checking whether the final position, orientation, distance traveled, and distance home are correct.  

I have created a helper class for testing called [http://nameless.cis.udel.edu/class_data/cg_s2017/TurtleTester.java TurtleTester.java].  Download it and add it to your project by putting it in the same folder as <tt>Lab3.java</tt>.  '''Instructions for and examples of using it are [[CISC181_S2017_TurtleTester | here]].'''  The TA will grade your submission using the examples on that page.