The text system handles TextComponents. More...

#include <TextSystem.h>

Inheritance diagram for Cogs::Core::TextSystem:

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

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

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

Public Member Functions inherited from Cogs::Core::ComponentSystem< TextComponent >
	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 TextComponent *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.

Private Attributes
MaterialHandle	textMaterial = MaterialHandle::NoHandle

SpriteMaterialKey	spriteMaterial = NoSpriteMaterial

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

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

Public Attributes inherited from Cogs::Core::ComponentSystem< TextComponent >
ComponentPool< TextComponent >	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.

Detailed Description

The text system handles TextComponents.

Definition at line 19 of file TextSystem.h.

Constructor & Destructor Documentation

◆ TextSystem()

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

inline

Definition at line 22 of file TextSystem.h.

Member Function Documentation

◆ initialize()

void Cogs::Core::TextSystem::initialize ( Context * context )

overridevirtual

Initialize the system.

Initialization is performed after all systems are created and a renderer initialized, but before the first time anything is rendered.

Parameters

context Pointer to the context the system lives in.

Reimplemented from Cogs::Core::ComponentSystemBase.

Definition at line 15 of file TextSystem.cpp.

References Cogs::Core::MaterialOptions::blendMode, Cogs::Core::ComponentSystemBase::context, Cogs::Core::MaterialOptions::depthWriteEnabled, Cogs::Core::ComponentSystemBase::initialize(), Cogs::Core::Material::options, and Cogs::Core::PremultipliedBlend.

◆ update()

void Cogs::Core::TextSystem::update ( Context * )

overridevirtual

Provided for custom update logic in derived systems.

Reimplemented from Cogs::Core::ComponentSystemBase.

Definition at line 33 of file TextSystem.cpp.

References Cogs::Core::Blend, Cogs::Core::Bottom, Cogs::Core::Center, Cogs::ComponentModel::Component::getComponentHandle(), Cogs::Core::Left, Cogs::Core::Pixels, Cogs::Core::PremultipliedBlend, Cogs::Core::Right, and Cogs::Core::World.

Member Data Documentation

◆ spriteMaterial

SpriteMaterialKey Cogs::Core::TextSystem::spriteMaterial = NoSpriteMaterial

private

Definition at line 29 of file TextSystem.h.

◆ textMaterial

MaterialHandle Cogs::Core::TextSystem::textMaterial = MaterialHandle::NoHandle

private

Definition at line 28 of file TextSystem.h.

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

Source/Systems/Core/TextSystem.h
Source/Systems/Core/TextSystem.cpp

Public Member Functions

Private Attributes

Additional Inherited Members