Struct Vector3D 

pub struct Vector3D { /* private fields */ }

A 3D vector with x, y, and z components represented as f64.

Implementations

impl Vector3D

Implements methods and operator overloading for Vector3D.

pub fn zero() -> Vector3D

Returns the zero vector (0.0, 0.0, 0.0).

Returns

• Vector3D - The zero vector.

pub fn right() -> Vector3D

Returns the unit vector pointing right (1.0, 0.0, 0.0).

Returns

• Vector3D - The right unit vector.

pub fn up() -> Vector3D

Returns the unit vector pointing up (0.0, 1.0, 0.0).

Returns

• Vector3D - The up unit vector.

pub fn forward() -> Vector3D

Returns the unit vector pointing forward (0.0, 0.0, -1.0).

In a right-handed coordinate system where -z is forward.

Returns

• Vector3D - The forward unit vector.

pub fn magnitude(&self) -> f64

Returns the magnitude (length) of the vector.

Returns

• f64 - The magnitude of the vector.

pub fn magnitude_squared(&self) -> f64

Returns the squared magnitude of the vector.

Avoids a square root, making it faster for comparison-only use cases.

Returns

• f64 - The squared magnitude of the vector.

pub fn normalized(&self) -> Vector3D

Returns a normalized (unit length) copy of this vector.

Returns the zero vector if the magnitude is zero.

Returns

• Vector3D - The normalized vector.

pub fn normalize(&mut self)

Normalizes this vector in place.

pub fn dot(&self, other: Vector3D) -> f64

Computes the dot product with another vector.

Arguments

• Vector3D - The other vector.

Returns

• f64 - The dot product.

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

Computes the 3D cross product with another vector.

Arguments

• Vector3D - The other vector.

Returns

• Vector3D - The cross product vector.

pub fn distance_to(&self, other: Vector3D) -> f64

Returns the distance from this point to another.

Arguments

• Vector3D - The target point.

Returns

• f64 - The Euclidean distance.

pub fn distance_squared_to(&self, other: Vector3D) -> f64

Returns the squared distance from this point to another.

Arguments

• Vector3D - The target point.

Returns

• f64 - The squared Euclidean distance.

pub fn direction_to(&self, other: Vector3D) -> Vector3D

Returns a unit vector pointing from this point to another.

Arguments

• Vector3D - The target point.

Returns

• Vector3D - The direction unit vector.

pub fn lerp(&self, other: Vector3D, t: f64) -> Vector3D

Returns a linearly interpolated vector between this and another.

Arguments

• Vector3D - The target vector.
• f64 - The interpolation factor.

Returns

• Vector3D - The interpolated vector.

pub fn scale(&mut self, scalar: f64)

Scales this vector by a scalar factor.

Arguments

• f64 - The scalar factor.

pub fn scaled(&self, scalar: f64) -> Vector3D

Returns a scaled copy of this vector.

Arguments

• f64 - The scalar factor.

Returns

• Vector3D - The scaled vector.

pub fn rotated_by(&self, quaternion: Quaternion) -> Vector3D

Rotates this vector by a quaternion.

Arguments

• Quaternion - The rotation quaternion.

Returns

• Vector3D - The rotated vector.

impl Vector3D

pub fn get_x(&self) -> f64

pub fn get_mut_x(&mut self) -> &mut f64

pub fn set_x(&mut self, val: f64) -> &mut Self

pub fn get_y(&self) -> f64

pub fn get_mut_y(&mut self) -> &mut f64

pub fn set_y(&mut self, val: f64) -> &mut Self

pub fn get_z(&self) -> f64

pub fn get_mut_z(&mut self) -> &mut f64

pub fn set_z(&mut self, val: f64) -> &mut Self

impl Vector3D

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

Trait Implementations

impl Add for Vector3D

Implements vector addition.

type Output = Vector3D

The resulting type after applying the + operator.

fn add(self, other: Vector3D) -> Vector3D

Performs the + operation.

impl AddAssign for Vector3D

Implements in-place vector addition.

fn add_assign(&mut self, other: Vector3D)

Performs the += operation.

impl Clone for Vector3D

fn clone(&self) -> Vector3D

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Copy for Vector3D

impl Debug for Vector3D

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

Formats the value using the given formatter.

impl Default for Vector3D

fn default() -> Vector3D

Returns the “default value” for a type.

impl Interpolable for Vector3D

Implements Interpolable for Vector3D.

fn lerp(&self, other: Vector3D, t: f64) -> Vector3D

Performs linear interpolation between self and other by the factor t.

impl Mul<f64> for Vector3D

Implements scalar multiplication.

type Output = Vector3D

The resulting type after applying the * operator.

fn mul(self, scalar: f64) -> Vector3D

Performs the * operation.

impl MulAssign<f64> for Vector3D

Implements in-place scalar multiplication.

fn mul_assign(&mut self, scalar: f64)

Performs the *= operation.

impl Neg for Vector3D

Implements vector negation.

type Output = Vector3D

The resulting type after applying the - operator.

fn neg(self) -> Vector3D

Performs the unary - operation.

impl PartialEq for Vector3D

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

Equality operator ==.

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

Inequality operator !=.

impl PartialOrd for Vector3D

fn partial_cmp(&self, other: &Vector3D) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

fn lt(&self, other: &Rhs) -> bool

Tests less than (for self and other) and is used by the < operator.

fn le(&self, other: &Rhs) -> bool

Tests less than or equal to (for self and other) and is used by the <= operator.

fn gt(&self, other: &Rhs) -> bool

Tests greater than (for self and other) and is used by the > operator.

fn ge(&self, other: &Rhs) -> bool

Tests greater than or equal to (for self and other) and is used by the >= operator.

impl StructuralPartialEq for Vector3D

impl Sub for Vector3D

Implements vector subtraction.

type Output = Vector3D

The resulting type after applying the - operator.

fn sub(self, other: Vector3D) -> Vector3D

Performs the - operation.

impl SubAssign for Vector3D

Implements in-place vector subtraction.

fn sub_assign(&mut self, other: Vector3D)

Performs the -= operation.

impl Vector for Vector3D

Implements the Vector trait for Vector3D, forwarding every method to the inherent implementation on the struct.

Vector3D also offers 3D-specific operations that are not part of the trait surface: cross (returning Vector3D), direction_to, distance_to, scale, and normalize. These remain inherent.

fn zero() -> Vector3D

Returns the additive identity (Self::default()).

fn dot(&self, other: Vector3D) -> f64

Computes the dot product with another vector.

fn magnitude(&self) -> f64

Returns the magnitude (length) of the vector.

fn magnitude_squared(&self) -> f64

Returns the squared magnitude of the vector.

fn normalized(&self) -> Vector3D

Returns a normalized (unit length) copy of this vector.

fn scaled(&self, scalar: f64) -> Vector3D

Returns a copy of this vector scaled by the given factor.

fn lerp(&self, other: Vector3D, t: f64) -> Vector3D

Performs linear interpolation between self and other by t.