ui_button.hpp

Go to the documentation of this file.

 
#ifndef TOYMAKERBUILTINS_UIBUTTON_H
#define TOYMAKERBUILTINS_UIBUTTON_H
 
#include <nlohmann/json.hpp>
 
#include "toymaker/engine/sim_system.hpp"
#include "toymaker/engine/signals.hpp"
 
#include "interface_pointer_callback.hpp"
#include "nine_slice_panel.hpp"
#include "ui_container.hpp"
 
namespace ToyMaker {

    class UIButton: public ToyMaker::SimObjectAspect<UIButton>, public IHoverable, public ILeftClickable, public IUIElement {
    public:
        enum State: uint8_t {
            ACTIVE, //< This button is active, and ready to be pressed.
            HOVER, //< This button is being hovered over by a pointer.
            PRESSED, //< This button has been pressed and held down.
            INACTIVE, //< This button is disabled and will not respond to pointer events.
 
            //=============
            TOTAL, //< The tally of all button states.
        };
        UIButton(): SimObjectAspect<UIButton>{0} {}

        inline static std::string getSimObjectAspectTypeName() { return "UIButton"; }

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

        std::shared_ptr<BaseSimObjectAspect> clone() const override;

        void onActivated() override;

        void enableButton();

        void disableButton();

        void updateText(const std::string& newText);

        void updateTextScale(float scale);

        void updateTextFont(const std::string& textResourceName);

        void updateTextColor(glm::u8vec4 textColor);

        void updateButtonAnchor(glm::vec2 newAnchor);

        void updateHighlightColor(glm::vec4 newColor);
 
        inline glm::vec2 getReferenceCoordinate() const override {
            return mReferenceCoordinate;
        }
 
        inline glm::vec3 getOffsets() const override {
            return mOffsets;
        }
 
        inline bool allowsDescendantControl() const override {
            return false;
        }
 
    private:
        State mCurrentState { State::ACTIVE };

        bool mHovered { false };

        std::array<std::shared_ptr<NineSlicePanel>, State::TOTAL> mStatePanels {};

        glm::vec2 mAnchor {.5f, .5f};

        std::string mValue {""};

        std::string mTextOverride {""};

        float mTextScaleOverride {1.f};

        std::string mTextFontOverride {""};

        glm::u8vec4 mTextColorOverride { 0x00, 0x00, 0x00, 0xFF };

        std::shared_ptr<NineSlicePanel> mHighlightPanel {};

        glm::vec4 mHighlightColor {0.f, 0.f, 0.f, 0.f};

        glm::vec2 mReferenceCoordinate { 0.f, 0.f };

        glm::vec3 mOffsets { 0.f, 0.f, 0.f };

        void recomputeTexture();

        void updateButtonState(UIButton::State newState);

        void fireStateEvent();

        std::shared_ptr<ToyMaker::SimObject> getTextObject();
    public:

        ToyMaker::Signal<std::string> mSigButtonPressed { *this, "ButtonPressed" };

        ToyMaker::Signal<std::string> mSigButtonReleased { *this, "ButtonReleased" };

        ToyMaker::Signal<std::string> mSigButtonHoveredOver { *this, "ButtonHoveredOver" };

        ToyMaker::Signal<> mSigButtonActivated { *this, "ButtonActivated" };

        ToyMaker::Signal<> mSigButtonDeactivated { *this, "ButtonDeactivated" };
 
    private:
        bool onPointerEnter(glm::vec4 pointerLocation) override;

        inline bool onPointerHover(glm::vec4 pointerLocation) override { return false; }

        bool onPointerLeave() override;

        bool onPointerLeftClick(glm::vec4 pointerLocation) override;

        bool onPointerLeftRelease(glm::vec4 pointerLocation) override;
    };
 

    NLOHMANN_JSON_SERIALIZE_ENUM(UIButton::State, {
        {UIButton::State::ACTIVE, "active"},
        {UIButton::State::HOVER, "hover"},
        {UIButton::State::PRESSED, "pressed"},
        {UIButton::State::INACTIVE, "inactive"},
    });
 
}
 
#endif