turtleplot module reference
===========================

The `turtleplot` module contains the `TurtlePlot` class that is
responsible for converting |turtle| graphics primitives into robot movements.
It is based on the python |turtle.py| module and tries to be faithful to the
original module so turtle programs are largely compatible within the limits of
the robot's capability and accuracy.

The `TurtlePlot` class can be used control new robots by creating a new
subclass and overriding the four interface functions `__init__`, `_turn`,
`_move` and `_pen`. These functions are responsible for controlling the actual
movement of a robot. The new class will inherit all the |turtle| graphics
primitives.

Interface functions
-------------------

`__init__`
^^^^^^^^^^
This function is called to initialize and configure the robot.

`_turn(angle)`
^^^^^^^^^^^^^^
This function tells the robot to turn left the number of
degrees passed in `angle`. Negative numbers indicate that
the robot should turn to the right.

`_move(distance)`
^^^^^^^^^^^^^^^^^
This function tells the robot to move forward the distance
passed to it.  The distance can be any unit of measure you
wish but is commonly millimeters. Negative values indicate
the robot should move backwards.

`_pen(down)`
^^^^^^^^^^^^
This function tells the draw bot to lower or raise the drawing
pen. True values indicate the pen should be lowered and False
values indicate the pen should be raised.

Class Methods Reference
-----------------------

.. automodule:: turtleplot
   :members:
   :exclude-members: fd, bk, backward, rt, lt, position, setpos, setposition, seth