Struct Vec3 

pub struct Vec3 {
    pub x: f32,
    pub y: f32,
    pub z: f32,
}

A len-3 column vector.

Fields

x: f32

y: f32

z: f32

Implementations

impl Vec3

pub const fn new(x: f32, y: f32, z: f32) -> Self

pub const fn new_zero() -> Self

pub const fn x() -> Self

pub const fn y() -> Self

pub const fn z() -> Self

pub fn from_slice(slice: &[f32]) -> Result<Self, BufError>

Construct from the first 3 values in a slice: &[x, y, z].

pub fn to_arr(&self) -> [f32; 3]

Convert to a len-3 array: [x, y, z].

pub fn splat(val: f32) -> Self

pub fn truncate_n(&self, n: usize) -> Vec2

Returns this vector with the nth element removed (0-based). For example: truncate_n(0) => drops .x, returns Vec2(y, z) truncate_n(1) => drops .y, returns Vec2(x, z) truncate_n(2) => drops .z, returns Vec2(x, y)

pub fn sum(&self) -> f32

Returns a sum of all elements

pub fn any_perpendicular(&self) -> Self

Returns an arbitrary unit vector perpendicular to it.

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

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

impl Vec3

pub fn hadamard_product(self, rhs: Self) -> Self

Calculates the Hadamard product (element-wise multiplication).

pub fn magnitude_squared(self) -> f32

Returns the vector magnitude squared

pub fn magnitude(&self) -> f32

Returns the vector magnitude

pub fn normalize(&mut self)

Normalize, modifying in place.

pub fn to_normalized(self) -> Self

Returns the normalized version of the vector.

pub fn dot(&self, rhs: Self) -> f32

Returns the dot product with another vector.

pub fn cross(&self, rhs: Self) -> Self

Calculate the cross product.

pub fn project_to_plane(self, plane_norm: Self) -> Self

Project a vector onto a plane defined by its normal vector. Assumes self and plane_norm are unit vectors.

pub fn project_to_vec(self, other: Self) -> Self

Projects this vector onto another vector.

impl Vec3

pub fn to_bytes_uniform(&self) -> [u8; 16]

Convert to a byte array, e.g. for sending to a GPU. Note that this function pads with an extra 4 bytes, IOC with the hardware 16-byte alignment requirement. This assumes we’re using this in a uniform; Vertexes don’t use padding.

pub fn to_bytes(&self) -> [u8; 12]

Convert to a native-endian byte array, e.g. for sending to a GPU.

pub fn to_le_bytes(&self) -> [u8; 12]

pub fn from_le_bytes(v: &[u8]) -> Self

Trait Implementations

impl Add<f32> for Vec3

type Output = Vec3

The resulting type after applying the + operator.

fn add(self, rhs: f32) -> Self::Output

Performs the + operation.

impl Add for Vec3

type Output = Vec3

The resulting type after applying the + operator.

fn add(self, rhs: Self) -> Self::Output

Performs the + operation.

impl AddAssign<f32> for Vec3

fn add_assign(&mut self, rhs: f32)

Performs the += operation.

impl AddAssign for Vec3

fn add_assign(&mut self, rhs: Self)

Performs the += operation.

impl Clone for Vec3

fn clone(&self) -> Vec3

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Vec3

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

Formats the value using the given formatter.

impl Default for Vec3

fn default() -> Self

Returns the “default value” for a type.

impl Display for Vec3

Available on crate feature std only.

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

Formats the value using the given formatter.

impl Div<f32> for Vec3

type Output = Vec3

The resulting type after applying the / operator.

fn div(self, rhs: f32) -> Self::Output

Performs the / operation.

impl DivAssign<f32> for Vec3

fn div_assign(&mut self, rhs: f32)

Performs the /= operation.

impl From<[f32; 3]> for Vec3

fn from(v: [f32; 3]) -> Self

Converts to this type from the input type.

impl From<Vec3> for Vec3

fn from(other: Vec3) -> Self

Converts to this type from the input type.

impl From<Vec3> for Vec3

fn from(other: Vec3) -> Self

Converts to this type from the input type.

impl Mul<Vec3> for Mat3

type Output = Vec3

The resulting type after applying the * operator.

fn mul(self, rhs: Vec3) -> Self::Output

Performs the * operation.

impl Mul<Vec3> for Quaternion

fn mul(self, rhs: Vec3) -> Self::Output

Returns the multiplication of a Quaternion with a vector. This is a normal Quaternion multiplication where the vector is treated as a Quaternion with a W element value of zero. The Quaternion is post- multiplied by the vector.

type Output = Quaternion

The resulting type after applying the * operator.

impl Mul<f32> for Vec3

type Output = Vec3

The resulting type after applying the * operator.

fn mul(self, rhs: f32) -> Self::Output

Performs the * operation.

impl MulAssign<f32> for Vec3

fn mul_assign(&mut self, rhs: f32)

Performs the *= operation.

impl Neg for Vec3

type Output = Vec3

The resulting type after applying the - operator.

fn neg(self) -> Self::Output

Performs the unary - operation.

impl PartialEq for Vec3

fn eq(&self, other: &Vec3) -> 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 Sub<f32> for Vec3

type Output = Vec3

The resulting type after applying the - operator.

fn sub(self, rhs: f32) -> Self::Output

Performs the - operation.

impl Sub for Vec3

type Output = Vec3

The resulting type after applying the - operator.

fn sub(self, rhs: Self) -> Self::Output

Performs the - operation.

impl SubAssign<f32> for Vec3

fn sub_assign(&mut self, rhs: f32)

Performs the -= operation.

impl SubAssign for Vec3

fn sub_assign(&mut self, rhs: Self)

Performs the -= operation.

impl Sum for Vec3

fn sum<I: Iterator<Item = Vec3>>(iter: I) -> Vec3

Takes an iterator and generates Self from the elements by “summing up” the items.

impl Copy for Vec3

impl StructuralPartialEq for Vec3