Struct Vec3

#[repr(C)]
pub struct Vec3 {
    pub x: f32,
    pub y: f32,
    pub z: f32,
}

A 3-dimensional vector with f32 components.

Fields

x: f32

The x component of the vector.

y: f32

The y component of the vector.

z: f32

The z component of the vector.

Implementations

impl Vec3

pub const ZERO: Self

A vector with all components set to 0.0.

pub const ONE: Self

A vector with all components set to 1.0.

pub const X: Self

The unit vector pointing along the positive X-axis.

pub const Y: Self

The unit vector pointing along the positive Y-axis.

pub const Z: Self

The unit vector pointing along the positive Z-axis.

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

Creates a new Vec3 with the specified components.

pub const fn abs(self) -> Self

Returns a new vector with the absolute value of each component.

pub fn length_squared(&self) -> f32

Calculates the squared length (magnitude) of the vector.

pub fn length(&self) -> f32

Calculates the length (magnitude) of the vector.

pub fn normalize(&self) -> Self

Returns a normalized version of the vector with a length of 1.

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

Calculates the dot product of this vector and another.

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

Computes the cross product of this vector and another.

pub fn distance_squared(&self, other: Self) -> f32

Calculates the squared distance between this vector and another.

pub fn distance(&self, other: Self) -> f32

Calculates the distance between this vector and another.

pub fn lerp(start: Self, end: Self, t: f32) -> Self

Performs a linear interpolation between two vectors.

pub fn get(&self, index: usize) -> f32

Retrieves a component of the vector by its index.

Panics

Panics if index is not 0, 1, or 2.

Trait Implementations

impl Add for Vec3

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

Adds two vectors component-wise.

type Output = Vec3

The resulting type after applying the + operator.

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 Vec3::ZERO.

impl Div<f32> for Vec3

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

Divides the vector by a scalar.

type Output = Vec3

The resulting type after applying the / operator.

impl Index<usize> for Vec3

fn index(&self, index: usize) -> &Self::Output

Allows accessing a vector component by index.

Panics

Panics if index is not 0, 1, or 2.

type Output = f32

The returned type after indexing.

impl IndexMut<usize> for Vec3

fn index_mut(&mut self, index: usize) -> &mut Self::Output

Allows mutably accessing a vector component by index.

Panics

Panics if index is not 0, 1, or 2.

impl Mul<Vec3> for Mat3

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

Transforms a Vec3 by this matrix.

type Output = Vec3

The resulting type after applying the * operator.

impl Mul<Vec3> for Quaternion

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

Rotates a Vec3 by this quaternion.

type Output = Vec3

The resulting type after applying the * operator.

impl Mul<Vec3> for f32

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

Multiplies a scalar by a vector.

type Output = Vec3

The resulting type after applying the * operator.

impl Mul<f32> for Vec3

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

Multiplies the vector by a scalar.

type Output = Vec3

The resulting type after applying the * operator.

impl Mul for Vec3

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

Multiplies two vectors component-wise.

type Output = Vec3

The resulting type after applying the * operator.

impl Neg for Vec3

fn neg(self) -> Self::Output

Negates the vector.

type Output = Vec3

The resulting type after applying the - operator.

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 for Vec3

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

Subtracts two vectors component-wise.

type Output = Vec3

The resulting type after applying the - operator.

impl Copy for Vec3

impl StructuralPartialEq for Vec3