#include <slider.h>

Inheritance diagram for Slider:

Public Member Functions
	Slider (Widget2 *const widget, const double scaleEnd, const double stepLength)

	Slider (Widget2 *const widget, const double scaleStart, const double scaleEnd, const double stepLength)

	~Slider ()

void	updateAlpha ()

void	draw (Graphics *const graphics)

void	safeDraw (Graphics *const graphics)

void	mouseEntered (MouseEvent &event)

void	mouseExited (MouseEvent &event)

void	mousePressed (MouseEvent &event)

void	mouseDragged (MouseEvent &event)

void	mouseWheelMovedUp (MouseEvent &event)

void	mouseWheelMovedDown (MouseEvent &event)

void	keyPressed (KeyEvent &event)

void	setScale (const double scaleStart, const double scaleEnd)

double	getScaleStart () const

void	setScaleStart (const double scaleStart)

double	getScaleEnd () const

void	setScaleEnd (const double scaleEnd)

void	setValue (const double value)

double	getValue () const

int	getMarkerLength () const

void	setMarkerLength (const int length)

void	setOrientation (const OrientationT orientation)

OrientationT	getOrientation () const

void	setStepLength (const double length)

double	getStepLength () const

Public Member Functions inherited from Widget
	Widget (const Widget2 *const widget)

	~Widget ()

virtual void	drawFrame (Graphics *graphics)

virtual void	safeDrawFrame (Graphics *graphics)

void	setFrameSize (const unsigned int frameSize)

unsigned int	getFrameSize () const

virtual void	logic ()

Widget *	getParent () const

void	setWidth (const int width)

int	getWidth () const

void	setHeight (const int height)

int	getHeight () const

void	setSize (const int width, const int height)

void	setX (const int x)

int	getX () const

void	setY (const int y)

int	getY () const

void	setPosition (const int x, const int y)

void	setDimension (const Rect &dimension)

const Rect &	getDimension () const

void	setFocusable (const bool focusable)

bool	isFocusable () const

virtual bool	isFocused () const

void	setEnabled (const bool enabled)

bool	isEnabled () const

void	setVisible (Visible visible)

bool	isVisible () const

void	setBaseColor (const Color &color)

const Color &	getBaseColor () const

void	setForegroundColor (const Color &color)

const Color &	getForegroundColor () const

void	setBackgroundColor (const Color &color)

const Color &	getBackgroundColor () const

virtual void	requestFocus ()

virtual void	requestMoveToTop ()

virtual void	requestMoveToBottom ()

virtual void	setFocusHandler (FocusHandler *const focusHandler)

FocusHandler *	getFocusHandler ()

void	addActionListener (ActionListener *const actionListener)

void	removeActionListener (ActionListener *const actionListener)

void	addDeathListener (WidgetDeathListener *const deathListener)

void	removeDeathListener (WidgetDeathListener *const deathListener)

void	addMouseListener (MouseListener *const mouseListener)

void	removeMouseListener (MouseListener *const mouseListener)

void	addKeyListener (KeyListener *const keyListener)

void	removeKeyListener (KeyListener *const keyListener)

void	addFocusListener (FocusListener *const focusListener)

void	removeFocusListener (FocusListener *const focusListener)

void	addWidgetListener (WidgetListener *const widgetListener)

void	removeWidgetListener (WidgetListener *const widgetListener)

void	setActionEventId (const std::string &actionEventId)

const std::string &	getActionEventId () const

virtual void	getAbsolutePosition (int &x, int &y) const

virtual void	setParent (Widget *parent)

Font *	getFont () const

void	setFont (Font *const font)

virtual void	fontChanged ()

bool	isTabInEnabled () const

void	setTabInEnabled (const bool enabled)

bool	isTabOutEnabled () const

void	setTabOutEnabled (const bool enabled)

void	requestModalFocus ()

virtual void	requestModalMouseInputFocus ()

virtual void	releaseModalFocus ()

virtual void	releaseModalMouseInputFocus ()

virtual bool	isModalFocused () const

virtual bool	isModalMouseInputFocused () const

virtual Widget *	getWidgetAt (int x, int y)

const std::list< MouseListener * > &	getMouseListeners () const A_CONST

const std::list< KeyListener * > &	getKeyListeners () const A_CONST

const std::list< FocusListener * > &	getFocusListeners () const A_CONST

virtual Rect	getChildrenArea ()

virtual FocusHandler *	getInternalFocusHandler ()

void	setInternalFocusHandler (FocusHandler *const internalFocusHandler)

virtual void	moveToTop (Widget *widget)

virtual void	moveToBottom (Widget *widget)

virtual void	focusNext ()

virtual void	focusPrevious ()

