Struct Vector3 

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

Represents a vector in 3D space.

Implementations

impl<T: Vector3Coordinate> Vector3<T>

pub fn x_axis() -> Self

Unit vector along the X-axis.

pub fn y_axis() -> Self

Unit vector along the Y-axis.

pub fn z_axis() -> Self

Unit vector along the Z-axis.

pub fn one() -> Self

Vector with all components set to 1.

pub fn zero() -> Self

Vector with all components set to 0.

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

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)

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

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

pub fn magnitude(&self) -> T

Computes the magnitude (length) of the vector.

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

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

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

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

Panics

Panics if T, the vector’s datatype, cannot be converted to a f64.

pub fn normalize(&mut self)

Scales the vector such that its magnitude becomes 1.

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

Computes the distance between this vector and another vector.

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

Projects this vector onto another vector.

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

Reflects this vector off a surface defined by a normal.

pub fn inverse(&self) -> Self

Inverts the components of the vector.

pub fn abs(&self) -> Self

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

pub fn ceil(&self) -> Self

Returns a new vector with the ceiling of each component.

pub fn floor(&self) -> Self

Returns a new vector with the floor of each component.

pub fn round(&self) -> Self

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

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

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

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

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

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).

impl<T: Vector3Coordinate> Vector3<T>

pub const 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 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 const fn x(&self) -> &T

Retrieves the X component of the vector.

pub const fn y(&self) -> &T

Retrieves the Y component of the vector.

pub const fn 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> DivAssign<T> for Vector3<T>

fn div_assign(&mut self, rhs: 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> FromStr for Vector3<T>

where T: Vector3Coordinate + FromStr,

type Err = ParseVector3Error

The associated error which can be returned from parsing.

fn from_str(s: &str) -> Result<Self, Self::Err>

Parses a string s to return a value of this type.

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

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

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> MulAssign<T> for Vector3<T>

fn mul_assign(&mut self, rhs: T)

Performs the *= operation.

impl<T: Vector3Coordinate + Neg<Output = T>> Neg for &Vector3<T>

type Output = Vector3<T>

The resulting type after applying the - operator.

fn neg(self) -> Self::Output

Performs the unary - operation.

impl<T: Vector3Coordinate + Neg<Output = T>> Neg for Vector3<T>

type Output = Vector3<T>

The resulting type after applying the - operator.

fn neg(self) -> Self::Output

Performs the unary - 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 for Vector3<T>

where T: Vector3Coordinate + Float,

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

where T: Vector3Coordinate + FromStr,

type Error = ParseVector3Error

The type returned in the event of a conversion error.

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

Performs the conversion.

impl<T> TryFrom<Box<str>> for Vector3<T>

where T: Vector3Coordinate + FromStr,

type Error = ParseVector3Error

The type returned in the event of a conversion error.

fn try_from(s: Box<str>) -> Result<Self, Self::Error>

Performs the conversion.

impl<T> TryFrom<Cow<'_, str>> for Vector3<T>

where T: Vector3Coordinate + FromStr,

type Error = ParseVector3Error

The type returned in the event of a conversion error.

fn try_from(s: Cow<'_, str>) -> Result<Self, Self::Error>

Performs the conversion.

impl<T> TryFrom<String> for Vector3<T>

where T: Vector3Coordinate + FromStr,

type Error = ParseVector3Error

The type returned in the event of a conversion error.

fn try_from(s: String) -> 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: Vector3Coordinate> TryFrom<VecDeque<T>> for Vector3<T>

type Error = ParseVector3Error

The type returned in the event of a conversion error.

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

Performs the conversion.

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

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

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