Struct bevy::math::UVec3

#[repr(transparent)]pub struct UVec3(_);

A 3-dimensional vector.

Implementations

impl UVec3

pub const ZERO: UVec3

All zeroes.

pub const ONE: UVec3

All ones.

pub const X: UVec3

[1, 0, 0]: a unit-length vector pointing along the positive X axis.

pub const Y: UVec3

[0, 1, 0]: a unit-length vector pointing along the positive Y axis.

pub const Z: UVec3

[0, 0, 1]: a unit-length vector pointing along the positive Z axis.

pub fn new(x: u32, y: u32, z: u32) -> UVec3

Creates a new 3D vector.

pub const fn unit_x() -> UVec3

👎 Deprecated:

Use Vec3::X instead

Creates a vector with values [x: 1.0, y: 0.0, z: 0.0].

pub const fn unit_y() -> UVec3

👎 Deprecated:

Use Vec3::Y instead

Creates a vector with values [x: 0.0, y: 1.0, z: 0.0].

pub const fn unit_z() -> UVec3

👎 Deprecated:

Use Vec3::Z instead

Creates a vector with values [x: 0.0, y: 0.0, z: 1.0].

pub fn extend(self, w: u32) -> UVec4

Creates a 4D vector from self and the given w value.

pub fn truncate(self) -> UVec2

Creates a Vec2 from the x and y elements of self, discarding z.

Truncation may also be performed by using self.xy() or Vec2::from().

pub fn cross(self, other: UVec3) -> UVec3

Computes the cross product of self and other.

pub const fn zero() -> UVec3

👎 Deprecated:

use ZERO constant instead

Creates a vector with all elements set to 0.0.

pub const fn one() -> UVec3

👎 Deprecated:

use ONE constant instead

Creates a vector with all elements set to 1.0.

pub fn splat(v: u32) -> UVec3

Creates a vector with all elements set to v.

pub fn select(mask: BVec3, if_true: UVec3, if_false: UVec3) -> UVec3

Creates a vector from the elements in if_true and if_false, selecting which to use for each element of self.

A true element in the mask uses the corresponding element from if_true, and false uses the element from if_false.

pub fn dot(self, other: UVec3) -> u32

Computes the dot product of self and other.

pub fn min(self, other: UVec3) -> UVec3

Returns a vector containing the mininum values for each element of self and other.

In other words this computes [self.x.max(other.x), self.y.max(other.y), ..].

pub fn max(self, other: UVec3) -> UVec3

Returns a vector containing the maximum values for each element of self and other.

In other words this computes [self.x.max(other.x), self.y.max(other.y), ..].

pub fn min_element(self) -> u32

Returns the horizontal minimum of self.

In other words this computes min(x, y, ..).

pub fn max_element(self) -> u32

Returns the horizontal maximum of self.

In other words this computes max(x, y, ..).

pub fn cmpeq(self, other: UVec3) -> BVec3

Returns a vector mask containing the result of a == comparison for each element of self and other.

In other words, this computes [self.x == other.x, self.y == other.y, ..] for all elements.

pub fn cmpne(self, other: UVec3) -> BVec3

Returns a vector mask containing the result of a != comparison for each element of self and other.

In other words this computes [self.x != other.x, self.y != other.y, ..] for all elements.

pub fn cmpge(self, other: UVec3) -> BVec3

Returns a vector mask containing the result of a >= comparison for each element of self and other.

In other words this computes [self.x >= other.x, self.y >= other.y, ..] for all elements.

pub fn cmpgt(self, other: UVec3) -> BVec3

Returns a vector mask containing the result of a > comparison for each element of self and other.

In other words this computes [self.x > other.x, self.y > other.y, ..] for all elements.

pub fn cmple(self, other: UVec3) -> BVec3

Returns a vector mask containing the result of a <= comparison for each element of self and other.

In other words this computes [self.x <= other.x, self.y <= other.y, ..] for all elements.

pub fn cmplt(self, other: UVec3) -> BVec3

Returns a vector mask containing the result of a < comparison for each element of self and other.

In other words this computes [self.x < other.x, self.y < other.y, ..] for all elements.

pub fn from_slice_unaligned(slice: &[u32]) -> UVec3

Creates a vector from the first N values in slice.

Panics

Panics if slice is less than N elements long.

pub fn write_to_slice_unaligned(self, slice: &mut [u32])

Writes the elements of self to the first N elements in slice.

