The InteractiveTurtleScreen class holds and maintains facilities in relation to displaying \ turtles and consuming input events from users through callbacks. This includes holding the actual data for a given scene after being populated by Turtle. It layers draw calls in the order they are called, independent of whatever Turtle object creates it. More...

#include <CTurtle.hpp>

Inheritance diagram for cturtle::InteractiveTurtleScreen:

[legend]

Collaboration diagram for cturtle::InteractiveTurtleScreen:

[legend]

Public Member Functions
	InteractiveTurtleScreen ()

	InteractiveTurtleScreen (const std::string &title)

	InteractiveTurtleScreen (int width, int height, const std::string &title=SCREEN_DEFAULT_TITLE)

	~InteractiveTurtleScreen ()

void	tracer (int countmax, unsigned int delayMS) override

void	bgcolor (const Color &color) override

Color	bgcolor () const override

void	bgpic (const Image &img)
	Sets the background image of the display. Sets the background image. Please note that the background image takes precedence over background color.

const Image &	bgpic ()

bool	supports_live_animation () const override

void	mode (ScreenMode mode) override

ScreenMode	mode () const override

void	clearscreen () override
	Clears this screen. Deletes all drawings and turtles, Resets the background to plain white, Clears all event bindings,.

void	resetscreen () override

ivec2	screensize (Color &bg) override

ivec2	screensize () override

void	update (bool invalidateDraw, bool processInput) override

void	delay (unsigned int ms) override

unsigned int	delay () const override

int	window_width () const override

int	window_height () const override

void	save (const std::string &file)

void	mainloop ()

void	bye () override

Image &	getcanvas () override

cimg::CImgDisplay &	internaldisplay ()

bool	isclosed () override

void	redraw (bool invalidate) override

Transform	screentransform () const override

void	onkeypress (const KeyFunc &func, KeyboardKey key)
	Adds an additional "on press" key binding for the specified key.

virtual void	onkeyrelease (const KeyFunc &func, KeyboardKey key)
	Adds an additional "on press" key binding for the specified key.

void	presskey (KeyboardKey key)
	Simulates a key "on press" event.

void	releasekey (KeyboardKey key)
	Simulates a key "on release" event.

void	onclick (const MouseFunc &func, MouseButton button=MOUSEB_LEFT)
	Adds an additional "on click" mouse binding for the specified button.

void	click (int x, int y, MouseButton button)

void	click (const Point &pt, MouseButton button)

void	ontimer (const TimerFunc &func, unsigned int time)
	Adds a timer function to be called every N milliseconds.

void	exitonclick ()

void	add (Turtle &turtle) override

void	remove (Turtle &turtle) override
	Removes the specified turtle from this screen.

std::list< SceneObject > &	getScene () override

AbstractDrawableObject &	shape (const std::string &name) override

void	addfont (const std::string &name, const BitmapFont &font)

const BitmapFont &	font (const std::string &name) const override

Public Member Functions inherited from cturtle::AbstractTurtleScreen
void	clear ()

void	reset ()

Protected Member Functions
void	initEventThread ()

Protected Attributes
cimg::CImgDisplay	display

Image	canvas

Image	turtleComposite

int	lastTotalObjects = 0

Color	backgroundColor = Color("white")

Image	backgroundImage

ScreenMode	curMode = SM_STANDARD

long int	delayMS = 10

int	redrawCounter = 0

int	redrawCounterMax = 1

std::list< SceneObject >	objects

std::list< Turtle * >	turtles

std::unique_ptr< std::thread >	eventThread

std::list< InputEvent >	cachedEvents

bool	killEventThread = false

std::mutex	eventCacheMutex

std::unordered_map< KeyboardKey, std::list< KeyFunc > >	keyBindings [2]

std::list< MouseFunc >	mouseBindings [3]

std::list< std::tuple< TimerFunc, uint64_t, uint64_t > >	timerBindings

std::unordered_map< std::string, std::unique_ptr< BitmapFont > >	fonts

Protected Attributes inherited from cturtle::AbstractTurtleScreen
std::unordered_map< std::string, Polygon >	shapes

Additional Inherited Members
Static Protected Member Functions inherited from cturtle::AbstractTurtleScreen
static Image	decodeDefaultFont ()