virtual void	showWidgetPart (Widget *const widget, const Rect &area)

void	setId (const std::string &id)

const std::string &	getId () const

virtual void	showPart (const Rect &rectangle)

bool	isAllowLogic () const

void	setMouseConsume (const bool b)

bool	isMouseConsume () const

void	setRedraw (const bool b)

virtual bool	isSelectable () const

void	setSelectable (const bool selectable)

void	windowResized ()

virtual void	postInit ()

Public Member Functions inherited from Widget2
virtual	~Widget2 ()

const Color &	getThemeColor (const ThemeColorIdT type, const unsigned int alpha) const A_INLINE

const Color &	getThemeCharColor (const signed char c, bool &valid) const A_INLINE

virtual void	setWidget2 (const Widget2 *const widget)

void	setPalette (int palette)

void	checkPalette ()

void	setForegroundColor2 (const Color &color)

Widget *	getWindow () const

virtual void	setWindow (Widget *const window)

Public Member Functions inherited from MouseListener
virtual	~MouseListener ()

virtual void	mouseReleased (MouseEvent &event)

virtual void	mouseClicked (MouseEvent &event)

virtual void	mouseMoved (MouseEvent &event)

Public Member Functions inherited from KeyListener
virtual	~KeyListener ()

virtual void	keyReleased (KeyEvent &event)

Private Member Functions
void	init ()

double	markerPositionToValue (const int position) const

int	valueToMarkerPosition (const double value) const

int	getMarkerPosition () const

Private Attributes
double	mValue

double	mStepLength

double	mScaleStart

double	mScaleEnd

OrientationT	mOrientation

ImageCollection *	mVertexes

int	mMarkerLength

bool	mHasMouse

Static Private Attributes
static ImageRect	buttons [2]

static float	mAlpha = 1.0

static int	mInstances = 0

Additional Inherited Members
Static Public Member Functions inherited from Widget
static void	setGlobalFont (Font *const font)

static Font *	getGloablFont ()

static void	cleanGlobalFont ()

static bool	widgetExists (const Widget *const widget)

static void	distributeWindowResizeEvent ()

static Widget *	callPostInit (Widget *const widget)

Data Fields inherited from Widget
Visible	mVisible

Protected Types inherited from Widget
typedef std::list< MouseListener * >	MouseListenerList

typedef MouseListenerList::iterator	MouseListenerIterator

typedef std::list< KeyListener * >	KeyListenerList

typedef KeyListenerList::iterator	KeyListenerIterator

typedef std::list< ActionListener * >	ActionListenerList

typedef ActionListenerList::iterator	ActionListenerIterator

typedef std::list< WidgetDeathListener * >	WidgetDeathListenerList

typedef WidgetDeathListenerList::iterator	WidgetDeathListenerIterator

typedef std::list< FocusListener * >	FocusListenerList

typedef FocusListenerList::iterator	FocusListenerIterator

typedef std::list< WidgetListener * >	WidgetListenerList

typedef WidgetListenerList::iterator	WidgetListenerIterator

Protected Member Functions inherited from Widget
void	distributeActionEvent ()

void	distributeResizedEvent ()

void	distributeMovedEvent ()

void	distributeHiddenEvent ()

void	distributeShownEvent ()

Protected Member Functions inherited from Widget2
	Widget2 (const Widget2 *const widget)

Protected Member Functions inherited from MouseListener
	MouseListener ()

Protected Member Functions inherited from KeyListener
	KeyListener ()

Protected Attributes inherited from Widget
MouseListenerList	mMouseListeners

KeyListenerList	mKeyListeners

ActionListenerList	mActionListeners

WidgetDeathListenerList	mDeathListeners

FocusListenerList	mFocusListeners

WidgetListenerList	mWidgetListeners

Color	mForegroundColor

Color	mBackgroundColor

Color	mBaseColor

Rect	mDimension

std::string	mActionEventId

std::string	mId

FocusHandler *	mFocusHandler

FocusHandler *	mInternalFocusHandler

Widget *	mParent

Font *	mCurrentFont

unsigned int	mFrameSize

bool	mFocusable

bool	mTabIn

bool	mTabOut

bool	mEnabled

bool	mAllowLogic

bool	mMouseConsume

bool	mRedraw

bool	mSelectable

Protected Attributes inherited from Widget2
int	mPaletteOffset

Widget *	mWindow

Color	mForegroundColor2

Static Protected Attributes inherited from Widget
static Font *	mGlobalFont = 0

Detailed Description

Slider widget. Same as the Guichan slider but with custom look.

Definition at line 86 of file slider.h.

Constructor & Destructor Documentation

◆ Slider() [1/2]

