#include <iEntity.h>

Public Member Functions
const iEntityID &	getID () const

iEntityIDPath	getIDPath () const

void	setName (const iaString &name)

const iaString &	getName () const

void	setParent (const iEntityID &parentID)

void	setParent (iEntityPtr parent)

void	removeParent ()

iEntityPtr	getParent () const

bool	hasParent () const

bool	isRoot () const

const std::vector< iEntityPtr > &	getChildren () const

const std::vector< iEntityPtr > &	getInactiveChildren () const

void	setActive (bool active)

void	setActiveExclusive (bool active)

bool	isActive () const

iEntityScenePtr	getScene () const

iEntityComponentMask	getComponentMask () const

template<typename T >
T *	addComponent (T *component)

void	addComponent (const std::type_index &typeID, iEntityComponentPtr component)

template<typename T >
T *	getComponent () const

iEntityComponentPtr	getComponent (const std::type_index &typeID) const

const std::vector< std::type_index >	getComponentTypes ()

template<typename T >
void	destroyComponent ()

template<typename T >
void	reloadComponent ()

void	addBehaviour (const iBehaviourDelegate &behaviour, const std::any &userData=std::any(), const iaString &name="", uint8 priority=100)

void	removeBehaviour (const iBehaviourDelegate &behaviour)

void	clearComponents ()

bool	isHierarchyDirty () const

void	setDirtyHierarchy ()

void	resetDirtyHierarchy ()

template<typename T >
T *	addComponent (T *component)

template<typename T >
T *	getComponent () const

template<typename T >
void	destroyComponent ()

template<typename T >
void	reloadComponent ()

Static Public Member Functions
static iEntityComponentMask	calcComponentMask (const std::vector< std::type_index > &types)

Friends
class	iEntityScene

class	iEntityTransformTraverser

class	iTransformComponent

Detailed Description

entity definition

Igor uses the terms entity, component and system but it is not a classic entity component system or ECS. An entity is a hierarchical element in the scene with parents and children. It behaves more like a game object.

Member Function Documentation

◆ addBehaviour()

void igor::iEntity::addBehaviour	(	const iBehaviourDelegate &	behaviour,
		const std::any &	userData = `std::any()`,
		const iaString &	name = `""`,
		uint8	priority = `100`
	)

adds behaviour to entity

Parameters

behaviour	the behaviour to be added
userData	user data added to behaviour
name	the name of the behaviour
priority	execution priority (low = 0, default = 100, high = ...)

◆ addComponent() [1/3]

void igor::iEntity::addComponent	(	const std::type_index &	typeID,
		iEntityComponentPtr	component
	)

adds component with given type id

entity takes ownership of component

Parameters

typeID	the given type id
component	the component to add

◆ addComponent() [2/3]

template<typename T >

T * igor::iEntity::addComponent ( T * component )

add component

entity takes ownership of component

Parameters

component the component to add

Returns: the new component

◆ addComponent() [3/3]

template<typename T >

T * igor::iEntity::addComponent ( T * component )

◆ calcComponentMask()

iEntityComponentMask igor::iEntity::calcComponentMask ( const std::vector< std::type_index > & types )

static

calculate type hash from component types

Parameters

types the types to use for calculation

◆ clearComponents()

void igor::iEntity::clearComponents ( )

removes all components

◆ destroyComponent() [1/2]

template<typename T >

void igor::iEntity::destroyComponent ( )

destroys given component by type

◆ destroyComponent() [2/2]

template<typename T >

void igor::iEntity::destroyComponent ( )

◆ getChildren()

const std::vector< iEntityPtr > & igor::iEntity::getChildren ( ) const

Returns: active children

◆ getComponent() [1/3]

template<typename T >

T * igor::iEntity::getComponent ( ) const

Returns: component for given type

◆ getComponent() [2/3]

template<typename T >

T * igor::iEntity::getComponent ( ) const

◆ getComponent() [3/3]

iEntityComponentPtr igor::iEntity::getComponent ( const std::type_index & typeID ) const

Returns: component for given type

Parameters

typeID the given type

◆ getComponentMask()

iEntityComponentMask igor::iEntity::getComponentMask ( ) const

Returns: type hash of this entity

◆ getComponentTypes()

const std::vector< std::type_index > igor::iEntity::getComponentTypes ( )

Returns: component types

◆ getID()

const iEntityID & igor::iEntity::getID ( ) const

