Scene Class Reference

#include <Scene.h>

Inheritance diagram for Scene:

Collaboration diagram for Scene:

Public Member Functions
	Scene ()
	Scene (std::string name)
	Scene (const Scene &)=default
auto	operator= (const Scene &) -> Scene &=default
	~Scene () override
	Scene (Scene &&other) noexcept=default
auto	operator= (Scene &&other) noexcept -> Scene &=default
auto	clone () const -> std::unique_ptr< GameObject > override
	makes a copy a GameObject even if it's held polymorphically
auto	componentShowMenu () -> void override
auto	onUpdate (float dt) -> void override
	called once every frame.
auto	onRender () -> void override
	called every frame after update has been called for every object.
auto	onEnterEngine () -> void override
	hook that is called when a GameObject enters the Engine tree.
auto	load (Stream &stream) -> void override
	Implementations will load the state of a GameObject from a th::Json Object.
auto	save (Stream &stream) const -> void override
	Implementations will load the state of a GameObject to a th::Json object.
auto	endWindow () -> void override
	currently unused, but intended to but was assumed to be necessary for a proper ImGui editor
auto	name () const -> const std::string &
auto	name (const std::string &name) -> void
auto	activate () -> void
auto	deactivate () -> void
auto	applyState (SceneState newState) -> SceneState
	sets the state of the scene (updating, rendering, and receiving Messages)
auto	pushState (SceneState newState) -> void
auto	popState () -> void
auto	getParentScene () const -> Scene *
Public Member Functions inherited from Component
auto	getType () const -> ComponentTypeEnum
auto	getKey () const -> Key override
	Generates a unique Key that corresponds to the GameObject.
auto	showMenu () -> void override
	Called before update each frame, for calling ImGui editor code relevant to the gameObject.
auto	getEntityParent () const -> Entity *
	gets the parent as an Entity.
Public Member Functions inherited from GameObject
	GameObject (std::string typeName, gobj::Type parentType, gobj::Type type)
	constructor for gameobject.
virtual	~GameObject ()
	destructor for GameObject.
	GameObject (const GameObject &other)
	Copy Constructor.
auto	operator= (const GameObject &other) -> GameObject &
	copy assignment operator
	GameObject (GameObject &&other) noexcept
	Move constructor.
auto	operator= (GameObject &&other) noexcept -> GameObject &
	Move assignment operator.
virtual auto	update (float dt) -> void
	called once every frame.
virtual auto	render () -> void
	called every frame after update has been called for every object.
virtual auto	destroy () -> void
	Marks an GameObject to be destroyed.
virtual auto	for_each (std::function< void(GameObject &)> func) -> void
	applies a function to every child.
virtual auto	for_each (std::function< void(const GameObject &)> func) const -> void
	applies a const function to every child.
virtual auto	getParent () const -> GameObject *
	Gets the parent of a GameObject.
virtual auto	parentTo (GameObject *newParent) -> bool
	Sets the GameObject as a child of another GameObject.
auto	getInternalParent () const -> GameObject *
	returns the actual owning parent of the GameObject
virtual auto	addChild (std::unique_ptr< GameObject > newChild) -> bool
	Adds a child to a GameObject.
auto	destroyed () const -> bool
auto	getUUID () const -> gobj::UUID
auto	isUUID (gobj::UUID compareUUID) const -> bool
auto	getName () const -> const std::string &
	Gets the type of the object as a string.
auto	getNickname () const -> const std::string &
	Gets the nickname (custom, writable name) of a GameObject.
void	calculateFormattedName () const
auto	getFormattedName () const -> const std::string &
	combines a GameObjects Type, Nickname, and UUID into one string, for use with logging.
auto	nameEquals (const std::string &compareString) const -> bool
	check whether a GameObjects typeName is equivilent to a given string.
auto	isType (gobj::Type otherType) const -> bool
	check whether the GameObject is the same as a given type.
auto	getObjectType () const -> gobj::Type
	gets the internal type of the GameObject, as an enum
auto	setNickname (const std::string &newNickname) -> void
	sets the GameObjects nickname.