Slider::Slider	(	Widget2 *const	widget,
		const double	scaleEnd,
		const double	stepLength
	)

Constructor with scale start equal to 0.

Definition at line 97 of file slider.cpp.

                                         :
     Widget(widget),
     MouseListener(),
     KeyListener(),
     mValue(0),
     mStepLength(stepLength),
     mScaleStart(0),
     mScaleEnd(scaleEnd),
     mOrientation(Orientation::HORIZONTAL),
     mVertexes(new ImageCollection),
     mMarkerLength(10),
     mHasMouse(false)
 {
     init();
 }

References init().

◆ Slider() [2/2]

Slider::Slider	(	Widget2 *const	widget,
		const double	scaleStart,
		const double	scaleEnd,
		const double	stepLength
	)

Constructor.

Definition at line 115 of file slider.cpp.

                                         :
     Widget(widget),
     MouseListener(),
     KeyListener(),
     mValue(scaleStart),
     mStepLength(stepLength),
     mScaleStart(scaleStart),
     mScaleEnd(scaleEnd),
     mOrientation(Orientation::HORIZONTAL),
     mVertexes(new ImageCollection),
     mMarkerLength(10),
     mHasMouse(false)
 {
     init();
 }

References init().

◆ ~Slider()

Slider::~Slider ( )

Destructor.

Definition at line 134 of file slider.cpp.

 {
     if (gui != nullptr)
         gui->removeDragged(this);
  
     delete2(mVertexes)
     mInstances--;
     if (mInstances == 0)
     {
         for (int mode = 0; mode < 2; mode ++)
             Theme::unloadRect(buttons[mode], 0, 8);
     }
 }

References buttons, delete2, gui, mInstances, mVertexes, Gui::removeDragged(), and Theme::unloadRect().

Member Function Documentation

◆ draw()

void Slider::draw ( Graphics *const graphics )

virtual

Draws the slider.

Implements Widget.

Definition at line 195 of file slider.cpp.

 {
     BLOCK_START("Slider::draw")
     if ((buttons[0].grid[SliderGrid::HSTART] == nullptr) ||
         (buttons[1].grid[SliderGrid::HSTART] == nullptr) ||
         (buttons[0].grid[SliderGrid::HEND] == nullptr))
     {
         BLOCK_END("Slider::draw")
         return;
     }
  
     int w = getWidth();
     const int h = getHeight();
     const int y = mHasMouse ?
         (h - buttons[1].grid[SliderGrid::HSTART]->getHeight()) / 2 :
         (h - buttons[0].grid[SliderGrid::HSTART]->getHeight()) / 2;
  
     updateAlpha();
  
     if (mRedraw || graphics->getRedraw())
     {
         int x = 0;
         mRedraw = false;
         mVertexes->clear();
         if (!mHasMouse)
         {
             graphics->calcTileCollection(mVertexes,
                 buttons[0].grid[SliderGrid::HSTART],
                 x, y);
  
             const int width = buttons[0].grid[SliderGrid::HSTART]->getWidth();
             w -= width + buttons[0].grid[SliderGrid::HEND]->getWidth();
             x += width;
  
             if (buttons[0].grid[SliderGrid::HMID] != nullptr)
             {
                 const Image *const hMid = buttons[0].grid[SliderGrid::HMID];
                 graphics->calcPattern(mVertexes,
                     hMid,
                     x, y,
                     w, hMid->getHeight());
             }
  
             x += w;
             graphics->calcTileCollection(mVertexes,
                 buttons[0].grid[SliderGrid::HEND],
                 x, y);
  
             const Image *const img = buttons[0].grid[SliderGrid::HGRIP];
             if (img != nullptr)
             {
                 graphics->calcTileCollection(mVertexes,
                     img,
                     getMarkerPosition(),
                     (mDimension.height - img->getHeight()) / 2);
             }
         }
         else
         {
             graphics->calcTileCollection(mVertexes,
                 buttons[1].grid[SliderGrid::HSTART],
                 x, y);
  
             const int width = buttons[1].grid[SliderGrid::HSTART]->getWidth();
             w -= width;
             if (buttons[1].grid[SliderGrid::HEND] != nullptr)
                 w -= buttons[1].grid[SliderGrid::HEND]->getWidth();
             x += width;
  
             if (buttons[1].grid[SliderGrid::HMID] != nullptr)
             {
                 const Image *const hMid = buttons[1].grid[SliderGrid::HMID];
                 graphics->calcPattern(mVertexes,
                     hMid,
                     x, y,
                     w, hMid->getHeight());
             }
  
             x += w;
             if (buttons[1].grid[SliderGrid::HEND] != nullptr)
             {
                 graphics->calcTileCollection(mVertexes,
                     buttons[1].grid[SliderGrid::HEND], x, y);
             }
  
             const Image *const img = buttons[1].grid[SliderGrid::HGRIP];
             if (img != nullptr)
             {
                 graphics->calcTileCollection(mVertexes,
                     img,
                     getMarkerPosition(),
                     (mDimension.height - img->getHeight()) / 2);
             }
         }
         graphics->finalize(mVertexes);
     }
     graphics->drawTileCollection(mVertexes);
  
     BLOCK_END("Slider::draw")
 }

