All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Macros Pages
Public Member Functions | Static Public Member Functions | List of all members
Eegeo::Modules::FireworksModule Class Reference

Object graph for a default implementation of Fireworks display animation and rendering. More...

#include <FireworksModule.h>

Inheritance diagram for Eegeo::Modules::FireworksModule:
Eegeo::Fireworks::IFireworksLocationRepository

Public Member Functions

 FireworksModule (const std::string &particleTextureFileName, Rendering::GlBufferPool &glBufferPool, Rendering::VertexLayouts::VertexBindingPool &vertexBindingPool, Rendering::VertexLayouts::VertexLayoutPool &vertexLayoutPool, Rendering::Shaders::ShaderIdGenerator &shaderIdGenerator, Rendering::Materials::MaterialIdGenerator &materialIdGenerator, Helpers::ITextureFileLoader &textureFileLoader, Rendering::RenderableFilters &renderableFilters, Streaming::StreamingController &streamingController, Streaming::CameraFrustumStreamingVolume &cameraFrustum, Resources::Terrain::Heights::TerrainHeightProvider &terrainHeightProvider)
 Create an object graph for adding animated fireworks displays to the world (for a simpler creation path, see the Create(..) method)
 
void Update (float dt, const Camera::RenderCamera &renderCamera)
 Update method to tick the animation of firework displays.
 
void AddFireworksLocation (u32 uid, Fireworks::FireworksLocationConfiguration &location)
 Add a location in the world where a Fireworks display may occur.
 
void RemoveFireworksLocation (u32 uid)
 Removes a location from the world based on a previously defined unique identifier.
 
void Clear ()
 Removes all locations from the repository, removing all fireworks displays from the world.
 

Static Public Member Functions

static FireworksModuleCreate (const std::string &particleTextureFileName, const Modules::Core::RenderingModule &renderingModule, Modules::IPlatformAbstractionModule &platformModule, Modules::Map::StreamingModule &streamingModule, Modules::Map::MapModule &mapModule, Modules::Map::Layers::TerrainModelModule &terrainModelModule)
 Factory method that creates an object graph for displaying Fireworks displays in the world.
 

Detailed Description

Object graph for a default implementation of Fireworks display animation and rendering.

This module creates an object graph to animate & display Fireworks displays in the world. By adding a defined FireworksLocationConfiguration to the module's repository, you can register a number of potential fireworks displays to play.


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