RangeSlider.hpp

 
//
// TGUI - Texus' Graphical User Interface
// Copyright (C) 2012-2024 Bruno Van de Velde (vdv_b@tgui.eu)
//
// This software is provided 'as-is', without any express or implied warranty.
// In no event will the authors be held liable for any damages arising from the use of this software.
//
// Permission is granted to anyone to use this software for any purpose,
// including commercial applications, and to alter it and redistribute it freely,
// subject to the following restrictions:
//
// 1. The origin of this software must not be misrepresented;
//    you must not claim that you wrote the original software.
//    If you use this software in a product, an acknowledgment
//    in the product documentation would be appreciated but is not required.
//
// 2. Altered source versions must be plainly marked as such,
//    and must not be misrepresented as being the original software.
//
// 3. This notice may not be removed or altered from any source distribution.
//
 
#ifndef TGUI_RANGE_SLIDER_HPP
#define TGUI_RANGE_SLIDER_HPP
 
#include <TGUI/Widget.hpp>
#include <TGUI/Renderers/RangeSliderRenderer.hpp>
 
 
TGUI_MODULE_EXPORT namespace tgui
{
    class TGUI_API RangeSlider : public Widget
    {
    public:
 
        using Ptr = std::shared_ptr<RangeSlider>; 
        using ConstPtr = std::shared_ptr<const RangeSlider>; 
 
        static constexpr const char StaticWidgetType[] = "RangeSlider"; 
 
        RangeSlider(const char* typeName = StaticWidgetType, bool initRenderer = true);
 
        TGUI_NODISCARD static RangeSlider::Ptr create(float minimum = 0, float maximum = 10);
 
        TGUI_NODISCARD static RangeSlider::Ptr copy(const RangeSlider::ConstPtr& slider);
 
        TGUI_NODISCARD RangeSliderRenderer* getSharedRenderer() override;
        TGUI_NODISCARD const RangeSliderRenderer* getSharedRenderer() const override;
 
        TGUI_NODISCARD RangeSliderRenderer* getRenderer() override;
 
        void setSize(const Layout2d& size) override;
        using Widget::setSize;
 
        TGUI_NODISCARD Vector2f getFullSize() const override;
 
        TGUI_NODISCARD Vector2f getWidgetOffset() const override;
 
        void setMinimum(float minimum);
 
        TGUI_NODISCARD float getMinimum() const;
 
        void setMaximum(float maximum);
 
        TGUI_NODISCARD float getMaximum() const;
 
        void setSelectionStart(float value);
 
        TGUI_NODISCARD float getSelectionStart() const;
 
        void setSelectionEnd(float value);
 
        TGUI_NODISCARD float getSelectionEnd() const;
 
        void setStep(float step);
 
        TGUI_NODISCARD float getStep() const;
 
        TGUI_NODISCARD bool isMouseOnWidget(Vector2f pos) const override;
 
        bool leftMousePressed(Vector2f pos) override;
 
        void leftMouseReleased(Vector2f pos) override;
 
        void mouseMoved(Vector2f pos) override;
 
        void leftMouseButtonNoLongerDown() override;
 
        void draw(BackendRenderTarget& target, RenderStates states) const override;
 
    protected:
 
        TGUI_NODISCARD Signal& getSignal(String signalName) override;
 
        void rendererChanged(const String& property) override;
 
        TGUI_NODISCARD std::unique_ptr<DataIO::Node> save(SavingRenderersMap& renderers) const override;
 
        void load(const std::unique_ptr<DataIO::Node>& node, const LoadingRenderersMap& renderers) override;
 
        // Returns the size without the borders
        TGUI_NODISCARD Vector2f getInnerSize() const;
 
        // Updates the position of the thumb based on the current value of the slider
        void updateThumbPositions();
 
        // Makes a copy of the widget
        TGUI_NODISCARD Widget::Ptr clone() const override;
 
    public:
 
        SignalRange onRangeChange = {"RangeChanged"}; 
 
    protected:
 
        std::pair<FloatRect, FloatRect> m_thumbs;
 
        // When the mouse went down, did it go down on top of the thumb? If so, which one and where?
        unsigned int m_mouseDownOnThumb = 0;
        Vector2f m_mouseDownOnThumbPos;
 
        float m_minimum = 0;
        float m_maximum = 10;
        float m_selectionStart = 0;
        float m_selectionEnd = 0;
        float m_step = 1;
 
        Orientation m_orientation = Orientation::Horizontal; // Is the slider drawn horizontally or vertically?
        Orientation m_imageOrientation = Orientation::Horizontal;  // Does the loaded image lie horizontally or vertically?
 
        Sprite m_spriteTrack;
        Sprite m_spriteTrackHover;
        Sprite m_spriteThumb;
        Sprite m_spriteThumbHover;
        Sprite m_spriteSelectedTrack;
        Sprite m_spriteSelectedTrackHover;
 
        // Cached renderer properties
        Borders m_bordersCached;
        Color   m_borderColorCached;
        Color   m_borderColorHoverCached;
        Color   m_thumbColorCached;
        Color   m_thumbColorHoverCached;
        Color   m_trackColorCached;
        Color   m_trackColorHoverCached;
        Color   m_selectedTrackColorCached;
        Color   m_selectedTrackColorHoverCached;
    };
 
}
 
 
#endif // TGUI_RANGE_SLIDER_HPP