References BLOCK_END, BLOCK_START, buttons, Graphics::calcPattern(), Graphics::calcTileCollection(), ImageCollection::clear(), Graphics::drawTileCollection(), Graphics::finalize(), Widget::getHeight(), getMarkerPosition(), Graphics::getRedraw(), Widget::getWidth(), ImageRect::grid, Rect::height, SliderGrid::HEND, SliderGrid::HGRIP, SliderGrid::HMID, SliderGrid::HSTART, Widget::mDimension, mHasMouse, Widget::mRedraw, mVertexes, updateAlpha(), x, and y.

◆ getMarkerLength()

int Slider::getMarkerLength ( ) const

inline

Gets the length of the marker.

Returns: The length of the marker.

See also: setMarkerLength

Definition at line 213 of file slider.h.

214 { return mMarkerLength; }

References mMarkerLength.

◆ getMarkerPosition()

int Slider::getMarkerPosition ( ) const

inlineprivate

Gets the marker position of the current selected value.

Returns: The marker position of the current selected value.

Definition at line 294 of file slider.h.

295 { return valueToMarkerPosition(getValue()); }

Slider::getValue

double getValue() const

Definition: slider.h:204

Slider::valueToMarkerPosition

int valueToMarkerPosition(const double value) const

Definition: slider.cpp:499

References getValue(), and valueToMarkerPosition().

Referenced by draw(), and safeDraw().

◆ getOrientation()

OrientationT Slider::getOrientation ( ) const

inline

Gets the orientation of the slider. A slider can be drawn vertically or horizontally.

Returns: The orientation of the slider.

See also: setOrientation

Definition at line 242 of file slider.h.

243 { return mOrientation; }

References mOrientation.

◆ getScaleEnd()

double Slider::getScaleEnd ( ) const

inline

Gets the end value of the scale.

Returns: The end value of the scale.

See also: setScaleEnd, setScale

Definition at line 178 of file slider.h.

179 { return mScaleEnd; }

References mScaleEnd.

◆ getScaleStart()

double Slider::getScaleStart ( ) const

inline

Gets the start value of the scale.

Returns: The start value of the scale.

See also: setScaleStart, setScale

Definition at line 160 of file slider.h.

161 { return mScaleStart; }

References mScaleStart.

Referenced by Setup_Video::action().

◆ getStepLength()

double Slider::getStepLength ( ) const

inline

Gets the step length. The step length is used when the keys LEFT and RIGHT are pressed to step in the scale.

Returns: the step length.

See also: setStepLength

Definition at line 262 of file slider.h.

263 { return mStepLength; }

References mStepLength.

◆ getValue()

double Slider::getValue ( ) const

inline

Gets the current selected value.

Returns: The current selected value.

See also: setValue

Definition at line 204 of file slider.h.

205 { return mValue; }

References mValue.

Referenced by SellDialog::action(), Setup_Colors::action(), Setup_Video::action(), BuyDialog::action(), ItemAmountWindow::action(), Setup_Video::apply(), SetupItemSlider::fromWidget(), SetupItemSlider2::fromWidget(), getMarkerPosition(), Setup_Colors::updateColor(), and SetupItemSlider2::updateLabel().

◆ init()

void Slider::init ( )

private

Used to initialize instances.

Definition at line 148 of file slider.cpp.

 {
     mAllowLogic = false;
     setFocusable(true);
     setFrameSize(1);
  
     addMouseListener(this);
     addKeyListener(this);
  
     setFrameSize(0);
  
     // Load resources
     if (mInstances == 0)
     {
         if (theme != nullptr)
         {
             for (int mode = 0; mode < 2; mode ++)
                 theme->loadRect(buttons[mode], data[mode], "slider.xml", 0, 8);
         }
         updateAlpha();
     }
  
     mInstances++;
  
     if (buttons[0].grid[SliderGrid::HGRIP] != nullptr)
         setMarkerLength(buttons[0].grid[SliderGrid::HGRIP]->getWidth());
 }

