Struct bevy_math::IVec3

pub struct IVec3 {
    pub x: i32,
    pub y: i32,
    pub z: i32,
}

A 3-dimensional vector.

Fields

x: i32

y: i32

z: i32

Implementations

impl IVec3

pub const ZERO: IVec3 = Self::splat(0)

All zeroes.

pub const ONE: IVec3 = Self::splat(1)

All ones.

pub const NEG_ONE: IVec3 = Self::splat(-1)

All negative ones.

pub const X: IVec3 = Self::new(1, 0, 0)

A unit-length vector pointing along the positive X axis.

pub const Y: IVec3 = Self::new(0, 1, 0)

A unit-length vector pointing along the positive Y axis.

pub const Z: IVec3 = Self::new(0, 0, 1)

A unit-length vector pointing along the positive Z axis.

pub const NEG_X: IVec3 = Self::new(-1, 0, 0)

A unit-length vector pointing along the negative X axis.

pub const NEG_Y: IVec3 = Self::new(0, -1, 0)

A unit-length vector pointing along the negative Y axis.

pub const NEG_Z: IVec3 = Self::new(0, 0, -1)

A unit-length vector pointing along the negative Z axis.

pub const AXES: [IVec3; 3] = [Self::X, Self::Y, Self::Z]

The unit axes.

pub const fn new(x: i32, y: i32, z: i32) -> IVec3

Creates a new vector.

pub const fn splat(v: i32) -> IVec3

Creates a vector with all elements set to v.

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

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 const fn from_array(a: [i32; 3]) -> IVec3

Creates a new vector from an array.

pub const fn to_array(&self) -> [i32; 3]

[x, y, z]

pub const fn from_slice(slice: &[i32]) -> IVec3

Creates a vector from the first 3 values in slice.

Panics

Panics if slice is less than 3 elements long.

pub fn write_to_slice(self, slice: &mut [i32])

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

Panics

Panics if slice is less than 3 elements long.

pub fn extend(self, w: i32) -> IVec4

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

pub fn truncate(self) -> IVec2

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

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

pub fn dot(self, rhs: IVec3) -> i32

Computes the dot product of self and rhs.

pub fn dot_into_vec(self, rhs: IVec3) -> IVec3

Returns a vector where every component is the dot product of self and rhs.

pub fn cross(self, rhs: IVec3) -> IVec3

Computes the cross product of self and rhs.

pub fn min(self, rhs: IVec3) -> IVec3

Returns a vector containing the minimum values for each element of self and rhs.

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

pub fn max(self, rhs: IVec3) -> IVec3

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

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

pub fn clamp(self, min: IVec3, max: IVec3) -> IVec3

Component-wise clamping of values, similar to i32::clamp.

Each element in min must be less-or-equal to the corresponding element in max.

Panics

Will panic if min is greater than max when glam_assert is enabled.

pub fn min_element(self) -> i32

Returns the horizontal minimum of self.

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

pub fn max_element(self) -> i32

Returns the horizontal maximum of self.

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

pub fn cmpeq(self, rhs: IVec3) -> BVec3

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

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

pub fn cmpne(self, rhs: IVec3) -> BVec3

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

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

pub fn cmpge(self, rhs: IVec3) -> BVec3

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

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

pub fn cmpgt(self, rhs: IVec3) -> BVec3

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

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

pub fn cmple(self, rhs: IVec3) -> BVec3

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

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

pub fn cmplt(self, rhs: IVec3) -> BVec3

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

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

pub fn abs(self) -> IVec3

Returns a vector containing the absolute value of each element of self.

pub fn signum(self) -> IVec3

Returns a vector with elements representing the sign of self.

• 0 if the number is zero
• 1 if the number is positive
• -1 if the number is negative

pub fn copysign(self, rhs: IVec3) -> IVec3

Returns a vector with signs of rhs and the magnitudes of self.

pub fn is_negative_bitmask(self) -> u32