auto	updates () const -> bool
auto	renders () const -> bool
auto	receivesMessages () const -> bool
auto	isActive () const -> bool
virtual auto	setShouldUpdate (const bool _shouldUpdate) -> void
	set whether the GameObject should update every frame, and whether all of it's children should update every frame
virtual auto	setShouldRender (const bool _shouldRender) -> void
	set whether the GameObject should render every frame, and whether all of it's children should render every frame
virtual auto	setShouldReceiveMessages (const bool _shouldReceiveMessages) -> void
	set whether the GameObject should Receive Messags, and whether all of it's children should receive messages
auto	setActive (const bool shouldBeActive) -> void
	set the GameObject should update, render, and receive messages

Private Member Functions
auto	updateParent () -> void

Private Attributes
std::string	_name
std::stack< SceneState >	stack
Scene *	parentScene = nullptr
bool	_pausesOtherScenes = false
bool	_mainScene = false
bool	_alwaysRenders = false
bool	_registered = false

Friends
auto	to_json (json &j, const Scene &p) ->void
auto	from_json (const json &j, Scene &p) ->void

Additional Inherited Members
Public Types inherited from Component
enum	ComponentTypeEnum : unsigned short {   cErrorType = 0 , cPhysics = 100 , cAnimation = 200 , cTransform = 300 ,   cCollider = 400 , cSprite = 500 , cBehavior = 600 , cTable = 650 ,   cCard = 700 , cDeck = 750 , cPlayer = 800 , cBoard = 850 ,   cScene = 900 , cPauseScene = 915 , cMainScene = 920 , cMainMenuScene = 925 ,   cConfirmDestructiveActionScene = 930 , cOptionsScene = 935 , cCreditsScene = 940 , cTutorialScene = 945 ,   cBackground = 950 , cSplashScreenScene = 955 , cWinScreenScene = 960 , cFlags = 1000 ,   cSelectable = 1100 , cMenu = 1200 , cActionProxy = 1300 , cEntityMover = 1400 ,   cMenuItem = 1500 , cMenuPosition = 1525 , cSelector = 1600 , cButton = 1700 }
	This enum lists out every type of component we have. More...
Public Attributes inherited from GameObject
friend	Entity
friend	Node
friend	ChildrenHandeler
friend	Engine
Protected Member Functions inherited from Component
	Component (ComponentTypeEnum type, const char *typeName)
auto	getComponentJson () const -> json
auto	getChildren () const -> std::shared_ptr< std::vector< GameObject * > > override
	override for component to return a vector of no children
Protected Member Functions inherited from GameObject
auto	setInternalParent (GameObject *parent) -> bool
	sets the internal parent of a GameObject directly, avoiding abstractions provided by ParentTo().
auto	getGameObjectJson () const -> json
	Used for serializing GameObjects.
auto	setGameObjectJson (const json &stream) -> void
	used for deserializing GameObjects
auto	checkAddToSceneHook () -> void
	Determine if the GameObject was recently added to the engine, and if it was, call onEngineEnter.

Constructor & Destructor Documentation

Scene() [1/4]

Scene::Scene

(

)

Here is the call graph for this function:

Here is the caller graph for this function:

Scene() [2/4]

Scene::Scene ( std::string name )

explicit

Here is the call graph for this function:

Scene() [3/4]

Scene::Scene ( const Scene & )

default

Here is the call graph for this function:

~Scene()

Scene::~Scene ( )

override

Here is the call graph for this function:

Scene() [4/4]

Scene::Scene ( Scene && other )

defaultnoexcept

Here is the call graph for this function:

Member Function Documentation

activate()

auto Scene::activate

(

)

->void

Here is the call graph for this function:

Here is the caller graph for this function:

applyState()

auto Scene::applyState

(

SceneState

newState

)

->SceneState

sets the state of the scene (updating, rendering, and receiving Messages)

Parameters

newState

the state of Updating Rendering and receivingMessages to apply

Returns

A SceneState that represents the old values, if they changed (to be pushed to stack if needed)

Here is the call graph for this function:

Here is the caller graph for this function:

