Struct density_mesh_core::coord::Coord

pub struct Coord {
    pub x: Scalar,
    pub y: Scalar,
}

Point coordinate.

Examples

use density_mesh_core::prelude::*;

let a = Coord::new(0.0, 0.0);
let b = Coord::new(2.0, 0.0);
assert_eq!((b - a).magnitude(), 2.0);
assert_eq!((b - a).sqr_magnitude(), 4.0);
assert_eq!((b - a).normalized(), Coord::new(1.0, 0.0));
assert_eq!((b - a).normalized().right(), Coord::new(0.0, -1.0));
assert_eq!(Coord::new(1.0, 0.0).dot(Coord::new(-1.0, 0.0)), -1.0);

Fields

x: Scalar

X value.

y: Scalar

Y value.

Implementations

impl Coord

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

Create new point coordinate.

Arguments

• x - X value.
• y - Y value.

pub fn sqr_magnitude(self) -> Scalar

Return squared length of the vector.

pub fn magnitude(self) -> Scalar

Return length of the vector.

pub fn normalized(self) -> Self

Return normalized vector (length equals to 1).

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

Returns dot product (cosinus of the angle between two vectors when both are normalized).

       self 1 other
            ^
            |
other 0 <---*---> 0 other
            |
            v
           -1
          other

Arguments

• other - Other vector.

pub fn right(self) -> Self

Return right vector.

     ^
self |
     *---> right

Trait Implementations

impl Add<Coord> for Coord

type Output = Self

The resulting type after applying the + operator.

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

Performs the + operation.

impl Add<f32> for Coord

type Output = Self

The resulting type after applying the + operator.

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

Performs the + operation.

impl Clone for Coord

fn clone(&self) -> Coord

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Copy for Coord

impl Debug for Coord

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

Formats the value using the given formatter.

impl Default for Coord

fn default() -> Coord

Returns the "default value" for a type.

impl<'de> Deserialize<'de> for Coord

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error> where
    __D: Deserializer<'de>, 

Deserialize this value from the given Serde deserializer.

impl Div<Coord> for Coord

type Output = Self

The resulting type after applying the / operator.

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

Performs the / operation.

impl Div<f32> for Coord

type Output = Self

The resulting type after applying the / operator.

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

Performs the / operation.

impl Mul<Coord> for Coord

type Output = Self

The resulting type after applying the * operator.

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

Performs the * operation.

impl Mul<f32> for Coord

type Output = Self

The resulting type after applying the * operator.

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

Performs the * operation.

impl Neg for Coord

type Output = Self

The resulting type after applying the - operator.

fn neg(self) -> Self

Performs the unary - operation.

impl PartialEq<Coord> for Coord

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

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

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

This method tests for !=.

impl Serialize for Coord

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

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for Coord

impl Sub<Coord> for Coord

type Output = Self

The resulting type after applying the - operator.

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

Performs the - operation.

impl Sub<f32> for Coord

type Output = Self

The resulting type after applying the - operator.

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

Performs the - operation.