Returns a bitmask with the lowest 3 bits set to the sign bits from the elements of self.

A negative element results in a 1 bit and a positive element in a 0 bit. Element x goes into the first lowest bit, element y into the second, etc.

pub fn as_vec3(&self) -> Vec3

Casts all elements of self to f32.

pub fn as_vec3a(&self) -> Vec3A

Casts all elements of self to f32.

pub fn as_dvec3(&self) -> DVec3

Casts all elements of self to f64.

pub fn as_uvec3(&self) -> UVec3

Casts all elements of self to u32.

Trait Implementations

impl Add<IVec3> for IVec3

type Output = IVec3

The resulting type after applying the + operator.

fn add(self, rhs: IVec3) -> IVec3

Performs the + operation.

impl Add<i32> for IVec3

type Output = IVec3

The resulting type after applying the + operator.

fn add(self, rhs: i32) -> IVec3

Performs the + operation.

impl AddAssign<IVec3> for IVec3

fn add_assign(&mut self, rhs: IVec3)

Performs the += operation.

impl AddAssign<i32> for IVec3

fn add_assign(&mut self, rhs: i32)

Performs the += operation.

impl AsMut<[i32; 3]> for IVec3

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

Converts this type into a mutable reference of the (usually inferred) input type.

impl AsRef<[i32; 3]> for IVec3

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

Converts this type into a shared reference of the (usually inferred) input type.

impl BitAnd<IVec3> for IVec3

type Output = IVec3

The resulting type after applying the & operator.

fn bitand(self, rhs: IVec3) -> <IVec3 as BitAnd<IVec3>>::Output

Performs the & operation.

impl BitAnd<i32> for IVec3

type Output = IVec3

The resulting type after applying the & operator.

fn bitand(self, rhs: i32) -> <IVec3 as BitAnd<i32>>::Output

Performs the & operation.

impl BitOr<IVec3> for IVec3

type Output = IVec3

The resulting type after applying the | operator.

fn bitor(self, rhs: IVec3) -> <IVec3 as BitOr<IVec3>>::Output

Performs the | operation.

impl BitOr<i32> for IVec3

type Output = IVec3

The resulting type after applying the | operator.

fn bitor(self, rhs: i32) -> <IVec3 as BitOr<i32>>::Output

Performs the | operation.

impl BitXor<IVec3> for IVec3

type Output = IVec3

The resulting type after applying the ^ operator.

fn bitxor(self, rhs: IVec3) -> <IVec3 as BitXor<IVec3>>::Output

Performs the ^ operation.

impl BitXor<i32> for IVec3

type Output = IVec3

The resulting type after applying the ^ operator.

fn bitxor(self, rhs: i32) -> <IVec3 as BitXor<i32>>::Output

Performs the ^ operation.

impl Clone for IVec3

fn clone(&self) -> IVec3

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for IVec3

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

Formats the value using the given formatter.

impl Default for IVec3

fn default() -> IVec3

Returns the “default value” for a type.

impl Display for IVec3

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

Formats the value using the given formatter.

impl Div<IVec3> for IVec3

type Output = IVec3

The resulting type after applying the / operator.

fn div(self, rhs: IVec3) -> IVec3

Performs the / operation.

impl Div<i32> for IVec3

type Output = IVec3

The resulting type after applying the / operator.

fn div(self, rhs: i32) -> IVec3

Performs the / operation.

impl DivAssign<IVec3> for IVec3

fn div_assign(&mut self, rhs: IVec3)

Performs the /= operation.

impl DivAssign<i32> for IVec3

fn div_assign(&mut self, rhs: i32)

Performs the /= operation.

impl From<[i32; 3]> for IVec3

fn from(a: [i32; 3]) -> IVec3

Converts to this type from the input type.

impl From<(IVec2, i32)> for IVec3

fn from(_: (IVec2, i32)) -> IVec3

Converts to this type from the input type.

impl From<(i32, i32, i32)> for IVec3

fn from(t: (i32, i32, i32)) -> IVec3

