Struct Vec3

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

Single-precision 3D vector.

Fields

x: f32

y: f32

z: f32

Implementations

impl Vec3

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

Full constructor.

pub fn zero() -> Vec3

Zero constructor.

pub fn xy(self) -> Vec2

Returns the XY components of the vector.

impl Vec3

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

Returns the cross product of two vectors.

impl Vec3

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

Returns the dot product of two vectors.

pub fn length(self) -> f32

Returns the length (magnitude) of the vector.

pub fn squared_length(self) -> f32

Returns the squared length of the vector.

pub fn normalize(self) -> Vec3

Scales the vector to unit length.

Panics

Panics if the vector is zero.

impl Vec3

pub fn angle(self, rhs: Vec3) -> f32

Returns the acute angle between two vectors.

Panics

Panics if self is the zero vector.

Trait Implementations

impl Add for Vec3

type Output = Vec3

The resulting type after applying the + operator.

fn add(self, rhs: Vec3) -> <Vec3 as Add>::Output

Performs the + operation.

impl AddAssign for Vec3

fn add_assign(&mut self, rhs: Vec3)

Performs the += operation.

impl ApproxEq for Vec3

type Epsilon = <Vector3<f32> as ApproxEq>::Epsilon

Used for specifying relative comparisons.

fn default_epsilon() -> <Vec3 as ApproxEq>::Epsilon

The default tolerance to use when testing values that are close together.

fn default_max_relative() -> <Vec3 as ApproxEq>::Epsilon

The default relative tolerance for testing values that are far-apart.

fn default_max_ulps() -> u32

The default ULPs to tolerate when testing values that are far-apart.

fn relative_eq( &self, other: &Vec3, epsilon: <Vec3 as ApproxEq>::Epsilon, max_relative: <Vec3 as ApproxEq>::Epsilon, ) -> bool

A test for equality that uses a relative comparison if the values are far apart.

fn ulps_eq( &self, other: &Vec3, epsilon: <Vec3 as ApproxEq>::Epsilon, max_ulps: u32, ) -> bool

A test for equality that uses units in the last place (ULP) if the values are far apart.

fn relative_ne( &self, other: &Self, epsilon: Self::Epsilon, max_relative: Self::Epsilon, ) -> bool

The inverse of ApproxEq::relative_eq.

fn ulps_ne(&self, other: &Self, epsilon: Self::Epsilon, max_ulps: u32) -> bool

The inverse of ApproxEq::ulps_eq.

impl AsRef<[f32; 3]> for Vec3

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

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

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<(), Error>

Formats the value using the given formatter.

impl Default for Vec3

fn default() -> Vec3

Returns the “default value” for a type.

impl Display for Vec3

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

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, arg: f32) -> <Vec3 as Div<f32>>::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(array: [f32; 3]) -> Vec3

Converts to this type from the input type.

impl<T> From<(T, f32)> for Vec3

where T: Into<Vec2>,

fn from(arg: (T, f32)) -> Vec3

Converts to this type from the input type.

impl From<DVec3> for Vec3

fn from(arg: DVec3) -> Vec3

Converts to this type from the input type.

impl From<Vec3> for DVec3

fn from(arg: Vec3) -> DVec3

Converts to this type from the input type.

impl From<f32> for Vec3

fn from(arg: f32) -> Vec3

Converts to this type from the input type.

impl From<f64> for Vec3

fn from(arg: f64) -> Vec3

Converts to this type from the input type.

impl Into<[f32; 3]> for Vec3

fn into(self) -> [f32; 3]

Converts this type into the (usually inferred) input type.

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

type Output = Vec3

The resulting type after applying the * operator.

fn mul(self, rhs: Vec3) -> <&'a Mat3 as Mul<Vec3>>::Output

Performs the * operation.

impl Mul<Vec3> for Mat3

type Output = Vec3

The resulting type after applying the * operator.

fn mul(self, rhs: Vec3) -> <Mat3 as Mul<Vec3>>::Output

Performs the * operation.

impl Mul<f32> for Vec3

type Output = Vec3

The resulting type after applying the * operator.

fn mul(self, arg: f32) -> <Vec3 as Mul<f32>>::Output

Performs the * operation.

impl MulAssign<f32> for Vec3

fn mul_assign(&mut self, rhs: f32)

Performs the *= 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 for Vec3

type Output = Vec3

The resulting type after applying the - operator.

fn sub(self, rhs: Vec3) -> <Vec3 as Sub>::Output

Performs the - operation.

impl SubAssign for Vec3

fn sub_assign(&mut self, rhs: Vec3)

Performs the -= operation.

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

fn sum<I>(iter: I) -> Vec3

where I: Iterator<Item = &'a Vec3>,

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

impl Sum for Vec3

fn sum<I>(iter: I) -> Vec3

where I: Iterator<Item = Vec3>,

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

impl Copy for Vec3

impl StructuralPartialEq for Vec3