ComponentSystem< T, DestroyComponents >

Base system class with components. More...

#include <ecsm.hpp>

Public Types
typedef T	ComponentType
using	ComponentPool = LinearPool<T, DestroyComponents>

Public Member Functions
const ComponentPool &	getComponents () const noexcept
	Returns system component pool.
std::string_view	getComponentName () const override
	Returns specific component name of the system.
std::type_index	getComponentType () const override
	Returns specific component typeid() of the system.
View< Component >	getComponent (ID< Component > instance) override
	Returns specific component View.
void	disposeComponents () override
	Actually destroys system components.

Protected Member Functions
ID< Component >	createComponent (ID< Entity > entity) override
	Creates a new system component instance for the entity.
void	destroyComponent (ID< Component > instance) override
	Destroys system component instance.
void	resetComponent (View< Component > component, bool full) override
	Resets system component data.
void	copyComponent (View< Component > source, View< Component > destination) override
	Copies system component data from the source to destination.

Protected Attributes
ComponentPool	components

Detailed Description

template<class T = Component, bool DestroyComponents = true>
class ecsm::ComponentSystem< T, DestroyComponents >

Base system class with components.

See the System.

Template Parameters

T	type of the system component
DestroyComponents	system should call destroy() function of the components

Member Typedef Documentation

ComponentType

template<class T = Component, bool DestroyComponents = true>

typedef T ComponentType

Type of the system component.

ComponentPool

template<class T = Component, bool DestroyComponents = true>

using ComponentPool = LinearPool<T, DestroyComponents>

System component pool type.

Member Function Documentation

createComponent()

template<class T = Component, bool DestroyComponents = true>

ID< Component > createComponent ( ID< Entity > entity )

inlineoverrideprotectedvirtual

Creates a new system component instance for the entity.

You should use Manager to add components to the entity.

Reimplemented from System.

destroyComponent()

template<class T = Component, bool DestroyComponents = true>

void destroyComponent ( ID< Component > instance )

inlineoverrideprotectedvirtual

Destroys system component instance.

You should use Manager to remove components from the entity.

Reimplemented from System.

resetComponent()

template<class T = Component, bool DestroyComponents = true>

void resetComponent ( View< Component > component, bool full )

inlineoverrideprotectedvirtual

Resets system component data.

You should use Manager to remove components from the entity.

Reimplemented from System.

copyComponent()

template<class T = Component, bool DestroyComponents = true>

void copyComponent ( View< Component > source, View< Component > destination )

inlineoverrideprotectedvirtual

Copies system component data from the source to destination.

You should use Manager to copy component data of entities.

Reimplemented from System.

getComponentName()

template<class T = Component, bool DestroyComponents = true>

std::string_view getComponentName ( ) const

inlineoverridevirtual

Returns specific component name of the system.

Reimplemented from System.

Reimplemented in DoNotDestroySystem, and DoNotDuplicateSystem.

getComponentType()

template<class T = Component, bool DestroyComponents = true>

std::type_index getComponentType ( ) const

inlineoverridevirtual

Returns specific component typeid() of the system.

Note

Override it to define a custom component of the system.

Reimplemented from System.

getComponent()

template<class T = Component, bool DestroyComponents = true>

View< Component > getComponent ( ID< Component > instance )

inlineoverridevirtual

Returns specific component View.

Parameters

instance

target system component instance

Reimplemented from System.

disposeComponents()

template<class T = Component, bool DestroyComponents = true>

void disposeComponents ( )

inlineoverridevirtual

Actually destroys system components.

Components are not destroyed immediately, only after the dispose call.

Reimplemented from System.

Member Data Documentation

components

template<class T = Component, bool DestroyComponents = true>

ComponentPool components

protected

System component pool.