clone()

auto Scene::clone ( ) const->std::unique_ptr< GameObject >

overridevirtual

makes a copy a GameObject even if it's held polymorphically

Warning

When overriding this function, make sure to set the parents object to this

Returns

a unique_ptr to a new stack allocated object that is a copy of the object

Implements GameObject.

Here is the call graph for this function:

componentShowMenu()

auto Scene::componentShowMenu ( ) ->void

overridevirtual

Reimplemented from Component.

Here is the call graph for this function:

Here is the caller graph for this function:

deactivate()

auto Scene::deactivate

(

)

->void

Here is the call graph for this function:

Here is the caller graph for this function:

endWindow()

auto Scene::endWindow ( ) ->void

inlineoverridevirtual

currently unused, but intended to but was assumed to be necessary for a proper ImGui editor

Implements GameObject.

Here is the call graph for this function:

Here is the caller graph for this function:

getParentScene()

auto Scene::getParentScene

(

)

const->Scene *

Here is the call graph for this function:

load()

auto Scene::load ( Stream & stream ) ->void

overridevirtual

Implementations will load the state of a GameObject from a th::Json Object.

Unimplemented in GameObject

Parameters

stream

th::Json Object

Implements GameObject.

Here is the caller graph for this function:

name() [1/2]

auto Scene::name ( ) const->conststd::string &

nodiscard

Here is the caller graph for this function:

name() [2/2]

auto Scene::name

(

const std::string &

name

)

->void

Here is the call graph for this function:

onEnterEngine()

auto Scene::onEnterEngine ( ) ->void

overridevirtual

hook that is called when a GameObject enters the Engine tree.

The hook is called immedietly after a gameobject's parent is called. Functionality may not be correct if an object was removed from the engine then re-added

Reimplemented from GameObject.

Here is the call graph for this function:

Here is the caller graph for this function:

onRender()

auto Scene::onRender ( ) ->void

overridevirtual

called every frame after update has been called for every object.

Generally used for rendering an object to the screen, when applicable. Unimplemented in GameObject

Implements GameObject.

Here is the caller graph for this function:

onUpdate()

auto Scene::onUpdate ( float dt ) ->void

overridevirtual

called once every frame.

Generally used for timers, movement, condition checks, etc. Unimplemented in GameObject

Parameters

dt	the time in seconds that has elapsed

Implements GameObject.

Here is the caller graph for this function:

operator=() [1/2]

auto Scene::operator= ( const Scene & ) ->Scene &=default

default

Here is the call graph for this function:

operator=() [2/2]

auto Scene::operator= ( Scene && other ) ->Scene &=default

defaultnoexcept

Here is the call graph for this function:

popState()

auto Scene::popState

(

)

->void

Here is the call graph for this function:

Here is the caller graph for this function:

pushState()

auto Scene::pushState

(

SceneState

newState

)

->void

Here is the call graph for this function:

Here is the caller graph for this function:

save()

auto Scene::save ( Stream & stream ) const->void

overridevirtual

Implementations will load the state of a GameObject to a th::Json object.

Unimplemented in GameObject

Parameters

stream

th::Json Object

Implements GameObject.

Here is the caller graph for this function:

updateParent()

auto Scene::updateParent ( ) ->void

private

Here is the call graph for this function:

Here is the caller graph for this function:

Friends And Related Symbol Documentation

from_json

auto from_json ( const json & j, Scene & p )->void

friend

to_json

auto to_json ( json & j, const Scene & p )->void

friend

Member Data Documentation

_alwaysRenders

bool Scene::_alwaysRenders = false

private

_mainScene

bool Scene::_mainScene = false

private

_name

std::string Scene::_name

private

_pausesOtherScenes

bool Scene::_pausesOtherScenes = false

private

_registered

bool Scene::_registered = false

private

parentScene

Scene* Scene::parentScene = nullptr

private

stack

std::stack<SceneState> Scene::stack

private

---

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

• /home/egrazil/sites/Brunot/The House/source/Component/Scene.h
• /home/egrazil/sites/Brunot/The House/source/Component/Scene.cpp