Struct UnitVec3 

pub struct UnitVec3(/* private fields */);

A Vec3 that is normalised to unit length at construction time.

Stored as a plain Vec3 internally — the invariant is only enforced at the construction boundary.

Implementations

impl UnitVec3

pub const X: Self

+X axis.

pub const Y: Self

+Y axis.

pub const Z: Self

+Z axis.

pub fn try_from_vec(v: Vec3) -> Option<Self>

Construct from a Vec3, normalising it. Returns None for zero vectors.

pub fn new_unchecked(v: Vec3) -> Self

Construct without checking — caller asserts |v| ≈ 1.

Safety

Violating the unit-length invariant leads to incorrect geometric results, not unsound memory, so this is not unsafe in the Rust sense.

pub fn as_vec(self) -> Vec3

Access the underlying Vec3.

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

Dot product with another unit vector.

pub fn dot_vec(self, v: Vec3) -> f64

Dot product with a free Vec3.

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

Cross product — result is a plain Vec3 (may not be unit length).

pub fn flip(self) -> Self

Return the opposite direction.

pub fn angle_to(self, other: Self) -> f64

Angle between two unit vectors (radians, always in [0, π]).

pub fn perp_basis(self) -> (Self, Self)

Build an orthonormal basis (self, u, v) where u and v span the plane perpendicular to self. u is arbitrary but consistent.

Trait Implementations

impl Clone for UnitVec3

fn clone(&self) -> UnitVec3

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Copy for UnitVec3

impl Debug for UnitVec3

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

Formats the value using the given formatter.

impl From<UnitVec3> for Vec3

fn from(u: UnitVec3) -> Vec3

Converts to this type from the input type.

impl Mul<UnitVec3> for f64

type Output = Vec3

The resulting type after applying the * operator.

fn mul(self, u: UnitVec3) -> Vec3

Performs the * operation.

impl Mul<f64> for UnitVec3

type Output = Vec3

The resulting type after applying the * operator.

fn mul(self, s: f64) -> Vec3

Performs the * operation.

impl Neg for UnitVec3

type Output = UnitVec3

The resulting type after applying the - operator.

fn neg(self) -> Self

Performs the unary - operation.

impl PartialEq for UnitVec3

fn eq(&self, other: &UnitVec3) -> 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 StructuralPartialEq for UnitVec3