Updates material components. More...

#include <MaterialSystem.h>

Inheritance diagram for Cogs::Core::MaterialSystem:

Public Member Functions
	MaterialSystem (Memory::Allocator *allocator, SizeType capacity)

void	update (Context *context) override
	Updates the material system.

void	cleanup (Context *context) override
	Cleanup the material system, releasing any shared material instances held.

void	removeUnusedSharedInstances ()
	Removes any shared material instances no longer in use.

Public Member Functions inherited from Cogs::Core::ComponentSystemWithDataPool< MaterialComponent, MaterialData >
	ComponentSystemWithDataPool (Memory::Allocator *allocator, SizeType size=1024)

MaterialData &	getData (const MaterialComponent *component)

const MaterialData &	getData (const MaterialComponent *component) const

Public Member Functions inherited from Cogs::Core::ComponentSystemWithDataPools< ComponentType, DataTypes >
	ComponentSystemWithDataPools (Memory::Allocator *allocator, SizeType size=1024, MemBlockType componentMemType=MemBlockType::Component, MemBlockType dataMemType=MemBlockType::ComponentData)

ComponentHandle	createComponent () override

void	destroyComponent (ComponentHandle component) override

template<typename T >
T &	getData (const ComponentType *component)
	Get the data stored for the given component from the data pool storing objects of the specified template type.

template<typename T >
const T &	getData (const ComponentType *component) const
	Get the const data stored for the given component from the data pool storing objects of the specified template type.

Public Member Functions inherited from Cogs::Core::ComponentSystem< ComponentType >
	ComponentSystem (Memory::Allocator *allocator, SizeType size=16384, MemBlockType componentMemType=MemBlockType::Component)

void	instrumentedPreUpdate () override
	Provided for tagged engine instrumentation.

void	instrumentedUpdate () override
	Provided for tagged engine instrumentation.

void	instrumentedPostUpdate () override
	Provided for tagged engine instrumentation.

ComponentHandle	createComponent () override
	Create a new component instance.

void	destroyComponent (ComponentHandle component) override
	Destroy the component held by the given handle.

SizeType	getComponentIndex (const Component *component) const
	Get the index of the given component in the component pool.

size_t	size ()
	Returns the number of active components.

void	clearCarryFlags ()
	Clear carry flags of all active components.

void	resetFlags ()
	Reset the flags of all active components.

void	prepareUpdate (Context *) override

void	postUpdate (Context *) override

ComponentHandle	getHandle (const ComponentType *component)
	Get a handle to the given Component instance.

virtual void	addEntitiesWithComponent (std::vector< EntityId > &entities, Reflection::TypeId componentTypeId) override
	Return all entities with a given.

Public Member Functions inherited from Cogs::Core::ComponentSystemBase
virtual	~ComponentSystemBase ()
	Provided for destruction via pointer to base.

	ComponentSystemBase (Reflection::TypeId componentType)
	Constructs a ComponentSystemBase to manage components of the given componentType.

virtual void	initialize (Context *context)
	Initialize the system.

void	preUpdate ()
	Run the pre-update method of the system.

void	update ()
	Updates the system state to that of the current frame.

void	postUpdate ()
	Perform post update logic in the system.

virtual void	preUpdate (Context *)
	Provided for custom pre update logic in derived systems.

virtual void	prepareUpdate (Context *)
	Provided for custom update preparation logic in derived systems.

virtual void	update (Context *)
	Provided for custom update logic in derived systems.

virtual void	postUpdate (Context *)
	Provided for custom post update logic in derived systems.

virtual void	instrumentedPreUpdate ()
	Provided for tagged engine instrumentation.

virtual void	instrumentedUpdate ()
	Provided for tagged engine instrumentation.

virtual void	instrumentedPostUpdate ()
	Provided for tagged engine instrumentation.

virtual void	addEntitiesWithComponent (std::vector< EntityId > &, Reflection::TypeId)
	Return all entities with a given.

virtual void	cleanup (Context *)
	Provided for custom cleanup logic in derived systems.

virtual ComponentHandle	createComponent ()
	Create a new component instance.

virtual void	destroyComponent (ComponentHandle)
	Destroy the component held by the given handle.

Reflection::TypeId	getComponentType () const
	Get the reflected type of the components managed by this system.

Public Attributes
std::unordered_map< size_t, MaterialInstanceHandle >	instances
	Holds shared material instances used by one or more MaterialComponent instances.

Public Attributes inherited from Cogs::Core::ComponentSystem< ComponentType >
ComponentPool< ComponentType >	pool
	Pool of components managed by the system.

Public Attributes inherited from Cogs::Core::ComponentSystemBase
Reflection::TypeId	componentType
	The type of components managed by this instance.

Context *	context = nullptr
	Pointer to the Context instance the system lives in.

Additional Inherited Members
Public Types inherited from Cogs::Core::ComponentSystem< ComponentType >
typedef ComponentType	component_type

Static Public Member Functions inherited from Cogs::Core::ComponentSystem< ComponentType >
static Reflection::TypeId	getTypeId ()
	Get the type id of the component type used by the system.

Detailed Description

Updates material components.

The material system creates actual MaterialInstance resources based on the contents of the material components. A set of shared material instances is kept to make it possible to share underlying resources between MaterialComponents with the same values.

The material instances created are applied to the corresponding *RenderComponent(s) found on the same entity.

Definition at line 35 of file MaterialSystem.h.

Constructor & Destructor Documentation

◆ MaterialSystem()

Cogs::Core::MaterialSystem::MaterialSystem	(	Memory::Allocator *	allocator,
		SizeType	capacity
	)

inline

Definition at line 38 of file MaterialSystem.h.

Member Function Documentation

◆ cleanup()

void Cogs::Core::MaterialSystem::cleanup ( Context * context )

overridevirtual

Cleanup the material system, releasing any shared material instances held.

Reimplemented from Cogs::Core::ComponentSystemBase.

Definition at line 308 of file MaterialSystem.cpp.

◆ removeUnusedSharedInstances()

void Cogs::Core::MaterialSystem::removeUnusedSharedInstances ( )

Removes any shared material instances no longer in use.

Definition at line 290 of file MaterialSystem.cpp.

Referenced by update().

◆ update()

void Cogs::Core::MaterialSystem::update ( Context * context )

overridevirtual

Member Data Documentation

◆ instances

std::unordered_map<size_t, MaterialInstanceHandle> Cogs::Core::MaterialSystem::instances

Holds shared material instances used by one or more MaterialComponent instances.

Definition at line 50 of file MaterialSystem.h.