com.badlogic.gdx.scenes.scene2d.ui

Class Slider

java.lang.Object

com.badlogic.gdx.scenes.scene2d.Actor

com.badlogic.gdx.scenes.scene2d.ui.Widget

com.badlogic.gdx.scenes.scene2d.ui.ProgressBar

com.badlogic.gdx.scenes.scene2d.ui.Slider

All Implemented Interfaces:

Disableable, Layout

public class Slider
extends ProgressBar

A slider is a horizontal indicator that allows a user to set a value. The slider has a range (min, max) and a stepping between each value the slider represents.

ChangeListener.ChangeEvent is fired when the slider knob is moved. Canceling the event will move the knob to where it was previously.

For a horizontal progress bar, its preferred height is determined by the larger of the knob and background, and the preferred width is 140, a relatively arbitrary size. These parameters are reversed for a vertical progress bar.

Author:

mzechner, Nathan Sweet

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	Slider.SliderStyle The style for a slider, see Slider.

Nested classes/interfaces inherited from class com.badlogic.gdx.scenes.scene2d.ui.ProgressBar

ProgressBar.ProgressBarStyle

Constructor Summary

Constructors

Constructor and Description
Slider(float min, float max, float stepSize, boolean vertical, Skin skin)
Slider(float min, float max, float stepSize, boolean vertical, Skin skin, String styleName)
Slider(float min, float max, float stepSize, boolean vertical, Slider.SliderStyle style) Creates a new slider.

Method Summary

Modifier and Type	Method and Description
Slider.SliderStyle	getStyle() Returns the slider's style.
boolean	isDragging() Returns true if the slider is being dragged.
boolean	isOver()
void	setButton(int button) Sets the mouse button, which can trigger a change of the slider.
void	setSnapToValues(float[] values, float threshold) Will make this progress bar snap to the specified values, if the knob is within the threshold.
void	setVisualInterpolationInverse(Interpolation interpolation) Sets the inverse interpolation to use for display.
void	setVisualPercent(float percent) Sets the value using the specified visual percent.

Methods inherited from class com.badlogic.gdx.scenes.scene2d.ui.ProgressBar

act, draw, getMaxValue, getMinValue, getPercent, getPrefHeight, getPrefWidth, getStepSize, getValue, getVisualPercent, getVisualValue, isAnimating, isDisabled, isVertical, setAnimateDuration, setAnimateInterpolation, setDisabled, setProgrammaticChangeEvents, setRange, setRound, setStepSize, setStyle, setValue, setVisualInterpolation, updateVisualValue

Methods inherited from class com.badlogic.gdx.scenes.scene2d.ui.Widget

getMaxHeight, getMaxWidth, getMinHeight, getMinWidth, invalidate, invalidateHierarchy, layout, needsLayout, pack, setFillParent, setLayoutEnabled, validate

Methods inherited from class com.badlogic.gdx.scenes.scene2d.Actor

addAction, addCaptureListener, addListener, ancestorsVisible, ascendantsVisible, clear, clearActions, clearListeners, clipBegin, clipBegin, clipEnd, debug, drawDebug, fire, firstAscendant, getActions, getCaptureListeners, getColor, getDebug, getHeight, getListeners, getName, getOriginX, getOriginY, getParent, getRight, getRotation, getScaleX, getScaleY, getStage, getTop, getTouchable, getUserObject, getWidth, getX, getX, getY, getY, getZIndex, hasActions, hasKeyboardFocus, hasParent, hasScrollFocus, hit, isAscendantOf, isDescendantOf, isTouchable, isTouchFocusListener, isTouchFocusTarget, isVisible, localToActorCoordinates, localToAscendantCoordinates, localToParentCoordinates, localToScreenCoordinates, localToStageCoordinates, moveBy, notify, parentToLocalCoordinates, remove, removeAction, removeCaptureListener, removeListener, rotateBy, scaleBy, scaleBy, screenToLocalCoordinates, setBounds, setColor, setColor, setDebug, setHeight, setName, setOrigin, setOrigin, setOriginX, setOriginY, setPosition, setPosition, setRotation, setScale, setScale, setScaleX, setScaleY, setSize, setTouchable, setUserObject, setVisible, setWidth, setX, setX, setY, setY, setZIndex, sizeBy, sizeBy, stageToLocalCoordinates, toBack, toFront, toString

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

Slider

public Slider(float min,
              float max,
              float stepSize,
              boolean vertical,
              Skin skin)

Slider

public Slider(float min,
              float max,
              float stepSize,
              boolean vertical,
              Skin skin,
              String styleName)

Slider

public Slider(float min,
              float max,
              float stepSize,
              boolean vertical,
              Slider.SliderStyle style)

Creates a new slider. If horizontal, its width is determined by the prefWidth parameter, its height is determined by the maximum of the height of either the slider NinePatch or slider handle TextureRegion. The min and max values determine the range the values of this slider can take on, the stepSize parameter specifies the distance between individual values. E.g. min could be 4, max could be 10 and stepSize could be 0.2, giving you a total of 30 values, 4.0 4.2, 4.4 and so on.

Parameters:

min - the minimum value

max - the maximum value

stepSize - the step size between values

style - the Slider.SliderStyle

Method Detail

getStyle

public Slider.SliderStyle getStyle()

Returns the slider's style. Modifying the returned style may not have an effect until ProgressBar.setStyle(ProgressBarStyle) is called.

Overrides:

getStyle in class ProgressBar

isOver

public boolean isOver()

setSnapToValues

public void setSnapToValues(@Null
                            float[] values,
                            float threshold)

Will make this progress bar snap to the specified values, if the knob is within the threshold.

Parameters:

values - May be null.

isDragging

public boolean isDragging()

Returns true if the slider is being dragged.

setButton

public void setButton(int button)

Sets the mouse button, which can trigger a change of the slider. Is -1, so every button, by default.

setVisualInterpolationInverse

public void setVisualInterpolationInverse(Interpolation interpolation)

Sets the inverse interpolation to use for display. This should perform the inverse of the visual interpolation.

setVisualPercent

public void setVisualPercent(float percent)

Sets the value using the specified visual percent.

See Also:

ProgressBar.setVisualInterpolation(Interpolation)