Struct myelin_geometry::Vector

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

A vector

Fields

x: f64

The x component of the Vector

y: f64

The y component of the Vector

Implementations

impl Vector

pub fn dot_product(self, other: Self) -> f64

Calculates the dot product of itself and another vector

Examples

use myelin_geometry::Vector;
// a · b = c
let a = Vector { x: 2.0, y: 3.0 };
let b = Vector { x: -4.0, y: 10.0 };
let c = a.dot_product(b);
assert_eq!(22.0, c);

pub fn cross_product(self, other: Self) -> f64

Calculates the cross product of itself and another vector

Examples

use myelin_geometry::Vector;
// a × b = c
let a = Vector { x: 2.0, y: 3.0 };
let b = Vector { x: -4.0, y: 10.0 };
let c = a.cross_product(b);
assert_eq!(32.0, c);

pub fn normal(self) -> Self

Returns the vector’s normal vector, i.e. a vector that is perpendicular to this vector

pub fn magnitude(self) -> f64

Returns the magnitude of the vector, i.e. its length if viewed as a line

pub fn unit(self) -> Self

Returns the unit vector of this vector, i.e. a vector with the same direction and a magnitude of 1

pub fn project_onto(self, other: Self) -> Self

Returns the projection of this vector onto another vector

pub fn rotate(self, rotation: Radians) -> Self

Rotate a vector by the given amount (counterclockwise)

pub fn rotate_clockwise(self, rotation: Radians) -> Self

Rotate a vector by the given amount (clockwise)

pub fn negative(self) -> Self

Negates the vector, returning a vector with the same magnitude pointing in the opposite direction.

Trait Implementations

impl Add for Vector

type Output = Vector

The resulting type after applying the + operator.

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

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 Default for Vector

fn default() -> Vector

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for Vector

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Div<f64> for Vector

type Output = Vector

The resulting type after applying the / operator.

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

Performs the / operation.

impl From<Point> for Vector

fn from(point: Point) -> Self

Converts to this type from the input type.

impl From<Vector> for Point

fn from(vector: Vector) -> Self

Converts to this type from the input type.

impl Mul<f64> for Vector

type Output = Vector

The resulting type after applying the * operator.

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

Performs the * 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 Serialize for Vector

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl Sub for Vector

type Output = Vector

The resulting type after applying the - operator.

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

Performs the - operation.

impl Copy for Vector

impl StructuralPartialEq for Vector