UI aspect responsible for managing and rendering a NineSlicePanel texture on the UI. More...

#include <ui_panel.hpp>

Inheritance diagram for UIPanel:

Public Member Functions
	UIPanel ()
	Constructs a new UIPanel aspect.

std::shared_ptr< BaseSimObjectAspect >	clone () const override
	Constructs a new UIPanel instance using this one as a blueprint.

void	onActivated () override
	Loads and renders the texture of a panel per its configuration.

void	updateContentSize (glm::vec2 contentSize)
	Updates the size of the central region of the NineSlicePanel.

void	updateAnchor (glm::vec2 anchor)
	Updates the point considered the new origin for this object, where (0,0) represents the top left corner of the object, and (1,1) the bottom right corner.

void	updateBasePanel (std::shared_ptr< NineSlicePanel > newPanel)
	Changes the panel resource used to create this object's panel texture.

Public Member Functions inherited from ToyMaker::BaseSimObjectAspect
virtual	~BaseSimObjectAspect ()=default
	Destroys this object.

virtual void	simulationUpdate (uint32_t simStepMillis)
	Overriding this allows an aspect to respond to simulation updates.

virtual void	variableUpdate (uint32_t variableStepMillis)
	Overriding this allows an aspect to respond to variable updates.

bool	handleAction (const ActionData &actionData, const ActionDefinition &actionDefinition) override final
	Pipes an action received from the InputManager via our SimObject to all that action's handler methods on this aspect.

