AnimatedTurtle (Turtle Logo 1.0.1 API)

java.lang.Object
- org.gannacademy.cdf.turtlelogo.Turtle
- - org.gannacademy.cdf.turtlelogo.AnimatedTurtle

All Implemented Interfaces:

Runnable
```
public class AnimatedTurtle
extends Turtle
implements Runnable
```
Animated turtles are turtles that move more slowly, so that we can observe them following their instructions. Their speed can be adjusted either when they are instantiated or as a separate instruction (speed(long))

Author:

Seth Battis

Nested Class Summary
- Nested classes/interfaces inherited from class org.gannacademy.cdf.turtlelogo.Turtle
  Turtle.UnderTheShell

Field Summary

Fields
Modifier and Type Field and Description

static long DEFAULT_FRAME_DELAY
10 milliseconds

static long TURN_SPEED_CUTOFF
25 milliseconds
- Fields inherited from class org.gannacademy.cdf.turtlelogo.Turtle
  DEFAULT_HEADING_IN_DEGREES, DEFAULT_HIDDEN, DEFAULT_PEN_COLOR, DEFAULT_PEN_DOWN, DEFAULT_PEN_WIDTH, EAST, NORTH, SOUTH, UNDER_THE_SHELL, WEST

Fields
Modifier and Type	Field and Description
`static long`	`DEFAULT_FRAME_DELAY` 10 milliseconds
`static long`	`TURN_SPEED_CUTOFF` 25 milliseconds

Constructor Summary

Constructors
Constructor and Description
`AnimatedTurtle()` Construct an animated turtle with `DEFAULT_FRAME_DELAY`
`AnimatedTurtle(long frameDelay)` Construct an animated turtle with a custom frame delay
`AnimatedTurtle(long frameDelay, Terrarium terrarium)` Construct an animated turtle with a custom frame delay in a specific terrarium
`AnimatedTurtle(Terrarium terrarium)` Construct an animated turtle with `DEFAULT_FRAME_DELAY` in a specific terrarium

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`draw(Graphics2D context, Terrarium.UnderTheSurface key)` Draw the turtle
`void`	`head(double heading)` Turn the turtle to a particular heading
`void`	`hide()` Hide the turtle
`void`	`home()` Reset the turtle to its home position
`void`	`move(double steps)` Move the turtle in the direction of its current heading
`void`	`moveTo(double x, double y)` Move the turtle to a particular location
`void`	`penColor(Color color)` Set the color of the turtle's pen
`void`	`penDown()` Lower the turtle's pen, causing it to leave a trail
`void`	`penUp()` Lift the turtle's pen up, causing it not to leave a track
`void`	`penWidth(double width)` Set the width of the turtle's pen
`void`	`run()` Thread execution
`void`	`show()` Show the turtle (if it was hidden)
`void`	`sp(long frameDelay)` Alias for `speed(long)`
`void`	`speed(long frameDelay)` Set the speed of the turtle's animation
`void`	`teleport(double x, double y)` Move the turtle instantaneously to a particular location
`void`	`turn(double angle)` Turn the turtle from its current heading

Methods inherited from class org.gannacademy.cdf.turtlelogo.Turtle
back, bk, drawIcon, fd, forward, getHeadingInDegrees, getHeadingInRadians, getPenColor, getPenStroke, getPenWidth, getTerrarium, getX, getY, hd, ht, isHidden, isPenDown, left, lt, pc, pd, pu, pw, right, rt, setTerrarium, st, to, tp

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

- Field Detail
  - DEFAULT_FRAME_DELAY
```
public static final long DEFAULT_FRAME_DELAY
```
    10 milliseconds
    
    See Also:
    
    Constant Field Values
  - TURN_SPEED_CUTOFF