References Widget::addKeyListener(), Widget::addMouseListener(), buttons, data, Widget::getWidth(), SliderGrid::HGRIP, Theme::loadRect(), Widget::mAllowLogic, mInstances, Widget::setFocusable(), Widget::setFrameSize(), setMarkerLength(), theme, and updateAlpha().

Referenced by Slider().

◆ keyPressed()

void Slider::keyPressed ( KeyEvent & event )

virtual

Called if a key is pressed when the widget has keyboard focus. If a key is held down the widget will generate multiple key presses.

Parameters

event Discribes the event.

Reimplemented from KeyListener.

Definition at line 432 of file slider.cpp.

 {
     const InputActionT action = event.getActionId();
  
     if (mOrientation == Orientation::HORIZONTAL)
     {
         if (action == InputAction::GUI_RIGHT)
         {
             setValue(mValue + mStepLength);
             distributeActionEvent();
             event.consume();
         }
         else if (action == InputAction::GUI_LEFT)
         {
             setValue(mValue - mStepLength);
             distributeActionEvent();
             event.consume();
         }
     }
     else
     {
         if (action == InputAction::GUI_UP)
         {
             setValue(mValue + mStepLength);
             distributeActionEvent();
             event.consume();
         }
         else if (action == InputAction::GUI_DOWN)
         {
             setValue(mValue - mStepLength);
             distributeActionEvent();
             event.consume();
         }
     }
 }

References Widget::distributeActionEvent(), InputAction::GUI_DOWN, InputAction::GUI_LEFT, InputAction::GUI_RIGHT, InputAction::GUI_UP, Orientation::HORIZONTAL, mOrientation, mStepLength, mValue, and setValue().

◆ markerPositionToValue()

double Slider::markerPositionToValue ( const int position ) const

private

Converts a marker position to a value in the scale.

Parameters

position The position to convert.

Returns: A scale value corresponding to the position.

See also: valueToMarkerPosition

Definition at line 487 of file slider.cpp.

 {
     int w;
     if (mOrientation == Orientation::HORIZONTAL)
         w = mDimension.width;
     else
         w = mDimension.height;
  
     const double pos = v / (static_cast<double>(w) - mMarkerLength);
     return (1.0 - pos) * mScaleStart + pos * mScaleEnd;
 }

References Rect::height, Orientation::HORIZONTAL, Widget::mDimension, mMarkerLength, mOrientation, mScaleEnd, mScaleStart, and Rect::width.

Referenced by mouseDragged(), and mousePressed().

◆ mouseDragged()

void Slider::mouseDragged ( MouseEvent & event )

virtual

Called when the mouse has moved and the mouse has previously been pressed on the widget.

Parameters

event Describes the event.

Reimplemented from MouseListener.

Definition at line 401 of file slider.cpp.

 {
     if (mOrientation == Orientation::HORIZONTAL)
     {
         setValue(markerPositionToValue(event.getX() - mMarkerLength / 2));
     }
     else
     {
         setValue(markerPositionToValue(
             mDimension.height - event.getY() - mMarkerLength / 2));
     }
  
     distributeActionEvent();
  
     event.consume();
 }

References Widget::distributeActionEvent(), MouseEvent::getX(), MouseEvent::getY(), Rect::height, Orientation::HORIZONTAL, markerPositionToValue(), Widget::mDimension, mMarkerLength, mOrientation, and setValue().

◆ mouseEntered()

void Slider::mouseEntered ( MouseEvent & event )

virtual

Called when the mouse enteres the widget area.

Reimplemented from MouseListener.

Definition at line 370 of file slider.cpp.

 {
     mHasMouse = true;
     mRedraw = true;
 }

References mHasMouse, and Widget::mRedraw.

◆ mouseExited()

void Slider::mouseExited ( MouseEvent & event )

virtual

Called when the mouse leaves the widget area.

Reimplemented from MouseListener.

Definition at line 376 of file slider.cpp.

 {
     mHasMouse = false;
     mRedraw = true;
 }

References mHasMouse, and Widget::mRedraw.

◆ mousePressed()

void Slider::mousePressed ( MouseEvent & event )

virtual

Called when a mouse button has been pressed on the widget area.

NOTE: A mouse press is NOT equal to a mouse click. Use mouseClickMessage to check for mouse clicks.

Parameters

event Describes the event.

Reimplemented from MouseListener.

Definition at line 382 of file slider.cpp.

 {
     const int x = event.getX();
     const int y = event.getY();
     const int width = mDimension.width;
     const int height = mDimension.height;
  
     if (event.getButton() == MouseButton::LEFT
         && x >= 0 && x <= width && y >= 0 && y <= height)
     {
         event.consume();
         if (mOrientation == Orientation::HORIZONTAL)
             setValue(markerPositionToValue(x - mMarkerLength / 2));
         else
             setValue(markerPositionToValue(height - y - mMarkerLength / 2));
         distributeActionEvent();
     }
 }

