Overlay component. More...

#include <OverlayComponent.h>

Inheritance diagram for Cogs::Core::OverlayComponent:

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
TextureHandle	image = TextureHandle::NoHandle
	Image to display.

glm::vec4	color = glm::vec4(1, 1, 1, 1)
	Color to tint the overlay image with.

glm::vec2	size = glm::vec2(0, 0)
	Size of the overlay.

SizeMode	sizeMode = SizeMode::Relative
	Size mode of the overlay.

PositionMode	positionMode = PositionMode::Relative
	Positioning mode of the overlay.

BlendMode	blendMode = BlendMode::Blend
	Blend mode of the overlay.

glm::mat4	imageTransform = glm::mat4(1.0f)
	Image transform matrix that can be used to manipulate the appearance of the overlay without performing complex calculations for size and position.

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

Overlay component.

Definition at line 19 of file OverlayComponent.h.

Member Function Documentation

◆ registerType()

void Cogs::Core::OverlayComponent::registerType ( )

static

Register the type in the type system.

Definition at line 7 of file OverlayComponent.cpp.

References blendMode, color, image, imageTransform, positionMode, size, and sizeMode.

Member Data Documentation

◆ blendMode

BlendMode Cogs::Core::OverlayComponent::blendMode = BlendMode::Blend

Blend mode of the overlay.

Definition at line 41 of file OverlayComponent.h.

Referenced by registerType().

◆ color

glm::vec4 Cogs::Core::OverlayComponent::color = glm::vec4(1, 1, 1, 1)

Color to tint the overlay image with.

Definition at line 29 of file OverlayComponent.h.

Referenced by registerType().

◆ image

TextureHandle Cogs::Core::OverlayComponent::image = TextureHandle::NoHandle

Image to display.

Definition at line 26 of file OverlayComponent.h.

Referenced by registerType().

◆ imageTransform

glm::mat4 Cogs::Core::OverlayComponent::imageTransform = glm::mat4(1.0f)

Image transform matrix that can be used to manipulate the appearance of the overlay without performing complex calculations for size and position.

As an example one can apply transitions like "pop in" by combining animation of the alpha value of the material used for the component and applying an image transform animating from scaling the [x, y] axes from [0, 0] to [1, 1].

Note that image transforms might interact poorly with overlays depending on exact pixel positioning and size to look good, since the resulting pixel positions will most likely no longer line up at pixel borders.

Definition at line 54 of file OverlayComponent.h.

Referenced by registerType().

◆ positionMode

PositionMode Cogs::Core::OverlayComponent::positionMode = PositionMode::Relative

Positioning mode of the overlay.

Definition at line 38 of file OverlayComponent.h.

Referenced by registerType().

◆ size

glm::vec2 Cogs::Core::OverlayComponent::size = glm::vec2(0, 0)

Size of the overlay.

See also: sizeMode

Definition at line 32 of file OverlayComponent.h.

Referenced by registerType().

◆ sizeMode

SizeMode Cogs::Core::OverlayComponent::sizeMode = SizeMode::Relative

Size mode of the overlay.

Definition at line 35 of file OverlayComponent.h.

Referenced by registerType().

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

Source/Components/Core/OverlayComponent.h
Source/Components/Core/OverlayComponent.cpp

Static Public Member Functions

Public Attributes

Additional Inherited Members

Detailed Description

Member Function Documentation

◆ registerType()

Member Data Documentation

◆ blendMode

◆ color

◆ image

◆ imageTransform

◆ positionMode

◆ size

◆ sizeMode