Knob.hpp

 
//
// TGUI - Texus's Graphical User Interface
// Copyright (C) 2012-2017 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_KNOB_HPP
#define TGUI_KNOB_HPP
 
 
#include <TGUI/Widget.hpp>
 
 
namespace tgui
{
 class KnobRenderer;
 
 class TGUI_API Knob : public Widget
 {
 public:
 
 typedef std::shared_ptr<Knob> Ptr; 
 typedef std::shared_ptr<const Knob> ConstPtr; 
 
 
 // Default constructor
 Knob();
 
 
 static Knob::Ptr create();
 
 
 static Knob::Ptr copy(Knob::ConstPtr knob);
 
 
 std::shared_ptr<KnobRenderer> getRenderer() const
 {
 return std::static_pointer_cast<KnobRenderer>(m_renderer);
 }
 
 
 virtual void setPosition(const Layout2d& position) override;
 using Transformable::setPosition;
 
 
 virtual void setSize(const Layout2d& size) override;
 using Transformable::setSize;
 
 
 virtual sf::Vector2f getFullSize() const override;
 
 
 void setStartRotation(float startRotation);
 
 
 void setEndRotation(float endRotation);
 
 
 float getStartRotation()
 {
 return m_startRotation;
 }
 
 
 float getEndRotation()
 {
 return m_endRotation;
 }
 
 
 virtual void setMinimum(int minimum);
 
 
 virtual void setMaximum(int maximum);
 
 
 virtual void setValue(int value);
 
 
 int getMinimum() const
 {
 return m_minimum;
 }
 
 
 int getMaximum() const
 {
 return m_maximum;
 }
 
 
 int getValue() const
 {
 return m_value;
 }
 
 
 void setClockwiseTurning(bool clockwise);
 
 
 bool getClockwiseTurning()
 {
 return m_clockwiseTurning;
 }
 
 
 virtual void setOpacity(float opacity) override;
 
 
 virtual sf::Vector2f getWidgetOffset() const override;
 
 
 virtual bool mouseOnWidget(float x, float y) const override;
 
 virtual void leftMousePressed(float x, float y) override;
 
 virtual void leftMouseReleased(float x, float y) override;
 
 virtual void mouseMoved(float x, float y) override;
 
 virtual void widgetFocused() override;
 
 
 protected:
 
 // Recalculates the rotation of the knob.
 void recalculateRotation();
 
 
 virtual void reload(const std::string& primary = "", const std::string& secondary = "", bool force = false) override;
 
 
 // Makes a copy of the widget
 virtual Widget::Ptr clone() const override
 {
 return std::make_shared<Knob>(*this);
 }
 
 
 // Draws the widget on the render target.
 virtual void draw(sf::RenderTarget& target, sf::RenderStates states) const override;
 
 
 protected:
 
 bool m_clockwiseTurning = true; // Does rotating clockwise increment the value?
 float m_startRotation = 270;
 float m_endRotation = 270;
 
 int m_minimum = 0;
 int m_value = 0;
 int m_maximum = 360;
 
 float m_angle = 270;
 
 friend class KnobRenderer;
 };
 
 
 
 class TGUI_API KnobRenderer : public WidgetRenderer, public WidgetBorders
 {
 public:
 
 KnobRenderer(Knob* knob) : m_knob{knob} {}
 
 
 virtual void setProperty(std::string property, const std::string& value) override;
 
 
 virtual void setProperty(std::string property, ObjectConverter&& value) override;
 
 
 virtual ObjectConverter getProperty(std::string property) const override;
 
 
 virtual std::map<std::string, ObjectConverter> getPropertyValuePairs() const override;
 
 
 void setImageRotation(float rotation);
 
 
 void setBackgroundColor(const Color& color);
 
 
 void setThumbColor(const Color& color);
 
 
 void setBorderColor(const Color& color);
 
 
 void setBackgroundTexture(const Texture& texture);
 
 
 void setForegroundTexture(const Texture& texture);
 
 
 // Draws the widget on the render target.
 void draw(sf::RenderTarget& target, sf::RenderStates states) const;
 
 
 private:
 
 // Makes a copy of the renderer
 virtual std::shared_ptr<WidgetRenderer> clone(Widget* widget) override;
 
 
 protected:
 
 Knob* m_knob;
 
 float m_imageRotation = 0;
 Texture m_backgroundTexture;
 Texture m_foregroundTexture;
 
 sf::Color m_backgroundColor;
 sf::Color m_thumbColor;
 
 sf::Color m_borderColor;
 
 friend class Knob;
 
 };
 
}
 
 
#endif // TGUI_KNOB_HPP