Ra::Engine::Scene::UiComponent Class Reference

Component for UI drawing. More...

#include <Engine/Scene/SystemDisplay.hpp>

Inheritance diagram for Ra::Engine::Scene::UiComponent:

Collaboration diagram for Ra::Engine::Scene::UiComponent:

Public Member Functions
	UiComponent (Entity *entity)
void	initialize () override
	Pure virtual method to be overridden by any component. When this method is called you are guaranteed that all other startup systems have been loaded.
Public Member Functions inherited from Ra::Engine::Scene::Component
	Component (const std::string &name, Entity *entity)
	CONSTRUCTOR.
virtual	~Component ()
	DESTRUCTOR.
virtual void	setEntity (Entity *entity)
	Set entity the component is part of. This method is called by the entity.
virtual Entity *	getEntity () const
	Return the entity the component belongs to.
virtual const std::string &	getName () const
	Return the component's name.
virtual void	setSystem (System *system)
	Set the system to which the component belongs.
virtual System *	getSystem () const
	Returns the system to which the component belongs.
Core::Utils::Index	addRenderObject (Rendering::RenderObject *renderObject)
	Add a new render object to the component. This adds the RO to the manager for drawing.
void	removeRenderObject (const Core::Utils::Index &roIdx)
	Remove the render object from the component.
virtual bool	canEdit (const Core::Utils::Index &) const
	Returns true if a transform can be edited with the render object index given as a key.
virtual Core::Transform	getTransform (const Core::Utils::Index &) const
	Get the transform associated with the given RO index key.
virtual void	setTransform (const Core::Utils::Index &, const Core::Transform &)
	Set the new transform associated with the RO index key.
void	notifyRenderObjectExpired (const Core::Utils::Index &idx)
virtual Core::Aabb	computeAabb ()
void	invalidateAabb ()
const std::vector< Core::Utils::Index > &	getRenderObjects ()

Additional Inherited Members
Public Attributes inherited from Ra::Engine::Scene::Component
std::vector< Core::Utils::Index >	m_renderObjects
Static Protected Member Functions inherited from Ra::Engine::Scene::Component
static Rendering::RenderObjectManager *	getRoMgr ()
	Shortcut to access the render object manager.
Protected Attributes inherited from Ra::Engine::Scene::Component
std::string	m_name {}
Entity *	m_entity { nullptr }
System *	m_system { nullptr }

Detailed Description

Component for UI drawing.

See also

SystemEntity.

Definition at line 43 of file SystemDisplay.hpp.

Constructor & Destructor Documentation

UiComponent()

Ra::Engine::Scene::UiComponent::UiComponent ( Entity * entity )

inlineexplicit

Definition at line 46 of file SystemDisplay.hpp.

Member Function Documentation

initialize()

void Ra::Engine::Scene::UiComponent::initialize ( )

inlineoverridevirtual

Pure virtual method to be overridden by any component. When this method is called you are guaranteed that all other startup systems have been loaded.

Implements Ra::Engine::Scene::Component.

Definition at line 48 of file SystemDisplay.hpp.

---

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

• /home/runner/work/Radium-Engine/Radium-Engine/src/Radium-Engine/src/Engine/Scene/SystemDisplay.hpp