References Widget::distributeActionEvent(), MouseEvent::getButton(), Rect::height, Orientation::HORIZONTAL, MouseButton::LEFT, markerPositionToValue(), Widget::mDimension, mMarkerLength, mOrientation, setValue(), Rect::width, x, and y.

◆ mouseWheelMovedDown()

void Slider::mouseWheelMovedDown ( MouseEvent & event )

virtual

Called when the mouse wheel has moved down on the widget area.

Parameters

event Describes the event.

Reimplemented from MouseListener.

Definition at line 425 of file slider.cpp.

 {
     setValue(mValue - mStepLength);
     distributeActionEvent();
     event.consume();
 }

References Widget::distributeActionEvent(), mStepLength, mValue, and setValue().

◆ mouseWheelMovedUp()

void Slider::mouseWheelMovedUp ( MouseEvent & event )

virtual

Called when the mouse wheel has moved up on the widget area.

Parameters

event Describes the event.

Reimplemented from MouseListener.

Definition at line 418 of file slider.cpp.

 {
     setValue(mValue + mStepLength);
     distributeActionEvent();
     event.consume();
 }

References Widget::distributeActionEvent(), mStepLength, mValue, and setValue().

◆ safeDraw()

void Slider::safeDraw ( Graphics *const graphics )

virtual

Implements Widget.

Definition at line 296 of file slider.cpp.

 {
     BLOCK_START("Slider::draw")
     if ((buttons[0].grid[SliderGrid::HSTART] == nullptr) ||
         (buttons[1].grid[SliderGrid::HSTART] == nullptr) ||
         (buttons[0].grid[SliderGrid::HEND] == nullptr))
     {
         BLOCK_END("Slider::draw")
         return;
     }
  
     int w = getWidth();
     const int h = getHeight();
     int x = 0;
     const int y = mHasMouse ?
         (h - buttons[1].grid[SliderGrid::HSTART]->getHeight()) / 2 :
         (h - buttons[0].grid[SliderGrid::HSTART]->getHeight()) / 2;
  
     updateAlpha();
  
     if (!mHasMouse)
     {
         graphics->drawImage(buttons[0].grid[SliderGrid::HSTART], x, y);
         const int width = buttons[0].grid[SliderGrid::HSTART]->getWidth();
         w -= width + buttons[0].grid[SliderGrid::HEND]->getWidth();
         x += width;
  
         if (buttons[0].grid[SliderGrid::HMID] != nullptr)
         {
             const Image *const hMid = buttons[0].grid[SliderGrid::HMID];
             graphics->drawPattern(hMid, x, y, w, hMid->getHeight());
         }
  
         x += w;
         graphics->drawImage(buttons[0].grid[SliderGrid::HEND], x, y);
  
         const Image *const img = buttons[0].grid[SliderGrid::HGRIP];
         if (img != nullptr)
         {
             graphics->drawImage(img, getMarkerPosition(),
                 (mDimension.height - img->getHeight()) / 2);
         }
     }
     else
     {
         graphics->drawImage(buttons[1].grid[SliderGrid::HSTART], x, y);
  
         const int width = buttons[1].grid[SliderGrid::HSTART]->getWidth();
         w -= width;
         if (buttons[1].grid[SliderGrid::HEND] != nullptr)
             w -= buttons[1].grid[SliderGrid::HEND]->getWidth();
         x += width;
  
         if (buttons[1].grid[SliderGrid::HMID] != nullptr)
         {
             const Image *const hMid = buttons[1].grid[SliderGrid::HMID];
             graphics->drawPattern(hMid, x, y, w, hMid->getHeight());
         }
  
         x += w;
         if (buttons[1].grid[SliderGrid::HEND] != nullptr)
             graphics->drawImage(buttons[1].grid[SliderGrid::HEND], x, y);
  
         const Image *const img = buttons[1].grid[SliderGrid::HGRIP];
         if (img != nullptr)
         {
             graphics->drawImage(img, getMarkerPosition(),
                 (mDimension.height - img->getHeight()) / 2);
         }
     }
  
     BLOCK_END("Slider::draw")
 }

References BLOCK_END, BLOCK_START, buttons, Graphics::drawImage(), Graphics::drawPattern(), Widget::getHeight(), getMarkerPosition(), Widget::getWidth(), ImageRect::grid, Rect::height, SliderGrid::HEND, SliderGrid::HGRIP, SliderGrid::HMID, SliderGrid::HSTART, Widget::mDimension, mHasMouse, updateAlpha(), x, and y.

◆ setMarkerLength()

