Struct rustic_zen::geom::Vector

pub struct Vector {
    pub x: f64,
    pub y: f64,
}

A standard 2D vector implementaion.

Fields

x: f64

y: f64

Implementations

impl Vector

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

Create new vector. This is just a helper given the fields are public.

pub fn magnitude(&self) -> f64

gets the linear size of the vector.

pub fn normalized(&self) -> Vector

returns a copy of this vector with a length of 1

pub fn normal(&self) -> Vector

get normal of this vector

pub fn mul_e(&self, other: &Vector) -> Vector

element wise multiply (it can come in handy)

pub fn scale_e(&self, sx: f64, sy: f64) -> Vector

element wise scaling with seperate x and y scaling factors

pub fn rotate(&self, theta: f64) -> Vector

apply a rotation matrix constructed around theta to this vector

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

Cross product of this vector with other

pub fn dot(&self, other: &Vector) -> f64

Dot product of this vector with other

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

Caluate a normal reflection of this vector as a direction vector against a surface with a normal vector of normal.

Parameters:

• self: a Vector representing the direction to be relected.
• normal: a Vector representing the normal of the surface being reflected off.

Neither vector needs to be normalised.

pub fn p(self) -> Point

Turn this vector back into a Point.

Only use when you are sure this vector actually represents a spacial coordinate.

Trait Implementations

impl Add<Point> for Vector

type Output = Point

The resulting type after applying the + operator.

fn add(self, rhs: Point) -> Point

Performs the + operation.

impl Add<Vector> for Point

type Output = Point

The resulting type after applying the + operator.

fn add(self, rhs: Vector) -> Point

Performs the + operation.

impl Add for Vector

type Output = Vector

The resulting type after applying the + operator.

fn add(self, rhs: Vector) -> Vector

Performs the + operation.

impl Clone for Vector

fn clone(&self) -> Vector

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Vector

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

Formats the value using the given formatter.

impl From<(f64, f64)> for Vector

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

Converts to this type from the input type.

impl Mul<Vector> for Matrix

type Output = Vector

The resulting type after applying the * operator.

fn mul(self, rhs: Vector) -> Vector

Performs the * operation.

impl Mul<f64> for Vector

type Output = Vector

The resulting type after applying the * operator.

fn mul(self, rhs: f64) -> Vector

Performs the * operation.

impl Neg for Vector

type Output = Vector

The resulting type after applying the - operator.

fn neg(self) -> Vector

Performs the unary - operation.

impl PartialEq for Vector

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

fn partial_cmp(&self, other: &Vector) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

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

This method tests less than (for self and other) and is used by the < operator.

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

This method tests less than or equal to (for self and other) and is used by the <= operator.

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

This method tests greater than (for self and other) and is used by the > operator.

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

This method tests greater than or equal to (for self and other) and is used by the >= operator.

impl Sub<Point> for Vector

type Output = Point

The resulting type after applying the - operator.

fn sub(self, rhs: Point) -> Point

Performs the - operation.

impl Sub<Vector> for Point

type Output = Point

The resulting type after applying the - operator.

fn sub(self, rhs: Vector) -> Point

Performs the - operation.

impl Sub for Vector

type Output = Vector

The resulting type after applying the - operator.

fn sub(self, rhs: Vector) -> Vector

Performs the - operation.

impl Copy for Vector

impl StructuralPartialEq for Vector