The Turtle Class Symbolically represents a turtle that runs around a screen that has a paint brush attached to its tail. The tail can be in two states; up and down. As the turtle moves forwards, backwards, left, and right, it can draw shapes and outlines, write text, and stamp itself onto whatever surface it's walking/crawling on (In this case, it's walking on a TurtleScreen). More...

#include <CTurtle.hpp>

Collaboration diagram for cturtle::Turtle:

[legend]

Public Member Functions
	Turtle (AbstractTurtleScreen &scr)
	The turtle constructor. Turtles are attached to whatever screen they are constructed with.

	Turtle (const Turtle &)=delete
	Turtles are not trivially copyable. The copy constructor is explicitly disallowed.

	Turtle (Turtle &&mv)=delete
	Turtles are not trivially moved. The move constructor is explicitly disallowed.

Turtle &	operator= (const Turtle &)=delete
	Turtles are not trivially moved. The copy operator is explicitly disallowed.

Turtle &	operator= (Turtle &&turtle)=delete
	Turtles are not trivially moved. The move operator is explicitly disallowed.

void	forward (int pixels)
	Moves the turtle forward the specified number of pixels.

void	fd (int pixels)
	Moves the turtle forward the specified number of pixels.

void	backward (int pixels)
	Moves the turtle backward the specified number of pixels.

void	bk (int pixels)
	Moves the turtle backward the specified number of pixels.

void	back (int pixels)
	Moves the turtle backward the specified number of pixels.

void	right (float amt)
	Rotates the turtle the specified number of units to the right. The unit by which the input is specified is determined by the current angle mode. The difference between Clockwise and Counterclockwise is determined by the current screen's mode.

void	rt (float angle)
	Rotates the turtle the specified number of units to the right. The unit by which the input is specified is determined by the current angle mode. The difference between Clockwise and Counterclockwise is determined by the current screen's mode.

void	left (float amt)
	Rotates the turtle the specified number of units to the left. The unit by which the input is specified is determined by the current angle mode. The difference between Clockwise and Counterclockwise is determined by the current screen's mode.

void	lt (float angle)
	Rotates the turtle the specified number of units to the left. The unit by which the input is specified is determined by the current angle mode. The difference between Clockwise and Counterclockwise is determined by the current screen's mode.

void	goTo (int x, int y)
	Sets the transform location of this turtle.

void	goTo (const Point &pt)
	Sets the transform location of this turtle.

void	setpos (int x, int y)
	Sets the transform location of this turtle.

void	setpos (const Point &pt)
	Sets the transform location of this turtle.

void	setposition (int x, int y)
	Sets the transform location of this turtle.

void	setposition (const Point &pt)
	Sets the transform location of this turtle.

void	setx (int x)
	Sets the X-axis transform location of this turtle.

void	sety (int y)
	Sets the Y-axis transform location of this turtle.

int	xcor () const
	Returns the current x coordinate location of this turtle.

int	ycor () const
	Returns the current y coordinate location of this turtle.

Point	getpos () const
	Returns the current location of the turtle, as a Point.

void	shift (int x, int y)
	Adds a "naive" translation to the current turtle's transform.\ Does not take into account the rotation, or orientation, of the turtle.

const PenState &	penstate () const

void	setheading (float amt)
	Sets the rotation of this turtle. The unit by which the input is specified is determined by the current angle mode. The difference between Clockwise and Counterclockwise is determined by the current screen's mode.

void	face (int x, int y)

void	face (const Point &pt)

int	distance (int x, int y)

int	distance (const Point &pt)

void	seth (float angle)
	Sets the rotation of this turtle. The unit by which the input is specified is determined by the current angle mode. The difference between Clockwise and Counterclockwise is determined by the current screen's mode.

float	towards (int x, int y)
	Returns the angle between the line of the current turtle transform to the given point.

float	towards (const Point &pt)
	Returns the angle between the line of the current turtle transform to the given point.

float	heading ()
	Returns the heading of the Turtle (e.g, its current rotation).

void	home ()

void	circle (int radius, int steps, const Color &color)
	Adds a circle to the screen.