void Slider::setMarkerLength ( const int length )

inline

Sets the length of the marker.

Parameters

length The length for the marker.

See also: getMarkerLength

Definition at line 222 of file slider.h.

223 { mMarkerLength = length; }

References mMarkerLength.

Referenced by init().

◆ setOrientation()

void Slider::setOrientation ( const OrientationT orientation )

inline

Sets the orientation of the slider. A slider can be drawn vertically or horizontally.

Parameters

orientation The orientation of the slider.

See also: getOrientation

Definition at line 232 of file slider.h.

233 { mOrientation = orientation; }

References mOrientation.

◆ setScale()

void Slider::setScale	(	const double	scaleStart,
		const double	scaleEnd
	)

Sets the scale of the slider.

Parameters

scaleStart	The start value of the scale.
scaleEnd	tThe end of value the scale.

See also: getScaleStart, getScaleEnd

Definition at line 468 of file slider.cpp.

 {
     mScaleStart = scaleStart;
     mScaleEnd = scaleEnd;
 }

References mScaleEnd, and mScaleStart.

Referenced by BuyDialog::updateSlider(), SellDialog::valueChanged(), Setup_Colors::valueChanged(), and BuyDialog::valueChanged().

◆ setScaleEnd()

void Slider::setScaleEnd ( const double scaleEnd )

inline

Sets the end value of the scale.

Parameters

scaleEnd The end value of the scale.

See also: getScaleEnd

Definition at line 187 of file slider.h.

188 { mScaleEnd = scaleEnd; }

References mScaleEnd.

◆ setScaleStart()

void Slider::setScaleStart ( const double scaleStart )

inline

Sets the start value of the scale.

Parameters

scaleStart The start value of the scale.

See also: getScaleStart

Definition at line 169 of file slider.h.

170 { mScaleStart = scaleStart; }

References mScaleStart.

◆ setStepLength()

void Slider::setStepLength ( const double length )

inline

Sets the step length. The step length is used when the keys LEFT and RIGHT are pressed to step in the scale.

Parameters

length The step length.

See also: getStepLength

Definition at line 252 of file slider.h.

253 { mStepLength = length; }

References mStepLength.

◆ setValue()

void Slider::setValue ( const double value )

Sets the current selected value.

Parameters

value The current selected value.

See also: getValue

Definition at line 474 of file slider.cpp.

 {
     mRedraw = true;
     if (value > mScaleEnd)
         mValue = mScaleEnd;
     else if (value < mScaleStart)
         mValue = mScaleStart;
     else
         mValue = value;
     mValue = CAST_S32((mValue - mScaleStart) / mStepLength)
         * mStepLength + mScaleStart;
 }

References CAST_S32, Widget::mRedraw, mScaleEnd, mScaleStart, mStepLength, and mValue.

Referenced by SellDialog::action(), Setup_Video::action(), BuyDialog::action(), ItemAmountWindow::action(), Setup_Colors::cancel(), Setup_Video::cancel(), SetupItemSlider::createControls(), SetupItemSlider2::createControls(), keyPressed(), ItemAmountWindow::keyReleased(), mouseDragged(), mousePressed(), mouseWheelMovedDown(), mouseWheelMovedUp(), SellDialog::reset(), BuyDialog::reset(), NpcSellDialog::sellOneItem(), Setup_Colors::setEntry(), Setup_Colors::Setup_Colors(), Setup_Video::Setup_Video(), SetupItemSlider::toWidget(), SetupItemSlider2::toWidget(), BuyDialog::updateSlider(), SellDialog::valueChanged(), Setup_Colors::valueChanged(), and BuyDialog::valueChanged().

◆ updateAlpha()

void Slider::updateAlpha ( )

Update the alpha value to the graphic components.

Definition at line 176 of file slider.cpp.

 {
     const float alpha = std::max(settings.guiAlpha,
         theme->getMinimumOpacity());
  
     if (alpha != mAlpha)
     {
         mAlpha = alpha;
         for (int f = 0; f < 2; f ++)
         {
             for (int d = 0; d < SliderGrid::SLIDER_MAX; d ++)
             {
                 if (buttons[f].grid[d] != nullptr)
                     buttons[f].grid[d]->setAlpha(mAlpha);
             }
         }
     }
 }

References buttons, Theme::getMinimumOpacity(), ImageRect::grid, Settings::guiAlpha, mAlpha, settings, SliderGrid::SLIDER_MAX, and theme.

Referenced by draw(), init(), and safeDraw().

◆ valueToMarkerPosition()

int Slider::valueToMarkerPosition ( const double value ) const

private

Converts a value to a marker position.

Parameters

value The value to convert.

Returns: A marker position corresponding to the value.

