Study Dungeon  1.0.0
A group project for COSC345
Public Member Functions
HowToScene Class Reference

Class for a scene to show the program instructions. More...

#include <howto_scene.h>

Inheritance diagram for HowToScene:
ConsoleUI::Scene

Public Member Functions

 HowToScene (ConsoleUI::UIManager &uiManager, std::function< void()> goBack)
 Construct a new HowTo Scene object. More...
 
void update () override
 function for continuous updates to the program state seperate from rendering and input handling
 
void render (std::shared_ptr< ConsoleUI::ConsoleWindow > window) override
 renders the scene on the console window More...
 
void init ()
 Initialise the scene.
 
void handleInput () override
 Handle the input for the scene.
 
void setStaticDrawn (bool staticDrawn) override
 Sets the static drawn state of the scene. More...
 
- Public Member Functions inherited from ConsoleUI::Scene
virtual ~Scene ()=default
 Destroy the Scene object.
 

Detailed Description

Class for a scene to show the program instructions.

Constructor & Destructor Documentation

◆ HowToScene()

HowToScene::HowToScene ( ConsoleUI::UIManager uiManager,
std::function< void()>  goBack 
)

Construct a new HowTo Scene object.

Parameters
uiManagerreference to the current UI mananger object
goBacka function to go back a scene

Member Function Documentation

◆ render()

void HowToScene::render ( std::shared_ptr< ConsoleUI::ConsoleWindow window)
overridevirtual

renders the scene on the console window

Parameters
windowshared pointer to the console window that is rendered on

draws the title of the scene, sets up a counter for the current number of the fib sequence and draws the buttons: reset, update and back.

Implements ConsoleUI::Scene.

◆ setStaticDrawn()

void HowToScene::setStaticDrawn ( bool  staticDrawn)
overridevirtual

Sets the static drawn state of the scene.

Parameters
staticDrawnBoolean indicating whether the static elements have been drawn.

Implements ConsoleUI::Scene.


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