SkyBoxAssets Class Reference

System manager for for creating and accessing SkyBox objects from external resources. More...

#include <SkyBoxAssets.h>

Detailed Description

System manager for for creating and accessing SkyBox objects from external resources.

The SkyBoxAssets is a singleton that allows the user to create and resuse SkyBox objects throughout their code.

SkyBoxes are created via the Load() function in the IonEngine::LoadResources() function. They can then be accessed by using the Get() function with the associated key that the user defined upon loading.

Public Types
typedef std::string	SkyBoxKey

Static Public Member Functions
static void	Load (const SkyBoxKey &SkyBox_Map_Key, float scale, ShaderBase *shader, Texture *pTexture)
	Function saves a SkyBox created from the desired texture. More...
static SkyBox *	Get (const SkyBoxKey &SkyBox_Map_Key)
	Function returns SkyBox pointer based off of the passed in key. More...

Member Typedef Documentation

typedef std::string SkyBoxAssets::SkyBoxKey

Typedef of an std::string for an easier to read name.

Member Function Documentation

static SkyBox* SkyBoxAssets::Get ( const SkyBoxKey &  SkyBox_Map_Key )

inlinestatic

Function returns SkyBox pointer based off of the passed in key.

This Get() function uses it's SkyBox_Map_Key parameter to search the SkyBox map and return the SkyBox object saved under the same key string.

Parameters

SkyBox_Map_Key

An std::string for use as a key to access the stored SkyBox

Returns

Pointer to SkyBox object at stored key

static void SkyBoxAssets::Load ( const SkyBoxKey &  SkyBox_Map_Key, float  scale, ShaderBase *  shader, Texture *  pTexture  )

inlinestatic

Function saves a SkyBox created from the desired texture.

Parameters

SkyBox_Map_Key
scale
shader
pTexture