Struct vec3_rs::Vector3

pub struct Vector3 { /* private fields */ }

Represents a vector in 3D space.

Doesn’t allow for NaN coordinates.

Implementations

impl Vector3

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

Creates a new Vector3 with the specified coordinates.

Panics

Panics if any of the coordinates is NaN.

Examples

use vec3_rs::Vector3;

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

pub fn from_i32(x: i32, y: i32, z: i32) -> Self

pub fn from_u32(x: u32, y: u32, z: u32) -> Self

pub fn from_i64(x: i64, y: i64, z: i64) -> Self

pub fn from_u64(x: u64, y: u64, z: u64) -> Self

pub fn random() -> Self

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

pub fn x_axis() -> &'static Self

Returns a reference to a Vector3 representing the X-axis.

pub fn y_axis() -> &'static Self

Returns a reference to a Vector3 representing the Y-axis.

pub fn z_axis() -> &'static Self

Returns a reference to a Vector3 representing the Z-axis.

pub fn zero() -> &'static Self

Returns a reference to the zero vector (0, 0, 0).

pub fn one() -> &'static Self

Returns a reference to the unit vector (1, 1, 1).

pub fn normalize(&mut self)

Scales the vector such that its magnitude becomes 1.

pub fn magnitude(&self) -> f64

Computes the magnitude (length) of the vector.

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

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

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

Computes the dot product between this vector and another vector.

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

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 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 get_x(&self) -> f64

Retrieves the X component of the vector.

pub fn get_y(&self) -> f64

Retrieves the Y component of the vector.

pub fn get_z(&self) -> f64

Retrieves the Z component of the vector.

Trait Implementations

impl Add<Vector3> for Vector3

Implementation of addition (+) operation between two Vector3 instances.

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

Adds two Vector3 instances component-wise.

type Output = Vector3

The resulting type after applying the + operator.

impl AddAssign<Vector3> for Vector3

Implementation of addition assignment (+=) operation for Vector3.

fn add_assign(&mut self, rhs: Self)

Adds the components of another Vector3 to this Vector3 instance in-place.

impl Clone for Vector3

fn clone(&self) -> Vector3

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Vector3

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

Formats the value using the given formatter.

impl Default for Vector3

fn default() -> Vector3

Returns the “default value” for a type.

impl Display for Vector3

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

Formats the value using the given formatter.

impl Div<Vector3> for Vector3

Implementation of division (/) operation between two Vector3 instances.

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

Divides each component of a Vector3 by the corresponding component of another. Returns None if any component of the divisor is NaN.

type Output = Option<Vector3>

The resulting type after applying the / operator.

impl Div<f64> for Vector3

Implementation of division (/) operation between a Vector3 and a scalar value.

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

Divides each component of a Vector3 by a scalar value. Returns None if the divisor is NaN.

type Output = Option<Vector3>

The resulting type after applying the / operator.

impl DivAssign<Vector3> for Vector3

Implementation of division assignment (/=) operation between two Vector3 instances.

fn div_assign(&mut self, rhs: Vector3)

Divides each component of this Vector3 instance by the corresponding component of another in-place.

Panics

Panics if any component of the divisor becomes NaN.

impl DivAssign<f64> for Vector3

Implementation of division assignment (/=) operation for Vector3 with a scalar.

fn div_assign(&mut self, rhs: f64)

Divides each component of this Vector3 instance by a scalar value in-place.

Panics

Panics if any resulting component becomes NaN.

impl From<[f64; 3]> for Vector3

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

Converts to this type from the input type.

impl From<(f64, f64, f64)> for Vector3

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

Converts to this type from the input type.

impl From<Vector3> for [f64; 3]

fn from(value: Vector3) -> Self

Converts to this type from the input type.

impl From<Vector3> for (f64, f64, f64)

fn from(value: Vector3) -> Self

Converts to this type from the input type.

impl Mul<Vector3> for Vector3

Implementation of multiplication (*) operation between two Vector3 instances.

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

Multiplies two Vector3 instances component-wise.

type Output = Vector3

The resulting type after applying the * operator.

impl Mul<f64> for Vector3

Implementation of multiplication (*) operation between a Vector3 and a scalar value.

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

Multiplies each component of a Vector3 by a scalar value.

type Output = Vector3

The resulting type after applying the * operator.

impl MulAssign<Vector3> for Vector3

Implementation of multiplication assignment (*=) operation between two Vector3 instances.

fn mul_assign(&mut self, rhs: Vector3)

Multiplies each component of this Vector3 instance by the corresponding component of another in-place.

impl MulAssign<f64> for Vector3

Implementation of multiplication assignment (*=) operation for Vector3 with a scalar.

fn mul_assign(&mut self, rhs: f64)

Multiplies each component of this Vector3 instance by a scalar value in-place.

impl PartialEq<Vector3> for Vector3

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

This method tests for self and other values to be equal, and is used by ==.

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

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Sub<Vector3> for Vector3

Implementation of subtraction (-) operation between two Vector3 instances.

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

Subtracts the components of the second Vector3 from the first Vector3 component-wise.

type Output = Vector3

The resulting type after applying the - operator.

impl SubAssign<Vector3> for Vector3

Implementation of subtraction assignment (-=) operation for Vector3.

fn sub_assign(&mut self, rhs: Self)

Subtracts the components of another Vector3 from this Vector3 instance in-place.

impl TryFrom<&str> for Vector3

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 TryFrom<Vec<f64, Global>> for Vector3

type Error = ParseVector3Error

The type returned in the event of a conversion error.

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

Performs the conversion.

impl Copy for Vector3

impl StructuralPartialEq for Vector3