Detailed Description

The InteractiveTurtleScreen class holds and maintains facilities in relation to displaying \ turtles and consuming input events from users through callbacks. This includes holding the actual data for a given scene after being populated by Turtle. It layers draw calls in the order they are called, independent of whatever Turtle object creates it.

See also: Turtle

Constructor & Destructor Documentation

◆ InteractiveTurtleScreen() [1/3]

cturtle::InteractiveTurtleScreen::InteractiveTurtleScreen ( )

inline

Empty constructor. Assigns an 800 x 600 pixel display with a title of "CTurtle".

◆ InteractiveTurtleScreen() [2/3]

cturtle::InteractiveTurtleScreen::InteractiveTurtleScreen ( const std::string & title )

inlineexplicit

Title constructor. Assigns an 800 x 600 pixel display with a specified title.

Parameters

title The title to assign the display with.

◆ InteractiveTurtleScreen() [3/3]

cturtle::InteractiveTurtleScreen::InteractiveTurtleScreen	(	int	width,
		int	height,
		const std::string &	title = SCREEN_DEFAULT_TITLE )

inline

Width, height, and title constructor. Assigns the display with the specified dimensions, in pixels, and assigns the display the specified title.

Parameters

width	The width of the display, in pixels.
height	The height of the display, in pixels.
title	The title of the display.

◆ ~InteractiveTurtleScreen()

cturtle::InteractiveTurtleScreen::~InteractiveTurtleScreen ( )

inline

Destructor. Calls "bye" function.

Member Function Documentation

◆ add()

void cturtle::InteractiveTurtleScreen::add ( Turtle & turtle )

inlineoverridevirtual

Adds the specified turtle to this screen.

Implements cturtle::AbstractTurtleScreen.

◆ addfont()

void cturtle::InteractiveTurtleScreen::addfont	(	const std::string &	name,
		const BitmapFont &	font )

inline

Adds the specified bitmap font to the screen. It can be referenced later by its given name.

Parameters

name	the name given to the font.
font	to add to the screen.

◆ bgcolor() [1/2]

Color cturtle::InteractiveTurtleScreen::bgcolor ( ) const

inlineoverridevirtual

Returns the background color of the screen.

Returns: The background color of the screen.

Implements cturtle::AbstractTurtleScreen.

◆ bgcolor() [2/2]

void cturtle::InteractiveTurtleScreen::bgcolor ( const Color & color )

inlineoverridevirtual

Sets the background color of the screen. Please note that, if there is a background image, this color is not applied until it is removed.

Parameters

color The background color.

See also: bgpic(image)

Implements cturtle::AbstractTurtleScreen.

◆ bgpic() [1/2]

const Image & cturtle::InteractiveTurtleScreen::bgpic ( )

inline

Returns a const reference to the background image.

◆ bgpic() [2/2]

void cturtle::InteractiveTurtleScreen::bgpic ( const Image & img )

inline

Sets the background image of the display. Sets the background image. Please note that the background image takes precedence over background color.

Parameters

img	The background image.

◆ bye()

void cturtle::InteractiveTurtleScreen::bye ( )

inlineoverridevirtual

Resets and closes this display.

Implements cturtle::AbstractTurtleScreen.

◆ clearscreen()

void cturtle::InteractiveTurtleScreen::clearscreen ( )

inlineoverridevirtual

Clears this screen. Deletes all drawings and turtles, Resets the background to plain white, Clears all event bindings,.

Implements cturtle::AbstractTurtleScreen.

◆ click() [1/2]

void cturtle::InteractiveTurtleScreen::click	(	const Point &	pt,
		MouseButton	button )

inline

Calls all previously added mouse button call-backs.

Parameters

x	The X coordinate at which to press.
y	The Y coordinate at which to press.
button	The button to simulate being pressed.

◆ click() [2/2]

void cturtle::InteractiveTurtleScreen::click	(	int	x,
		int	y,
		MouseButton	button )

inline

Calls all previously added mouse button call-backs.

Parameters

x	The X coordinate at which to press.
y	The Y coordinate at which to press.
button	The button to simulate being pressed.

◆ delay() [1/2]