void	circle (const Color &color)
	Adds a circle to the screen. Default parameters are circle with a radius of 30 with 15 steps.

void	dot (const Color &color, int size=10)
	Adds a dot to the screen.

void	fill (bool val)
	Sets the "filling" state-> If the input is false but the prior state is true, a SceneObject is put on the screen in the shape of the previously captured points.

bool	filling () const
	Returns a boolean indicating if this turtle is currently filling a shape.

void	begin_fill ()
	Begins filling a polygon.

void	end_fill ()
	Stops filling a polygon.

void	fillcolor (const Color &c)
	Sets the fill color of this turtle.

Color	fillcolor ()
	Returns the fill color of this turtle.

void	write (const std::string &text)

void	write (const std::string &text, const std::string &font, const Color &color={"white"}, float scale=1.0f, TextAlign alignment=TEXT_ALIGN_LEFT)

int	stamp ()
	Puts the current shape of this turtle on the screen with the current fill color and the outline of the shape.

void	clearstamp (int stampid)
	Removes the stamp with the specified ID.

void	clearstamps (int stampid=-1)
	Removes all stamps with an ID less than that which is specified. If the specified stampid is less than 0, it removes ALL stamps.

void	shape (const AbstractDrawableObject &p)
	Sets the shape of this turtle.

void	shape (const std::string &name)
	Sets the shape of this turtle from the specified shape name.

const AbstractDrawableObject &	shape ()
	Returns the shape of this turtle.

bool	undo (bool try_redraw=true)
	Undoes the previous action of this turtle.

void	setundobuffer (unsigned int size)
	Set, or disable, the undo buffer.

unsigned int	undobufferentries ()
	Returns the size of the undo stack.

void	speed (float val)
	Sets the speed of this turtle in range of 0 to 10.

float	speed ()
	Returns the speed of this turtle.

void	tilt (float amt)
	Applies a rotation to the turtle's cursor.

float	tilt () const
	Returns the rotation of the cursor. Not the heading, or the angle at which the forward function will move.

void	setshowturtle (bool val)
	Set whether or not the turtle is being shown.

void	showturtle ()
	Shows the turtle. Equivalent to calling setshowturtle(true).

void	hideturtle ()
	Hides the turtle.

void	setpenstate (bool down)
	Sets whether or not the pen is down.

void	penup ()
	Brings the pen up.

void	pendown ()
	Brings the pen down.

void	pencolor (const Color &c)
	Sets the pen color.

Color	pencolor () const
	Returns the pen color; the color of the lines between movements.

void	width (int pixels)

int	width () const

void	draw (const Transform &screenTransform, Image &canvas)
	Draws this turtle on the specified canvas with the specified transform.

void	degrees ()

void	radians ()

void	reset ()
	Resets this turtle. Moves this turtle home, resets all pen attributes, and removes all previously added scene objects.

void	setScreen (AbstractTurtleScreen *scr)
	Sets this turtles screen.

virtual	~Turtle ()
	Empty virtual destructor.

Protected Member Functions
void	pushState ()

bool	popState ()

bool	pushGeometry (const Transform &t, AbstractDrawableObject *geom)
	Internal function used to add geometry to the turtle screen.

bool	pushStamp (const Transform &t, AbstractDrawableObject *geom)
	Internal function used to add a stamp object to the turtle screen.

bool	pushText (const Transform &t, const Color &color, const BitmapFont &font, const std::string &text, float scale=1.0f, TextAlign alignment=TEXT_ALIGN_LEFT)
	Internal function used to add a text object to the turtle screen.

bool	pushTraceLine (Point a, Point b)
	Internal function used to add a trace line object to the turtle screen. Trace lines do NOT push a state. Their state is encompassed by movement, and these lines are only added when moving the turtle while the pen is down.

long int	getAnimMS ()

void	updateParent (bool invalidate=false, bool input=true)

void	travelBetween (Transform src, const Transform &dest, bool doPushState)

void	travelTo (const Transform &dest)

void	travelBack ()

	Turtle ()=default

Protected Attributes
std::list< std::list< SceneObject >::iterator >	objects

std::list< PenState >	stateStack = {PenState()}

std::list< Line >	fillLines

Transform *	transform = nullptr