Converts to this type from the input type.

impl Hash for IVec3

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

Feeds this value into the given Hasher.

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

Feeds a slice of this type into the given Hasher.

impl Index<usize> for IVec3

type Output = i32

The returned type after indexing.

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

Performs the indexing (container[index]) operation.

impl IndexMut<usize> for IVec3

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

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

impl Mul<IVec3> for IVec3

type Output = IVec3

The resulting type after applying the * operator.

fn mul(self, rhs: IVec3) -> IVec3

Performs the * operation.

impl Mul<i32> for IVec3

type Output = IVec3

The resulting type after applying the * operator.

fn mul(self, rhs: i32) -> IVec3

Performs the * operation.

impl MulAssign<IVec3> for IVec3

fn mul_assign(&mut self, rhs: IVec3)

Performs the *= operation.

impl MulAssign<i32> for IVec3

fn mul_assign(&mut self, rhs: i32)

Performs the *= operation.

impl Neg for IVec3

type Output = IVec3

The resulting type after applying the - operator.

fn neg(self) -> IVec3

Performs the unary - operation.

impl Not for IVec3

type Output = IVec3

The resulting type after applying the ! operator.

fn not(self) -> <IVec3 as Not>::Output

Performs the unary ! operation.

impl PartialEq<IVec3> for IVec3

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

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

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

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

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

fn product<I>(iter: I) -> IVec3where I: Iterator<Item = &'a IVec3>,

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

impl Product<IVec3> for IVec3

fn product<I>(iter: I) -> IVec3where I: Iterator<Item = IVec3>,

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

impl Rem<IVec3> for IVec3

type Output = IVec3

The resulting type after applying the % operator.

fn rem(self, rhs: IVec3) -> IVec3

Performs the % operation.

impl Rem<i32> for IVec3

type Output = IVec3

The resulting type after applying the % operator.

fn rem(self, rhs: i32) -> IVec3

Performs the % operation.

impl RemAssign<IVec3> for IVec3

fn rem_assign(&mut self, rhs: IVec3)

Performs the %= operation.

impl RemAssign<i32> for IVec3

fn rem_assign(&mut self, rhs: i32)

Performs the %= operation.

impl Shl<IVec3> for IVec3

type Output = IVec3

The resulting type after applying the << operator.

fn shl(self, rhs: IVec3) -> <IVec3 as Shl<IVec3>>::Output

Performs the << operation.

impl Shl<IVec3> for UVec3

type Output = UVec3

The resulting type after applying the << operator.

fn shl(self, rhs: IVec3) -> <UVec3 as Shl<IVec3>>::Output

Performs the << operation.

impl Shl<UVec3> for IVec3

type Output = IVec3

The resulting type after applying the << operator.

fn shl(self, rhs: UVec3) -> <IVec3 as Shl<UVec3>>::Output

Performs the << operation.

impl Shl<i16> for IVec3

type Output = IVec3

The resulting type after applying the << operator.

fn shl(self, rhs: i16) -> <IVec3 as Shl<i16>>::Output

Performs the << operation.

impl Shl<i32> for IVec3

type Output = IVec3

The resulting type after applying the << operator.

fn shl(self, rhs: i32) -> <IVec3 as Shl<i32>>::Output

Performs the << operation.

impl Shl<i8> for IVec3

type Output = IVec3

The resulting type after applying the << operator.

fn shl(self, rhs: i8) -> <IVec3 as Shl<i8>>::Output

Performs the << operation.

impl Shl<u16> for IVec3

type Output = IVec3

The resulting type after applying the << operator.

fn shl(self, rhs: u16) -> <IVec3 as Shl<u16>>::Output

Performs the << operation.

impl Shl<u32> for IVec3

type Output = IVec3

The resulting type after applying the << operator.

fn shl(self, rhs: u32) -> <IVec3 as Shl<u32>>::Output

Performs the << operation.

impl Shl<u8> for IVec3

type Output = IVec3

