Struct Vector2

pub struct Vector2<T: CoordsFloat>(pub T, pub T);

2D vector representation

Generics

• T: CoordsFloat – Generic type for coordinates representation.

Example

use honeycomb_core::prelude::Vector2;

let unit_x = Vector2::unit_x();
let unit_y = Vector2::unit_y();

assert_eq!(unit_x.dot(&unit_y), 0.0);
assert_eq!(unit_x.normal_dir()?, unit_y);

let two: f64 = 2.0;
let x_plus_y: Vector2<f64> = unit_x + unit_y;

assert_eq!(x_plus_y.norm(), two.sqrt());
assert_eq!(x_plus_y.unit_dir()?, Vector2(1.0 / two.sqrt(), 1.0 / two.sqrt()));

Tuple Fields

0: T

1: T

Implementations

impl<T: CoordsFloat> Vector2<T>

pub fn unit_x() -> Self

Base vector

Return

Return a unit vector along the x axis.

pub fn unit_y() -> Self

Base vector

Return

Return a unit vector along the y axis.

pub fn into_inner(self) -> (T, T)

Consume self to return inner value

Return

Return coordinate values as a simple tuple.

pub fn x(&self) -> T

Getter

Return

Return the value of the x coordinate of the vector.

pub fn y(&self) -> T

Getter

Return

Return the value of the y coordinate of the vector.

pub fn norm(&self) -> T

Compute the norm of self.

Return

Return the norm. Its type is the same as the one used for internal representation.

Example

See Vector2 example.

pub fn unit_dir(&self) -> Result<Self, CoordsError>

Compute the direction of self as a unit vector.

Return

Return a Vector2 indicating the direction of self. The norm of the returned struct is equal to one.

Errors

This method will return an error if called on a Vector2 with a norm equal to zero, i.e. a null Vector2.

Example

See Vector2 example.

pub fn normal_dir(&self) -> Result<Vector2<T>, CoordsError>

Compute the direction of the normal vector to self.

Return

Return a Vector2 indicating the direction of the normal to self. The norm of the returned struct is equal to one.

Errors

This method will return an error if called on a Vector2 with a norm equal to zero, i.e. a null Vector2.

Example

See Vector2 example.

pub fn dot(&self, other: &Vector2<T>) -> T

Compute the dot product between two vectors

Arguments

• other: &Vector2 – reference to the second vector.

Return

Return the dot product between self and other.

Example

See Vector2 example.

Trait Implementations

impl<T: CoordsFloat> Add<&Vector2<T>> for Vertex2<T>

type Output = Vertex2<T>

The resulting type after applying the + operator.

fn add(self, rhs: &Vector2<T>) -> Self::Output

Performs the + operation.

impl<T: CoordsFloat> Add<Vector2<T>> for Vertex2<T>

type Output = Vertex2<T>

The resulting type after applying the + operator.

fn add(self, rhs: Vector2<T>) -> Self::Output

Performs the + operation.

impl<T: CoordsFloat> Add for Vector2<T>

type Output = Vector2<T>

The resulting type after applying the + operator.

fn add(self, rhs: Vector2<T>) -> Self::Output

Performs the + operation.

impl<T: CoordsFloat> AddAssign<&Vector2<T>> for Vertex2<T>

fn add_assign(&mut self, rhs: &Vector2<T>)

Performs the += operation.

impl<T: CoordsFloat> AddAssign<Vector2<T>> for Vertex2<T>

fn add_assign(&mut self, rhs: Vector2<T>)

Performs the += operation.

impl<T: CoordsFloat> AddAssign for Vector2<T>

fn add_assign(&mut self, rhs: Vector2<T>)

Performs the += operation.

impl<T: Clone + CoordsFloat> Clone for Vector2<T>

fn clone(&self) -> Vector2<T>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<T: Debug + CoordsFloat> Debug for Vector2<T>

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

Formats the value using the given formatter.

impl<T: Default + CoordsFloat> Default for Vector2<T>

fn default() -> Vector2<T>

Returns the “default value” for a type.

impl<T: CoordsFloat> Div<T> for Vector2<T>

type Output = Vector2<T>

The resulting type after applying the / operator.

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

Performs the / operation.

impl<T: CoordsFloat> DivAssign<T> for Vector2<T>

fn div_assign(&mut self, rhs: T)

Performs the /= operation.

impl<T: CoordsFloat> From<(T, T)> for Vector2<T>

fn from((x, y): (T, T)) -> Self

Converts to this type from the input type.

impl<T: CoordsFloat> From<Vector2<T>> for Vector3<T>

fn from(v: Vector2<T>) -> Self

Converts to this type from the input type.

impl<T: CoordsFloat> Mul<T> for Vector2<T>

type Output = Vector2<T>

The resulting type after applying the * operator.

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

Performs the * operation.

impl<T: CoordsFloat> MulAssign<T> for Vector2<T>

fn mul_assign(&mut self, rhs: T)

Performs the *= operation.

impl<T: CoordsFloat> Neg for Vector2<T>

type Output = Vector2<T>

The resulting type after applying the - operator.

fn neg(self) -> Self::Output

Performs the unary - operation.

impl<T: PartialEq + CoordsFloat> PartialEq for Vector2<T>

fn eq(&self, other: &Vector2<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: CoordsFloat> Sub<&Vector2<T>> for Vertex2<T>

type Output = Vertex2<T>

The resulting type after applying the - operator.

fn sub(self, rhs: &Vector2<T>) -> Self::Output

Performs the - operation.

impl<T: CoordsFloat> Sub<Vector2<T>> for Vertex2<T>

type Output = Vertex2<T>

The resulting type after applying the - operator.

fn sub(self, rhs: Vector2<T>) -> Self::Output

Performs the - operation.

impl<T: CoordsFloat> Sub for Vector2<T>

type Output = Vector2<T>

The resulting type after applying the - operator.

fn sub(self, rhs: Vector2<T>) -> Self::Output

Performs the - operation.

impl<T: CoordsFloat> SubAssign<&Vector2<T>> for Vertex2<T>

fn sub_assign(&mut self, rhs: &Vector2<T>)

Performs the -= operation.

impl<T: CoordsFloat> SubAssign<Vector2<T>> for Vertex2<T>

fn sub_assign(&mut self, rhs: Vector2<T>)

Performs the -= operation.

impl<T: CoordsFloat> SubAssign for Vector2<T>

fn sub_assign(&mut self, rhs: Vector2<T>)

Performs the -= operation.

impl<T: Copy + CoordsFloat> Copy for Vector2<T>

impl<T: CoordsFloat> Send for Vector2<T>

impl<T: CoordsFloat> StructuralPartialEq for Vector2<T>

impl<T: CoordsFloat> Sync for Vector2<T>