Struct Vector3

Source

pub struct Vector3<T: Vector3Coordinate> { /* private fields */ }

Expand description

Represents a vector in 3D space.

Implementations§

Source §

impl<T: Vector3Coordinate> Vector3<T>

Source

pub fn x_axis() -> Self

Unit vector along the X-axis.

Source

pub fn y_axis() -> Self

Unit vector along the Y-axis.

Source

pub fn z_axis() -> Self

Unit vector along the Z-axis.

Source

pub fn one() -> Self

Vector with all components set to 1.

Source

pub fn zero() -> Self

Vector with all components set to 0.

Source §

impl<T: Vector3Coordinate + Float> Vector3<T>

Source

pub fn fuzzy_equal(&self, target: &Self, epsilon: T) -> bool

Checks if this vector is approximately equal to another vector within a given epsilon.

§Panics

Panics if epsilon is negative.

§Examples

use vec3_rs::Vector3;

let v1 = Vector3::new(0.1, 0.2, 0.3);
let v2 = Vector3::new(0.101, 0.199, 0.299);

let epsilon = 0.01;
let is_approx_equal = v1.fuzzy_equal(&v2, epsilon);
assert!(is_approx_equal)

Source

pub fn lerp(&self, target: &Self, alpha: T) -> Self

Linearly interpolates between this vector and another vector by a given ratio.

§Examples

type Vector3 = vec3_rs::Vector3<f64>;

let origin = Vector3::zero();
let x_axis = Vector3::x_axis();
assert_eq!(origin.lerp(&x_axis, 0.5), Vector3::new(0.5, 0, 0))

Source

pub fn magnitude(&self) -> T

Computes the magnitude (length) of the vector.

§Examples

type Vector3 = vec3_rs::Vector3<f64>;

let mut vector3 = Vector3::new(12354,7324,-7765).normalized();
assert_eq!(vector3.magnitude(), 1.0);

Source

pub fn angle(&self, target: &Self) -> T

Computes the angle in radians (0..2pi) between this vector and another vector.

Source

pub fn angle_deg(&self, target: &Self) -> T
where T: From<f64>,

Computes the angle in degrees (0.0..360.0) between this vector and another vector.

Source

pub fn normalize(&mut self)

Scales the vector such that its magnitude becomes 1.

Source

pub fn normalized(&self) -> Self

Copies the vector and scales it such that its magnitude becomes 1.

Source

pub fn distance(&self, target: &Self) -> T

Computes the distance between this vector and another vector.

§Examples

type Vector3 = vec3_rs::Vector3<f64>;

let left = -Vector3::x_axis();
let right = Vector3::x_axis();
assert_eq!(left.distance(&right), 2.0);

Source

pub fn project(&self, on_normal: &Self) -> Self

Projects this vector onto another vector.

Source

pub fn reflect(&self, normal: &Self) -> Self

Reflects this vector off a surface defined by a normal.

Source

pub fn inverse(&self) -> Self

Inverts the components of the vector.

Source

pub fn abs(&self) -> Self

Returns a new vector with the absolute value of each component.

Source

pub fn ceil(&self) -> Self

Returns a new vector with the ceiling of each component.

Source

pub fn floor(&self) -> Self

Returns a new vector with the floor of each component.

Source

pub fn round(&self) -> Self

Returns a new vector with the rounded value of each component.

Source

pub fn clamp(&self, min: T, max: T) -> Self

Returns a new vector with each component clamped to a given range.

Source

pub fn rotated(&self, axis: &Self, angle: T) -> Self

Rotates the vector around an axis by a given angle in radians.

Source

pub fn from_spherical(radius: T, polar: T, azimuth: T) -> Self

Creates a new Vector3 from spherical coordinates.

§Arguments

radius - The distance from the origin.
polar - The polar angle (the angle from the z-axis, in radians).
azimuth - The azimuth angle (the angle from the x-axis in the xy-plane, in radians).

Source §

impl<T: Vector3Coordinate> Vector3<T>

Source

pub fn new<U: Into<T>, V: Into<T>, W: Into<T>>(x: U, y: V, z: W) -> Self

Creates a new Vector3 with the specified coordinates.

§Examples

type Vector3 = vec3_rs::Vector3<f64>;

let vector3 = Vector3::new(1.0, 2.0, 3.0);
let also_ok = Vector3::new(1, 2, 3);
assert_eq!(vector3, also_ok);

// can also be created from arrays and tuples
// but no automatic number conversion
let from_array = Vector3::from([1.0, 2.0, 3.0]);
let from_tuple = Vector3::from((1.0, 2.0, 3.0));
assert_eq!(vector3, from_array);
assert_eq!(vector3, from_tuple);

// conversion is fallible with unknown sized data types
let slice: &[f64] = [1.0, 2.0, 3.0].as_ref();
let from_slice = Vector3::try_from(slice).unwrap();
let from_vec = Vector3::try_from(vec![1.0, 2.0, 3.0]).unwrap();
assert_eq!(vector3, from_slice);
assert_eq!(vector3, from_vec);