The BadgeSet system manages and displays BadgeSets as instanced quads. More...

#include <BadgeSetSystem.h>

Inheritance diagram for Cogs::Core::BadgeSetSystem:

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

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

virtual void	generateMesh (Context *context)

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

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

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

BadgeSetData &	getData (const BadgeSetComponent *component)

const BadgeSetData &	getData (const BadgeSetComponent *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.

Private Types
using	base_type = Cogs::Core::ComponentSystemWithDataPool< BadgeSetComponent, BadgeSetData >

Private Attributes
MeshHandle	quadMesh

MaterialHandle	instMaterial

VertexFormatHandle	vertexFormatHandle

VariableKey	viewPlaneLocalKey = NoProperty

VariableKey	viewXLocalKey = NoProperty

VariableKey	viewYLocalKey = NoProperty

VariableKey	pointSizeKey = NoProperty

VariableKey	anchorPointOffsetKey = NoProperty

VariableKey	nearCutoffKey = NoProperty

VariableKey	farCutoffKey = NoProperty

VariableKey	nearVisibilityLimitKey = NoProperty

VariableKey	farVisibilityLimitKey = NoProperty

VariableKey	outputAlphaValueKey = NoProperty

VariableKey	iconTextureKey = NoProperty

VariableKey	styleTextureKey = NoProperty

VariableKey	digitTextureKey = NoProperty

std::unique_ptr< BadgeSetPicker >	picker

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.

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.

Detailed Description

The BadgeSet system manages and displays BadgeSets as instanced quads.

Definition at line 29 of file BadgeSetSystem.h.

Member Typedef Documentation

◆ base_type

using Cogs::Core::BadgeSetSystem::base_type = Cogs::Core::ComponentSystemWithDataPool<BadgeSetComponent, BadgeSetData>

private

Definition at line 30 of file BadgeSetSystem.h.

Constructor & Destructor Documentation

◆ BadgeSetSystem()

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

inline

Definition at line 32 of file BadgeSetSystem.h.

◆ ~BadgeSetSystem()

Cogs::Core::BadgeSetSystem::~BadgeSetSystem ( )

Definition at line 26 of file BadgeSetSystem.cpp.

Member Function Documentation

◆ cleanup()

void Cogs::Core::BadgeSetSystem::cleanup ( Context * )

overridevirtual

Provided for custom cleanup logic in derived systems.

Cleanup is performed during shutdown of the system, and all entities and related data should have been deleted.

All system services are available during the execution of cleanup().

Reimplemented from Cogs::Core::ComponentSystemBase.

Definition at line 243 of file BadgeSetSystem.cpp.

◆ generateMesh()

void Cogs::Core::BadgeSetSystem::generateMesh ( Context * context )

virtual

Definition at line 35 of file BadgeSetSystem.cpp.

◆ initialize()

void Cogs::Core::BadgeSetSystem::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 30 of file BadgeSetSystem.cpp.

References Cogs::Core::ComponentSystemBase::initialize().

◆ update()

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

overridevirtual

Provided for custom update logic in derived systems.

Reimplemented from Cogs::Core::ComponentSystemBase.

Definition at line 91 of file BadgeSetSystem.cpp.

References Cogs::SamplerState::Clamp, Cogs::Core::Mesh::clear(), Cogs::ComponentModel::Component::getComponent(), Cogs::Core::HandleIsValid(), Cogs::Core::BadgeSetComponent::icons, Cogs::Core::InstancedMeshRenderComponent::instanceCount, Cogs::Core::InstancedMeshRenderComponent::instanceMesh, Cogs::Core::InstancedMeshRenderComponent::material, Cogs::Core::MeshComponent::meshHandle, Cogs::Core::ParentPickable, Cogs::Core::BadgeSetComponent::positions, Cogs::Core::SelfPickable, Cogs::Core::SelfVisibility, Cogs::ComponentModel::Component::setChanged(), Cogs::Core::RenderComponent::setRenderFlag(), Cogs::Core::InstancedMeshRenderComponent::startIndex, Cogs::Core::InstancedMeshRenderComponent::startInstance, Cogs::Core::BadgeSetComponent::styles, Cogs::Core::RenderComponent::unsetRenderFlag(), and Cogs::Core::SceneComponent::visible.

Member Data Documentation

◆ anchorPointOffsetKey

VariableKey Cogs::Core::BadgeSetSystem::anchorPointOffsetKey = NoProperty

private

Definition at line 50 of file BadgeSetSystem.h.

◆ digitTextureKey

VariableKey Cogs::Core::BadgeSetSystem::digitTextureKey = NoProperty

private

Definition at line 58 of file BadgeSetSystem.h.

◆ farCutoffKey

VariableKey Cogs::Core::BadgeSetSystem::farCutoffKey = NoProperty

private

Definition at line 52 of file BadgeSetSystem.h.

◆ farVisibilityLimitKey

VariableKey Cogs::Core::BadgeSetSystem::farVisibilityLimitKey = NoProperty

private

Definition at line 54 of file BadgeSetSystem.h.

◆ iconTextureKey

VariableKey Cogs::Core::BadgeSetSystem::iconTextureKey = NoProperty

private

Definition at line 56 of file BadgeSetSystem.h.

◆ instMaterial

MaterialHandle Cogs::Core::BadgeSetSystem::instMaterial

private

Definition at line 42 of file BadgeSetSystem.h.

◆ nearCutoffKey

VariableKey Cogs::Core::BadgeSetSystem::nearCutoffKey = NoProperty

private

Definition at line 51 of file BadgeSetSystem.h.

◆ nearVisibilityLimitKey

VariableKey Cogs::Core::BadgeSetSystem::nearVisibilityLimitKey = NoProperty

private

Definition at line 53 of file BadgeSetSystem.h.

◆ outputAlphaValueKey

VariableKey Cogs::Core::BadgeSetSystem::outputAlphaValueKey = NoProperty

private

Definition at line 55 of file BadgeSetSystem.h.

◆ picker

std::unique_ptr<BadgeSetPicker> Cogs::Core::BadgeSetSystem::picker

private

Definition at line 60 of file BadgeSetSystem.h.

◆ pointSizeKey

VariableKey Cogs::Core::BadgeSetSystem::pointSizeKey = NoProperty

private

Definition at line 49 of file BadgeSetSystem.h.

◆ quadMesh

MeshHandle Cogs::Core::BadgeSetSystem::quadMesh

private

Definition at line 41 of file BadgeSetSystem.h.

◆ styleTextureKey

VariableKey Cogs::Core::BadgeSetSystem::styleTextureKey = NoProperty

private

Definition at line 57 of file BadgeSetSystem.h.

◆ vertexFormatHandle

VertexFormatHandle Cogs::Core::BadgeSetSystem::vertexFormatHandle

private

Definition at line 44 of file BadgeSetSystem.h.

◆ viewPlaneLocalKey

VariableKey Cogs::Core::BadgeSetSystem::viewPlaneLocalKey = NoProperty

private

Definition at line 46 of file BadgeSetSystem.h.

◆ viewXLocalKey

VariableKey Cogs::Core::BadgeSetSystem::viewXLocalKey = NoProperty

private

Definition at line 47 of file BadgeSetSystem.h.

◆ viewYLocalKey

VariableKey Cogs::Core::BadgeSetSystem::viewYLocalKey = NoProperty

private

Definition at line 48 of file BadgeSetSystem.h.

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

Extensions/BadgeSet/Source/BadgeSetSystem.h
Extensions/BadgeSet/Source/BadgeSetSystem.cpp

Public Member Functions

Private Types

Private Attributes

Additional Inherited Members

Detailed Description

Member Typedef Documentation

◆ base_type

Constructor & Destructor Documentation

◆ BadgeSetSystem()

◆ ~BadgeSetSystem()

Member Function Documentation

◆ cleanup()

◆ generateMesh()

◆ initialize()

◆ update()

Member Data Documentation

◆ anchorPointOffsetKey

◆ digitTextureKey

◆ farCutoffKey

◆ farVisibilityLimitKey

◆ iconTextureKey

◆ instMaterial

◆ nearCutoffKey

◆ nearVisibilityLimitKey

◆ outputAlphaValueKey

◆ picker

◆ pointSizeKey

◆ quadMesh

◆ styleTextureKey

◆ vertexFormatHandle

◆ viewPlaneLocalKey

◆ viewXLocalKey

◆ viewYLocalKey