Knob.hpp

//
// TGUI - Texus's Graphical User Interface
// Copyright (C) 2012-2015 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 TGUI_API Knob : public Widget
 {
 public:

 typedef SharedWidgetPtr<Knob> Ptr;


 Knob();


 Knob(const Knob& copy);


 virtual ~Knob();


 Knob& operator= (const Knob& right);


 // Makes a copy of the widget by calling the copy constructor.
 // This function calls new and if you use this function then you are responsible for calling delete.
 virtual Knob* clone();


 bool load(const std::string& configFileFilename, const std::string& sectionName = "Knob");


 const std::string& getLoadedConfigFile() const;


 virtual void setPosition(float x, float y);
 using Transformable::setPosition;


 virtual void setSize(float width, float height);


 virtual sf::Vector2f getSize() const;


 void setStartRotation(float startRotation);


 void setEndRotation(float endRotation);


 virtual void setMinimum(int minimum);


 virtual void setMaximum(int maximum);


 virtual void setValue(int value);


 int getMinimum() const;


 int getMaximum() const;


 int getValue() const;


 void setClockwiseTurning(bool clockwise);


 bool getClockwiseTurning();


 virtual void setTransparency(unsigned char transparency);


 virtual bool mouseOnWidget(float x, float y);

 virtual void leftMousePressed(float x, float y);

 virtual void leftMouseReleased(float x, float y);

 virtual void mouseMoved(float x, float y);

 virtual void widgetFocused();


 // This function is a (slow) way to set properties on the widget, no matter what type it is.
 // When the requested property doesn't exist in the widget then the functions will return false.
 virtual bool setProperty(std::string property, const std::string& value);

 // This function is a (slow) way to get properties of the widget, no matter what type it is.
 // When the requested property doesn't exist in the widget then the functions will return false.
 virtual bool getProperty(std::string property, std::string& value) const;


 // Returns a list of all properties that can be used in setProperty and getProperty.
 // The second value in the pair is the type of the property (e.g. int, uint, string, ...).
 virtual std::list< std::pair<std::string, std::string> > getPropertyList() const;


 protected:

 // Recalculates the rotation of the knob.
 void recalculateRotation();


 // Draws the widget on the render target.
 virtual void draw(sf::RenderTarget& target, sf::RenderStates states) const;


 public:

 enum KnobCallbacks
 {
 ValueChanged = WidgetCallbacksCount * 1, 
 AllKnobCallbacks = WidgetCallbacksCount * 2 - 1, 
 KnobCallbacksCount = WidgetCallbacksCount * 2
 };


 protected:

 std::string m_loadedConfigFile;

 Texture m_backgroundTexture;
 Texture m_foregroundTexture;

 sf::Vector2f m_size;

 bool m_clockwiseTurning; // Does rotating clockwise increment the value?
 float m_imageRotation;
 float m_startRotation;
 float m_endRotation;

 int m_minimum;
 int m_value;
 int m_maximum;
 };

}


#endif // TGUI_KNOB_HPP