PenState *	state = nullptr

Point	travelPoints [2]

bool	traveling = false

unsigned int	undoStackSize = 100

Polygon	fillAccum

AbstractTurtleScreen *	screen = nullptr

Detailed Description

The Turtle Class Symbolically represents a turtle that runs around a screen that has a paint brush attached to its tail. The tail can be in two states; up and down. As the turtle moves forwards, backwards, left, and right, it can draw shapes and outlines, write text, and stamp itself onto whatever surface it's walking/crawling on (In this case, it's walking on a TurtleScreen).

See also: TurtleScreen

Constructor & Destructor Documentation

◆ Turtle()

cturtle::Turtle::Turtle ( )

protecteddefault

Inheritors must assign screen pointer!

Member Function Documentation

◆ back()

void cturtle::Turtle::back ( int pixels )

inline

Moves the turtle backward the specified number of pixels.

◆ begin_fill()

void cturtle::Turtle::begin_fill ( )

inline

Begins filling a polygon.

See also: fill(bool)

◆ bk()

void cturtle::Turtle::bk ( int pixels )

inline

Moves the turtle backward the specified number of pixels.

◆ circle() [1/2]

void cturtle::Turtle::circle ( const Color & color )

inline

Adds a circle to the screen. Default parameters are circle with a radius of 30 with 15 steps.

Parameters

color The color of the circle.

◆ circle() [2/2]

void cturtle::Turtle::circle	(	int	radius,
		int	steps,
		const Color &	color )

inline

Adds a circle to the screen.

Parameters

radius	The radius, in pixels, of the circle.
steps	The "quality" of the circle. Higher is slow but looks better. Use with low numbers for N-sided shapes.
color	The color of the circle.

◆ degrees()

void cturtle::Turtle::degrees ( )

inline

Sets this turtle to use angles measured in degrees.

See also: radians()

◆ distance() [1/2]

int cturtle::Turtle::distance ( const Point & pt )

inline

Returns the distance between this turtle and the given point.

Parameters

pt

Returns

See also: distance(int, int)

◆ distance() [2/2]

int cturtle::Turtle::distance	(	int	x,
		int	y )

inline

Returns the distance between this turtle and the given coordinate pair.

Parameters

x	X axis
y	Y axis

Returns: distance between turtle position and coordinate pair.

See also: distance(point)

◆ dot()

void cturtle::Turtle::dot	(	const Color &	color,
		int	size = 10 )

inline

Adds a dot to the screen.

Parameters

The	color of the dot.
size	The size of the dot.

◆ draw()

void cturtle::Turtle::draw	(	const Transform &	screenTransform,
		Image &	canvas )

inline

Draws this turtle on the specified canvas with the specified transform.

Parameters

screenTransform	The transform at which to draw the turtle objects.
canvas	The canvas on which to draw this turtle.

◆ end_fill()

void cturtle::Turtle::end_fill ( )

inline

Stops filling a polygon.

See also: fill(bool)

◆ face() [1/2]

void cturtle::Turtle::face ( const Point & pt )

inline

Rotates the turtle to face the specified point.

Parameters

pt	point to face towards

See also: face(x, y)

◆ face() [2/2]

void cturtle::Turtle::face	(	int	x,
		int	y )

inline

Rotates the turtle to face the specified point.

Parameters

x	coordinate along the x axis to face
y	coordinate along the y axis to face

See also: face(point)

◆ fd()

void cturtle::Turtle::fd ( int pixels )

inline

Moves the turtle forward the specified number of pixels.

Parameters

pixels total number of pixels to move.

◆ fill()

void cturtle::Turtle::fill ( bool val )

inline

Sets the "filling" state-> If the input is false but the prior state is true, a SceneObject is put on the screen in the shape of the previously captured points.

Parameters

state Whether or not the turtle is filling a polygon.

◆ fillcolor() [1/2]

Color cturtle::Turtle::fillcolor ( )

inline

Returns the fill color of this turtle.

Returns: The current fill color.

◆ fillcolor() [2/2]

void cturtle::Turtle::fillcolor ( const Color & c )

inline

Sets the fill color of this turtle.

Parameters

