Component for showing lots of badges. More...

#include <BadgeSetComponent.h>

Inheritance diagram for Cogs::Core::BadgeSetComponent:

Static Public Member Functions
static void	registerType ()
	Register the type in the type system.

Static Public Member Functions inherited from Cogs::ComponentModel::Component
static COGSFOUNDATION_API void	registerType ()
	Register the Component type in the global type database.

static COGSFOUNDATION_API Reflection::TypeId	getComponentTypeId (const StringView &name)
	Get the type id of the component type with the given name.

Public Attributes
std::vector< glm::vec3 >	positions
	Badge positions.

std::vector< int >	icons
	Icon (index) to be rendered on top of style.

std::vector< int >	numbers
	The number to display on the badge.

std::vector< int >	styles
	Style (index) used for background behind icon.

TextureHandle	iconTexture
	Texture array (ktx2) containing icons.

TextureHandle	styleTexture
	Texture array (ktx2) containing background styling.

TextureHandle	digitTexture
	Texture array (ktx2) containing all valid numeric icons.

float	badgeSize = 70.0f
	Size of the badge.

glm::vec2	anchorPoint = glm::vec2{ 0.5, 0.5 }
	The location where the badge is anchored.

glm::vec2	boundingBoxLower = glm::vec2{ 0, 0 }
	Position of the lower corner of the bounding box.

glm::vec2	boundingBoxUpper = glm::vec2{ 1, 1 }
	Position of the upper corner of the bounding box.

float	nearScalingCutoff = 200.0f
	Determines the near limit where the badge stops scaling freely.

float	farScalingCutoff = 5000.0f
	Determines the far limit where the badge stops scaling freely.

float	nearVisibilityLimit = 0.f
	Don't display badges closer than this distance from the camera.

float	farVisibilityLimit = std::numeric_limits<float>::max()
	Don't display badges further than this distance from the camera.

float	outputAlphaValue = 1.0f
	Output alpha value for the fragments not discarded by the shader.

Additional Inherited Members
Public Member Functions inherited from Cogs::ComponentModel::Component
class Entity *	getContainer () const
	Get the container currently owning this component instance.

void	setContainer (class Entity *container)
	Set the container owning this component instance.

template<typename ComponentType >
ComponentType *	getComponent () const

COGSFOUNDATION_API Component *	getComponent (const Reflection::Name &name) const

COGSFOUNDATION_API Component *	getComponent (const Reflection::TypeId &id) const

template<typename ComponentType >
ComponentHandle	getComponentHandle () const

COGSFOUNDATION_API ComponentHandle	getComponentHandle (const Reflection::Name &name) const

COGSFOUNDATION_API ComponentHandle	getComponentHandle (const Reflection::TypeId &id) const

void	setActive ()
	Sets the component to the ComponentFlags::Active state.

bool	isActive () const
	Gets if the component is currently set to the ComponentFlags::Active state.

void	setChanged ()
	Sets the component to the ComponentFlags::Changed state with carry.

void	setChangedTransient ()
	Sets the component to the ComponentFlags::Changed state without carry.

void	setFieldChanged (const Reflection::FieldId fieldId)
	Sets the component to the ComponentFlags::Changed state without carry.

template<typename ClassType , typename FieldType >
void	setFieldChanged (FieldType ClassType::*field)
	Sets a flag indicating that the given field has changed.

void	setFieldChangedTransient (const Reflection::FieldId fieldId)
	Sets the component to the ComponentFlags::Changed state without carry.

bool	hasChanged () const

bool	hasAnyfieldChanged () const
	Gets if any fields have been changed.

bool	hasFieldChanged (const Reflection::FieldId fieldId) const
	Gets if the field with the given id on this component instance has changed.

template<typename ClassType , typename FieldType >
bool	hasFieldChanged (FieldType ClassType::*field) const
	Gets if the given field has changed.

void	resetCarryChanged ()
	Reset the CarryChanged flag. Called at start of redraw. See ComponentFlags::CarryChanged.

void	resetChanged ()
	Resets the changed state of the component, respecting any carry state set.

template<typename ClassType , typename FieldType >
Reflection::FieldId	getFieldId (FieldType ClassType::*field) const
	Gets field ID of the given field.

void	resetFieldsChanged ()
	Resets the state of all changed field flags.

void	resetFieldChanged (const Reflection::FieldId fieldId)
	Resets the changed state of the given fieldId.

template<typename ClassType , typename FieldType >
void	resetFieldChanged (FieldType ClassType::*field)
	Resets the changed state of the given field.

constexpr void	setFlags (const uint32_t flags)
	Override all flags of the Component, setting the given flags.

constexpr void	setFlag (const uint32_t flag)
	Set the given flags. Does not override the currently set flags.

constexpr void	unsetFlag (const uint32_t flag)
	Unset the given flag. Does not remove the status of other than the given flags.

constexpr bool	isSet (const uint32_t flag) const
	Checks if the given flag is set. Requires exact bit match if test of several bits.

constexpr void	setTypeId (const Reflection::TypeId typeId)
	Set the Reflection::TypeId of the component.

constexpr Reflection::TypeId	getTypeId () const
	Get the Reflection::TypeId of the component.

COGSFOUNDATION_API const Reflection::Type &	getType () const
	Get the full Reflection::Type of the component.

constexpr void	setIndex (const ComponentIndex index)
	Set the components pool index. For internal use only.

constexpr ComponentIndex	getIndex () const
	Get the components pool index. For internal use only.

constexpr void	setGeneration (uint16_t generation)
	Sets the component generation.

constexpr uint16_t	getGeneration () const
	Gets the component generation.

size_t	hash (size_t hashValue=Cogs::hash()) const
	Calculates a hash of this component's members.

