UIText Class Reference

A UI text element. More...

#include <ui_text.h>

Inheritance diagram for UIText:

Public Member Functions
	UIText (Scene &scene, std::string text, std::string font, std::string font_path, float width, float height, Point pivot, Point anchor)
void	update (float dt) override
	Update the UI object.
const std::string &	text () const
UIText &	text (const std::string &text)
const std::string &	font () const
UIText &	font (const std::string &font)
const std::string &	font_path () const
UIText &	font_path (const std::string &font_path)
int	font_size () const
UIText &	font_size (int font_size)
Color	color () const
UIText &	color (Color color)
Public Member Functions inherited from UIObject
	UIObject (Scene &scene, float width, float height, Point pivot, Point anchor)
virtual void	render () const
	Render the UI object.
float	width () const
UIObject &	width (float width)
float	height () const
UIObject &	height (float height)
Point	pivot () const
UIObject &	pivot (Point pivot)
Point	anchor () const
UIObject &	anchor (Point anchor)
Public Member Functions inherited from GameObject
	GameObject (Scene &scene)
virtual	~GameObject ()=default
	GameObject (const GameObject &)=delete
GameObject &	operator= (const GameObject &)=delete
	GameObject (GameObject &&)=default
GameObject &	operator= (GameObject &&)=default
std::optional< std::reference_wrapper< GameObject > >	parent () const
GameObject &	parent (GameObject &parent)
GameObject &	parent (std::nullopt_t null_opt)
std::string	id () const noexcept
bool	is_active_in_world () const noexcept
	Retrieves whether the GameObject is active in the world.
bool	is_active () const noexcept
	Retrieves whether the GameObject is active.
void	set_inactive () noexcept
void	set_active () noexcept
void	set_active_in_world () noexcept
void	set_inactive_in_world () noexcept
GameObject &	mark_for_deletion () noexcept
	Marks the GameObject for deletion.
bool	marked_for_deletion () const noexcept
void	mark_dont_destroy_on_load (bool dont_destroy) noexcept
	Sets whether the GameObject should not be destroyed on scene load.
bool	dont_destroy_on_load () const noexcept
GameObject &	name (const std::string &name)
const std::string &	name () const
GameObject &	tag (const std::string &tag)
const std::string &	tag () const
GameObject &	prefab_type_id (const std::string &id)
const std::string &	prefab_type_id () const
GameObject &	layer (int layer)
int	layer () const
GameObject &	transform (Transform transform)
Transform &	transform ()
const Transform &	transform () const
Scene &	scene () const noexcept
void	scene (Scene &scene) noexcept
std::vector< std::reference_wrapper< GameObject > > &	children ()
GameObject &	add_child (GameObject &child)
GameObject &	remove_child (GameObject &child)
template<IsComponent T>
std::optional< std::reference_wrapper< T > >	get_component () const noexcept
	Get the first component of type T attached to this GameObject.
template<IsComponent T>
std::vector< std::reference_wrapper< T > >	get_components () const
	Get all components of type T attached to this GameObject.
template<IsComponent BS, typename B >
std::optional< std::reference_wrapper< B > >	get_script () const noexcept
	Get the first script component of base type BS with behavior of type B.
std::vector< std::reference_wrapper< Component > >	get_components_all () const
	Get all components attached to this GameObject.
template<IsComponent T>
std::vector< std::reference_wrapper< T > >	get_components_from_children () const
	Get all components of type T attached to this GameObject and its children.
template<IsComponent T, typename... Args>
T &	add_component (Args &&... args)
	Adds a component of type T to this GameObject.
template<IsComponent T>
void	remove_component (T &component)
	Removes a component of type T from this GameObject.
void	remove_all_components ()
void	serialize (std::vector< uint8_t > &out) const
	Serialize this GameObject's own state and its components into out. The format produced is: uint16_t name_len, name bytes uint16_t tag_len, tag bytes uint8_t is_active int32_t layer uint16_t component_count for each component: uint16_t type_name_len, type_name bytes uint32_t payload_len, payload bytes.
void	deserialize (const std::vector< uint8_t > &data, size_t &offset)
	Deserialize this GameObject's state and dispatch component payloads from data starting at offset. Implementations should advance offset by the number of bytes consumed. Subclasses overriding this method should call GameObject::deserialize first to keep base behavior.

Additional Inherited Members
Protected Attributes inherited from UIObject
float	width_
float	height_
Point	pivot_
Point	anchor_

Detailed Description

A UI text element.

UIText represents a text element in the user interface. It inherits from UIObject and adds properties specific to text rendering, such as the text content, font name, font size, and color.

In its core UIText is a game object with UIObject as its base class. The reason for this class is to encapsulate text-specific functionality and state management, making it easier to create and manage text elements within the UI system.

Usage:

• Create a UIText component with desired properties.
• Attach the UIText component to a GameObject to display text in the UI.
• Modify properties such as text content, font, size, color as needed.

  Note

  Ensure the specified font is available in the assets.

Constructor & Destructor Documentation

UIText()

UIText::UIText	(	Scene &	scene,
		std::string	text,
		std::string	font,
		std::string	font_path,
		float	width,
		float	height,
		Point	pivot,
		Point	anchor
	)

Member Function Documentation

color() [1/2]

Color UIText::color

(

)

const

color() [2/2]

UIText & UIText::color

(

Color

color

)

font() [1/2]

const std::string & UIText::font

(

)

const

font() [2/2]

UIText & UIText::font

(

const std::string &

font

)

font_path() [1/2]

const std::string & UIText::font_path

(

)

const

font_path() [2/2]

UIText & UIText::font_path

(

const std::string &

font_path

)

font_size() [1/2]

int UIText::font_size

(

)

const

font_size() [2/2]

UIText & UIText::font_size

(

int

font_size

)

text() [1/2]

const std::string & UIText::text

(

)

const

text() [2/2]

UIText & UIText::text

(

const std::string &

text

)

update()

void UIText::update ( float  dt )

overridevirtual

Update the UI object.

This should be overridden by derived classes to implement specific update logic. Such as handling animations or state changes (e.g pressed, hovered, etc.).

Parameters

dt	Delta time since the last update.

Reimplemented from UIObject.

---

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

• include/engine/public/ui/ui_text.h