c	The color with which to fill polygons.

◆ filling()

bool cturtle::Turtle::filling ( ) const

inline

Returns a boolean indicating if this turtle is currently filling a shape.

Returns: a boolean indicating if this turtle is currently filling a shape.

◆ forward()

void cturtle::Turtle::forward ( int pixels )

inline

Moves the turtle forward the specified number of pixels.

Parameters

pixels total number of pixels to move.

◆ getAnimMS()

long int cturtle::Turtle::getAnimMS ( )

inlineprotected

Returns the speed, of any applicable animation in milliseconds, based off of this turtle's speed setting.

◆ getpos()

Point cturtle::Turtle::getpos ( ) const

inline

Returns the current location of the turtle, as a Point.

Returns: the current location of the turtle, as a Point.

◆ heading()

float cturtle::Turtle::heading ( )

inline

Returns the heading of the Turtle (e.g, its current rotation).

Returns: the heading of the Turtle (e.g, its current rotation)

◆ hideturtle()

void cturtle::Turtle::hideturtle ( )

inline

Hides the turtle.

See also: setshowturtle(bool)

◆ home()

void cturtle::Turtle::home ( )

inline

\Brings the turtle back to its origin. Depends on the current screen mode. If the screen mode is set to "world", The turtle is turned to the right and positive angles are counterclockwise. Otherwise, if it is set to "logo", The turtle face upwards and positive angles are clockwise.

See also: TurtleScreen::mode()

◆ left()

void cturtle::Turtle::left ( float amt )

inline

Rotates the turtle the specified number of units to the left. The unit by which the input is specified is determined by the current angle mode. The difference between Clockwise and Counterclockwise is determined by the current screen's mode.

See also: degrees(); radians(); TurtleScreen::mode()

◆ lt()

void cturtle::Turtle::lt ( float angle )

inline

Rotates the turtle the specified number of units to the left. The unit by which the input is specified is determined by the current angle mode. The difference between Clockwise and Counterclockwise is determined by the current screen's mode.

See also: degrees(); radians(); TurtleScreen::mode()

◆ pencolor() [1/2]

Color cturtle::Turtle::pencolor ( ) const

inline

Returns the pen color; the color of the lines between movements.

Returns: The color of the pen.

◆ pencolor() [2/2]

void cturtle::Turtle::pencolor ( const Color & c )

inline

Sets the pen color.

Parameters

c	The color used by the pen; the color of lines between movements.

◆ penstate()

const PenState & cturtle::Turtle::penstate ( ) const

inline

Returns: a constant reference to the current state of this turtle.

◆ pushGeometry()

bool cturtle::Turtle::pushGeometry	(	const Transform &	t,
		AbstractDrawableObject *	geom )

inlineprotected

Internal function used to add geometry to the turtle screen.

Parameters

t	The transform of the geometry.
color	The color of the geometry.
geom	The geometry to add.

Returns: A boolean indicating if the geometry was added to the scene.

◆ pushStamp()

bool cturtle::Turtle::pushStamp	(	const Transform &	t,
		AbstractDrawableObject *	geom )

inlineprotected

Internal function used to add a stamp object to the turtle screen.

Parameters

t	The transform at which to draw the stamp.
color	The color with which to draw the stamp.
geom	The geometry of the stamp.

◆ pushText()

bool cturtle::Turtle::pushText	(	const Transform &	t,
		const Color &	color,
		const BitmapFont &	font,
		const std::string &	text,
		float	scale = 1.0f,
		TextAlign	alignment = TEXT_ALIGN_LEFT )

inlineprotected

Internal function used to add a text object to the turtle screen.

Parameters

t	The transform at which to draw the text.
color	The color with which to draw the text.
font	to use to draw the text.
scale	to draw the text at.
text	The string to draw.
alignment	The alignment of the text. Particularly useful for multi-line strings.

◆ pushTraceLine()

bool cturtle::Turtle::pushTraceLine	(	Point	a,
		Point	b )

inlineprotected

Internal function used to add a trace line object to the turtle screen. Trace lines do NOT push a state. Their state is encompassed by movement, and these lines are only added when moving the turtle while the pen is down.

