tbx_interface.hpp

#ifndef TurtleBrainsExpress_Interface_hpp
#define TurtleBrainsExpress_Interface_hpp

#include <turtle_brains/graphics/tb_graphic.hpp>

#include <array>

namespace TurtleBrainsExpress
{
    namespace Interface
    {
        namespace Unstable
        {
            class Element;
            typedef tbCore::uint32 ElementHandle;

            enum class NavigationDirection
            {
                Up,
                Down,
                Left,
                Right
            };
            extern const std::array<NavigationDirection, 4>& theNavigationDirections;
            size_t DirectionToIndex(const NavigationDirection& direction);
            NavigationDirection DirectionFromIndex(const size_t& index);
            NavigationDirection OppositeDirection(const NavigationDirection& direction);


            enum class UserEventType
            {
                NavigateUp,
                NavigateDown,
                NavigateLeft,
                NavigateRight,
                Accept,
                Cancel,

                PointerMove,  //Mouse or Touch
                PointerDrag,  //Mouse or Touch drag while clicked/touching
                PrimaryPressed, //Mouse or Touch
                PrimaryReleased, //Mouse or Touch
                //SecondaryClick,
                //ScrollUp,
                //ScrollDown

                TypedCharacter, //A-Z 0-9
            };

            struct Point
            {
                tbGraphics::PixelSpace x;
                tbGraphics::PixelSpace y;

                Point(const tbGraphics::PixelSpace& valueX = 0, const tbGraphics::PixelSpace& valueY = 0);
            };

            struct UserEvent
            {
                UserEventType mType;
                //Great place to use a tbMath::VectorType<PixelSpace>
                Point mPointerPosition;
                tbCore::tbString mTypedCharacter;

                UserEvent(const UserEventType& type, const Point& pointerPosition = Point(0, 0),
                    const tbCore::tbString& typedCharacter = tb_string(""));

                bool IsNavigating(const NavigationDirection& direction) const;
            };

            Element& GetMutableFocusedElement(void);
            const Element* GetFocusedElementPointer(void);
            const Element& GetFocusedElement(void);
            void SetFocusedElement(Element* focusedElement);

        };
    }; /* namespace Interface */
}; /* namespace TurtleBrainsExpress */

namespace tbxInterface = TurtleBrainsExpress::Interface;

#endif /* TurtleBrainsExpress_Interface_hpp */