Enum Vector3Axis

#[repr(i32)]
pub enum Vector3Axis {
    X = 0,
    Y = 1,
    Z = 2,
}

Enumerates the axes in a Vector3.

Vector3 implements Index<Vector3Axis> and IndexMut<Vector3Axis> , 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.

Z = 2

The Z axis.

Trait Implementations

impl Clone for Vector3Axis

fn clone(&self) -> Vector3Axis

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Vector3Axis

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

Formats the value using the given formatter.

impl EngineEnum for Vector3Axis

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

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 Vector3Axis

fn try_from_godot( via: <Vector3Axis as GodotConvert>::Via, ) -> Result<Vector3Axis, 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.

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.

impl GodotConvert for Vector3Axis

type Via = i32

The type through which Self is represented in Godot.

impl Index<Vector3Axis> for Vector3

type Output = f32

The returned type after indexing.

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

Performs the indexing (container[index]) operation.

impl Index<Vector3Axis> for Vector3i

type Output = i32

The returned type after indexing.

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

Performs the indexing (container[index]) operation.

impl IndexMut<Vector3Axis> for Vector3

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

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

impl IndexMut<Vector3Axis> for Vector3i

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

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

impl Ord for Vector3Axis

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

This method returns an Ordering between self and other.

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

where Self: Sized,

Compares and returns the maximum of two values.

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

where Self: Sized,

Compares and returns the minimum of two values.

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

where Self: Sized,

Restrict a value to a certain interval.

impl PartialEq for Vector3Axis

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

Tests for self and other values to be equal, and is used by ==.

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 Vector3Axis

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

This method returns an ordering between self and other values if one exists.

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

Tests less than (for self and other) and is used by the < operator.

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

Tests less than or equal to (for self and other) and is used by the <= operator.

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

Tests greater than (for self and other) and is used by the > operator.

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

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

impl ToGodot for Vector3Axis

type ToVia<'v> = i32

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

fn to_godot(&self) -> <Vector3Axis 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 Vector3Axis

impl Eq for Vector3Axis

impl StructuralPartialEq for Vector3Axis