```
public static final long TURN_SPEED_CUTOFF
```
    25 milliseconds
    
    This is an internal measure, sued to determine how and when to animate turtle turns (frame delays longer than this cutoff will have the turns animated in larger steps
    
    See Also:
    
    Constant Field Values
- Constructor Detail
  - AnimatedTurtle
```
public AnimatedTurtle()
```
    Construct an animated turtle with DEFAULT_FRAME_DELAY
  - AnimatedTurtle
```
public AnimatedTurtle(long frameDelay)
```
    Construct an animated turtle with a custom frame delay
    
    Parameters:
    
    frameDelay - between frames of animation, measured in milliseconds
  - AnimatedTurtle
```
public AnimatedTurtle(Terrarium terrarium)
```
    Construct an animated turtle with DEFAULT_FRAME_DELAY in a specific terrarium
    
    Parameters:
    
    terrarium - to house the turtle
  - AnimatedTurtle
```
public AnimatedTurtle(long frameDelay,
                      Terrarium terrarium)
```
    Construct an animated turtle with a custom frame delay in a specific terrarium
    
    Parameters:
    
    frameDelay - between frames of animation, measured in milliseconds
    
    terrarium - to house the turtle
- Method Detail
  - move
```
public void move(double steps)
```
    Description copied from class: Turtle
    
    Move the turtle in the direction of its current heading
    
    A positive value for steps is interpreted as forward movement and a negative value as backward movement
    
    Overrides:
    
    move in class Turtle
    
    Parameters:
    
    steps - in pixels
  - turn
```
public void turn(double angle)
```
    Description copied from class: Turtle
    
    Turn the turtle from its current heading
    
    A positive angle is interpreted as a right turn and a negative angle is a left turn. This is mildly surprising if you know about the unit circle, but is because the Y-axis of the window increases from top to bottom, which results in a mirrored unit circle around the X-axis, with 90° at the Turtle.SOUTH and270° at the Turtle.NORTH
    
    Overrides:
    
    turn in class Turtle
    
    Parameters:
    
    angle - in degrees
  - head
```
public void head(double heading)
```
    Description copied from class: Turtle
    
    Turn the turtle to a particular heading
    
    Note that, because the Y-axis of the window increases from top to bottom, the usual angles of the unit circle have been mirrored around the X-axis, with 90° at the Turtle.SOUTH and 270%deg; at the Turtle.NORTH. Convenience constants have been provided for the cardinal directions.
    
    Overrides:
    
    head in class Turtle
    
    Parameters:
    
    heading - [0..360) in degrees
  - penUp
```
public void penUp()
```
    Description copied from class: Turtle
    
    Lift the turtle's pen up, causing it not to leave a track
    
    Overrides:
    
    penUp in class Turtle
  - penDown
```
public void penDown()
```
    Description copied from class: Turtle
    
    Lower the turtle's pen, causing it to leave a trail
    
    Overrides:
    
    penDown in class Turtle
  - penColor
```
public void penColor(Color color)
```
    Description copied from class: Turtle
    
    Set the color of the turtle's pen
    
    Color values are given as Color values. Color has a number of helpful constants like Color.GREEN or Color.GREEN. Custom colors can also be constructed. Refer to the java.awt.Color API documentation more details (including how to create transparent colors!)
    
    Overrides:
    
    penColor in class Turtle
    
    Parameters:
    
    color - to use
  - penWidth
```
public void penWidth(double width)
```
    Description copied from class: Turtle
    
    Set the width of the turtle's pen
    
    Overrides:
    
    penWidth in class Turtle
    
    Parameters:
    
    width - in pixels
  - hide
```
public void hide()
```
    Description copied from class: Turtle
    
    Hide the turtle
    
    Hiding the turtle causes it to become invisible — it can still be moved and create tracks, but the turtle itself is not visible
    
    Overrides:
    
    hide in class Turtle
  - show
```
public void show()
```
    Description copied from class: Turtle
    
    Show the turtle (if it was hidden)
    
    Overrides:
    
    show in class Turtle
  - teleport
```
public void teleport(double x,
                     double y)
```
    Description copied from class: Turtle
    
    Move the turtle instantaneously to a particular location
    
    The turtle moves directly to the window coordinates (x, y). Note that the origin of the wind ow is in the top, left corner and that, while the X-axis increases from left to right, the Y-axis increases from to to bottom.
    
    No track is left by a teleportation.
    
    Overrides:
    
    teleport in class Turtle
    
    Parameters:
    
    x - coordinate
    
    y - coordinate
  - moveTo
```
public void moveTo(double x,
                   double y)
```
    Description copied from class: Turtle
    
    Move the turtle to a particular location
    
    The turtle moves directly to the window coordinates (x, y). Note that the origin of the wind ow is in the top, left corner and that, while the X-axis increases from left to right, the Y-axis increases from to to bottom.
    
    If the turtle's pen is currently down, the move will create a track from the old location to the new location.
    
    Overrides:
    
    moveTo in class Turtle
    
    Parameters:
    
    x - coordinate
    
    y - coordinate
  - home
```
public void home()
```
    Description copied from class: Turtle
    
    Reset the turtle to its home position
    
    The turtle's home position is at the center of the window, heading Turtle.EAST
    
    Overrides:
    
    home in class Turtle
  - sp
```
public void sp(long frameDelay)
```
    Alias for speed(long)
    
    Parameters:
    
    frameDelay - in milliseconds
  - speed
```
public void speed(long frameDelay)
```
    Set the speed of the turtle's animation
    
    The frame delay is the time between individual frames of animation. Shorter frame delays (below TURN_SPEED_CUTOFF) will cause turn animations to be animated in more detail to allow them to remain visible to the naked eye
    
    Parameters:
    
    frameDelay - in milliseconds
  - run
```
public void run()
```
    Thread execution
    
    This method is the control loop that allows animation to be updated in a separate control loop for each turtle. This method should not be called by students (although calling it manually should do nothing).
    
    Specified by:
    
    run in interface Runnable
  - draw
```
public void draw(Graphics2D context,
                 Terrarium.UnderTheSurface key)
```
    Description copied from class: Turtle
    
    Draw the turtle
    
    May only be called by Terrarium and its subclasses, enforced by Terrarium.UnderTheSurface
    
    Overrides:
    
    draw in class Turtle
    
    Parameters:
    
    context - for drawing commands
    
    key - to authenticate "Terrarium-iality"

Class AnimatedTurtle

Nested Class Summary

Nested classes/interfaces inherited from class org.gannacademy.cdf.turtlelogo.Turtle

Field Summary

Fields inherited from class org.gannacademy.cdf.turtlelogo.Turtle

Constructor Summary

Method Summary

Methods inherited from class org.gannacademy.cdf.turtlelogo.Turtle

Methods inherited from class java.lang.Object

Field Detail

DEFAULT_FRAME_DELAY

TURN_SPEED_CUTOFF

Constructor Detail

AnimatedTurtle

AnimatedTurtle

AnimatedTurtle

AnimatedTurtle

Method Detail

move

turn

head

penUp

penDown

penColor

penWidth

hide

show

teleport

moveTo

home

sp

speed

run

draw