Struct Direction 

pub struct Direction { /* private fields */ }

Direction is a vector quantity that represents a change in Position.

Position and Direction are two sides of the same coin. We can also think of any position as a change of position from the origin (Position::ZERO) to the target location.

Implementations

impl Direction

Methods

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

New Direction.

pub fn to_array(&self) -> [Magnitude; 3]

pub fn x(&self) -> Magnitude

pub fn y(&self) -> Magnitude

pub fn z(&self) -> Magnitude

pub fn magnitude(&self) -> Magnitude

Returns the Magnitude of the current Direction.

$$ d = |\bm{a}| = \sqrt{x^2 + y^2 + z^2} $$

pub fn magnitude_squared(&self) -> Magnitude

Returns the square of the Magnitude of the current Direction.

This is faster than getting the Magnitude since we avoid having to calculate the square root of the sum of the vector components. This can be useful if we just need to compare magnitudes.

$$ d^2 = |\bm{a}|^2 = x^2 + y^2 + z^2 $$

pub fn normalize(&self) -> Direction

Returns the normalized vector, as a unit vector.

That is the Direction with a Magnitude of 1.

$$ \bm{n} = \widehat{\bm{a}} = \frac{1}{d}\thinspace\bm{a} = \frac{\bm{a}}{|\bm{a}|} $$

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

Returns the cross product.

Also known as the vector product. It allows to point in a Direction orthogonal to both vectors.

$$ \bm{a}\times\bm{b} = \begin{bmatrix} a_x \cr a_y \cr a_z \end{bmatrix} \times \begin{bmatrix} b_x \cr b_y \cr b_z \end{bmatrix} = \begin{bmatrix} a_y b_z - a_z b_y \cr a_z b_x - a_x b_z \cr a_x b_y - a_y b_x \end{bmatrix} $$

pub fn dot(&self, other: Self) -> Magnitude

Returns the dot product.

Also known as the scalar product. It allows us to calculate the Magnitude of one vector in the direction of another.

$$ \bm{a}\cdot\bm{b} = \begin{bmatrix} a_x \cr a_y \cr a_z \end{bmatrix} \cdot \begin{bmatrix} b_x \cr b_y \cr b_z \end{bmatrix} = a_x b_x + a_y b_y + a_z b_z $$

pub fn vector(&self) -> DVec3

Returns the underlying vector type.

impl Direction

Constants

pub const ZERO: Self

All zeros.

pub const ONE: Self

All ones.

Trait Implementations

impl Add for Direction

type Output = Direction

The resulting type after applying the + operator.

fn add(self, other: Self) -> Self

Performs the + operation.

impl AddAssign for Direction

fn add_assign(&mut self, other: Self)

Performs the += operation.

impl Clone for Direction

fn clone(&self) -> Direction

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Direction

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

Formats the value using the given formatter.

impl Default for Direction

fn default() -> Direction

Returns the “default value” for a type.

impl Display for Direction

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

Formats the value using the given formatter.

impl Div<f64> for Direction

type Output = Direction

The resulting type after applying the / operator.

fn div(self, other: Magnitude) -> Self

Performs the / operation.

impl DivAssign<f64> for Direction

fn div_assign(&mut self, other: Magnitude)

Performs the /= operation.

impl Mul<f64> for Direction

type Output = Direction

The resulting type after applying the * operator.

fn mul(self, other: Magnitude) -> Self

Performs the * operation.

impl MulAssign<f64> for Direction

fn mul_assign(&mut self, other: Magnitude)

Performs the *= operation.

impl PartialEq for Direction

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

type Output = Direction

The resulting type after applying the - operator.

fn sub(self, other: Self) -> Self

Performs the - operation.

impl SubAssign for Direction

fn sub_assign(&mut self, other: Self)

Performs the -= operation.

impl Copy for Direction

impl StructuralPartialEq for Direction