Level H Engine
Public Member Functions | Private Attributes | List of all members
HeightmapDemo Class Reference

A State that contains and runs the Demo. More...

#include <HeightmapDemo.h>

Inheritance diagram for HeightmapDemo:
Inheritance graph
Collaboration diagram for HeightmapDemo:
Collaboration graph

Public Member Functions

 HeightmapDemo (StateManager *stateManager, SDL_Window *window)
 Constructs the State object. More...
 
 ~HeightmapDemo ()
 Destructs the State object. More...
 
bool input ()
 Handles the State input. More...
 
void update ()
 A function to update the State. More...
 
void draw ()
 A function to draw the State to the screen. More...
 
- Public Member Functions inherited from State
 State (StateManager *stateManager, SDL_Window *window, std::string name)
 Constructs a State object. More...
 
virtual ~State ()
 A virtual destructor for the State object. More...
 
SDL_Window * getWindow ()
 Gets the window. More...
 
std::string getName ()
 Gets the name of the state. More...
 
void destroyState ()
 A function to destroy all data in a state. More...
 

Private Attributes

std::string backgroundMusicID
 The background music id. More...
 
bool initialLoop
 Initital loop bool. More...
 
bool helpToggle
 A boolean for help toggle. More...
 
bool cameraToggle
 A boolean for camera toggle. More...
 
Vec3 defaultCameraPos
 The default camera position. More...
 
Vec3 defaultCameraRotation
 The default camera rotation. More...
 
std::string UIImageID
 The UI image ID. More...
 
std::string helpID
 The Help image ID. More...
 
std::string heightmapImageID
 The heightmap image ID. More...
 

Additional Inherited Members

- Protected Attributes inherited from State
StateManagerstateManager
 A pointer to the state manager. More...
 
SDL_Window * window
 The window to display to. More...
 
std::string name
 The state name. More...
 
bool destroyed
 A boolean for if the state is destroyed. More...
 

Detailed Description

A State that contains and runs the Demo.

Constructor & Destructor Documentation

◆ HeightmapDemo()

HeightmapDemo::HeightmapDemo ( StateManager stateManager,
SDL_Window *  window 
)

Constructs the State object.

Parameters
stateManagerA pointer to the StateManager.
windowA pointer to the window in use.
Here is the call graph for this function:

◆ ~HeightmapDemo()

HeightmapDemo::~HeightmapDemo ( )

Destructs the State object.

Here is the call graph for this function:

Member Function Documentation

◆ draw()

void HeightmapDemo::draw ( )
virtual

A function to draw the State to the screen.

Implements State.

Here is the call graph for this function:

◆ input()

bool HeightmapDemo::input ( )
virtual

Handles the State input.

Returns
If false then quit the State.

Implements State.

Here is the call graph for this function:

◆ update()

void HeightmapDemo::update ( )
virtual

A function to update the State.

Implements State.

Here is the call graph for this function:

Member Data Documentation

◆ backgroundMusicID

std::string HeightmapDemo::backgroundMusicID
private

The background music id.

◆ cameraToggle

bool HeightmapDemo::cameraToggle
private

A boolean for camera toggle.

◆ defaultCameraPos

Vec3 HeightmapDemo::defaultCameraPos
private

The default camera position.

◆ defaultCameraRotation

Vec3 HeightmapDemo::defaultCameraRotation
private

The default camera rotation.

◆ heightmapImageID

std::string HeightmapDemo::heightmapImageID
private

The heightmap image ID.

◆ helpID

std::string HeightmapDemo::helpID
private

The Help image ID.

◆ helpToggle

bool HeightmapDemo::helpToggle
private

A boolean for help toggle.

◆ initialLoop

bool HeightmapDemo::initialLoop
private

Initital loop bool.

◆ UIImageID

std::string HeightmapDemo::UIImageID
private

The UI image ID.


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