unsigned int cturtle::InteractiveTurtleScreen::delay ( ) const

inlineoverridevirtual

Returns the delay set between screen swaps in milliseconds.

Implements cturtle::AbstractTurtleScreen.

◆ delay() [2/2]

void cturtle::InteractiveTurtleScreen::delay ( unsigned int ms )

inlineoverridevirtual

Sets the delay set between turtle commands.

Implements cturtle::AbstractTurtleScreen.

◆ exitonclick()

void cturtle::InteractiveTurtleScreen::exitonclick ( )

inline

Binds the "bye" function to the onclick event for the left mouse button.

◆ font()

const BitmapFont & cturtle::InteractiveTurtleScreen::font ( const std::string & name ) const

inlineoverridevirtual

Returns a read-only reference to the bitmap font with the specified name.

Parameters

name	to be given to the font.

Returns: read-only BitmapFont reference.

Implements cturtle::AbstractTurtleScreen.

◆ getcanvas()

Image & cturtle::InteractiveTurtleScreen::getcanvas ( )

inlineoverridevirtual

Returns the canvas image used by this screen.

Implements cturtle::AbstractTurtleScreen.

◆ getScene()

std::list< SceneObject > & cturtle::InteractiveTurtleScreen::getScene ( )

inlineoverridevirtual

Returns a reference to the list of scene objects. This list is used to redraw the screen.

Implements cturtle::AbstractTurtleScreen.

◆ initEventThread()

void cturtle::InteractiveTurtleScreen::initEventThread ( )

inlineprotected

Initializes the underlying event thread. This thread is cleanly managed and destroyed when its owning object is destroyed. The thread just populates the cachedEvents list, so that events may be processed in the main thread.

◆ internaldisplay()

cimg::CImgDisplay & cturtle::InteractiveTurtleScreen::internaldisplay ( )

inline

Returns the internal CImg display.

◆ isclosed()

bool cturtle::InteractiveTurtleScreen::isclosed ( )

inlineoverridevirtual

Returns a boolean indicating if the screen has been closed.

Implements cturtle::AbstractTurtleScreen.

◆ mainloop()

void cturtle::InteractiveTurtleScreen::mainloop ( )

inline

Enters a loop, lasting until the display has been closed, which updates the screen. This is useful for programs which rely heavily on user input, as events are still called like normal.

◆ mode() [1/2]

ScreenMode cturtle::InteractiveTurtleScreen::mode ( ) const

inlineoverridevirtual

Returns the screen mode of this screen.

Implements cturtle::AbstractTurtleScreen.

◆ mode() [2/2]

void cturtle::InteractiveTurtleScreen::mode ( ScreenMode mode )

inlineoverridevirtual

Sets the screen mode of this screen. Screen mode influences the initial heading added Turtles have, as well as the direction of rotations. This function brings ALL attached turtles to the home/default location.

Parameters

mode	The screen mode.

Implements cturtle::AbstractTurtleScreen.

◆ onclick()

void cturtle::InteractiveTurtleScreen::onclick	(	const MouseFunc &	func,
		MouseButton	button = MOUSEB_LEFT )

inline

Adds an additional "on click" mouse binding for the specified button.

Parameters

func	The function to call when the specified button is clicked.
button	The specified button.

◆ onkeypress()

void cturtle::InteractiveTurtleScreen::onkeypress	(	const KeyFunc &	func,
		KeyboardKey	key )

inline

Adds an additional "on press" key binding for the specified key.

Parameters

func	The function to call when the specified key is pressed.
key	The specified key.

◆ onkeyrelease()

virtual void cturtle::InteractiveTurtleScreen::onkeyrelease	(	const KeyFunc &	func,
		KeyboardKey	key )

inlinevirtual

Adds an additional "on press" key binding for the specified key.

Parameters

func	The function to call when the specified key is released.
key	The specified key.

◆ ontimer()

void cturtle::InteractiveTurtleScreen::ontimer	(	const TimerFunc &	func,
		unsigned int	time )

inline

Adds a timer function to be called every N milliseconds.

Parameters

func	The function to call when the timer has finished.
time	The total number of milliseconds between calls.

◆ presskey()

void cturtle::InteractiveTurtleScreen::presskey ( KeyboardKey key )

