Abstract base class for range-based controls.
    public abstract class Range : Control

Range is a base class for Control nodes that change a floating-point value between a minimum and a maximum, using step and page, for example a ScrollBar.

Inheritance Chain

Derived Classes

Signals

    "changed" ()

Emitted when MinValue, MaxValue, Page, or Step change.

    "value_changed" (float value)

Emitted when Value changes.

Properties

    public bool AllowGreater { get; set; }

If true, Value may be greater than MaxValue.

    public bool AllowLesser { get; set; }

If true, Value may be less than MinValue.

    public bool ExpEdit { get; set; }

If true, and min_value is greater than 0, value will be represented exponentially rather than linearly.

    public double MaxValue { get; set; }

Maximum value. Range is clamped if value is greater than max_value.

    public double MinValue { get; set; }

Minimum value. Range is clamped if value is less than min_value.

    public double Page { get; set; }

Page size. Used mainly for ScrollBar. ScrollBar’s length is its size multiplied by page over the difference between min_value and max_value.

    public double Ratio { get; set; }

The value mapped between 0 and 1.

    public bool Rounded { get; set; }

If true, value will always be rounded to the nearest integer.

    public double Step { get; set; }

If greater than 0, value will always be rounded to a multiple of step. If rounded is also true, value will first be rounded to a multiple of step then rounded to the nearest integer.

    public double Value { get; set; }

Range’s current value.

Methods

    [Obsolete("GetAsRatio is deprecated. Use the Ratio property instead.")]
    public double GetAsRatio()

    [Obsolete("GetMax is deprecated. Use the MaxValue property instead.")]
    public double GetMax()

    [Obsolete("GetMin is deprecated. Use the MinValue property instead.")]
    public double GetMin()

    [Obsolete("GetPage is deprecated. Use the Page property instead.")]
    public double GetPage()

    [Obsolete("GetStep is deprecated. Use the Step property instead.")]
    public double GetStep()

    [Obsolete("GetValue is deprecated. Use the Value property instead.")]
    public double GetValue()

    [Obsolete("IsGreaterAllowed is deprecated. Use the AllowGreater property instead.")]
    public bool IsGreaterAllowed()

Getter for AllowGreater

    [Obsolete("IsLesserAllowed is deprecated. Use the AllowLesser property instead.")]
    public bool IsLesserAllowed()

Getter for AllowLesser

    [Obsolete("IsRatioExp is deprecated. Use the ExpEdit property instead.")]
    public bool IsRatioExp()

Getter for ExpEdit

    [Obsolete("IsUsingRoundedValues is deprecated. Use the Rounded property instead.")]
    public bool IsUsingRoundedValues()

Getter for Rounded

    [Obsolete("SetAllowGreater is deprecated. Use the AllowGreater property instead.")]
    public void SetAllowGreater(bool allow)

Setter for AllowGreater

    [Obsolete("SetAllowLesser is deprecated. Use the AllowLesser property instead.")]
    public void SetAllowLesser(bool allow)

Setter for AllowLesser

    [Obsolete("SetAsRatio is deprecated. Use the Ratio property instead.")]
    public void SetAsRatio(double value)

    [Obsolete("SetExpRatio is deprecated. Use the ExpEdit property instead.")]
    public void SetExpRatio(bool enabled)

Setter for ExpEdit

    [Obsolete("SetMax is deprecated. Use the MaxValue property instead.")]
    public void SetMax(double maximum)

    [Obsolete("SetMin is deprecated. Use the MinValue property instead.")]
    public void SetMin(double minimum)

    [Obsolete("SetPage is deprecated. Use the Page property instead.")]
    public void SetPage(double pagesize)

    [Obsolete("SetStep is deprecated. Use the Step property instead.")]
    public void SetStep(double step)

    [Obsolete("SetUseRoundedValues is deprecated. Use the Rounded property instead.")]
    public void SetUseRoundedValues(bool enabled)

Setter for Rounded

    [Obsolete("SetValue is deprecated. Use the Value property instead.")]
    public void SetValue(double value)

    public void Share(Node with)

Binds two ranges together along with any ranges previously grouped with either of them. When any of range’s member variables change, it will share the new value with all other ranges in its group.

    public void Unshare()

Stops range from sharing its member variables with any other.

Tags: