Struct Vec3 

pub struct Vec3 {
    pub x: f64,
    pub y: f64,
    pub z: f64,
}

A 3-dimensional vector type.

Provides common vector operations such as addition, subtraction, scalar and component-wise multiplication, normalization, dot and cross products.

Examples

use lars::Vec3;
let a = Vec3::new(1.0, 0.0, 0.0);
let b = Vec3::new(0.0, 1.0, 0.0);

let cross = a.cross(&b); // Vec3 { x: 0.0, y: 0.0, z: 1.0 }
let dot = a.dot(&b); // 0.0

Fields

x: f64

X component of the vector.

y: f64

Y component of the vector.

z: f64

Z component of the vector.

Implementations

impl Vec3

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

impl Vec3

pub const ZERO: Vec3

A zero Vector (0.0, 0.0, 0.0)

pub const ONE: Vec3

A one Vector (1.0, 1.0, 1.0)

pub const UNIT_X: Vec3

A Unit Vector in X (1.0, 0.0, 0.0)

pub const UNIT_Y: Vec3

A Unit Vector in Y (0.0, 1.0, 0.0)

pub const UNIT_Z: Vec3

A Unit Vector in Z (0.0, 0.0, 1.0)

pub fn mag(&self) -> f64

Returns the magnitude (length) of the vector.

Examples

 use lars::Vec3;
let v = Vec3::new(3.0, 4.0, 0.0);
assert_eq!(v.mag(), 5.0);

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

Returns the dot product between self and another Vec3.

Examples

use lars::Vec3;
let a = Vec3::new(1.0, 2.0, 3.0);
let b = Vec3::new(4.0, -5.0, 6.0);
assert_eq!(a.dot(&b), 12.0);

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

Returns the cross product between self and another Vec3.

The cross product is perpendicular to both vectors.

Examples

use lars::Vec3;
let a = Vec3::new(1.0, 0.0, 0.0);
let b = Vec3::new(0.0, 1.0, 0.0);
assert_eq!(a.cross(&b), Vec3::new(0.0, 0.0, 1.0));

pub fn map<F>(&self, f: F) -> Vec3

where F: Fn(f64) -> f64,

Applies a function f to each component (x, y, and z) of the vector.

Examples

 use lars::Vec3;
let v = Vec3::new(1.0, 2.0, 3.0);
let squared = v.map(|x| x * x);
assert_eq!(squared, Vec3::new(1.0, 4.0, 9.0));

pub fn normalize(&self) -> Vec3

Returns a normalized version of the vector (unit length).

Each component is divided by the vector’s magnitude.

Panics

Panics if the vector has zero magnitude (division by zero).

Examples

 use lars::Vec3;
let v = Vec3::new(3.0, 0.0, 0.0);
assert_eq!(v.normalize(), Vec3::new(1.0, 0.0, 0.0));

pub fn mag_sq(&self) -> f64

Returns the magnitude of the vector, squared.

Examples

 use lars::Vec3;
let v = Vec3::new(3.0, 4.0, 0.0);
assert_eq!(v.mag_sq(), 25.0);

impl Vec3

pub fn dist(&self, other: &Point3D) -> f64

Finds the unsigned distance between self and another 3D point Other.

#examples

use lars::{Point3D};
let a = Point3D::new(1.0, 0.0, 0.0);
let b = Point3D::new(0.0, 0.0, 0.0);
assert_eq!(a.dist(&b), 1.0)

pub fn dist_sq(&self, other: &Point3D) -> f64

Finds the unsigned distance between self and another 3D point Other, squared

#examples

use lars::Point3D;
let a = Point3D::new(2.0, 0.0, 0.0);
let b = Point3D::new(0.0, 0.0, 0.0);
assert_eq!(a.dist_sq(&b), 4.0)

Trait Implementations

impl Add for Vec3

type Output = Vec3

The resulting type after applying the + operator.

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

Performs the + operation.

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

Returns (0.0, 0.0, 0.0)

fn default() -> Self

Returns the “default value” for a type.

impl Display for Vec3

displays the vector in the form (X, Y, Z)

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

Formats the value using the given formatter.

impl<__RhsT: Copy> Div<__RhsT> for Vec3

where f64: Div<__RhsT, Output = f64>,

type Output = Vec3

The resulting type after applying the / operator.

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

Performs the / operation.

impl Mul<Mat3> for Vec3

type Output = Vec3

The resulting type after applying the * operator.

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

Performs the * operation.

impl Mul<Vec3> for Mat3

type Output = Vec3

The resulting type after applying the * operator.

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

Performs the * operation.

impl Mul<Vec3> for f64

Implements scalar multiplication of a vector by a float (f64).

This enables f64 * Vec3 syntax.

Examples

 use lars::Vec3;
let v = Vec3::new(1.0, 2.0, 3.0);
let scaled = 2.0 * v;
assert_eq!(scaled, Vec3::new(2.0, 4.0, 6.0));

type Output = Vec3

The resulting type after applying the * operator.

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

Performs the * operation.

impl<__RhsT: Copy> Mul<__RhsT> for Vec3

where f64: Mul<__RhsT, Output = f64>,

type Output = Vec3

The resulting type after applying the * operator.

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

Performs the * operation.

impl Mul for Vec3

Implements component-wise multiplication between two Vec3s.

This is useful for operations such as color blending or per-component scaling.

Examples

 use lars::Vec3;
let a = Vec3::new(1.0, 2.0, 3.0);
let b = Vec3::new(2.0, 0.5, 4.0);
assert_eq!(a * b, Vec3::new(2.0, 1.0, 12.0));

type Output = Vec3

The resulting type after applying the * operator.

fn mul(self, vector: 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 PartialEq for Vec3

fn eq(&self, other: &Self) -> 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 PartialOrd for Vec3

fn partial_cmp(&self, other: &Vec3) -> 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 Sub for Vec3

type Output = Vec3

The resulting type after applying the - operator.

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

Performs the - operation.

impl Copy for Vec3