The AbstractTurtleScreen class is the abstract type for most turtle functionality. It intentionally excludes all input/output functionality, allowing for two intended derivates: an "interactive" screen, vs an "offline rendering" screen. The Turtle class doesn't care which one it gets attached to. More...

#include <CTurtle.hpp>

Inheritance diagram for cturtle::AbstractTurtleScreen:

[legend]

Public Member Functions
virtual void	tracer (int countmax, unsigned int delayMS)=0

virtual int	window_width () const =0

virtual int	window_height () const =0

virtual Color	bgcolor () const =0

virtual void	bgcolor (const Color &c)=0

virtual void	mode (ScreenMode mode)=0

virtual ScreenMode	mode () const =0

virtual void	clearscreen ()=0

void	clear ()

virtual void	resetscreen ()=0

void	reset ()

virtual bool	supports_live_animation () const =0

virtual ivec2	screensize (Color &bg)=0

virtual ivec2	screensize ()=0

virtual void	update (bool invalidateDraw, bool processInput)=0

virtual void	delay (unsigned int ms)=0

virtual unsigned int	delay () const =0

virtual void	bye ()=0

virtual Image &	getcanvas ()=0

virtual bool	isclosed ()=0

virtual void	redraw (bool invalidate)=0

virtual Transform	screentransform () const =0
	Calculates and returns the root-level screen transformation.

virtual void	add (Turtle &turtle)=0
	Adds the specified turtle to this screen. The turtle cannot belong to other screens, as that would break ownership responsibility.

virtual void	remove (Turtle &turtle)=0
	Removes the specified turtle from this screen.

virtual std::list< SceneObject > &	getScene ()=0
	Returns a read-write reference to the list of scene objects currently residing on this screen.

virtual AbstractDrawableObject &	shape (const std::string &name)=0
	Returns a read-write reference to the registered shape with the specified name.

virtual const BitmapFont &	font (const std::string &name) const =0
	Returns a read-only reference to a previously loaded bitmap font.

Static Protected Member Functions
static Image	decodeDefaultFont ()

Protected Attributes
std::unordered_map< std::string, Polygon >	shapes

Detailed Description

The AbstractTurtleScreen class is the abstract type for most turtle functionality. It intentionally excludes all input/output functionality, allowing for two intended derivates: an "interactive" screen, vs an "offline rendering" screen. The Turtle class doesn't care which one it gets attached to.

Member Function Documentation

◆ add()

virtual void cturtle::AbstractTurtleScreen::add ( Turtle & turtle )

pure virtual

Adds the specified turtle to this screen. The turtle cannot belong to other screens, as that would break ownership responsibility.

Implemented in cturtle::InteractiveTurtleScreen.

◆ bgcolor() [1/2]

virtual Color cturtle::AbstractTurtleScreen::bgcolor ( ) const

pure virtual

Returns the current background color.

Implemented in cturtle::InteractiveTurtleScreen.

◆ bgcolor() [2/2]

virtual void cturtle::AbstractTurtleScreen::bgcolor ( const Color & c )

pure virtual

Sets the current background color.

Implemented in cturtle::InteractiveTurtleScreen.

◆ bye()

virtual void cturtle::AbstractTurtleScreen::bye ( )

pure virtual

Closes this turtle screen.

Implemented in cturtle::InteractiveTurtleScreen.

◆ clear()

void cturtle::AbstractTurtleScreen::clear ( )

inline

Alias for clearscreen function

See also: clearscreen()

◆ clearscreen()

virtual void cturtle::AbstractTurtleScreen::clearscreen ( )

pure virtual

Clears the screen.

Implemented in cturtle::InteractiveTurtleScreen.

◆ decodeDefaultFont()

static Image cturtle::AbstractTurtleScreen::decodeDefaultFont ( )

inlinestaticprotected

Decodes the default font image from memory. The font is encoded as 1 bit per pixel (on/off) for simplicity, and is relatively easily decoded through bit-shifting.

The loading of this was delegated to the AbstractTurtleScreen class simply because all derived classes should have an idea of their own internal states, however they will ALL have these managed states, and thus ALL derived classes will need to call this function at some point while performing default initialization.

Returns: the decoded default font image.

◆ delay() [1/2]

virtual unsigned int cturtle::AbstractTurtleScreen::delay ( ) const

pure virtual

Implemented in cturtle::InteractiveTurtleScreen.

◆ delay() [2/2]

virtual void cturtle::AbstractTurtleScreen::delay ( unsigned int ms )

pure virtual

Implemented in cturtle::InteractiveTurtleScreen.

◆ font()

virtual const BitmapFont & cturtle::AbstractTurtleScreen::font ( const std::string & name ) const

pure virtual

Returns a read-only reference to a previously loaded bitmap font.

Returns: a previously loaded font by its specified name.

Implemented in cturtle::InteractiveTurtleScreen.

◆ getcanvas()

virtual Image & cturtle::AbstractTurtleScreen::getcanvas ( )

pure virtual

Implemented in cturtle::InteractiveTurtleScreen.

◆ getScene()

virtual std::list< SceneObject > & cturtle::AbstractTurtleScreen::getScene ( )

pure virtual

Returns a read-write reference to the list of scene objects currently residing on this screen.