Returns: entity id

◆ getIDPath()

iEntityIDPath igor::iEntity::getIDPath ( ) const

Returns: entity id path

This is slow. Use with care

◆ getInactiveChildren()

const std::vector< iEntityPtr > & igor::iEntity::getInactiveChildren ( ) const

Returns: inactive children

◆ getName()

const iaString & igor::iEntity::getName ( ) const

Returns: name of entity

◆ getParent()

iEntityPtr igor::iEntity::getParent ( ) const

Returns: parent

◆ getScene()

iEntityScenePtr igor::iEntity::getScene ( ) const

Returns: scene this entity belongs to

◆ hasParent()

bool igor::iEntity::hasParent ( ) const

Returns: true if entity has parent

◆ isActive()

bool igor::iEntity::isActive ( ) const

Returns: true if entity is active

◆ isHierarchyDirty()

bool igor::iEntity::isHierarchyDirty ( ) const

Returns: true if hierarchy (including transforms) is dirty

◆ isRoot()

bool igor::iEntity::isRoot ( ) const

Returns: true if this is the root entity

used for special case handling

◆ reloadComponent() [1/2]

template<typename T >

void igor::iEntity::reloadComponent ( )

destroys given component by type

◆ reloadComponent() [2/2]

template<typename T >

void igor::iEntity::reloadComponent ( )

◆ removeBehaviour()

void igor::iEntity::removeBehaviour ( const iBehaviourDelegate & behaviour )

removes behaviour from entity

Parameters

behaviour the behaviour to be removed

◆ removeParent()

void igor::iEntity::removeParent ( )

removes parent connection

◆ resetDirtyHierarchy()

void igor::iEntity::resetDirtyHierarchy ( )

resets dirty flag on this entity

◆ setActive()

void igor::iEntity::setActive ( bool active )

sets wether and entity is active or not

Parameters

active if true entity will be active

◆ setActiveExclusive()

void igor::iEntity::setActiveExclusive ( bool active )

sets wether and entity is active or not while at the same time make sure all siblings will be set to the opposite

Parameters

active if true entity will be active

◆ setDirtyHierarchy()

void igor::iEntity::setDirtyHierarchy ( )

sets dirty flag up and down the hierarchy

◆ setName()

void igor::iEntity::setName ( const iaString & name )

sets name of entity

Parameters

name	the name to set

◆ setParent() [1/2]

void igor::iEntity::setParent ( const iEntityID & parentID )

sets parent of this entity by id

Parameters

parentID the given parent id

◆ setParent() [2/2]

void igor::iEntity::setParent ( iEntityPtr parent )

sets parent of this entity

Parameters

parent the given parent

Friends And Related Function Documentation

◆ iEntityScene

friend class iEntityScene

friend

◆ iEntityTransformTraverser

friend class iEntityTransformTraverser

friend

◆ iTransformComponent

friend class iTransformComponent

friend

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

/home/martin/dev/Igor/src/igor/igor/entities/iEntity.h
/home/martin/dev/Igor/src/igor/igor/entities/iEntity.cpp
/home/martin/dev/Igor/src/igor/igor/entities/iEntity.inl

Public Member Functions

Static Public Member Functions

Friends

Detailed Description

Member Function Documentation

◆ addBehaviour()

◆ addComponent() [1/3]

◆ addComponent() [2/3]

◆ addComponent() [3/3]

◆ calcComponentMask()

◆ clearComponents()

◆ destroyComponent() [1/2]

◆ destroyComponent() [2/2]

◆ getChildren()

◆ getComponent() [1/3]

◆ getComponent() [2/3]

◆ getComponent() [3/3]

◆ getComponentMask()

◆ getComponentTypes()

◆ getID()

◆ getIDPath()

◆ getInactiveChildren()

◆ getName()

◆ getParent()

◆ getScene()

◆ hasParent()

◆ isActive()

◆ isHierarchyDirty()

◆ isRoot()

◆ reloadComponent() [1/2]

◆ reloadComponent() [2/2]

◆ removeBehaviour()

◆ removeParent()

◆ resetDirtyHierarchy()

◆ setActive()

◆ setActiveExclusive()

◆ setDirtyHierarchy()

◆ setName()

◆ setParent() [1/2]

◆ setParent() [2/2]

Friends And Related Function Documentation

◆ iEntityScene

◆ iEntityTransformTraverser

◆ iTransformComponent