A GameObject is any object in the game. It contains a list of components that provides functionality to the GameObject. More...

#include <GameObject.h>

Inheritance diagram for spark::core::GameObject:

Public Member Functions
	GameObject (std::string name, GameObject *parent=nullptr)
	Instantiates a new GameObject.

	GameObject (const GameObject &other)=delete

	GameObject (GameObject &&other) noexcept=default

GameObject &	operator= (const GameObject &other)=delete

GameObject &	operator= (GameObject &&other) noexcept=default

const lib::Uuid &	uuid () const
	Gets the UUID of the GameObject.

const std::string &	name () const
	Gets the name of the GameObject.

components::Transform *	transform () const
	Gets the transform component of the GameObject.

void	addComponent (Component *component, bool managed=false)
	Adds a component to the GameObject.

template<typename T , typename... Args> requires std::is_base_of_v<Component, T>
void	addComponent (Args &&... args)
	Adds a component of type T to the GameObject.

void	removeComponent (Component *component)
	Removes a component from the GameObject.

template<typename T > requires std::is_base_of_v<Component, T>
void	removeComponent ()
	Removes a component of the given type from the GameObject.

template<typename T > requires std::is_base_of_v<Component, T>
bool	hasComponent () const
	Checks if the GameObject has a component of type T.

std::vector< Component * >	components () const
	Gets all the components for this GameObject.

template<typename T > requires std::is_base_of_v<Component, T>
std::vector< T * >	componentsInChildren () const
	Gets a list of components of type T in any direct child of the GameObject.

template<typename T > requires std::is_base_of_v<Component, T>
T *	component () const
	Gets a component of type T.

template<typename T > requires std::is_base_of_v<Component, T>
T *	componentInChildren () const
	Gets a component of type T in any direct child of the GameObject.

template<typename T > requires std::is_base_of_v<Component, T>
T *	componentInParent () const
	Gets a component of type T in any direct parent of the GameObject.

virtual void	onSpawn ()
	Method called when the GameObject is spawned in the scene.

virtual void	onUpdate (float dt)
	Method called on every frame.

virtual void	onDestroyed ()
	Method called when the GameObject is destroyed.

Public Member Functions inherited from spark::rtti::HasRtti
	HasRtti (const HasRtti &other)=default

	HasRtti (HasRtti &&other) noexcept=default

HasRtti &	operator= (const HasRtti &other)=default

HasRtti &	operator= (HasRtti &&other) noexcept=default

virtual RttiBase &	rttiInstance () const =0

Public Member Functions inherited from spark::core::details::AbstractGameObject< GameObject >
	AbstractGameObject (GameObject *parent=nullptr)

	AbstractGameObject (const AbstractGameObject &other)=delete

	AbstractGameObject (AbstractGameObject &&other) noexcept=default

AbstractGameObject &	operator= (const AbstractGameObject &other)=delete

AbstractGameObject &	operator= (AbstractGameObject &&other) noexcept=default

void	onSpawn ()
	Method calling the corresponding method on the implementation, the children and components.

void	onUpdate (float dt)
	Method calling the corresponding method on the implementation, the children and components.

void	onDestroyed ()
	Method calling the corresponding method on the implementation, the children and components.

Public Member Functions inherited from spark::patterns::Composite< GameObject, GameObjectDeleter >
	Composite (GameObject *parent)

	Composite (const Composite &other)=delete

	Composite (Composite &&other) noexcept=default

Composite &	operator= (const Composite &other)=delete

Composite &	operator= (Composite &&other) noexcept=default

std::vector< GameObject * >	children () const

GameObject *	parent ()

const GameObject *	parent () const

GameObject *	root ()

const GameObject *	root () const

Static Public Member Functions
template<typename T = GameObject, typename... Args> requires std::is_base_of_v<GameObject, T>
static T *	Instantiate (std::string name, GameObject *parent, Args &&... args)
	Instantiates a new GameObject.

static void	Destroy (GameObject *object, bool immediate=false)
	Destroys the current GameObject and all its children from the current scene.

static GameObject *	FindById (GameObject *root, const lib::Uuid &uuid)
	Finds a GameObject by its UUID.

static GameObject *	FindByName (GameObject *root, const std::string &name)
	Finds a GameObject by its name.

Public Attributes
bool	isShown = true
	A boolean indicating if the GameObject is shown in the scene.

Detailed Description

A GameObject is any object in the game. It contains a list of components that provides functionality to the GameObject.

GameObjects can be parented to other GameObjects. When a GameObject is destroyed, all its children are destroyed as well with their components.

Constructor & Destructor Documentation

◆ GameObject()

spark::core::GameObject::GameObject	(	std::string	name,
		GameObject *	parent = nullptr )

explicit

Instantiates a new GameObject.

Parameters

name	The name of the GameObject.
parent	The parent of the GameObject. If nullptr, the GameObject is parented to the root GameObject.

Use GameObject::Instantiate to instantiate a GameObject externally.

Member Function Documentation

◆ addComponent() [1/2]

template<typename T , typename... Args>
requires std::is_base_of_v<Component, T>

void spark::core::GameObject::addComponent ( Args &&... args )

Adds a component of type T to the GameObject.

Template Parameters

T	The type of component to add.
Args	The types of the arguments to pass to the constructor of the component.

Parameters

args	The arguments to pass to the constructor of the component.

◆ addComponent() [2/2]

