Fireworks Engine  v2.0
Lightweight Sandbox Game Engine using OpenGL for additional Customisation and Quick Prototyping
fireworks::graphics::Scene3D Class Reference

The scene object that contains information about the 3d rendering and renderables objects. More...

#include <scene3d.h>

Collaboration diagram for fireworks::graphics::Scene3D:

Public Member Functions

 Scene3D (Renderer3D *renderer)
 Creates a 3D scene to store 3d renderable objects. More...
 
virtual ~Scene3D ()
 Destructor of the scene More...
 
virtual void add (Renderable3D *renderable)
 Adds 3D renderables to the scene. More...
 
virtual void render ()
 Renders the scene by submitting it's renderables to the renderer's render queue. More...
 
const std::vector< Renderable3D * > & getRendetables () const
 Gets a reference to the pool of renderables in the scene. More...
 

Public Attributes

Renderer3Drenderer
 The Renderer3D used by the scene to render the 3d renderables. More...
 
std::vector< Renderable3D * > renderables
 The list of 3d renderables that are present in the scene. More...
 

Detailed Description

The scene object that contains information about the 3d rendering and renderables objects.

It stores all the renderables and information about renderable3d objects, also takes care of render queuing

Constructor & Destructor Documentation

◆ Scene3D()

fireworks::graphics::Scene3D::Scene3D ( Renderer3D renderer)

Creates a 3D scene to store 3d renderable objects.

Parameters
rendererThe 3DRenderer to use to render the 3d objects

◆ ~Scene3D()

fireworks::graphics::Scene3D::~Scene3D ( )
virtual

Destructor of the scene

Member Function Documentation

◆ add()

void fireworks::graphics::Scene3D::add ( Renderable3D renderable)
virtual

Adds 3D renderables to the scene.

Parameters
renderableThe renderable object to be rendered in the scene

◆ getRendetables()

const std::vector<Renderable3D*>& fireworks::graphics::Scene3D::getRendetables ( ) const
inline

Gets a reference to the pool of renderables in the scene.

◆ render()

void fireworks::graphics::Scene3D::render ( )
virtual

Renders the scene by submitting it's renderables to the renderer's render queue.

Member Data Documentation

◆ renderables

std::vector<Renderable3D*> fireworks::graphics::Scene3D::renderables

The list of 3d renderables that are present in the scene.

◆ renderer

Renderer3D* fireworks::graphics::Scene3D::renderer

The Renderer3D used by the scene to render the 3d renderables.


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