inline

Simulates a key "on press" event.

Parameters

key	The key to call "on press" bindings for.

◆ redraw()

void cturtle::InteractiveTurtleScreen::redraw ( bool invalidate )

inlineoverridevirtual

Draws all geometry from all child turtles and swaps this display.

Implements cturtle::AbstractTurtleScreen.

◆ releasekey()

void cturtle::InteractiveTurtleScreen::releasekey ( KeyboardKey key )

inline

Simulates a key "on release" event.

Parameters

key	The key to call "on release" bindings for.

◆ remove()

void cturtle::InteractiveTurtleScreen::remove ( Turtle & turtle )

inlineoverridevirtual

Removes the specified turtle from this screen.

Parameters

turtle

Implements cturtle::AbstractTurtleScreen.

◆ resetscreen()

void cturtle::InteractiveTurtleScreen::resetscreen ( )

inlineoverridevirtual

Resets all turtles belonging to this screen to their original state->

Implements cturtle::AbstractTurtleScreen.

◆ save()

void cturtle::InteractiveTurtleScreen::save ( const std::string & file )

inline

Saves the display as a file, the format of which is dependent on the file extension given in the specified file path string.

◆ screensize() [1/2]

ivec2 cturtle::InteractiveTurtleScreen::screensize ( )

inlineoverridevirtual

Returns the size of the screen, in pixels.

Implements cturtle::AbstractTurtleScreen.

◆ screensize() [2/2]

ivec2 cturtle::InteractiveTurtleScreen::screensize ( Color & bg )

inlineoverridevirtual

Returns the size of this screen, in pixels. Also returns the background color of the screen, by assigning the input reference.

Implements cturtle::AbstractTurtleScreen.

◆ screentransform()

Transform cturtle::InteractiveTurtleScreen::screentransform ( ) const

inlineoverridevirtual

Returns the screen-level Transform of this screen. This is what puts the origin at the center of the screen rather than at at the top left, for example.

Implements cturtle::AbstractTurtleScreen.

◆ shape()

AbstractDrawableObject & cturtle::InteractiveTurtleScreen::shape ( const std::string & name )

inlineoverridevirtual

Returns the shape associated with the specified name.

Parameters

name

Returns

Implements cturtle::AbstractTurtleScreen.

◆ supports_live_animation()

bool cturtle::InteractiveTurtleScreen::supports_live_animation ( ) const

inlineoverridevirtual

Returns: a boolean indicating if this turtle screen supports live animation. "Live animation" is regarded as the frames of animation that encompass movement over space.

Implements cturtle::AbstractTurtleScreen.

◆ tracer()

void cturtle::InteractiveTurtleScreen::tracer	(	int	countmax,
		unsigned int	delayMS )

inlineoverridevirtual

Sets an internal variable that dictates how many frames are skipped between screen updates; higher numbers will speed up complex turtle drawings. Setting it to ZERO will COMPLETELY disable animation until this value changes.

Parameters

countmax	The value of the aforementioned variable.
delayMS	This value is sent to function "delay".

Implements cturtle::AbstractTurtleScreen.

◆ update()

void cturtle::InteractiveTurtleScreen::update	(	bool	invalidateDraw,
		bool	processInput )

inlineoverridevirtual

Updates the screen's graphics and input.

Parameters

invalidateDraw	Completely redraws the scene if true. If false, only draws the newest geometry.
processInput	A boolean indicating to process input.

No events to process in the cache, or we're not processing it right now.

Implements cturtle::AbstractTurtleScreen.

◆ window_height()

int cturtle::InteractiveTurtleScreen::window_height ( ) const

inlineoverridevirtual

Returns the height of the window, in pixels.

Implements cturtle::AbstractTurtleScreen.

◆ window_width()

int cturtle::InteractiveTurtleScreen::window_width ( ) const

inlineoverridevirtual

Returns the width of the window, in pixels.

Implements cturtle::AbstractTurtleScreen.

Member Data Documentation

◆ backgroundColor

Color cturtle::InteractiveTurtleScreen::backgroundColor = Color("white")

protected

The background color of this TurtleScreen.

◆ backgroundImage

Image cturtle::InteractiveTurtleScreen::backgroundImage