The resulting type after applying the << operator.

fn shl(self, rhs: u8) -> <IVec3 as Shl<u8>>::Output

Performs the << operation.

impl Shr<IVec3> for IVec3

type Output = IVec3

The resulting type after applying the >> operator.

fn shr(self, rhs: IVec3) -> <IVec3 as Shr<IVec3>>::Output

Performs the >> operation.

impl Shr<IVec3> for UVec3

type Output = UVec3

The resulting type after applying the >> operator.

fn shr(self, rhs: IVec3) -> <UVec3 as Shr<IVec3>>::Output

Performs the >> operation.

impl Shr<UVec3> for IVec3

type Output = IVec3

The resulting type after applying the >> operator.

fn shr(self, rhs: UVec3) -> <IVec3 as Shr<UVec3>>::Output

Performs the >> operation.

impl Shr<i16> for IVec3

type Output = IVec3

The resulting type after applying the >> operator.

fn shr(self, rhs: i16) -> <IVec3 as Shr<i16>>::Output

Performs the >> operation.

impl Shr<i32> for IVec3

type Output = IVec3

The resulting type after applying the >> operator.

fn shr(self, rhs: i32) -> <IVec3 as Shr<i32>>::Output

Performs the >> operation.

impl Shr<i8> for IVec3

type Output = IVec3

The resulting type after applying the >> operator.

fn shr(self, rhs: i8) -> <IVec3 as Shr<i8>>::Output

Performs the >> operation.

impl Shr<u16> for IVec3

type Output = IVec3

The resulting type after applying the >> operator.

fn shr(self, rhs: u16) -> <IVec3 as Shr<u16>>::Output

Performs the >> operation.

impl Shr<u32> for IVec3

type Output = IVec3

The resulting type after applying the >> operator.

fn shr(self, rhs: u32) -> <IVec3 as Shr<u32>>::Output

Performs the >> operation.

impl Shr<u8> for IVec3

type Output = IVec3

The resulting type after applying the >> operator.

fn shr(self, rhs: u8) -> <IVec3 as Shr<u8>>::Output

Performs the >> operation.

impl Sub<IVec3> for IVec3

type Output = IVec3

The resulting type after applying the - operator.

fn sub(self, rhs: IVec3) -> IVec3

Performs the - operation.

impl Sub<i32> for IVec3

type Output = IVec3

The resulting type after applying the - operator.

fn sub(self, rhs: i32) -> IVec3

Performs the - operation.

impl SubAssign<IVec3> for IVec3

fn sub_assign(&mut self, rhs: IVec3)

Performs the -= operation.

impl SubAssign<i32> for IVec3

fn sub_assign(&mut self, rhs: i32)

Performs the -= operation.

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

fn sum<I>(iter: I) -> IVec3where I: Iterator<Item = &'a IVec3>,

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

impl Sum<IVec3> for IVec3

fn sum<I>(iter: I) -> IVec3where I: Iterator<Item = IVec3>,

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

impl Vec3Swizzles for IVec3

type Vec2 = IVec2

type Vec4 = IVec4

fn xx(self) -> IVec2

fn xy(self) -> IVec2

fn xz(self) -> IVec2

fn yx(self) -> IVec2

fn yy(self) -> IVec2

fn yz(self) -> IVec2

fn zx(self) -> IVec2

fn zy(self) -> IVec2

fn zz(self) -> IVec2

fn xxx(self) -> IVec3

fn xxy(self) -> IVec3

fn xxz(self) -> IVec3

fn xyx(self) -> IVec3

fn xyy(self) -> IVec3

fn xyz(self) -> IVec3

fn xzx(self) -> IVec3

fn xzy(self) -> IVec3

fn xzz(self) -> IVec3

fn yxx(self) -> IVec3

fn yxy(self) -> IVec3

fn yxz(self) -> IVec3

fn yyx(self) -> IVec3

fn yyy(self) -> IVec3

fn yyz(self) -> IVec3

