Struct gramit::vec::Vec3

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

Fields

x: f32

y: f32

z: f32

Methods

impl Vec3

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

Create a new vector with the given components.

pub fn x() -> Self

Create a unit vector along this axis.

pub fn y() -> Self

Create a unit vector along this axis.

pub fn z() -> Self

Create a unit vector along this axis.

pub fn angle_between(&self, other: &Vec3) -> Angle

Get the angle between this vector and another.

impl Vec3

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

Compute the cross product self × other.

pub fn extend(self, w: f32) -> Vec4

Extend this Vec3 to a Vec4, with the given w component.

pub fn homogeneous(self) -> Vec4

Get a homogeneous (point) representation of this Vec3.

This is equivalent to calling vec3.extend(1.0).

pub fn truncate(self) -> Vec2

Truncate the z component of this Vec3 to produce a Vec2.

Trait Implementations

impl ApproxEq<Vec3> for Vec3

fn approx_eq(self, rhs: Vec3) -> bool

Compare two values for approximate equality, using a default difference treshold.

fn within_threshold(self, rhs: Vec3, threshold: Vec3) -> bool

Compare two vectors for approximate equality.

Uses a third vector for component-wise thresholds.

impl Vector for Vec3

type Scalar = f32

The scalar type over which this vector type is defined.

const DIMS: usize

The dimension of this vector type.

fn length(&self) -> f32

The length (norm) of this vector.

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

The dot (scalar) product of this vector with another.

fn ones() -> Self

Returns a vector of all 1's.

fn zeros() -> Self

Returns a vector of all 0's.

fn unit(&self) -> Self

Returns the normalized (unit-length) version of this vector.

fn scalar_mul(&self, s: &f32) -> Self

The scalar multiplication operation.

fn vector_add(&self, v: &Self) -> Self

The vector addition operation.

impl AsMut<[f32]> for Vec3

fn as_mut(&mut self) -> &mut [f32]

Performs the conversion.

impl AsRef<[f32]> for Vec3

fn as_ref(&self) -> &[f32]

Performs the conversion.

impl From<Vec3> for Quaternion

fn from(vec: Vec3) -> Quaternion

Converts a Vec3 into a Quaternion with only a vector part.

This conversion is identical to that performed by Quaternion::vector.

impl Into<Vec<f32>> for Vec3

fn into(self) -> Vec<f32>

Performs the conversion.

impl Clone for Vec3

fn clone(&self) -> Vec3

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Copy for Vec3

impl Default for Vec3

fn default() -> Vec3

Returns the "default value" for a type.

impl PartialEq<Vec3> for Vec3

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

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

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

This method tests for !=.

impl Debug for Vec3

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

Formats the value using the given formatter.

impl Div<Vec3> for Vec3

type Output = Vec3

The resulting type after applying the / operator.

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

Component-wise arithemetic operation.

impl<'_> Div<&'_ Vec3> for Vec3

type Output = Vec3

The resulting type after applying the / operator.

fn div(self, rhs: &Vec3) -> Vec3

Component-wise arithemetic operation.

impl<'_> Div<Vec3> for &'_ Vec3

type Output = Vec3

The resulting type after applying the / operator.

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

Component-wise arithemetic operation.

impl<'_, '_> Div<&'_ Vec3> for &'_ Vec3

type Output = Vec3

The resulting type after applying the / operator.

fn div(self, rhs: &Vec3) -> Vec3

Component-wise arithemetic operation.

impl Div<f32> for Vec3

type Output = Vec3

The resulting type after applying the / operator.

fn div(self, rhs: f32) -> Vec3

Performs the / operation.

impl<'_> Div<&'_ f32> for Vec3

type Output = Vec3

The resulting type after applying the / operator.

fn div(self, rhs: &f32) -> Vec3

Performs the / operation.

impl<'_> Div<f32> for &'_ Vec3

type Output = Vec3

The resulting type after applying the / operator.

fn div(self, rhs: f32) -> Vec3

Performs the / operation.

impl<'_, '_> Div<&'_ f32> for &'_ Vec3

type Output = Vec3

The resulting type after applying the / operator.

fn div(self, rhs: &f32) -> Vec3

Performs the / operation.

impl Sub<Vec3> for Vec3

type Output = Vec3

The resulting type after applying the - operator.

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

Component-wise arithemetic operation.

impl<'_> Sub<&'_ Vec3> for Vec3

type Output = Vec3

The resulting type after applying the - operator.

fn sub(self, rhs: &Vec3) -> Vec3

Component-wise arithemetic operation.

impl<'_> Sub<Vec3> for &'_ Vec3

type Output = Vec3

The resulting type after applying the - operator.

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

Component-wise arithemetic operation.

impl<'_, '_> Sub<&'_ Vec3> for &'_ Vec3

type Output = Vec3

The resulting type after applying the - operator.

fn sub(self, rhs: &Vec3) -> Vec3

Component-wise arithemetic operation.

impl Add<Vec3> for Vec3

type Output = Vec3

The resulting type after applying the + operator.

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

Component-wise arithemetic operation.

impl<'_> Add<&'_ Vec3> for Vec3

type Output = Vec3

The resulting type after applying the + operator.

fn add(self, rhs: &Vec3) -> Vec3

Component-wise arithemetic operation.

impl<'_> Add<Vec3> for &'_ Vec3

type Output = Vec3

The resulting type after applying the + operator.

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

Component-wise arithemetic operation.

impl<'_, '_> Add<&'_ Vec3> for &'_ Vec3