Returns: the list of scene objects currently residing on this screen.

Implemented in cturtle::InteractiveTurtleScreen.

◆ isclosed()

virtual bool cturtle::AbstractTurtleScreen::isclosed ( )

pure virtual

Implemented in cturtle::InteractiveTurtleScreen.

◆ mode() [1/2]

virtual ScreenMode cturtle::AbstractTurtleScreen::mode ( ) const

pure virtual

Returns the current screen mode.

Implemented in cturtle::InteractiveTurtleScreen.

◆ mode() [2/2]

virtual void cturtle::AbstractTurtleScreen::mode ( ScreenMode mode )

pure virtual

Sets the current screen mode.

Implemented in cturtle::InteractiveTurtleScreen.

◆ redraw()

virtual void cturtle::AbstractTurtleScreen::redraw ( bool invalidate )

pure virtual

Implemented in cturtle::InteractiveTurtleScreen.

◆ remove()

virtual void cturtle::AbstractTurtleScreen::remove ( Turtle & turtle )

pure virtual

Removes the specified turtle from this screen.

Parameters

turtle

Implemented in cturtle::InteractiveTurtleScreen.

◆ reset()

void cturtle::AbstractTurtleScreen::reset ( )

inline

Resets all turtles belonging to this screen to their original state.

◆ resetscreen()

virtual void cturtle::AbstractTurtleScreen::resetscreen ( )

pure virtual

Resets all turtles belonging to this screen to their original state.

Implemented in cturtle::InteractiveTurtleScreen.

◆ screensize() [1/2]

virtual ivec2 cturtle::AbstractTurtleScreen::screensize ( )

pure virtual

Implemented in cturtle::InteractiveTurtleScreen.

◆ screensize() [2/2]

virtual ivec2 cturtle::AbstractTurtleScreen::screensize ( Color & bg )

pure virtual

Implemented in cturtle::InteractiveTurtleScreen.

◆ screentransform()

virtual Transform cturtle::AbstractTurtleScreen::screentransform ( ) const

pure virtual

Calculates and returns the root-level screen transformation.

Implemented in cturtle::InteractiveTurtleScreen.

◆ shape()

virtual AbstractDrawableObject & cturtle::AbstractTurtleScreen::shape ( const std::string & name )

pure virtual

Returns a read-write reference to the registered shape with the specified name.

Parameters

name	of the shape

Returns: read-write reference to the associated shape

Implemented in cturtle::InteractiveTurtleScreen.

◆ supports_live_animation()

virtual bool cturtle::AbstractTurtleScreen::supports_live_animation ( ) const

pure virtual

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.

Implemented in cturtle::InteractiveTurtleScreen.

◆ tracer()

virtual void cturtle::AbstractTurtleScreen::tracer	(	int	countmax,
		unsigned int	delayMS )

pure virtual

Sets the tracer setting for this window.

Implemented in cturtle::InteractiveTurtleScreen.

◆ update()

virtual void cturtle::AbstractTurtleScreen::update	(	bool	invalidateDraw,
		bool	processInput )

pure virtual

Implemented in cturtle::InteractiveTurtleScreen.

◆ window_height()

virtual int cturtle::AbstractTurtleScreen::window_height ( ) const

pure virtual

Returns the height of the window, in pixels.

Implemented in cturtle::InteractiveTurtleScreen.

◆ window_width()

virtual int cturtle::AbstractTurtleScreen::window_width ( ) const

pure virtual

Returns the width of the window, in pixels.

Implemented in cturtle::InteractiveTurtleScreen.

Member Data Documentation

◆ shapes

std::unordered_map<std::string, Polygon> cturtle::AbstractTurtleScreen::shapes

protected

Initial value:

= {
                
                {"triangle",
                        Polygon{
                                {0, 0},
                                {-5, 5},
                                {5, 5}}},
                {"square",
                        Polygon{
                                {-5, -5},
                                {-5, 5},
                                {5, 5},
                                {5, -5}}},
                {"indented triangle",
                        Polygon{
                                
                                {0, 0},
                                {-5, 10},
                                {0, 8},
                                {5, 10}}},
                {"arrow",
                        Polygon{
                                {0, 0},
                                {-5, 5},
                                {-3, 5},
                                {-3, 10},
                                {3, 10},
                                {3, 5},
                                {5, 5}}}
        }

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

CTurtle.hpp

Public Member Functions

Static Protected Member Functions

Protected Attributes

Detailed Description

Member Function Documentation

◆ add()

◆ bgcolor() [1/2]

◆ bgcolor() [2/2]

◆ bye()

◆ clear()

◆ clearscreen()

◆ decodeDefaultFont()

◆ delay() [1/2]

◆ delay() [2/2]

◆ font()

◆ getcanvas()

◆ getScene()

◆ isclosed()

◆ mode() [1/2]

◆ mode() [2/2]

◆ redraw()

◆ remove()

◆ reset()

◆ resetscreen()

◆ screensize() [1/2]

◆ screensize() [2/2]

◆ screentransform()

◆ shape()

◆ supports_live_animation()

◆ tracer()

◆ update()

◆ window_height()

◆ window_width()

Member Data Documentation

◆ shapes