Panics

Panics if slice is less than N elements long.

pub fn as_f32(&self) -> Vec3

Casts all elements of self to f32.

pub fn as_f64(&self) -> DVec3

Casts all elements of self to f64.

pub fn as_i32(&self) -> IVec3

Casts all elements of self to i32.

Trait Implementations

impl Add<UVec3> for UVec3

type Output = UVec3

The resulting type after applying the + operator.

pub fn add(self, other: UVec3) -> UVec3

Performs the + operation.

impl AddAssign<UVec3> for UVec3

pub fn add_assign(&mut self, other: UVec3)

Performs the += operation.

impl AsMut<[u32; 3]> for UVec3

pub fn as_mut(&mut self) -> &mut [u32; 3]

Performs the conversion.

impl AsRef<[u32; 3]> for UVec3

pub fn as_ref(&self) -> &[u32; 3]

Performs the conversion.

impl Clone for UVec3

pub fn clone(&self) -> UVec3

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Copy for UVec3

impl Debug for UVec3

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

Formats the value using the given formatter.

impl Default for UVec3

pub fn default() -> UVec3

Returns the “default value” for a type.

impl Deref for UVec3

type Target = XYZ<u32>

The resulting type after dereferencing.

pub fn deref(&self) -> &<UVec3 as Deref>::Target

Dereferences the value.

impl DerefMut for UVec3

pub fn deref_mut(&mut self) -> &mut <UVec3 as Deref>::Target

Mutably dereferences the value.

impl<'de> Deserialize<'de> for UVec3

pub fn deserialize<D>(
    deserializer: D
) -> Result<UVec3, <D as Deserializer<'de>>::Error> where
    D: Deserializer<'de>, 

Deserialize this value from the given Serde deserializer.

impl Display for UVec3

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

Formats the value using the given formatter.

impl Div<UVec3> for UVec3

type Output = UVec3

The resulting type after applying the / operator.

pub fn div(self, other: UVec3) -> UVec3

Performs the / operation.

impl Div<u32> for UVec3

type Output = UVec3

The resulting type after applying the / operator.

pub fn div(self, other: u32) -> UVec3

Performs the / operation.

impl DivAssign<UVec3> for UVec3

pub fn div_assign(&mut self, other: UVec3)

Performs the /= operation.

impl DivAssign<u32> for UVec3

pub fn div_assign(&mut self, other: u32)

Performs the /= operation.

impl Eq for UVec3

impl From<[u32; 3]> for UVec3

pub fn from(a: [u32; 3]) -> UVec3

Performs the conversion.

impl From<(UVec2, u32)> for UVec3

pub fn from((UVec2, u32)) -> UVec3

Performs the conversion.

impl From<(u32, u32, u32)> for UVec3

pub fn from(t: (u32, u32, u32)) -> UVec3

Performs the conversion.

impl From<UVec3> for UVec2

pub fn from(v: UVec3) -> UVec2

Creates a Vec2 from the x and y elements of self, discarding z.

impl From<UVec3> for XYZ<u32>

pub fn from(t: UVec3) -> XYZ<u32>

Performs the conversion.

impl From<UVec3> for (u32, u32, u32)

pub fn from(v: UVec3) -> (u32, u32, u32)

Performs the conversion.

impl From<UVec3> for [u32; 3]

pub fn from(v: UVec3) -> [u32; 3]

Performs the conversion.

impl From<UVec4> for UVec3

pub fn from(v: UVec4) -> UVec3

Creates a 3D vector from the x, y and z elements of self, discarding w.

impl From<XYZ<u32>> for UVec3

pub fn from(t: XYZ<u32>) -> UVec3

Performs the conversion.

impl GetTypeRegistration for UVec3

pub fn get_type_registration() -> TypeRegistration

impl Hash for UVec3

pub fn hash<H>(&self, state: &mut H) where
    H: Hasher, 

Feeds this value into the given Hasher.

pub fn hash_slice<H>(data: &[Self], state: &mut H) where
    H: Hasher, 

Feeds a slice of this type into the given Hasher.

impl Index<usize> for UVec3

type Output = u32

The returned type after indexing.

pub fn index(&self, index: usize) -> &<UVec3 as Index<usize>>::Output

Performs the indexing (container[index]) operation.

impl IndexMut<usize> for UVec3

pub fn index_mut(
    &mut self,
    index: usize
) -> &mut <UVec3 as Index<usize>>::Output

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