See also: markerPositionToValue

Definition at line 499 of file slider.cpp.

 {
     int v;
     if (mOrientation == Orientation::HORIZONTAL)
         v = mDimension.width;
     else
         v = mDimension.height;
  
     const int w = CAST_S32((v - mMarkerLength)
             * (value  - mScaleStart)
             / (mScaleEnd - mScaleStart));
  
     if (w < 0)
         return 0;
  
     if (w > v - mMarkerLength)
         return v - mMarkerLength;
  
     return w;
 }

References CAST_S32, Rect::height, Orientation::HORIZONTAL, Widget::mDimension, mMarkerLength, mOrientation, mScaleEnd, mScaleStart, and Rect::width.

Referenced by getMarkerPosition().

Field Documentation

◆ buttons

ImageRect Slider::buttons

staticprivate

Definition at line 297 of file slider.h.

Referenced by draw(), init(), safeDraw(), updateAlpha(), and ~Slider().

◆ mAlpha

float Slider::mAlpha = 1.0

staticprivate

Definition at line 298 of file slider.h.

Referenced by updateAlpha().

◆ mHasMouse

bool Slider::mHasMouse

private

Definition at line 335 of file slider.h.

Referenced by draw(), mouseEntered(), mouseExited(), and safeDraw().

◆ mInstances

int Slider::mInstances = 0

staticprivate

Definition at line 299 of file slider.h.

Referenced by init(), and ~Slider().

◆ mMarkerLength

int Slider::mMarkerLength

private

Holds the length of the marker.

Definition at line 333 of file slider.h.

Referenced by getMarkerLength(), markerPositionToValue(), mouseDragged(), mousePressed(), setMarkerLength(), and valueToMarkerPosition().

◆ mOrientation

OrientationT Slider::mOrientation

private

Holds the orientation of the slider. A slider can be drawn vertically or horizontally.

Definition at line 326 of file slider.h.

Referenced by getOrientation(), keyPressed(), markerPositionToValue(), mouseDragged(), mousePressed(), setOrientation(), and valueToMarkerPosition().

◆ mScaleEnd

double Slider::mScaleEnd

private

Holds the end value of the scale.

Definition at line 320 of file slider.h.

Referenced by getScaleEnd(), markerPositionToValue(), setScale(), setScaleEnd(), setValue(), and valueToMarkerPosition().

◆ mScaleStart

double Slider::mScaleStart

private

Holds the start value of the scale.

Definition at line 315 of file slider.h.

Referenced by getScaleStart(), markerPositionToValue(), setScale(), setScaleStart(), setValue(), and valueToMarkerPosition().

◆ mStepLength

double Slider::mStepLength

private

Holds the step length. The step length is used when the keys LEFT and RIGHT are pressed to step in the scale.

Definition at line 310 of file slider.h.

Referenced by getStepLength(), keyPressed(), mouseWheelMovedDown(), mouseWheelMovedUp(), setStepLength(), and setValue().

◆ mValue

double Slider::mValue

private

Holds the current selected value.

Definition at line 304 of file slider.h.

Referenced by getValue(), keyPressed(), mouseWheelMovedDown(), mouseWheelMovedUp(), and setValue().

◆ mVertexes

ImageCollection* Slider::mVertexes

private

Definition at line 328 of file slider.h.

Referenced by draw(), and ~Slider().

The documentation for this class was generated from the following files:

src/gui/widgets/slider.h (986a3bf)
src/gui/widgets/slider.cpp (986a3bf)

Public Member Functions

Private Member Functions

Private Attributes

Static Private Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ Slider() [1/2]

◆ Slider() [2/2]

◆ ~Slider()

Member Function Documentation

◆ draw()

◆ getMarkerLength()

◆ getMarkerPosition()

◆ getOrientation()

◆ getScaleEnd()

◆ getScaleStart()

◆ getStepLength()

◆ getValue()

◆ init()

◆ keyPressed()

◆ markerPositionToValue()

◆ mouseDragged()

◆ mouseEntered()

◆ mouseExited()

◆ mousePressed()

◆ mouseWheelMovedDown()

◆ mouseWheelMovedUp()

◆ safeDraw()

◆ setMarkerLength()

◆ setOrientation()

◆ setScale()

◆ setScaleEnd()

◆ setScaleStart()

◆ setStepLength()

◆ setValue()

◆ updateAlpha()

◆ valueToMarkerPosition()

Field Documentation

◆ buttons

◆ mAlpha

◆ mHasMouse

◆ mInstances

◆ mMarkerLength

◆ mOrientation

◆ mScaleEnd

◆ mScaleStart

◆ mStepLength

◆ mValue

◆ mVertexes