ViewportNode &	getLocalViewport ()
	Returns the closest ancestor viewport to this node, if one exists (which it should, since this shouldn't be called until this aspect is attached to an active SimObject).

Public Member Functions inherited from ToyMaker::SignalTracker
	SignalTracker ()
	Constructs a new SignalTracker object.

	SignalTracker (const SignalTracker &other)
	Constructs a new SignalTracker.

SignalTracker &	operator= (const SignalTracker &other)
	Copy assignment operator.

	SignalTracker (SignalTracker &&other)
	Moves resources from another SignalTracker into this one, invalidating them from the other.

SignalTracker &	operator= (SignalTracker &&other)
	Moves resources from another SignalTracker into this one, destroying this tracker's resources in the process.

void	connect (const std::string &theirSignal, const std::string &ourObserver, SignalTracker &other)
	Method that connects one of this objects SignalObservers to another tracker's Signal.

Static Public Member Functions
static std::string	getSimObjectAspectTypeName ()
	Gets the aspect type string associated with this class.

static std::shared_ptr< BaseSimObjectAspect >	create (const nlohmann::json &jsonAspectProperties)
	Constructs a new UIPanel instance based on its JSON description.

Private Member Functions
void	recomputeTexture ()
	The method responsible for actually creating the new texture through the loaded panel resource.

Private Attributes
std::shared_ptr< NineSlicePanel >	mBasePanel {}
	The panel resource used to create this texture.

glm::vec2	mContentSize {0.f, 0.f}
	The size of the central area of the nine slice panel in which content can be displayed.

glm::vec2	mAnchor {0.f, 0.f}
	The point considered the origin of this object, where (0,0) represents the top left corner and (1,1) the bottom right corner.

Additional Inherited Members
Protected Member Functions inherited from ToyMaker::SimObjectAspect< UIPanel >
	SimObjectAspect (int explicitlyInitializeMe)

Protected Member Functions inherited from ToyMaker::BaseSimObjectAspect
	BaseSimObjectAspect (const BaseSimObjectAspect &other)=delete

	BaseSimObjectAspect (BaseSimObjectAspect &&other)=delete

SimObject &	getSimObject ()
	Returns the sim object that this aspect is attached to.

template<typename TComponent>
void	addComponent (const TComponent &component)
	Adds a component of some type to the underlying entity.

template<typename TComponent>
bool	hasComponent ()
	Tests whether a component of some specific type is present on the object.

template<typename TComponent>
void	updateComponent (const TComponent &component)
	Updates the value of a component belonging to this object to a new one.

template<typename TComponent>
TComponent	getComponent (const float simulationProgress=1.f) const
	Gets the value of a component belonging to this object.

template<typename TComponent>
void	removeComponent ()
	Removes a component of some type belonging to the underlying SimObject.

void	addAspect (const nlohmann::json &jsonAspectProperties)
	Adds a new aspect to the underlying SimObject constructed based on its properties in JSON.

void	addAspect (const BaseSimObjectAspect &aspect)
	Adds a new aspect to the underlying SimObject copied from an already existing aspect.

template<typename TSimObjectAspect>
bool	hasAspect () const
	Tests whether an aspect of a particular type is attached to the underlying SimObject.

bool	hasAspect (const std::string &aspectType) const
	Tests whether an aspect of a particular type is attached to the underlying SimObject.

template<typename TSimObjectAspect>
TSimObjectAspect &	getAspect ()
	Gets an aspect of a particular type belonging to the underlying SimObject.

BaseSimObjectAspect &	getAspect (const std::string &aspectType)
	Gets (a base class reference to) an aspect of a particular type belonging to the underlying SimObject.

template<typename TSimObjectAspect>
void	removeAspect ()
	Removes an aspect from the underlying SimObject.

void	addOrReplaceAspect (const BaseSimObjectAspect &aspect)
	Adds or replaces an aspect on the underlying SimObject with a new aspect constructed as a copy of another.

void	addOrReplaceAspect (const nlohmann::json &jsonAspectProperties)
	Adds or replaces an aspect on the underlying SimObject with a new aspect constructed from its JSON description.

std::weak_ptr< FixedActionBinding >	declareFixedActionBinding (const std::string &context, const std::string &action, std::function< bool(const ActionData &, const ActionDefinition &)>)
	Binds some method (or any function) present on this object to an action generated by the InputManager.

EntityID	getEntityID () const
	Gets the ID of the ECSWorld Entity belonging to our SimObject.

std::weak_ptr< ECSWorld >	getWorld () const
	Gets a weak reference to the ECSWorld to which our SimObject's entity belongs.

Static Protected Member Functions inherited from ToyMaker::BaseSimObjectAspect
template<typename TSimObjectAspectDerived>
static void	registerAspect ()
	Registers an implementation of an aspect with the SimSystem.

Detailed Description

UI aspect responsible for managing and rendering a NineSlicePanel texture on the UI.

Usage:

Its appearance in JSON is as follows:

{
    "type": "UIPanel",
    "anchor": [1.0, 0.0],
    "content_size": [454.0, 764.0],
    "panel_resource_name": "Bad_Panel"
}

Member Function Documentation

◆ clone()

std::shared_ptr< ToyMaker::BaseSimObjectAspect > UIPanel::clone ( ) const

overridevirtual

Constructs a new UIPanel instance using this one as a blueprint.

Returns: std::shared_ptr<BaseSimObjectAspect> The newly constructed UIPanel instance.

Implements ToyMaker::BaseSimObjectAspect.

◆ create()

std::shared_ptr< ToyMaker::BaseSimObjectAspect > UIPanel::create ( const nlohmann::json & jsonAspectProperties )

static

Constructs a new UIPanel instance based on its JSON description.

Parameters

jsonAspectProperties The JSON description of a UIPanel.

Returns: std::shared_ptr<BaseSimObjectAspect> The newly constructed UIPanel instance.

◆ getSimObjectAspectTypeName()

static std::string UIPanel::getSimObjectAspectTypeName ( )

inlinestatic

Gets the aspect type string associated with this class.

Returns: std::string The aspect type string associated with this class.

◆ onActivated()

void UIPanel::onActivated ( )

overridevirtual

Loads and renders the texture of a panel per its configuration.

Reimplemented from ToyMaker::BaseSimObjectAspect.

◆ updateAnchor()

void UIPanel::updateAnchor ( glm::vec2 anchor )

Updates the point considered the new origin for this object, where (0,0) represents the top left corner of the object, and (1,1) the bottom right corner.

Parameters

anchor The point considered the new origin of this object.

◆ updateBasePanel()

void UIPanel::updateBasePanel ( std::shared_ptr< NineSlicePanel > newPanel )

Changes the panel resource used to create this object's panel texture.

Parameters

newPanel The new panel resource used to render this object's texture.

◆ updateContentSize()

void UIPanel::updateContentSize ( glm::vec2 contentSize )

Updates the size of the central region of the NineSlicePanel.

Parameters

contentSize The new content display region of the NineSlicePanel.

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

src/app/ui_panel.hpp
src/app/ui_panel.cpp

Public Member Functions

Static Public Member Functions

Private Member Functions

Private Attributes

Additional Inherited Members

Detailed Description

Usage:

Member Function Documentation

◆ clone()

◆ create()

◆ getSimObjectAspectTypeName()

◆ onActivated()

◆ updateAnchor()

◆ updateBasePanel()

◆ updateContentSize()