Parameters

a	Point A
b	Point B

◆ radians()

void cturtle::Turtle::radians ( )

inline

Sets this turtle to use angles measured in radians.

See also: degress()

◆ right()

void cturtle::Turtle::right ( float amt )

inline

Rotates the turtle the specified number of units to the right. The unit by which the input is specified is determined by the current angle mode. The difference between Clockwise and Counterclockwise is determined by the current screen's mode.

See also: degrees(); radians(); TurtleScreen::mode()

◆ rt()

void cturtle::Turtle::rt ( float angle )

inline

Rotates the turtle the specified number of units to the right. The unit by which the input is specified is determined by the current angle mode. The difference between Clockwise and Counterclockwise is determined by the current screen's mode.

See also: degrees(); radians(); TurtleScreen::mode()

◆ seth()

void cturtle::Turtle::seth ( float angle )

inline

Sets the rotation of this turtle. The unit by which the input is specified is determined by the current angle mode. The difference between Clockwise and Counterclockwise is determined by the current screen's mode.

See also: degrees(); radians(); TurtleScreen::mode()

◆ setheading()

void cturtle::Turtle::setheading ( float amt )

inline

Sets the rotation of this turtle. The unit by which the input is specified is determined by the current angle mode. The difference between Clockwise and Counterclockwise is determined by the current screen's mode.

See also: degrees(); radians(); TurtleScreen::mode()

◆ setpos() [1/2]

void cturtle::Turtle::setpos ( const Point & pt )

inline

Sets the transform location of this turtle.

◆ setpos() [2/2]

void cturtle::Turtle::setpos	(	int	x,
		int	y )

inline

Sets the transform location of this turtle.

◆ setposition() [1/2]

void cturtle::Turtle::setposition ( const Point & pt )

inline

Sets the transform location of this turtle.

◆ setposition() [2/2]

void cturtle::Turtle::setposition	(	int	x,
		int	y )

inline

Sets the transform location of this turtle.

◆ setshowturtle()

void cturtle::Turtle::setshowturtle ( bool val )

inline

Set whether or not the turtle is being shown.

Parameters

state True when showing, false othewise.

◆ setundobuffer()

void cturtle::Turtle::setundobuffer ( unsigned int size )

inline

Set, or disable, the undo buffer.

Parameters

size	The size of the undo buffer.

◆ shape() [1/2]

void cturtle::Turtle::shape ( const AbstractDrawableObject & p )

inline

Sets the shape of this turtle.

Parameters

p	The polygon to derive shape geometry from.

◆ shape() [2/2]

void cturtle::Turtle::shape ( const std::string & name )

inline

Sets the shape of this turtle from the specified shape name.

Parameters

name	The name of the shape to set.

◆ shift()

void cturtle::Turtle::shift	(	int	x,
		int	y )

inline

Adds a "naive" translation to the current turtle's transform.\ Does not take into account the rotation, or orientation, of the turtle.

Parameters

x	component of coordinate pair
y	component of coordinate pair.

◆ showturtle()

void cturtle::Turtle::showturtle ( )

inline

Shows the turtle. Equivalent to calling setshowturtle(true).

See also: setshowturtle(bool)

◆ speed()

void cturtle::Turtle::speed ( float val )

inline

Sets the speed of this turtle in range of 0 to 10.

Parameters

The	speed of the turtle, in range of 0 to 10.

See also: cturtle::TurtleSpeed

◆ stamp()

int cturtle::Turtle::stamp ( )

inline

Puts the current shape of this turtle on the screen with the current fill color and the outline of the shape.

Returns: The stamp ID of the put stamp.

◆ towards() [1/2]

float cturtle::Turtle::towards ( const Point & pt )

inline

Returns the angle between the line of the current turtle transform to the given point.

Parameters

pt

Returns

◆ towards() [2/2]

float cturtle::Turtle::towards	(	int	x,
		int	y )

inline

Returns the angle between the line of the current turtle transform to the given point.

Parameters

x	component of coordinate pair
y	component of coordinate pair.

Returns

◆ travelBack()

void cturtle::Turtle::travelBack ( )

inlineprotected

