Relationship::Utils Namespace Reference

Functions
auto	SetChildOf (Engine::Entity child, Engine::Entity parent) -> void
auto	IsChildOf (Engine::Entity child, Engine::Entity parent) -> bool
auto	RemoveParent (Engine::Entity child) -> void
auto	GetParent (Engine::Entity child) -> std::optional< Engine::Entity >
template<typename TFunc>
auto	ForEachChild (Engine::Entity parent, TFunc func) -> void

Function Documentation

ForEachChild()

template<typename TFunc>

auto Relationship::Utils::ForEachChild	(	Engine::Entity	parent,
		TFunc	func ) -> void

GetParent()

auto Relationship::Utils::GetParent

(

Engine::Entity

child

)

-> std::optional< Engine::Entity >

Get the parent of an entity.

Parameters

child

child entity

Returns

the parent entity, or nullopt if the entity has no parent

IsChildOf()

auto Relationship::Utils::IsChildOf	(	Engine::Entity	child,
		Engine::Entity	parent ) -> bool

Check if an entity is a child of another entity.

Parameters

parent	parent entity
child	child entity

Returns

true if the child is a child of the parent

RemoveParent()

auto Relationship::Utils::RemoveParent

(

Engine::Entity

child

)

-> void

Remove the parent of an entity.

Parameters

child

child entity

SetChildOf()

auto Relationship::Utils::SetChildOf	(	Engine::Entity	child,
		Engine::Entity	parent ) -> void

Set the child of an entity to another entity.

Parameters

parent	parent entity
child	child entity