ToyMaker::UIContainer Class Reference

Container for UI elements, responsible for repositioning elements in case their properties, or its properties, change. More...

#include <ui_container.hpp>

Inheritance diagram for ToyMaker::UIContainer:

Public Member Functions
	UIContainer ()
	Constructs a new UIContainer aspect.
std::shared_ptr< BaseSimObjectAspect >	clone () const override
	Constructs a new UIContainer instance using this one as a blueprint.
void	onActivated () override
	Subscribes to viewport resizing signals, and adjusts positions of child UI elements.
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 UIContainer instance based on its JSON description.

Private Member Functions
void	onViewportResized (const ViewportNode::RenderConfiguration &renderConfiguration)
	Procedure for when the owning viewport is resized, where the container is scaled to the viewport's dimensions, and child UI elements are repositioned.

Private Attributes
glm::vec2	mContentSize { 1.f, 1.f }
	The total dimensions spanned by this container.
SignalObserver< ViewportNode::RenderConfiguration >	mObservedViewportResized
	Observer for viewport resize events, which calls onViewportResized.

Additional Inherited Members
Protected Member Functions inherited from ToyMaker::SimObjectAspect< UIContainer >
	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

Container for UI elements, responsible for repositioning elements in case their properties, or its properties, change.

Changes size according to its owning viewport.

Each UI element decides on a point between (0, 0), and (1, 1), representing the top-left and bottom-right corners of this container respectively, relative to which the element's anchor is offset. When the container's size changes, the UI element's position in the scene changes accordingly.

Elements are marked with IUIElement.

See also

ToyMaker::IUIElement

@TODO: Either flesh this out or replace with a proper UI library.

@WARNING: There can only be one of these in one viewport.

Member Function Documentation

clone()

std::shared_ptr< BaseSimObjectAspect > UIContainer::clone ( ) const

overridevirtual

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

Returns

std::shared_ptr<BaseSimObjectAspect> The newly constructed UIContainer instance.

Implements ToyMaker::BaseSimObjectAspect.

create()

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

static

Constructs a new UIContainer instance based on its JSON description.

Parameters

jsonAspectProperties

The JSON description of the container.

Returns

std::shared_ptr<BaseSimObjectAspect> The newly constructed UIContainer instance.

getSimObjectAspectTypeName()

std::string ToyMaker::UIContainer::getSimObjectAspectTypeName ( )

inlinestatic

Gets the aspect type string associated with this class.

Returns

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

onActivated()

void UIContainer::onActivated ( )

overridevirtual

Subscribes to viewport resizing signals, and adjusts positions of child UI elements.

Reimplemented from ToyMaker::BaseSimObjectAspect.

Member Data Documentation

mObservedViewportResized

SignalObserver<ViewportNode::RenderConfiguration> ToyMaker::UIContainer::mObservedViewportResized

private

Initial value:

{
            *this, "onViewportResized", [this](const auto& renderConfiguration) {
                this->onViewportResized(renderConfiguration);
            }
        }

Observer for viewport resize events, which calls onViewportResized.

---

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

• ToyMaker_Builtins/include/toymaker/builtins/ui_container.hpp
• ToyMaker_Builtins/src/ui_container.cpp