Jamie Slowgrove - PGG Assignment 2
 All Classes Namespaces Files Functions Variables Typedefs Macros
Public Member Functions | Private Member Functions | Private Attributes | List of all members
Help Class Reference

Creates an Help object that inherits State and runs the Help screen. More...

#include <Help.h>

Inheritance diagram for Help:
Inheritance graph
Collaboration diagram for Help:
Collaboration graph

Public Member Functions

 Help (StateManager *stateManager, SDL_Window *window, int screenWidth, int screenHeight, Audio *music)
 
 ~Help ()
 
bool input ()
 
void update (float dt)
 
void draw ()
 
- Public Member Functions inherited from State
 State (StateManager *stateManager, SDL_Window *window, int screenWidth, int screenHeight)
 
virtual ~State ()
 
SDL_Window * getWindow ()
 

Private Member Functions

void loadingScreen ()
 

Private Attributes

std::unordered_map
< std::string, Object * > 
objects
 
std::unordered_map
< std::string, Shader * > 
shaders
 
Cameracamera
 
HelpUIuserInterface
 
Audiomusic
 

Additional Inherited Members

- Protected Attributes inherited from State
StateManagerstateManager
 
SDL_Window * window
 
int screenWidth
 
int screenHeight
 

Detailed Description

Creates an Help object that inherits State and runs the Help screen.

Author
Jamie Slowgrove

Constructor & Destructor Documentation

Help::Help ( StateManager stateManager,
SDL_Window *  window,
int  screenWidth,
int  screenHeight,
Audio music 
)

Constructs a Help object.

Parameters
stateManagerA pointer to the StateManager.
windowA pointer to the window.
screenWidthThe screen width.
screenHeightThe screen height.
musicA pointer to the background music.
Help::~Help ( )

Destructs an Help object.

Member Function Documentation

void Help::draw ( )
virtual

A function to draw to the screen.

Implements State.

Here is the call graph for this function:

bool Help::input ( )
virtual

Handles the Help input.

Returns
If false then quit the Help State.

Implements State.

Here is the call graph for this function:

void Help::loadingScreen ( )
private

Draws a LoadingScreen.

void Help::update ( float  dt)
virtual

A function to update the Help.

Parameters
dtThe delta time.

Implements State.

Here is the call graph for this function:

Member Data Documentation

Camera* Help::camera
private

The Camera for the Help

Audio* Help::music
private

The background music

std::unordered_map<std::string, Object*> Help::objects
private

The loaded Object files

std::unordered_map<std::string, Shader*> Help::shaders
private

The loaded Shader files

HelpUI* Help::userInterface
private

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