impl Mul<UVec3> for UVec3

type Output = UVec3

The resulting type after applying the * operator.

pub fn mul(self, other: UVec3) -> UVec3

Performs the * operation.

impl Mul<u32> for UVec3

type Output = UVec3

The resulting type after applying the * operator.

pub fn mul(self, other: u32) -> UVec3

Performs the * operation.

impl MulAssign<UVec3> for UVec3

pub fn mul_assign(&mut self, other: UVec3)

Performs the *= operation.

impl MulAssign<u32> for UVec3

pub fn mul_assign(&mut self, other: u32)

Performs the *= operation.

impl PartialEq<UVec3> for UVec3

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

This method tests for self and other values to be equal, and is used by ==.

#[must_use]pub fn ne(&self, other: &Rhs) -> bool

This method tests for !=.

impl PartialOrd<UVec3> for UVec3

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

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

#[must_use]pub fn lt(&self, other: &Rhs) -> bool

This method tests less than (for self and other) and is used by the < operator.

#[must_use]pub fn le(&self, other: &Rhs) -> bool

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

#[must_use]pub fn gt(&self, other: &Rhs) -> bool

This method tests greater than (for self and other) and is used by the > operator.

#[must_use]pub fn ge(&self, other: &Rhs) -> bool

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

impl<'a> Product<&'a UVec3> for UVec3

pub fn product<I>(iter: I) -> UVec3 where
    I: Iterator<Item = &'a UVec3>, 

Method which takes an iterator and generates Self from the elements by multiplying the items.

impl Reflect for UVec3

pub fn type_name(&self) -> &str