void spark::core::GameObject::addComponent	(	Component *	component,
		bool	managed = false )

Adds a component to the GameObject.

Parameters

component	A pointer to the component to add.
managed	A boolean indicating if the component is managed by the GameObject. If true, the component will be destroyed when the GameObject is destroyed.

◆ component()

template<typename T >
requires std::is_base_of_v<Component, T>

T * spark::core::GameObject::component ( ) const

nodiscard

Gets a component of type T.

Template Parameters

T	The type of component to get.

Returns: A pointer to the component of type T, or nullptr if no component is not found.

◆ componentInChildren()

template<typename T >
requires std::is_base_of_v<Component, T>

T * spark::core::GameObject::componentInChildren ( ) const

nodiscard

Gets a component of type T in any direct child of the GameObject.

Template Parameters

T	The type of component to get.

Returns: A pointer to the component of type T, or nullptr if no component is not found.

◆ componentInParent()

template<typename T >
requires std::is_base_of_v<Component, T>

T * spark::core::GameObject::componentInParent ( ) const

nodiscard

Gets a component of type T in any direct parent of the GameObject.

Template Parameters

T	The type of component to get.

Returns: A pointer to the component of type T, or nullptr if no component is not found.

◆ components()

std::vector< Component * > spark::core::GameObject::components ( ) const

nodiscard

Gets all the components for this GameObject.

Returns: A vector of pointers to the components.

◆ componentsInChildren()

template<typename T >
requires std::is_base_of_v<Component, T>

std::vector< T * > spark::core::GameObject::componentsInChildren ( ) const

nodiscard

Gets a list of components of type T in any direct child of the GameObject.

Template Parameters

T	The type of component to get.

Returns: A vector of pointers to the component of type T, or an empty vector if no component was found.

◆ Destroy()

void spark::core::GameObject::Destroy	(	GameObject *	object,
		bool	immediate = false )

static

Destroys the current GameObject and all its children from the current scene.

Parameters

object	The object to destroy.
immediate	`true` to destroy the object immediately, `false` to destroy it at the end of the frame. Default is `false`.

◆ FindById()

GameObject * spark::core::GameObject::FindById	(	GameObject *	root,
		const lib::Uuid &	uuid )

static

Finds a GameObject by its UUID.

Parameters

root	The root GameObject to start the search from.
uuid	The UUID of the GameObject to find.

Returns: A pointer to the GameObject if found, nullptr otherwise.

◆ FindByName()

GameObject * spark::core::GameObject::FindByName	(	GameObject *	root,
		const std::string &	name )

static

Finds a GameObject by its name.

Parameters

root	The root GameObject to start the search from.
name	The name of the GameObject to find.

Returns: A pointer to the GameObject if found, nullptr otherwise.

◆ hasComponent()

template<typename T >
requires std::is_base_of_v<Component, T>

bool spark::core::GameObject::hasComponent ( ) const

nodiscard

Checks if the GameObject has a component of type T.

Template Parameters

T	The type of component to check.

Returns: A boolean indicating if the GameObject has a component of type T.

◆ Instantiate()

template<typename T , typename... Args>
requires std::is_base_of_v<GameObject, T>

T * spark::core::GameObject::Instantiate	(	std::string	name,
		GameObject *	parent,
		Args &&...	args )

static

Instantiates a new GameObject.

Template Parameters

T	The type of GameObject to instantiate

Parameters

name	The name of the GameObject
parent	The parent GameObject in the scene
args	The arguments to pass to the constructor of the GameObject

Returns: A pointer to the instantiated GameObject

This method should only be called during the game runtime, not in editor. Use GameObject::GameObject for this.

◆ name()

const std::string & spark::core::GameObject::name ( ) const

nodiscard

Gets the name of the GameObject.

Returns: A const reference to the name of this GameObject.

◆ onUpdate()

virtual void spark::core::GameObject::onUpdate ( float dt )

inlinevirtual

Method called on every frame.

Parameters

dt	The time in seconds since the last frame.

◆ removeComponent() [1/2]

template<typename T >
requires std::is_base_of_v<Component, T>

void spark::core::GameObject::removeComponent ( )

Removes a component of the given type from the GameObject.

Template Parameters

T	The type of component to remove.

◆ removeComponent() [2/2]

void spark::core::GameObject::removeComponent ( Component * component )

Removes a component from the GameObject.

Parameters

component A pointer to the component to remove.

◆ transform()

components::Transform * spark::core::GameObject::transform ( ) const

nodiscard

Gets the transform component of the GameObject.

Returns: A pointer to the transform component of the GameObject.

◆ uuid()

const lib::Uuid & spark::core::GameObject::uuid ( ) const

nodiscard

Gets the UUID of the GameObject.

Returns: A const reference to the UUID of this GameObject.

Public Member Functions

Static Public Member Functions

Public Attributes

Detailed Description

Constructor & Destructor Documentation

◆ GameObject()

Member Function Documentation

◆ addComponent() [1/2]

◆ addComponent() [2/2]

◆ component()

◆ componentInChildren()

◆ componentInParent()

◆ components()

◆ componentsInChildren()

◆ Destroy()

◆ FindById()

◆ FindByName()

◆ hasComponent()

◆ Instantiate()

◆ name()

◆ onUpdate()

◆ removeComponent() [1/2]

◆ removeComponent() [2/2]

◆ transform()

◆ uuid()