Detailed Description

Component for showing lots of badges.

Definition at line 14 of file BadgeSetComponent.h.

Member Function Documentation

◆ registerType()

void Cogs::Core::BadgeSetComponent::registerType ( )

static

Register the type in the type system.

Definition at line 6 of file BadgeSetComponent.cpp.

References anchorPoint, badgeSize, boundingBoxLower, boundingBoxUpper, digitTexture, farScalingCutoff, farVisibilityLimit, icons, iconTexture, nearScalingCutoff, nearVisibilityLimit, numbers, outputAlphaValue, positions, styles, and styleTexture.

Referenced by Cogs::Core::BadgeSetExtension::initializeStatic().

Member Data Documentation

◆ anchorPoint

glm::vec2 Cogs::Core::BadgeSetComponent::anchorPoint = glm::vec2{ 0.5, 0.5 }

The location where the badge is anchored.

[0,0] is bottom left and [1,1] is top right. [0.5, 0.5] is middle, which is default.

Definition at line 26 of file BadgeSetComponent.h.

Referenced by registerType().

◆ badgeSize

float Cogs::Core::BadgeSetComponent::badgeSize = 70.0f

Size of the badge.

Definition at line 25 of file BadgeSetComponent.h.

Referenced by registerType().

◆ boundingBoxLower

glm::vec2 Cogs::Core::BadgeSetComponent::boundingBoxLower = glm::vec2{ 0, 0 }

Position of the lower corner of the bounding box.

It is set as [0,0] as bottom left corner by default.

Definition at line 27 of file BadgeSetComponent.h.

Referenced by registerType().

◆ boundingBoxUpper

glm::vec2 Cogs::Core::BadgeSetComponent::boundingBoxUpper = glm::vec2{ 1, 1 }

Position of the upper corner of the bounding box.

It is set as [1,1] as top right corner by default.

Definition at line 28 of file BadgeSetComponent.h.

Referenced by registerType().

◆ digitTexture

TextureHandle Cogs::Core::BadgeSetComponent::digitTexture

Texture array (ktx2) containing all valid numeric icons.

Index is retrieved from InstanceColor's x value.

Definition at line 24 of file BadgeSetComponent.h.

Referenced by registerType().

◆ farScalingCutoff

float Cogs::Core::BadgeSetComponent::farScalingCutoff = 5000.0f

Determines the far limit where the badge stops scaling freely.

Definition at line 30 of file BadgeSetComponent.h.

Referenced by registerType().

◆ farVisibilityLimit

float Cogs::Core::BadgeSetComponent::farVisibilityLimit = std::numeric_limits<float>::max()

Don't display badges further than this distance from the camera.

Definition at line 32 of file BadgeSetComponent.h.

Referenced by registerType().

◆ icons

std::vector<int> Cogs::Core::BadgeSetComponent::icons

Icon (index) to be rendered on top of style.

Definition at line 19 of file BadgeSetComponent.h.

Referenced by registerType(), and Cogs::Core::BadgeSetSystem::update().

◆ iconTexture

TextureHandle Cogs::Core::BadgeSetComponent::iconTexture

Texture array (ktx2) containing icons.

Index is retrieved from InstanceColor's w value.

Definition at line 22 of file BadgeSetComponent.h.

Referenced by registerType().

◆ nearScalingCutoff

float Cogs::Core::BadgeSetComponent::nearScalingCutoff = 200.0f

Determines the near limit where the badge stops scaling freely.

Definition at line 29 of file BadgeSetComponent.h.

Referenced by registerType().

◆ nearVisibilityLimit

float Cogs::Core::BadgeSetComponent::nearVisibilityLimit = 0.f

Don't display badges closer than this distance from the camera.

Definition at line 31 of file BadgeSetComponent.h.

Referenced by registerType().

◆ numbers

std::vector<int> Cogs::Core::BadgeSetComponent::numbers

The number to display on the badge.

Definition at line 20 of file BadgeSetComponent.h.

Referenced by registerType().

◆ outputAlphaValue

float Cogs::Core::BadgeSetComponent::outputAlphaValue = 1.0f

Output alpha value for the fragments not discarded by the shader.

Definition at line 33 of file BadgeSetComponent.h.

Referenced by registerType().

◆ positions

std::vector<glm::vec3> Cogs::Core::BadgeSetComponent::positions

Badge positions.

Definition at line 18 of file BadgeSetComponent.h.

Referenced by registerType(), and Cogs::Core::BadgeSetSystem::update().

◆ styles

std::vector<int> Cogs::Core::BadgeSetComponent::styles

Style (index) used for background behind icon.

Definition at line 21 of file BadgeSetComponent.h.

Referenced by registerType(), and Cogs::Core::BadgeSetSystem::update().

◆ styleTexture

TextureHandle Cogs::Core::BadgeSetComponent::styleTexture

Texture array (ktx2) containing background styling.

Index is retrieved from InstanceColor's y value.

Definition at line 23 of file BadgeSetComponent.h.

Referenced by registerType().

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

Extensions/BadgeSet/Source/BadgeSetComponent.h
Extensions/BadgeSet/Source/BadgeSetComponent.cpp

Static Public Member Functions

Public Attributes

Additional Inherited Members

Detailed Description

Member Function Documentation

◆ registerType()

Member Data Documentation

◆ anchorPoint

◆ badgeSize

◆ boundingBoxLower

◆ boundingBoxUpper

◆ digitTexture

◆ farScalingCutoff

◆ farVisibilityLimit

◆ icons

◆ iconTexture

◆ nearScalingCutoff

◆ nearVisibilityLimit

◆ numbers

◆ outputAlphaValue

◆ positions

◆ styles

◆ styleTexture