Turtle (JPAZ2 1.1.1 API)

java.lang.Object
- sk.upjs.jpaz2.Turtle

All Implemented Interfaces:

PaneObject

Direct Known Subclasses:

Actor
```
public class Turtle
extends Object
implements PaneObject
```
Represents a turtle living on a pane. The turtle provides basic functionality to draw turtle graphics.

Field Summary

Fields
Modifier and Type Field and Description

protected String referenceIdentification
Reference identification of the instance.

Fields
Modifier and Type	Field and Description
`protected String`	`referenceIdentification` Reference identification of the instance.

Constructor Summary

Constructors
Constructor and Description
`Turtle()` Constructs new turtle.
`Turtle(double x, double y)` Constructs new turtle at a given position.
`Turtle(double x, double y, String name)` Constructs new turtle at a given position and with a given name.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`center()` Changes turtle's position to the center of the parent pane.
`void`	`circle(double radius)` Paints a circle with specified radius.
`void`	`closePolygon()` Stops collecting the points of a polygon and paints a filled polygon whose border are determined by collected points.
`boolean`	`containsInShape(double x, double y)` Returns whether the given point is a point on the turtle's shape.
`double`	`directionTowards(double x, double y)` Computes the direction towards the specified location.
`double`	`directionTowards(Point2D point)` Computes the direction towards the specified location.
`double`	`distanceTo(double x, double y)` Computes distance from turtle to the specified location.
`double`	`distanceTo(Point2D point)` Computes distance from turtle to the specified location.
`void`	`dot(double radius)` Paints a filled circle with specified radius.
`double`	`getDirection()` Returns the current direction of the turtle.
`Color`	`getFillColor()` Gets the color used to fill polygons.
`Font`	`getFont()` Gets the font used by the turtle for drawing strings.
`int`	`getFrameCount()` Returns the number of animation frames in the current turtle shape.
`long`	`getFrameDuration()` Returns the frame duration in milliseconds, i.e., the period between two changes of animation frames for shapes with multiple frames.
`int`	`getFrameIndex()` Returns the index of the current animation frame of the turtle's shape view.
`double`	`getMoveTurnSpeed()` Returns the speed of move and turn actions.
`String`	`getName()` Gets the turle's name.
`Pane`	`getPane()` Gets the pane to which this turtle belongs.
`Color`	`getPenColor()` Gets the current color of the turtle's pen.
`double`	`getPenWidth()` Gets the current width of the turtle's pen.
`Point2D`	`getPosition()` Returns the current position of the turtle.
`Rectangle2D`	`getRange()` Gets the turtle's range.
`RangeStyle`	`getRangeStyle()` Gets the range style.
`double`	`getScale()` Returns the shape scale.
`TurtleShape`	`getShape()` Gets the current shape of the turtle.
`int`	`getTextHeight()` Returns height of the current turtle's font.
`double`	`getTransparency()` Gets the current transparency of the turtle's shape.
`int`	`getViewCount()` Returns the number of views in the current turtle shape.
`int`	`getViewIndex()` Returns the index of the current view of the turtle shape.
`double`	`getX()` Gets the current x-coordinate of the turtle's position.
`double`	`getY()` Gets the current y-coordinate of the turtle's position.
`protected void`	`invalidateParent()` Calls invalidate method of the parent pane.
`boolean`	`isPenDown()` Gets whether turtle's pen is down.
`boolean`	`isPolygonOpen()` Gets whether the turtle is currently collecting points for drawing a filled polygon.
`boolean`	`isShapeAnimation()` Returns whether automatic animation of shapes is enabled.
`boolean`	`isViewBoundToDirection()` Returns whether view on shape is bound to turtle's direction.
`boolean`	`isVisible()` Gets whether the turtle (turtle's shape) is visible.
`void`	`moveTo(double x, double y)` Moves the turtle to new position.
`void`	`moveTo(Point2D point)` Moves the turtle to new position.
`void`	`openPolygon()` Starts collecting the points of a polygon.
`void`	`paintToPaneGraphics(Graphics2D g)` Paints the shape of turtle to a graphics at position relative to parent's coordinate system.
`void`	`penDown()` Sets the turtle's pen down.
`void`	`penUp()` Sets the turtle's pen up.
`void`	`print(String message)` Prints a text at turtle's position and in the turtle's direction.
`void`	`printCenter(String message)` Prints centered text at turtle's position and in the turtle's direction.
`void`	`setDirection(double direction)` Sets the direction of the turtle.
`void`	`setDirectionTowards(double x, double y)` Sets direction of the turtle towards the specified location.
`void`	`setDirectionTowards(Point2D point)` Sets direction of the turtle towards the specified location.
`void`	`setFillColor(Color fillColor)` Sets the color used to fill polygons.
`void`	`setFont(Font font)` Sets the font used by the turtle for drawing strings.
`void`	`setFrameDuration(long frameDuration)` Sets the frame duration in milliseconds, i.e., the period between two changes of consecutive animation frames of the shape with multiple frames.
`void`	`setFrameIndex(int frameIndex)` Sets the index of the current animation frame of the turtle's shape view.
`void`	`setMoveTurnSpeed(double moveTurnSpeed)` Sets the speed of move and turn actions.
`void`	`setName(String name)` Sets the turtle's name.
`void`	`setPane(Pane newParentPane)` Sets the parent pane, i.e., the containing pane.
`void`	`setPenColor(Color penColor)` Sets the color of the turtle's pen.
`void`	`setPenDown(boolean penDownState)` Sets the state of the turtle's pen.
`void`	`setPenWidth(double penWidth)` Sets width of the turtle's pen.
`void`	`setPosition(double x, double y)` Sets the position of the turtle.
`void`	`setPosition(Point2D point)` Sets the position of the turtle.
`void`	`setRange(Rectangle2D range)` Sets the turtle's range.
`void`	`setRangeStyle(RangeStyle rangeStyle)` Sets the range style.
`void`	`setScale(double scale)` Sets the shape scale.
`void`	`setShape(TurtleShape shape)` Sets new turtle's shape.
`void`	`setShapeAnimation(boolean enabled)` Sets the state of automatic animation of shapes.
`void`	`setTransparency(double transparency)` Sets the turtles's shape transparency.
`void`	`setViewBoundToDirection(boolean bound)` Sets whether view on shape is bound to turtle's direction.
`void`	`setViewIndex(int viewIndex)` Sets the index of the current view of the turtle shape.
`void`	`setVisible(boolean visible)` Sets the visibility of the turtle.
`void`	`setX(double x)` Sets x-coordinate of the turtle's position.
`void`	`setY(double y)` Sets the y-coordinate of the turtle's position.
`void`	`stamp()` Paints the shape to the parent pane.
`void`	`step(double length)` Moves the turtle in the current direction.
`int`	`textWidth(String message)` Returns width of the message in pixels after printing this message using current turtle's font.
`String`	`toString()`
`void`	`turn(double angle)` Turns the turtle in a clockwise direction.
`void`	`turnTowards(double x, double y)` Turns this turtle towards the specified location.
`void`	`turnTowards(Point2D point)` Turns this turtle towards the specified location.

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

- Field Detail
  - referenceIdentification
```
protected final String referenceIdentification
```
    Reference identification of the instance.
- Constructor Detail
  - Turtle
```
public Turtle()
```
    Constructs new turtle.
  - Turtle
```
public Turtle(double x,
              double y)
```
    Constructs new turtle at a given position.
    
    Parameters:
    
    x - the X-coordinate of the turtle's position.
    
    y - the Y-coordinate of the turtle's position.
  - Turtle
```
public Turtle(double x,
              double y,
              String name)
```
    Constructs new turtle at a given position and with a given name.
    
    Parameters:
    
    x - the X-coordinate of the turtle's position.
    
    y - the Y-coordinate of the turtle's position.
    
    name - the name for the turtle.
- Method Detail
  - getX
```
public double getX()
```
    Gets the current x-coordinate of the turtle's position. The position is relative to the coordinate system of the parent pane.
    
    Returns:
    
    the x-coordinate of the turtle's position.
  - setX
```
public void setX(double x)
```
    Sets x-coordinate of the turtle's position. The position is relative to the coordinate system of the parent pane.
    
    Parameters:
    
    x - the desired x-coordinate.
  - getY
```
public double getY()
```
    Gets the current y-coordinate of the turtle's position. The position is relative to the coordinate system of the parent pane.
    
    Returns:
    
    the y-coordinate of the turtle's position.
  - setY
```
public void setY(double y)
```
    Sets the y-coordinate of the turtle's position. The position is relative to the coordinate system of the parent pane.
    
    Parameters:
    
    y - the desired y-coordinate.
  - getDirection
```
public double getDirection()
```
    Returns the current direction of the turtle. The degree 0 targets to top and the value of direction is clockwise increasing.
    
    Returns:
    
    the current direction of the turtle in degrees.
  - setDirection
```
public void setDirection(double direction)
```
    Sets the direction of the turtle. The degree 0 targets to top and the value of direction is clockwise increasing.
    
    Parameters:
    
    direction - the desired direction of the turtle in degrees.
  - getPenWidth
```
public double getPenWidth()
```
    Gets the current width of the turtle's pen.
    
    Returns:
    
    the width of the pen.
  - setPenWidth
```
public void setPenWidth(double penWidth)
```
    Sets width of the turtle's pen.
    
    Parameters:
    
    penWidth - the desired width of the turtle's pen. In case of a negative value, the value 0 is set.
  - getPenColor
```
public Color getPenColor()
```
    Gets the current color of the turtle's pen.
    
    Returns:
    
    the color of the pen.
  - setPenColor
```
public void setPenColor(Color penColor)
```
    Sets the color of the turtle's pen.
    
    Parameters:
    
    penColor - the desired pen color.
    
    Throws:
    
    NullPointerException - if the desired pen color is null.
  - isPenDown
```
public boolean isPenDown()
```
    Gets whether turtle's pen is down.
    
    Returns:
    
    true, if the pen is down, false otherwise.
  - setPenDown
```
public void setPenDown(boolean penDownState)
```
    Sets the state of the turtle's pen.
    
    Parameters:
    
    penDownState - true for turtle's pen down, false otherwise.
  - isVisible
```
public boolean isVisible()
```
    Gets whether the turtle (turtle's shape) is visible.
    
    Returns:
    
    true, if the turtle is visible, false otherwise.
  - setVisible
```
public void setVisible(boolean visible)
```
    Sets the visibility of the turtle.
    
    Parameters:
    
    visible - true for visible turtle, false for invisible turle
  - getShape
```
public TurtleShape getShape()
```
    Gets the current shape of the turtle.
    
    Returns:
    
    the shape of this turtle.
  - setShape
```
public void setShape(TurtleShape shape)
```
    Sets new turtle's shape.
    
    Parameters:
    
    shape - the desired shape of the turtle. If set to null, the default turtle shape is used.
  - getTransparency
```
public double getTransparency()
```
    Gets the current transparency of the turtle's shape. The transparency is a real number between 0 (no transparency) and 1 (fully transparent).
    
    Returns:
    
    the transparency of the turtle's shape.
  - setTransparency
```
public void setTransparency(double transparency)
```
    Sets the turtles's shape transparency. The transparency is a real number between 0 (no transparency) and 1 (fully transparent).
    
    Parameters:
    
    transparency - the desired shape transparency. If it is a number smaller than 0, the value 0 is set. If it is a number greater than 1, the value 1 is set.
  - setScale
```
public void setScale(double scale)
```
    Sets the shape scale. The scale is a non negative number used as a multiplication factor for resizing the current turtle's shape.
    
    Parameters:
    
    scale - the desired shape scale.
  - getScale
```
public double getScale()
```
    Returns the shape scale. The scale is a non negative number used as a multiplication factor for resizing the current turtle's shape.
    
    Returns:
    
    the scale.
  - getName
```
public String getName()
```
    Gets the turle's name.
    
    Returns:
    
    the name of the turtle.
  - setName
```
public void setName(String name)
```
    Sets the turtle's name.
    
    Parameters:
    
    name - the desired turtle name (String or null).
  - getFont
```
public Font getFont()
```
    Gets the font used by the turtle for drawing strings.
    
    Returns:
    
    the font used to print or null for the default font.
  - setFont
```
public void setFont(Font font)
```
    Sets the font used by the turtle for drawing strings.
    
    Parameters:
    
    font - the desired font
  - isPolygonOpen
```
public boolean isPolygonOpen()
```
    Gets whether the turtle is currently collecting points for drawing a filled polygon.
    
    Returns:
    
    true, if the turtle has an open polygon, false otherwise.
  - getRangeStyle
```
public RangeStyle getRangeStyle()
```
    Gets the range style. The range style determines what happens if the turtle reaches the range border while doing a step.
    
    Returns:
    
    the range style.
  - setRangeStyle
```
public void setRangeStyle(RangeStyle rangeStyle)
```
    Sets the range style. The range style determines what happens if the turtle reaches the range border while doing a step.
    
    Parameters:
    
    rangeStyle - the desired range style.
  - getRange
```
public Rectangle2D getRange()
```
    Gets the turtle's range. The shape of range is always a rectangle. The turtle cannot be located out of range with exception of WINDOW range style.
    
    Returns:
    
    the turtle's range or null, if no range is set.
  - setRange
```
public void setRange(Rectangle2D range)
```
    Sets the turtle's range. The shape of range is always a rectangle. The turtle cannot be located out of range with exception of WINDOW range style. If the range is null, the parent pane determines the range.
    
    Parameters:
    
    range - the desired range rectangle or null if the range is determined by the parent pane.
  - getFillColor
```
public Color getFillColor()
```
    Gets the color used to fill polygons.
    
    Returns:
    
    the fill color.
  - setFillColor
```
public void setFillColor(Color fillColor)
```
    Sets the color used to fill polygons.
    
    Parameters:
    
    fillColor - the desired fill color.
    
    Throws:
    
    NullPointerException - if the color is set to null.
  - setMoveTurnSpeed
```
public void setMoveTurnSpeed(double moveTurnSpeed)
```
    Sets the speed of move and turn actions.
    
    Parameters:
    
    moveTurnSpeed - the speed of move and turn actions (smaller is faster), the value 0 disabled animations during turn and move/step actions.
  - getMoveTurnSpeed
```
public double getMoveTurnSpeed()
```
    Returns the speed of move and turn actions.
    
    Returns:
    
    the speed of move and turn actions.
    
    See Also:
    
    setMoveTurnSpeed(double)
  - turn
```
public void turn(double angle)
```
    Turns the turtle in a clockwise direction.
    
    Parameters:
    
    angle - angle in degrees.
  - setPosition
```
public void setPosition(Point2D point)
```
    Sets the position of the turtle. If the range style is not WINDOW and the new coordinates are out of range, the new coordinate are the closest location inside the range.
    
    Parameters:
    
    point - the desired location.
  - setPosition
```
public void setPosition(double x,
                        double y)
```
    Sets the position of the turtle. If the range style is not WINDOW and the new coordinates are out of range, the new coordinate are the closest location inside the range.
    
    Parameters:
    
    x - the X-coordinate of the desired turtle position.
    
    y - the Y-coordinate of the desired turtle position.
  - getPosition
```
public Point2D getPosition()
```
    Returns the current position of the turtle.
    
    Returns:
    
    the position of the turtle.
  - center
```
public void center()
```
    Changes turtle's position to the center of the parent pane. If the turtle is not living in a pane, the turtle doesn't change its position.
  - penDown
```
public void penDown()
```
    Sets the turtle's pen down.
  - penUp
```
public void penUp()
```
    Sets the turtle's pen up.
  - moveTo
```
public void moveTo(double x,
                   double y)
```
    Moves the turtle to new position. A line from original position to the new position is drawn in case that the turtle's pen is down. If the range style is not WINDOW and the new coordinates are out of range, the new coordinate are the closest location inside the range.
    
    Parameters:
    
    x - the X-coordinate of the target position.
    
    y - the Y-coordinate of the target position.
  - moveTo
```
public void moveTo(Point2D point)
```
    Moves the turtle to new position. A line from original position to the new position is drawn in case that the turtle's pen is down. If the range style is not WINDOW and the new coordinates are out of range, the new coordinate are the closest location inside the range.
    
    Parameters:
    
    point - the target position.
  - step
```
public void step(double length)
```
    Moves the turtle in the current direction. The path of the move depends on the current range style.
    
    Parameters:
    
    length - the length of the step.
  - distanceTo
```
public double distanceTo(double x,
                         double y)
```
    Computes distance from turtle to the specified location.
    
    Parameters:
    
    x - the x-coordinate of the location.
    
    y - the y-coordinate of the location.
    
    Returns:
    
    the computed distance.
  - distanceTo
```
public double distanceTo(Point2D point)
```
    Computes distance from turtle to the specified location.
    
    Parameters:
    
    point - the location.
    
    Returns:
    
    the computed distance.
  - directionTowards
```
public double directionTowards(double x,
                               double y)
```
    Computes the direction towards the specified location.
    
    Parameters:
    
    x - the x-coordinate of the location.
    
    y - the y-coordinate of the location.
    
    Returns:
    
    the direction (absolute angle in degrees).
  - directionTowards
```
public double directionTowards(Point2D point)
```
    Computes the direction towards the specified location.
    
    Parameters:
    
    point - the location.
    
    Returns:
    
    the direction (absolute angle in degrees).
  - turnTowards
```
public void turnTowards(Point2D point)
```
    Turns this turtle towards the specified location.
    
    Parameters:
    
    point - the location.
  - turnTowards
```
public void turnTowards(double x,
                        double y)
```
    Turns this turtle towards the specified location.
    
    Parameters:
    
    x - the X-coordinate of the location.
    
    y - the Y-coordinate of the location.
  - setDirectionTowards
```
public void setDirectionTowards(double x,
                                double y)
```
    Sets direction of the turtle towards the specified location.
    
    Parameters:
    
    x - the X-coordinate of the location.
    
    y - the Y-coordinate of the location.
  - setDirectionTowards
```
public void setDirectionTowards(Point2D point)
```
    Sets direction of the turtle towards the specified location.
    
    Parameters:
    
    point - the location.
  - print
```
public void print(String message)
```
    Prints a text at turtle's position and in the turtle's direction.
    
    Parameters:
    
    message - the message to be printed.
  - printCenter
```
public void printCenter(String message)
```
    Prints centered text at turtle's position and in the turtle's direction.
    
    Parameters:
    
    message - the message to be printed.
  - textWidth
```
public int textWidth(String message)
```
    Returns width of the message in pixels after printing this message using current turtle's font.
    
    Parameters:
    
    message - the message.
    
    Returns:
    
    the width of message in pixels.
  - getTextHeight
```
public int getTextHeight()
```
    Returns height of the current turtle's font.
    
    Returns:
    
    the height of current turtle's font.
  - openPolygon
```
public void openPolygon()
```
    Starts collecting the points of a polygon. The border of the polygon is determined future turtle's moves.
  - closePolygon
```
public void closePolygon()
```
    Stops collecting the points of a polygon and paints a filled polygon whose border are determined by collected points.
  - dot
```
public void dot(double radius)
```
    Paints a filled circle with specified radius.
    
    Parameters:
    
    radius - the radius of the circle.
  - circle
```
public void circle(double radius)
```
    Paints a circle with specified radius.
    
    Parameters:
    
    radius - the radius of the circle.
  - stamp
```
public void stamp()
```
    Paints the shape to the parent pane.
  - paintToPaneGraphics
```
public void paintToPaneGraphics(Graphics2D g)
```
    Paints the shape of turtle to a graphics at position relative to parent's coordinate system.
    
    Specified by:
    
    paintToPaneGraphics in interface PaneObject
    
    Parameters:
    
    g - the graphics where the content is drawn.
  - getPane
```
public Pane getPane()
```
    Gets the pane to which this turtle belongs.
    
    Specified by:
    
    getPane in interface PaneObject
    
    Returns:
    
    the parent pane.
  - setPane
```
public void setPane(Pane newParentPane)
```
    Sets the parent pane, i.e., the containing pane.
    
    Specified by:
    
    setPane in interface PaneObject
    
    Parameters:
    
    newParentPane - the desired parent pane.
  - isViewBoundToDirection
```
public boolean isViewBoundToDirection()
```
    Returns whether view on shape is bound to turtle's direction.
    
    Returns:
    
    true, if view is bound to directions, false otherwise.
  - setViewBoundToDirection
```
public void setViewBoundToDirection(boolean bound)
```
    Sets whether view on shape is bound to turtle's direction.
    
    Parameters:
    
    bound - desired binding state.
  - getViewIndex
```
public int getViewIndex()
```
    Returns the index of the current view of the turtle shape. Views are indexed from 0.
    
    Returns:
    
    the index of the current view.
  - setViewIndex
```
public void setViewIndex(int viewIndex)
```
    Sets the index of the current view of the turtle shape. Views are indexed from 0.
    
    Parameters:
    
    viewIndex - the index of desired view on the turtle shape.
  - getViewCount
```
public int getViewCount()
```
    Returns the number of views in the current turtle shape. Shape can consist of several shape views, e.g. for each direction of the turtle.
    
    Returns:
    
    the number of views in the current turtle shape.
  - getFrameIndex
```
public int getFrameIndex()
```
    Returns the index of the current animation frame of the turtle's shape view. Animation frames are indexed from 0.
    
    Returns:
    
    the index of the current animation frame.
  - setFrameIndex
```
public void setFrameIndex(int frameIndex)
```
    Sets the index of the current animation frame of the turtle's shape view. Animation frames are indexed from 0.
    
    Parameters:
    
    frameIndex - the index of desired frame in the current view on the turtle shape.
  - getFrameCount
```
public int getFrameCount()
```
    Returns the number of animation frames in the current turtle shape. Each view of turtle shape can consist of several animation frames.
    
    Returns:
    
    the number of frames in the current turtle shape.
  - getFrameDuration
```
public long getFrameDuration()
```
    Returns the frame duration in milliseconds, i.e., the period between two changes of animation frames for shapes with multiple frames.
    
    Returns:
    
    the frame duration in milliseconds.
  - setFrameDuration
```
public void setFrameDuration(long frameDuration)
```
    Sets the frame duration in milliseconds, i.e., the period between two changes of consecutive animation frames of the shape with multiple frames. A negative value and 0 will stop shape animation.
    
    Parameters:
    
    frameDuration - the desired frame duration in milliseconds.
  - isShapeAnimation
```
public boolean isShapeAnimation()
```
    Returns whether automatic animation of shapes is enabled.
    
    Returns:
    
    true, if automatic animation of shapes is enabled, false otherwise.
  - setShapeAnimation
```
public void setShapeAnimation(boolean enabled)
```
    Sets the state of automatic animation of shapes.
    
    Parameters:
    
    enabled - true for enabling automatic animation, false for disabling.
  - containsInShape
```
public boolean containsInShape(double x,
                               double y)
```
    Returns whether the given point is a point on the turtle's shape.
    
    Parameters:
    
    x - the x-coordinate of the point.
    
    y - the y-coordinate of the point.
    
    Returns:
    
    true, if the given point is lying on the turtle's shape, false otherwise.
  - invalidateParent
```
protected void invalidateParent()
```
    Calls invalidate method of the parent pane.
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class Object

Class Turtle

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

referenceIdentification

Constructor Detail

Turtle

Turtle

Turtle

Method Detail

getX

setX

getY

setY

getDirection

setDirection

getPenWidth

setPenWidth

getPenColor

setPenColor

isPenDown

setPenDown

isVisible

setVisible

getShape

setShape

getTransparency

setTransparency

setScale

getScale

getName

setName

getFont

setFont

isPolygonOpen

getRangeStyle

setRangeStyle

getRange

setRange

getFillColor

setFillColor

setMoveTurnSpeed

getMoveTurnSpeed

turn

setPosition

setPosition

getPosition

center

penDown

penUp

moveTo

moveTo

step

distanceTo

distanceTo

directionTowards

directionTowards

turnTowards

turnTowards

setDirectionTowards

setDirectionTowards

print

printCenter

textWidth

getTextHeight

openPolygon

closePolygon

dot

circle

stamp

paintToPaneGraphics

getPane

setPane

isViewBoundToDirection

setViewBoundToDirection

getViewIndex

setViewIndex

getViewCount