[−][src]Struct gdnative::api::Slider
core class Slider
inherits Range
(unsafe).
Official documentation
See the documentation of this class in the Godot engine's official documentation.
Class hierarchy
Slider inherits methods from:
Safety
All types in the Godot API have "interior mutability" in Rust parlance.
To enforce that the official thread-safety guidelines are
followed, the typestate pattern is used in the Ref
and TRef
smart pointers,
and the Instance
API. The typestate Access
in these types tracks whether the
access is unique, shared, or exclusive to the current thread. For more information,
see the type-level documentation on Ref
.
Implementations
impl Slider
[src]
pub fn ticks(&self) -> i64
[src]
Number of ticks displayed on the slider, including border ticks. Ticks are uniformly-distributed value markers.
pub fn ticks_on_borders(&self) -> bool
[src]
If [code]true[/code], the slider will display ticks for minimum and maximum values.
pub fn is_editable(&self) -> bool
[src]
If [code]true[/code], the slider can be interacted with. If [code]false[/code], the value can be changed only by code.
pub fn is_scrollable(&self) -> bool
[src]
If [code]true[/code], the value can be changed using the mouse wheel.
pub fn set_editable(&self, editable: bool)
[src]
If [code]true[/code], the slider can be interacted with. If [code]false[/code], the value can be changed only by code.
pub fn set_scrollable(&self, scrollable: bool)
[src]
If [code]true[/code], the value can be changed using the mouse wheel.
pub fn set_ticks(&self, count: i64)
[src]
Number of ticks displayed on the slider, including border ticks. Ticks are uniformly-distributed value markers.
pub fn set_ticks_on_borders(&self, ticks_on_border: bool)
[src]
If [code]true[/code], the slider will display ticks for minimum and maximum values.
Methods from Deref<Target = Range>
pub fn as_ratio(&self) -> f64
[src]
The value mapped between 0 and 1.
pub fn max(&self) -> f64
[src]
Maximum value. Range is clamped if [code]value[/code] is greater than [code]max_value[/code].
pub fn min(&self) -> f64
[src]
Minimum value. Range is clamped if [code]value[/code] is less than [code]min_value[/code].
pub fn page(&self) -> f64
[src]
Page size. Used mainly for [ScrollBar]. ScrollBar's length is its size multiplied by [code]page[/code] over the difference between [code]min_value[/code] and [code]max_value[/code].
pub fn step(&self) -> f64
[src]
If greater than 0, [code]value[/code] will always be rounded to a multiple of [code]step[/code]. If [code]rounded[/code] is also [code]true[/code], [code]value[/code] will first be rounded to a multiple of [code]step[/code] then rounded to the nearest integer.
pub fn value(&self) -> f64
[src]
Range's current value.
pub fn is_greater_allowed(&self) -> bool
[src]
If [code]true[/code], [member value] may be greater than [member max_value].
pub fn is_lesser_allowed(&self) -> bool
[src]
If [code]true[/code], [member value] may be less than [member min_value].
pub fn is_ratio_exp(&self) -> bool
[src]
If [code]true[/code], and [code]min_value[/code] is greater than 0, [code]value[/code] will be represented exponentially rather than linearly.
pub fn is_using_rounded_values(&self) -> bool
[src]
If [code]true[/code], [code]value[/code] will always be rounded to the nearest integer.
pub fn set_allow_greater(&self, allow: bool)
[src]
If [code]true[/code], [member value] may be greater than [member max_value].
pub fn set_allow_lesser(&self, allow: bool)
[src]
If [code]true[/code], [member value] may be less than [member min_value].
pub fn set_as_ratio(&self, value: f64)
[src]
The value mapped between 0 and 1.
pub fn set_exp_ratio(&self, enabled: bool)
[src]
If [code]true[/code], and [code]min_value[/code] is greater than 0, [code]value[/code] will be represented exponentially rather than linearly.
pub fn set_max(&self, maximum: f64)
[src]
Maximum value. Range is clamped if [code]value[/code] is greater than [code]max_value[/code].
pub fn set_min(&self, minimum: f64)
[src]
Minimum value. Range is clamped if [code]value[/code] is less than [code]min_value[/code].
pub fn set_page(&self, pagesize: f64)
[src]
Page size. Used mainly for [ScrollBar]. ScrollBar's length is its size multiplied by [code]page[/code] over the difference between [code]min_value[/code] and [code]max_value[/code].
pub fn set_step(&self, step: f64)
[src]
If greater than 0, [code]value[/code] will always be rounded to a multiple of [code]step[/code]. If [code]rounded[/code] is also [code]true[/code], [code]value[/code] will first be rounded to a multiple of [code]step[/code] then rounded to the nearest integer.
pub fn set_use_rounded_values(&self, enabled: bool)
[src]
If [code]true[/code], [code]value[/code] will always be rounded to the nearest integer.
pub fn set_value(&self, value: f64)
[src]
Range's current value.
pub fn share(&self, with: impl AsArg<Node>)
[src]
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.
pub fn unshare(&self)
[src]
Stops range from sharing its member variables with any other.
Trait Implementations
impl Debug for Slider
[src]
impl Deref for Slider
[src]
impl DerefMut for Slider
[src]
impl GodotObject for Slider
[src]
type RefKind = ManuallyManaged
The memory management kind of this type. This modifies the behavior of the
Ref
smart pointer. See its type-level documentation for more
information. Read more
fn class_name() -> &'static str
[src]
fn null() -> Null<Self>
[src]
fn new() -> Ref<Self, Unique> where
Self: Instanciable,
[src]
Self: Instanciable,
fn cast<T>(&self) -> Option<&T> where
T: GodotObject + SubClass<Self>,
[src]
T: GodotObject + SubClass<Self>,
fn upcast<T>(&self) -> &T where
Self: SubClass<T>,
T: GodotObject,
[src]
Self: SubClass<T>,
T: GodotObject,
unsafe fn assume_shared(&self) -> Ref<Self, Shared>
[src]
unsafe fn assume_thread_local(&self) -> Ref<Self, ThreadLocal> where
Self: GodotObject<RefKind = RefCounted>,
[src]
Self: GodotObject<RefKind = RefCounted>,
unsafe fn assume_unique(&self) -> Ref<Self, Unique>
[src]
impl QueueFree for Slider
[src]
unsafe fn godot_queue_free(obj: *mut c_void)
[src]
impl SubClass<CanvasItem> for Slider
[src]
impl SubClass<Control> for Slider
[src]
impl SubClass<Node> for Slider
[src]
impl SubClass<Object> for Slider
[src]
impl SubClass<Range> for Slider
[src]
impl SubClass<Slider> for HSlider
[src]
impl SubClass<Slider> for VSlider
[src]
Auto Trait Implementations
impl RefUnwindSafe for Slider
impl !Send for Slider
impl !Sync for Slider
impl Unpin for Slider
impl UnwindSafe for Slider
Blanket Implementations
impl<T> Any for T where
T: 'static + ?Sized,
[src]
T: 'static + ?Sized,
impl<T> Borrow<T> for T where
T: ?Sized,
[src]
T: ?Sized,
impl<T> BorrowMut<T> for T where
T: ?Sized,
[src]
T: ?Sized,
fn borrow_mut(&mut self) -> &mut T
[src]
impl<T> From<T> for T
[src]
impl<T, U> Into<U> for T where
U: From<T>,
[src]
U: From<T>,
impl<T> SubClass<T> for T where
T: GodotObject,
[src]
T: GodotObject,
impl<T, U> TryFrom<U> for T where
U: Into<T>,
[src]
U: Into<T>,
type Error = Infallible
The type returned in the event of a conversion error.
fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>
[src]
impl<T, U> TryInto<U> for T where
U: TryFrom<T>,
[src]
U: TryFrom<T>,