type Output = Vec3

The resulting type after applying the + operator.

fn add(self, rhs: &Vec3) -> Vec3

Component-wise arithemetic operation.

impl Mul<Vec3> for Mat3

type Output = Vec3

The resulting type after applying the * operator.

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

Matrix-vector multiplication operation.

impl<'_> Mul<&'_ Vec3> for Mat3

type Output = Vec3

The resulting type after applying the * operator.

fn mul(self, rhs: &Vec3) -> Vec3

Matrix-vector multiplication operation.

impl<'_> Mul<Vec3> for &'_ Mat3

type Output = Vec3

The resulting type after applying the * operator.

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

Matrix-vector multiplication operation.

impl<'_, '_> Mul<&'_ Vec3> for &'_ Mat3

type Output = Vec3

The resulting type after applying the * operator.

fn mul(self, rhs: &Vec3) -> Vec3

Matrix-vector multiplication operation.

impl Mul<Vec3> for Vec3

type Output = Vec3

The resulting type after applying the * operator.

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

Component-wise arithemetic operation.

impl<'_> Mul<&'_ Vec3> for Vec3

type Output = Vec3

The resulting type after applying the * operator.

fn mul(self, rhs: &Vec3) -> Vec3

Component-wise arithemetic operation.

impl<'_> Mul<Vec3> for &'_ Vec3

type Output = Vec3

The resulting type after applying the * operator.

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

Component-wise arithemetic operation.

impl<'_, '_> Mul<&'_ Vec3> for &'_ Vec3

type Output = Vec3

The resulting type after applying the * operator.

fn mul(self, rhs: &Vec3) -> Vec3

Component-wise arithemetic operation.

impl Mul<f32> for Vec3

type Output = Vec3

The resulting type after applying the * operator.

fn mul(self, rhs: f32) -> Vec3

Performs the * operation.

impl Mul<Vec3> for f32

type Output = Vec3

The resulting type after applying the * operator.

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

Performs the * operation.

impl<'_> Mul<&'_ f32> for Vec3

type Output = Vec3

The resulting type after applying the * operator.

fn mul(self, rhs: &f32) -> Vec3

Performs the * operation.

impl<'_> Mul<Vec3> for &'_ f32

type Output = Vec3

The resulting type after applying the * operator.

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

Performs the * operation.

impl<'_> Mul<f32> for &'_ Vec3

type Output = Vec3

The resulting type after applying the * operator.

fn mul(self, rhs: f32) -> Vec3

Performs the * operation.

impl<'_> Mul<&'_ Vec3> for f32

type Output = Vec3

The resulting type after applying the * operator.

fn mul(self, rhs: &Vec3) -> Vec3

Performs the * operation.

impl<'_, '_> Mul<&'_ f32> for &'_ Vec3

type Output = Vec3

The resulting type after applying the * operator.

fn mul(self, rhs: &f32) -> Vec3

Performs the * operation.

impl<'_, '_> Mul<&'_ Vec3> for &'_ f32

type Output = Vec3

The resulting type after applying the * operator.

fn mul(self, rhs: &Vec3) -> Vec3

Performs the * operation.

impl Neg for Vec3

type Output = Vec3

The resulting type after applying the - operator.

fn neg(self) -> Vec3

Performs the unary - operation.

impl<'_> Neg for &'_ Vec3

type Output = Vec3

The resulting type after applying the - operator.

fn neg(self) -> Vec3

Performs the unary - operation.

impl AddAssign<Vec3> for Vec3

fn add_assign(&mut self, rhs: Vec3)

Component-wise arithmetic assignment operation.

impl<'_> AddAssign<&'_ Vec3> for Vec3

fn add_assign(&mut self, rhs: &Vec3)

Component-wise arithmetic assignment operation.

impl SubAssign<Vec3> for Vec3

fn sub_assign(&mut self, rhs: Vec3)

Component-wise arithmetic assignment operation.

impl<'_> SubAssign<&'_ Vec3> for Vec3

fn sub_assign(&mut self, rhs: &Vec3)

Component-wise arithmetic assignment operation.

impl MulAssign<Vec3> for Vec3

fn mul_assign(&mut self, rhs: Vec3)

Component-wise arithmetic assignment operation.

impl<'_> MulAssign<&'_ Vec3> for Vec3

fn mul_assign(&mut self, rhs: &Vec3)

Component-wise arithmetic assignment operation.

impl MulAssign<f32> for Vec3

fn mul_assign(&mut self, rhs: f32)

Performs the *= operation.

impl<'_> MulAssign<&'_ f32> for Vec3

fn mul_assign(&mut self, rhs: &f32)

Performs the *= operation.

impl DivAssign<Vec3> for Vec3

fn div_assign(&mut self, rhs: Vec3)

Component-wise arithmetic assignment operation.

impl<'_> DivAssign<&'_ Vec3> for Vec3

fn div_assign(&mut self, rhs: &Vec3)

Component-wise arithmetic assignment operation.

impl DivAssign<f32> for Vec3

fn div_assign(&mut self, rhs: f32)

Performs the /= operation.

impl<'_> DivAssign<&'_ f32> for Vec3

fn div_assign(&mut self, rhs: &f32)

Performs the /= operation.

impl Index<usize> for Vec3

type Output = f32

The returned type after indexing.

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

Performs the indexing (container[index]) operation.

impl IndexMut<usize> for Vec3

fn index_mut(&mut self, idx: usize) -> &mut f32

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

impl StructuralPartialEq for Vec3