godot::prelude

Enum Vector2Axis

#[repr(i32)]
pub enum Vector2Axis { X = 0, Y = 1, }
Expand description

Enumerates the axes in a Vector2.

Vector2 implements Index<Vector2Axis> and IndexMut<Vector2Axis> , so you can use this type to access a vector component as vec[axis].

Variants§

§

X = 0

The X axis.

§

Y = 1

The Y axis.

Trait Implementations§

§

impl Clone for Vector2Axis

§

fn clone(&self) -> Vector2Axis

Returns a copy of the value. Read more
1.0.0 · Source§

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source. Read more
§

impl Debug for Vector2Axis

§

fn fmt(&self, f: &mut Formatter<'_>) -> Result<(), Error>

Formats the value using the given formatter. Read more
§

impl EngineEnum for Vector2Axis

§

fn try_from_ord(ord: i32) -> Option<Vector2Axis>

§

fn ord(self) -> i32

Ordinal value of the enumerator, as specified in Godot. This is not necessarily unique.
§

fn as_str(&self) -> &'static str

§

fn godot_name(&self) -> &'static str

§

fn from_ord(ord: i32) -> Self

§

impl FromGodot for Vector2Axis

§

fn try_from_godot( via: <Vector2Axis as GodotConvert>::Via, ) -> Result<Vector2Axis, ConvertError>

Converts the Godot representation to this type, returning Err on failure.
§

fn from_godot(via: Self::Via) -> Self

⚠️ Converts the Godot representation to this type. Read more
§

fn try_from_variant(variant: &Variant) -> Result<Self, ConvertError>

Performs the conversion from a Variant, returning Err on failure.
§

fn from_variant(variant: &Variant) -> Self

⚠️ Performs the conversion from a Variant. Read more
§

impl GodotConvert for Vector2Axis

§

type Via = i32

The type through which Self is represented in Godot.
§

impl Index<Vector2Axis> for Vector2

§

type Output = f32

The returned type after indexing.
§

fn index(&self, axis: Vector2Axis) -> &f32

Performs the indexing (container[index]) operation. Read more
§

impl Index<Vector2Axis> for Vector2i

§

type Output = i32

The returned type after indexing.
§

fn index(&self, axis: Vector2Axis) -> &i32

Performs the indexing (container[index]) operation. Read more
§

impl IndexMut<Vector2Axis> for Vector2

§

fn index_mut(&mut self, axis: Vector2Axis) -> &mut f32

Performs the mutable indexing (container[index]) operation. Read more
§

impl IndexMut<Vector2Axis> for Vector2i

§

fn index_mut(&mut self, axis: Vector2Axis) -> &mut i32

Performs the mutable indexing (container[index]) operation. Read more
§

impl Ord for Vector2Axis

§

fn cmp(&self, other: &Vector2Axis) -> Ordering

This method returns an Ordering between self and other. Read more
1.21.0 · Source§

fn max(self, other: Self) -> Self
where Self: Sized,

Compares and returns the maximum of two values. Read more
1.21.0 · Source§

fn min(self, other: Self) -> Self
where Self: Sized,

Compares and returns the minimum of two values. Read more
1.50.0 · Source§

fn clamp(self, min: Self, max: Self) -> Self
where Self: Sized,

Restrict a value to a certain interval. Read more
§

impl PartialEq for Vector2Axis

§

fn eq(&self, other: &Vector2Axis) -> bool

Tests for self and other values to be equal, and is used by ==.
1.0.0 · Source§

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.
§

impl PartialOrd for Vector2Axis

§

fn partial_cmp(&self, other: &Vector2Axis) -> Option<Ordering>

This method returns an ordering between self and other values if one exists. Read more
1.0.0 · Source§

fn lt(&self, other: &Rhs) -> bool

Tests less than (for self and other) and is used by the < operator. Read more
1.0.0 · Source§

fn le(&self, other: &Rhs) -> bool

Tests less than or equal to (for self and other) and is used by the <= operator. Read more
1.0.0 · Source§

fn gt(&self, other: &Rhs) -> bool

Tests greater than (for self and other) and is used by the > operator. Read more
1.0.0 · Source§

fn ge(&self, other: &Rhs) -> bool

Tests greater than or equal to (for self and other) and is used by the >= operator. Read more
§

impl ToGodot for Vector2Axis

§

type ToVia<'v> = i32

Target type of to_godot(), which differs from Via for pass-by-reference types.
§

fn to_godot(&self) -> <Vector2Axis as ToGodot>::ToVia<'_>

Converts this type to the Godot type by reference, usually by cloning.
§

fn to_variant(&self) -> Variant

Converts this type to a Variant.
§

impl Copy for Vector2Axis

§

impl Eq for Vector2Axis

§

impl StructuralPartialEq for Vector2Axis

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dst: *mut T)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dst. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.