EGG::Scene Class Reference

#include <Scene.hh>

Description

Base class for all scenes.

A scene compartmentalizes certain elements of the game, such as the menu, the race, the credits, etc. This allows for easy cleanup when transitioning to a different scene, as scenes destroy instances of classes used only during the scene lifetime. While this is not an abstract class, you'll never see an instance of this base class.

Definition at line 16 of file Scene.hh.

Inheritance diagram for EGG::Scene:

Public Member Functions
virtual void	calc ()
virtual void	enter ()
virtual void	exit ()
virtual void	reinit ()
virtual void	incoming_childDestroy ()
virtual void	outgoing_childCreate ()

Setters
void	setParent (Scene *parent)
void	setChild (Scene *child)
void	setId (int id)
void	setSceneMgr (SceneManager *sceneMgr)

Getters
Heap *	heap () const
Scene *	parent () const
Scene *	child () const
int	id () const
SceneManager *	sceneMgr () const

Protected Attributes
Heap *	m_heap
Scene *	m_parent
Scene *	m_child
int	m_id
SceneManager *	m_sceneMgr

Additional Inherited Members
Private Member Functions inherited from EGG::Disposer
Static Private Member Functions inherited from EGG::Disposer
static constexpr u16	getLinkOffset ()

Constructor & Destructor Documentation

Scene()

EGG::Scene::Scene ( )

0x8023AD10

Definition at line 8 of file Scene.cc.

Member Function Documentation

calc()

virtual void EGG::Scene::calc ( )

inlinevirtual

Definition at line 29 of file Scene.hh.

child()

Scene * EGG::Scene::child ( ) const

inlinenodiscard

Definition at line 63 of file Scene.hh.

enter()

virtual void EGG::Scene::enter ( )

inlinevirtual

Definition at line 30 of file Scene.hh.

exit()

virtual void EGG::Scene::exit ( )

inlinevirtual

Definition at line 31 of file Scene.hh.

heap()

Heap * EGG::Scene::heap ( ) const

inlinenodiscard

Definition at line 55 of file Scene.hh.

id()

int EGG::Scene::id ( ) const

inlinenodiscard

Definition at line 67 of file Scene.hh.

incoming_childDestroy()

virtual void EGG::Scene::incoming_childDestroy ( )

inlinevirtual

Definition at line 33 of file Scene.hh.

outgoing_childCreate()

virtual void EGG::Scene::outgoing_childCreate ( )

inlinevirtual

Definition at line 34 of file Scene.hh.

parent()

Scene * EGG::Scene::parent ( ) const

inlinenodiscard

Definition at line 59 of file Scene.hh.

reinit()

virtual void EGG::Scene::reinit ( )

inlinevirtual

Definition at line 32 of file Scene.hh.

sceneMgr()

SceneManager * EGG::Scene::sceneMgr ( ) const

inlinenodiscard

Definition at line 71 of file Scene.hh.

setChild()

void EGG::Scene::setChild ( Scene * child )

inline

Definition at line 41 of file Scene.hh.

setId()

void EGG::Scene::setId ( int id )

inline

Definition at line 45 of file Scene.hh.

setParent()

void EGG::Scene::setParent ( Scene * parent )

inline

Definition at line 37 of file Scene.hh.

setSceneMgr()

void EGG::Scene::setSceneMgr ( SceneManager * sceneMgr )

inline

Definition at line 49 of file Scene.hh.

Member Data Documentation

m_child

Scene* EGG::Scene::m_child

protected

Definition at line 83 of file Scene.hh.

m_heap

Heap* EGG::Scene::m_heap

protected

Definition at line 81 of file Scene.hh.

m_id

int EGG::Scene::m_id

protected

Definition at line 84 of file Scene.hh.

m_parent

Scene* EGG::Scene::m_parent

protected

Definition at line 82 of file Scene.hh.

m_sceneMgr

SceneManager* EGG::Scene::m_sceneMgr

protected

Definition at line 85 of file Scene.hh.