pub fn any(&self) -> &(dyn Any + 'static)

pub fn any_mut(&mut self) -> &mut (dyn Any + 'static)

pub fn clone_value(&self) -> Box<dyn Reflect + 'static, Global>

pub fn apply(&mut self, value: &(dyn Reflect + 'static))

pub fn set(
    &mut self,
    value: Box<dyn Reflect + 'static, Global>
) -> Result<(), Box<dyn Reflect + 'static, Global>>

pub fn reflect_ref(&self) -> ReflectRef<'_>

pub fn reflect_mut(&mut self) -> ReflectMut<'_>

pub fn reflect_hash(&self) -> Option<u64>

Returns a hash of the value (which includes the type) if hashing is supported. Otherwise None will be returned.

pub fn reflect_partial_eq(
    &self,
    value: &(dyn Reflect + 'static)
) -> Option<bool>

Returns a “partial equal” comparison result if comparison is supported. Otherwise None will be returned.

pub fn serializable(&self) -> Option<Serializable<'_>>

Returns a serializable value, if serialization is supported. Otherwise None will be returned.

impl Serialize for UVec3

pub fn serialize<S>(
    &self,
    serializer: S
) -> Result<<S as Serializer>::Ok, <S as Serializer>::Error> where
    S: Serializer, 

Serialize this value into the given Serde serializer.

impl Sub<UVec3> for UVec3

type Output = UVec3

The resulting type after applying the - operator.

pub fn sub(self, other: UVec3) -> UVec3

Performs the - operation.

impl SubAssign<UVec3> for UVec3

pub fn sub_assign(&mut self, other: UVec3)

Performs the -= operation.

impl<'a> Sum<&'a UVec3> for UVec3

pub fn sum<I>(iter: I) -> UVec3 where
    I: Iterator<Item = &'a UVec3>, 

Method which takes an iterator and generates Self from the elements by “summing up” the items.

impl Vec3Swizzles for UVec3

type Vec2 = UVec2

type Vec4 = UVec4

pub fn xxxx(self) -> UVec4

pub fn xxxy(self) -> UVec4

pub fn xxxz(self) -> UVec4

pub fn xxyx(self) -> UVec4

pub fn xxyy(self) -> UVec4

pub fn xxyz(self) -> UVec4

pub fn xxzx(self) -> UVec4

pub fn xxzy(self) -> UVec4

pub fn xxzz(self) -> UVec4

pub fn xyxx(self) -> UVec4

pub fn xyxy(self) -> UVec4

pub fn xyxz(self) -> UVec4

pub fn xyyx(self) -> UVec4

pub fn xyyy(self) -> UVec4

pub fn xyyz(self) -> UVec4

pub fn xyzx(self) -> UVec4

pub fn xyzy(self) -> UVec4

pub fn xyzz(self) -> UVec4

pub fn xzxx(self) -> UVec4

pub fn xzxy(self) -> UVec4

pub fn xzxz(self) -> UVec4

pub fn xzyx(self) -> UVec4

pub fn xzyy(self) -> UVec4

pub fn xzyz(self) -> UVec4

pub fn xzzx(self) -> UVec4

pub fn xzzy(self) -> UVec4

pub fn xzzz(self) -> UVec4

pub fn yxxx(self) -> UVec4

pub fn yxxy(self) -> UVec4

pub fn yxxz(self) -> UVec4

pub fn yxyx(self) -> UVec4

pub fn yxyy(self) -> UVec4

pub fn yxyz(self) -> UVec4

pub fn yxzx(self) -> UVec4

pub fn yxzy(self) -> UVec4

pub fn yxzz(self) -> UVec4

pub fn yyxx(self) -> UVec4

pub fn yyxy(self) -> UVec4

pub fn yyxz(self) -> UVec4

pub fn yyyx(self) -> UVec4

pub fn yyyy(self) -> UVec4

pub fn yyyz(self) -> UVec4

pub fn yyzx(self) -> UVec4

pub fn yyzy(self) -> UVec4

pub fn yyzz(self) -> UVec4

pub fn yzxx(self) -> UVec4

pub fn yzxy(self) -> UVec4

pub fn yzxz(self) -> UVec4

pub fn yzyx(self) -> UVec4

pub fn yzyy(self) -> UVec4

pub fn yzyz(self) -> UVec4

pub fn yzzx(self) -> UVec4

pub fn yzzy(self) -> UVec4

pub fn yzzz(self) -> UVec4

pub fn zxxx(self) -> UVec4

pub fn zxxy(self) -> UVec4

pub fn zxxz(self) -> UVec4

pub fn zxyx(self) -> UVec4

pub fn zxyy(self) -> UVec4

pub fn zxyz(self) -> UVec4

pub fn zxzx(self) -> UVec4

pub fn zxzy(self) -> UVec4

pub fn zxzz(self) -> UVec4

pub fn zyxx(self) -> UVec4

pub fn zyxy(self) -> UVec4

pub fn zyxz(self) -> UVec4

pub fn zyyx(self) -> UVec4

pub fn zyyy(self) -> UVec4

pub fn zyyz(self) -> UVec4

pub fn zyzx(self) -> UVec4

pub fn zyzy(self) -> UVec4

pub fn zyzz(self) -> UVec4

pub fn zzxx(self) -> UVec4

pub fn zzxy(self) -> UVec4

pub fn zzxz(self) -> UVec4

pub fn zzyx(self) -> UVec4

pub fn zzyy(self) -> UVec4

pub fn zzyz(self) -> UVec4

pub fn zzzx(self) -> UVec4

pub fn zzzy(self) -> UVec4

pub fn zzzz(self) -> UVec4

pub fn xxx(self) -> UVec3

pub fn xxy(self) -> UVec3

pub fn xxz(self) -> UVec3

pub fn xyx(self) -> UVec3

pub fn xyy(self) -> UVec3

pub fn xzx(self) -> UVec3

pub fn xzy(self) -> UVec3

pub fn xzz(self) -> UVec3

pub fn yxx(self) -> UVec3

pub fn yxy(self) -> UVec3

pub fn yxz(self) -> UVec3

pub fn yyx(self) -> UVec3

pub fn yyy(self) -> UVec3

pub fn yyz(self) -> UVec3

pub fn yzx(self) -> UVec3

pub fn yzy(self) -> UVec3

pub fn yzz(self) -> UVec3

pub fn zxx(self) -> UVec3

pub fn zxy(self) -> UVec3

pub fn zxz(self) -> UVec3

pub fn zyx(self) -> UVec3

pub fn zyy(self) -> UVec3

pub fn zyz(self) -> UVec3

pub fn zzx(self) -> UVec3

pub fn zzy(self) -> UVec3

pub fn zzz(self) -> UVec3

pub fn xx(self) -> UVec2

pub fn xy(self) -> UVec2

pub fn xz(self) -> UVec2

pub fn yx(self) -> UVec2

pub fn yy(self) -> UVec2

pub fn yz(self) -> UVec2

pub fn zx(self) -> UVec2

pub fn zy(self) -> UVec2

pub fn zz(self) -> UVec2