Unigine::WidgetSlider Class

WidgetSlider Class

Members

---

static WidgetSliderPtr create ( const Ptr<Gui> & gui, int min = 0, int max = 100, int value = 0 ) #

Constructor. Creates a slider with given properties (horizontal one by default) and adds it to the specified GUI.

Arguments

• const Ptr<Gui> & gui - GUI, to which the slider will belong.
• int min - Minimum value.
• int max - Maximum value.
• int value - Initial value.

static WidgetSliderPtr create ( int min = 0, int max = 100, int value = 0 ) #

Constructor. Creates a slider with given properties (horizontal one by default) and adds it to the Engine GUI.

Arguments

• int min - Minimum value.
• int max - Maximum value.
• int value - Initial value.

void setButtonHeight ( int height ) #

Sets the height of the slider handle in pixels (for a vertical slider).

Arguments

• int height - Height of the handle in pixels.

int getButtonHeight ( ) const#

Returns the height of the slider handle in pixels (for a vertical slider).

Return value

Height of the handle in pixels.

void setButtonWidth ( int width ) #

Sets width of the slider handle in pixels (for a horizontal slider).

Arguments

• int width - Width of the handle in pixels.

int getButtonWidth ( ) const#

Returns the width of the slider handle in pixels (for a horizontal slider).

Return value

Width of the handle in pixels.

void setMaxExpand ( int expand ) #

Sets the maximum value, up to which the upper limit of the range of the slider values can be expanded.

Arguments

• int expand - Maximum value, up to which the slider's upper limit can be raised.

int getMaxExpand ( ) const#

Returns the current maximum value, up to which the upper limit of the range of the slider values can be expanded. The upper limit of the slider can be expanded only if the slider is attached to an editline with the Gui::ATTACH_MAX_EXPAND flag.

Return value

Maximum value, up to which the slider's upper limit can be raised.

void setMaxValue ( int value ) #

Sets the maximum value for the slider.

Arguments

• int value - Maximum value.

int getMaxValue ( ) const#

Returns the maximum value of the slider.

Return value

Maximum value.

void setMinExpand ( int expand ) #

Sets the minimum value, up to which the lower limit of the range of the slider values can be expanded.

Arguments

• int expand - Minimum value, up to which the slider's lower limit can be dropped.

int getMinExpand ( ) const#

Returns the minimum value, up to which the lower limit of the range of the slider values can be expanded. The lower limit of the slider can be expanded only if the slider is attached to an editline with the Gui::ATTACH_MIN_EXPAND flag.

Return value

Minimum value, up to which the slider's lower limit can be dropped.

void setMinValue ( int value ) #

Sets the minimum value for the slider.

Arguments

• int value - Minimum value.

int getMinValue ( ) const#

Returns the minimum value of the slider.

Return value

Minimum value.

void setOrientation ( int orientation ) #

Sets orientation of the slider: horizontal (by default) or vertical one.

Arguments

• int orientation - 1 to set horizontal orientation; 0 to set vertical one.

int getOrientation ( ) const#

Returns the current orientation of the slider: horizontal or vertical one.

Return value

1 if the orientation is vertical; 0 if it is horizontal.

void setValue ( int value ) #

Sets a new current value for the slider, i.e. its position.

Arguments

• int value - Slider value.

int getValue ( ) const#

Returns the current value of the slider, i.e. its position.

Return value

Current slider value.

void setBackgroundColor ( const Math::vec4 & color ) #

Sets the background color to be used for the widget.

Arguments

• const Math::vec4 & color - Four-component vector specifying the color in the RGBA format.

Math::vec4 getBackgroundColor ( ) const#

Returns the current background color used for the widget.

Return value

Four-component vector specifying the color in the RGBA format.

void setButtonColor ( const Math::vec4 & color ) #

Sets the color for the widget's button.

Arguments

• const Math::vec4 & color - Four-component vector specifying the color in the RGBA format.

Math::vec4 getButtonColor ( ) const#

Returns the current color for the widget's button.

Return value

Four-component vector specifying the color in the RGBA format.