Performs an interpolation, with animation, between the current transformation and the previous one. Will not push the state stack. ENSURE STATE STACK IS BIG ENOUGH TO DO THIS BEFORE CALLING.

◆ travelBetween()

void cturtle::Turtle::travelBetween	(	Transform	src,
		const Transform &	dest,
		bool	doPushState )

inlineprotected

Performs an interpolation, with animation, between the source transform and the destination transform. May push a new fill vertex if filling and pushing state, and applies appropriate lines if the pen is down. Generally manages all state related to movement as a side effect.

◆ travelTo()

void cturtle::Turtle::travelTo ( const Transform & dest )

inlineprotected

Performs an interpolation, with animation, between the current transform and the specified one. Pushes a new fill vertex if filling, and applies appropriate lines if the pen is down. Does push the state stack.

◆ updateParent()

void cturtle::Turtle::updateParent	(	bool	invalidate = false,
		bool	input = true )

inlineprotected

Conditionally calls the parent screen's update function.

◆ width() [1/2]

int cturtle::Turtle::width ( ) const

inline

Returns the width of the pen line.

Returns: The width of the line, in pixels.

◆ width() [2/2]

void cturtle::Turtle::width ( int pixels )

inline

Sets the width of the pen line.

Parameters

pixels The total width, in pixels, of the pen line.

◆ write() [1/2]

void cturtle::Turtle::write ( const std::string & text )

inline

Writes the specified string to the screen. Uses the current filling color.

Parameters

text	The text to write.

See also: fillcolor(color)

◆ write() [2/2]

void cturtle::Turtle::write	(	const std::string &	text,
		const std::string &	font,
		const Color &	color = {"white"},
		float	scale = 1.0f,
		TextAlign	alignment = TEXT_ALIGN_LEFT )

inline

Writes the specified string to the screen. Uses the specified color.

Parameters

text	The text to write.
font	The font name to use. Uses "default" font by default. Must be registered to parent screen.
color	The color to write the text in.
scale	The scale to draw the text at. This is relative to the size of the used font.
alignment	The horizontal alignment of text. This is specifically useful for multi-line strings.

See also: fillcolor(color)

◆ xcor()

int cturtle::Turtle::xcor ( ) const

inline

Returns the current x coordinate location of this turtle.

Returns: x coordinate

◆ ycor()

int cturtle::Turtle::ycor ( ) const

inline

Returns the current y coordinate location of this turtle.

Returns: y coordinate

The documentation for this class was generated from the following file:

CTurtle.hpp

Public Member Functions

Protected Member Functions

Protected Attributes

Detailed Description

Constructor & Destructor Documentation

◆ Turtle()

Member Function Documentation

◆ back()

◆ begin_fill()

◆ bk()

◆ circle() [1/2]

◆ circle() [2/2]

◆ degrees()

◆ distance() [1/2]

◆ distance() [2/2]

◆ dot()

◆ draw()

◆ end_fill()

◆ face() [1/2]

◆ face() [2/2]

◆ fd()

◆ fill()

◆ fillcolor() [1/2]

◆ fillcolor() [2/2]

◆ filling()

◆ forward()

◆ getAnimMS()

◆ getpos()

◆ heading()

◆ hideturtle()

◆ home()

◆ left()

◆ lt()

◆ pencolor() [1/2]

◆ pencolor() [2/2]

◆ penstate()

◆ pushGeometry()

◆ pushStamp()

◆ pushText()

◆ pushTraceLine()

◆ radians()

◆ right()

◆ rt()

◆ seth()

◆ setheading()

◆ setpos() [1/2]

◆ setpos() [2/2]

◆ setposition() [1/2]

◆ setposition() [2/2]

◆ setshowturtle()

◆ setundobuffer()

◆ shape() [1/2]

◆ shape() [2/2]

◆ shift()

◆ showturtle()

◆ speed()

◆ stamp()

◆ towards() [1/2]

◆ towards() [2/2]

◆ travelBack()

◆ travelBetween()

◆ travelTo()

◆ updateParent()

◆ width() [1/2]

◆ width() [2/2]

◆ write() [1/2]

◆ write() [2/2]

◆ xcor()

◆ ycor()