Struct rust_3d::Norm2D

pub struct Norm2D { /* fields omitted */ }

Norm2D, a normalized vector within 2D space

Trait Implementations

impl Clone for Norm2D

fn clone(&self) -> Norm2D

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Norm2D

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

Formats the value using the given formatter.

impl Eq for Norm2D

impl Hash for Norm2D

fn hash<H: Hasher>(&self, state: &mut H)

Feeds this value into the given [Hasher].

fn hash_slice<H>(data: &[Self], state: &mut H) where
    H: Hasher, 

Feeds a slice of this type into the given [Hasher].

impl Is2D for Norm2D

fn x(&self) -> f64

Should return the x-coordinate

fn y(&self) -> f64

Should return the y-coordinate

fn xy(&self) -> [f64; 2]

Returns the Position as x,y array

fn dot(&self, other: &dyn Is2D) -> f64

Calculates the dot product with another Is2D

fn cross(&self, other: &dyn Is2D) -> f64

Calculates the cross product with another Is2D

fn abs(&self) -> NonNegative

The absolute / length of this position

fn rad_to(&self, other: &dyn Is2D) -> Rad

Calculates the angle to the other Is2D in radians

fn to_str(&self) -> String

Transforms the position in a "x y" string. E.g. "3.72 5.99"

impl IsND for Norm2D

fn n_dimensions() -> usize

Should return the number of dimensions. E.g. 2 for points in 2D space, 3 for points in 3D space etc.

fn position_nd(&self, dimension: usize) -> Result<f64>

Should return the value of a given dimensions. E.g. for 2D position with x = 4.3, y = 1.8 the result for dimension = 1 should be 1.8

impl IsNormalized2D for Norm2D

fn new<P>(p: P) -> Result<Self> where
    P: Is2D, 

Should construct a new object and only fail if it can't be normalized

fn norm_x() -> Self

Returns a new normalized object which only points in the positive x-Direction

fn norm_y() -> Self

Returns a new normalized object which only points in the positive y-Direction

fn norm_x_neg() -> Self

Returns a new normalized object which only points in the negative x-Direction

fn norm_y_neg() -> Self

Returns a new normalized object which only points in the negative y-Direction

impl Mul<f64> for Norm2D

type Output = Point2D

The resulting type after applying the * operator.

fn mul(self, other: f64) -> Point2D

Performs the * operation.

impl<'_> Mul<f64> for &'_ Norm2D

type Output = Point2D

The resulting type after applying the * operator.

fn mul(self, other: f64) -> Point2D

Performs the * operation.

impl Neg for Norm2D

type Output = Norm2D

The resulting type after applying the - operator.

fn neg(self) -> Norm2D

Performs the unary - operation.

impl<'_> Neg for &'_ Norm2D

type Output = Norm2D

The resulting type after applying the - operator.

fn neg(self) -> Norm2D

Performs the unary - operation.

impl Ord for Norm2D

fn cmp(&self, other: &Self) -> Ordering

This method returns an [Ordering] between self and other.

#[must_use]fn max(self, other: Self) -> Self

Compares and returns the maximum of two values.

#[must_use]fn min(self, other: Self) -> Self

Compares and returns the minimum of two values.

#[must_use]fn clamp(self, min: Self, max: Self) -> Self

🔬 This is a nightly-only experimental API. (clamp)

Restrict a value to a certain interval.

impl PartialEq<Norm2D> for Norm2D

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

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

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

This method tests for !=.

impl PartialOrd<Norm2D> for Norm2D

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

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

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

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

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

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

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

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

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

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

impl StructuralPartialEq for Norm2D