Struct Vector3

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

Represents a vector in 3D space.

Implementations

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

where Standard: Distribution<T>,

pub fn random() -> Self

Generates a random Vector3 with components in the range [0.0, 1.0).

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

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

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);
println!("Are v1 and v2 approximately equal? {}", is_approx_equal);

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

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

impl Vector3<f64>

pub fn normalize(&mut self)

Scales the vector such that its magnitude becomes 1.

impl Vector3<f32>

pub fn normalize(&mut self)

Scales the vector such that its magnitude becomes 1.

impl<T: Vector3Coordinate> Vector3<T>

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

Creates a new Vector3 with the specified coordinates.

Examples

use vec3_rs::Vector3;

let vector3 = Vector3::new(1.0, 2.0, 3.0);

pub fn magnitude(&self) -> f64

Computes the magnitude (length) of the vector.

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

Computes the dot product between this vector and another vector.

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

Computes the cross product between this vector and another vector.

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

Computes the component-wise maximum of this vector and another vector.

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

Computes the component-wise minimum of this vector and another vector.

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

Computes the angle in radians between this vector and another vector.

pub fn angle_deg(&self, target: &Self) -> f64

Computes the angle in degrees between this vector and another vector.

pub const fn get_x(&self) -> T

Retrieves the X component of the vector.

pub const fn get_y(&self) -> T

Retrieves the Y component of the vector.

pub const fn get_z(&self) -> T

Retrieves the Z component of the vector.

Trait Implementations

impl<T: Vector3Coordinate> Add for Vector3<T>

type Output = Vector3<T>

The resulting type after applying the + operator.

fn add(self, rhs: Vector3<T>) -> Self::Output

Performs the + operation.

impl<T: Vector3Coordinate> AddAssign for Vector3<T>

fn add_assign(&mut self, rhs: Self)

Performs the += operation.

impl<T: Clone + Vector3Coordinate> Clone for Vector3<T>

fn clone(&self) -> Vector3<T>

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<T: Debug + Vector3Coordinate> Debug for Vector3<T>

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

Formats the value using the given formatter.

impl<T: Default + Vector3Coordinate> Default for Vector3<T>

fn default() -> Vector3<T>

Returns the “default value” for a type.

impl<T: Vector3Coordinate> Display for Vector3<T>

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

Formats the value using the given formatter.

impl<T: Vector3Coordinate> Div<T> for Vector3<T>

type Output = Vector3<T>

The resulting type after applying the / operator.

fn div(self, rhs: T) -> Self::Output

Performs the / operation.

impl<T: Vector3Coordinate> Div for Vector3<T>

type Output = Vector3<T>

The resulting type after applying the / operator.

fn div(self, rhs: Vector3<T>) -> Self::Output

Performs the / operation.

impl<T: Vector3Coordinate> DivAssign<T> for Vector3<T>

fn div_assign(&mut self, rhs: T)

Performs the /= operation.

impl<T: Vector3Coordinate> DivAssign for Vector3<T>

fn div_assign(&mut self, rhs: Vector3<T>)

Performs the /= operation.

impl<T: Vector3Coordinate> From<[T; 3]> for Vector3<T>

fn from(value: [T; 3]) -> Self

Converts to this type from the input type.

impl<T: Vector3Coordinate> From<(T, T, T)> for Vector3<T>

fn from(value: (T, T, T)) -> Self

Converts to this type from the input type.

impl<T: Vector3Coordinate> From<Vector3<T>> for [T; 3]

fn from(value: Vector3<T>) -> Self

Converts to this type from the input type.

impl<T: Vector3Coordinate> From<Vector3<T>> for (T, T, T)

fn from(value: Vector3<T>) -> Self

Converts to this type from the input type.

impl<T: Vector3Coordinate> Mul<T> for Vector3<T>

type Output = Vector3<T>

The resulting type after applying the * operator.

fn mul(self, rhs: T) -> Self::Output

Performs the * operation.

impl<T: Vector3Coordinate> Mul for Vector3<T>

type Output = Vector3<T>

The resulting type after applying the * operator.

fn mul(self, rhs: Vector3<T>) -> Self::Output

Performs the * operation.

impl<T: Vector3Coordinate> MulAssign<T> for Vector3<T>

fn mul_assign(&mut self, rhs: T)

Performs the *= operation.

impl<T: Vector3Coordinate> MulAssign for Vector3<T>

fn mul_assign(&mut self, rhs: Vector3<T>)

Performs the *= operation.

impl<T: PartialEq + Vector3Coordinate> PartialEq for Vector3<T>

fn eq(&self, other: &Vector3<T>) -> 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<T: PartialOrd + Vector3Coordinate> PartialOrd for Vector3<T>

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

type Output = Vector3<T>

The resulting type after applying the - operator.

fn sub(self, rhs: Vector3<T>) -> Self::Output

Performs the - operation.

impl<T: Vector3Coordinate> SubAssign for Vector3<T>

fn sub_assign(&mut self, rhs: Vector3<T>)

Performs the -= operation.

impl TryFrom<&str> for Vector3<f64>

type Error = ParseVector3Error

The type returned in the event of a conversion error.

fn try_from(value: &str) -> Result<Self, Self::Error>

Performs the conversion.

impl<T: Vector3Coordinate> TryFrom<Vec<T>> for Vector3<T>

type Error = ParseVector3Error

The type returned in the event of a conversion error.

fn try_from(value: Vec<T>) -> Result<Self, Self::Error>

Performs the conversion.

impl<T: Copy + Vector3Coordinate> Copy for Vector3<T>

impl<T: Vector3Coordinate> StructuralPartialEq for Vector3<T>