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

A class for the 2D HelpUI that inherits UI. More...

#include <HelpUI.h>

Inheritance diagram for HelpUI:
Inheritance graph
Collaboration diagram for HelpUI:
Collaboration graph

Public Member Functions

 HelpUI (std::string vertexShaderFileName, std::string fragmentShaderFileName, std::unordered_map< std::string, Shader * > &shaders)
 
 HelpUI (std::unordered_map< std::string, Shader * > &shaders)
 
 ~HelpUI ()
 
void update (float dt)
 
void draw ()
 
- Public Member Functions inherited from UI
 UI (std::string vertexShaderFileName, std::string fragmentShaderFileName, std::unordered_map< std::string, Shader * > &shaders)
 
 UI (std::unordered_map< std::string, Shader * > &shaders)
 
 ~UI ()
 

Private Attributes

UIObjecthelp
 

Additional Inherited Members

- Protected Member Functions inherited from UI
void initialiseShaders (std::string vertexShaderFileName, std::string fragmentShaderFileName, std::unordered_map< std::string, Shader * > &shaders)
 
- Protected Attributes inherited from UI
Shadershader
 

Detailed Description

A class for the 2D HelpUI that inherits UI.

Author
Jamie Slowgrove

Constructor & Destructor Documentation

HelpUI::HelpUI ( std::string  vertexShaderFileName,
std::string  fragmentShaderFileName,
std::unordered_map< std::string, Shader * > &  shaders 
)

Constructs the HelpUI object.

Parameters
vertexShaderFileNameThe name of the vertex shader file.
fragmentShaderFileNameThe name of the fragment shader file.
shadersA reference to the loaded Shader files
HelpUI::HelpUI ( std::unordered_map< std::string, Shader * > &  shaders)

Constructs the HelpUI object.

Parameters
shadersA reference to the loaded Shader files
HelpUI::~HelpUI ( )

Destructs the HelpUI object.

Member Function Documentation

void HelpUI::draw ( )
virtual

A function to draw to the screen.

Implements UI.

Here is the call graph for this function:

Here is the caller graph for this function:

void HelpUI::update ( float  dt)
virtual

A function to update the HelpUI.

Parameters
dtThe delta time.

Implements UI.

Member Data Documentation

UIObject* HelpUI::help
private

The help image


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