fn yzx(self) -> IVec3

fn yzy(self) -> IVec3

fn yzz(self) -> IVec3

fn zxx(self) -> IVec3

fn zxy(self) -> IVec3

fn zxz(self) -> IVec3

fn zyx(self) -> IVec3

fn zyy(self) -> IVec3

fn zyz(self) -> IVec3

fn zzx(self) -> IVec3

fn zzy(self) -> IVec3

fn zzz(self) -> IVec3

fn xxxx(self) -> IVec4

fn xxxy(self) -> IVec4

fn xxxz(self) -> IVec4

fn xxyx(self) -> IVec4

fn xxyy(self) -> IVec4

fn xxyz(self) -> IVec4

fn xxzx(self) -> IVec4

fn xxzy(self) -> IVec4

fn xxzz(self) -> IVec4

fn xyxx(self) -> IVec4

fn xyxy(self) -> IVec4

fn xyxz(self) -> IVec4

fn xyyx(self) -> IVec4

fn xyyy(self) -> IVec4

fn xyyz(self) -> IVec4

fn xyzx(self) -> IVec4

fn xyzy(self) -> IVec4

fn xyzz(self) -> IVec4

fn xzxx(self) -> IVec4

fn xzxy(self) -> IVec4

fn xzxz(self) -> IVec4

fn xzyx(self) -> IVec4

fn xzyy(self) -> IVec4

fn xzyz(self) -> IVec4

fn xzzx(self) -> IVec4

fn xzzy(self) -> IVec4

fn xzzz(self) -> IVec4

fn yxxx(self) -> IVec4

fn yxxy(self) -> IVec4

fn yxxz(self) -> IVec4

fn yxyx(self) -> IVec4

fn yxyy(self) -> IVec4

fn yxyz(self) -> IVec4

fn yxzx(self) -> IVec4

fn yxzy(self) -> IVec4

fn yxzz(self) -> IVec4

fn yyxx(self) -> IVec4

fn yyxy(self) -> IVec4

fn yyxz(self) -> IVec4

fn yyyx(self) -> IVec4

fn yyyy(self) -> IVec4

fn yyyz(self) -> IVec4

fn yyzx(self) -> IVec4

fn yyzy(self) -> IVec4

fn yyzz(self) -> IVec4

fn yzxx(self) -> IVec4

fn yzxy(self) -> IVec4

fn yzxz(self) -> IVec4

fn yzyx(self) -> IVec4

fn yzyy(self) -> IVec4

fn yzyz(self) -> IVec4

fn yzzx(self) -> IVec4

fn yzzy(self) -> IVec4

fn yzzz(self) -> IVec4

fn zxxx(self) -> IVec4

fn zxxy(self) -> IVec4

fn zxxz(self) -> IVec4

fn zxyx(self) -> IVec4

fn zxyy(self) -> IVec4

fn zxyz(self) -> IVec4

fn zxzx(self) -> IVec4

fn zxzy(self) -> IVec4

fn zxzz(self) -> IVec4

fn zyxx(self) -> IVec4

fn zyxy(self) -> IVec4

fn zyxz(self) -> IVec4

fn zyyx(self) -> IVec4

fn zyyy(self) -> IVec4

fn zyyz(self) -> IVec4

fn zyzx(self) -> IVec4

fn zyzy(self) -> IVec4

fn zyzz(self) -> IVec4

fn zzxx(self) -> IVec4

fn zzxy(self) -> IVec4

fn zzxz(self) -> IVec4

fn zzyx(self) -> IVec4

fn zzyy(self) -> IVec4

fn zzyz(self) -> IVec4

fn zzzx(self) -> IVec4

fn zzzy(self) -> IVec4

fn zzzz(self) -> IVec4

impl Zeroable for IVec3

fn zeroed() -> Self

Calls zeroed.

impl Copy for IVec3

impl Eq for IVec3

impl Pod for IVec3

impl StructuralEq for IVec3

impl StructuralPartialEq for IVec3