protected

The background image of this TurtleScreen. When not empty, this image takes precedence over the background color when drawing.

◆ cachedEvents

std::list<InputEvent> cturtle::InteractiveTurtleScreen::cachedEvents

protected

A list of cached events. Filled by event thread, processed and emptied by main thread.

◆ canvas

Image cturtle::InteractiveTurtleScreen::canvas

protected

The canvas onto which scene objects are drawn to.

◆ curMode

ScreenMode cturtle::InteractiveTurtleScreen::curMode = SM_STANDARD

protected

The current screen mode.

See also: mode(m)

◆ delayMS

long int cturtle::InteractiveTurtleScreen::delayMS = 10

protected

Redraw delay, in milliseconds.

◆ display

cimg::CImgDisplay cturtle::InteractiveTurtleScreen::display

protected

The underlying display mechanism for a TurtleScreen.

◆ eventCacheMutex

std::mutex cturtle::InteractiveTurtleScreen::eventCacheMutex

protected

The mutex which controls synchronization between the main thread and the event thread.

◆ eventThread

std::unique_ptr<std::thread> cturtle::InteractiveTurtleScreen::eventThread

protected

A unique pointer to the event thread.

See also: initEventThread()

◆ keyBindings

std::unordered_map<KeyboardKey, std::list<KeyFunc> > cturtle::InteractiveTurtleScreen::keyBindings[2]

protected

Initial value:

◆ killEventThread

bool cturtle::InteractiveTurtleScreen::killEventThread = false

protected

A boolean indicating whether or not to kill the event thread.

◆ lastTotalObjects

int cturtle::InteractiveTurtleScreen::lastTotalObjects = 0

protected

The total objects on screen the last time this screen was drawn. Used to keep track of newer scene objects for a speed improvement.

◆ mouseBindings

std::list<MouseFunc> cturtle::InteractiveTurtleScreen::mouseBindings[3]

protected

Initial value:

◆ objects

std::list<SceneObject> cturtle::InteractiveTurtleScreen::objects

protected

The scene list.

◆ redrawCounter

int cturtle::InteractiveTurtleScreen::redrawCounter = 0

protected

These variables are used specifically in tracer settings. Redraw Counter.

◆ redrawCounterMax

int cturtle::InteractiveTurtleScreen::redrawCounterMax = 1

protected

Redraw counter max.

◆ turtles

std::list<Turtle*> cturtle::InteractiveTurtleScreen::turtles

protected

The list of attached turtles.

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

CTurtle.hpp

Public Member Functions

Protected Member Functions

Protected Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ InteractiveTurtleScreen() [1/3]

◆ InteractiveTurtleScreen() [2/3]

◆ InteractiveTurtleScreen() [3/3]

◆ ~InteractiveTurtleScreen()

Member Function Documentation

◆ add()

◆ addfont()

◆ bgcolor() [1/2]

◆ bgcolor() [2/2]

◆ bgpic() [1/2]

◆ bgpic() [2/2]

◆ bye()

◆ clearscreen()

◆ click() [1/2]

◆ click() [2/2]

◆ delay() [1/2]

◆ delay() [2/2]

◆ exitonclick()

◆ font()

◆ getcanvas()

◆ getScene()

◆ initEventThread()

◆ internaldisplay()

◆ isclosed()

◆ mainloop()

◆ mode() [1/2]

◆ mode() [2/2]

◆ onclick()

◆ onkeypress()

◆ onkeyrelease()

◆ ontimer()

◆ presskey()

◆ redraw()

◆ releasekey()

◆ remove()

◆ resetscreen()

◆ save()

◆ screensize() [1/2]

◆ screensize() [2/2]

◆ screentransform()

◆ shape()

◆ supports_live_animation()

◆ tracer()

◆ update()

◆ window_height()

◆ window_width()

Member Data Documentation

◆ backgroundColor

◆ backgroundImage

◆ cachedEvents

◆ canvas

◆ curMode

◆ delayMS

◆ display

◆ eventCacheMutex

◆ eventThread

◆ keyBindings

◆ killEventThread

◆ lastTotalObjects

◆ mouseBindings

◆ objects

◆ redrawCounter

◆ redrawCounterMax

◆ turtles