Struct Direction2 

pub struct Direction2(/* private fields */);

A unit vector in the plane.

Implementations

impl Direction2

pub const X: Self

+X.

pub const Y: Self

+Y.

pub fn new(v: Vector2, tol: Tolerances) -> OgeomResult<Self>

Normalize v into a direction.

Errors

OgeomError::Construction if v is non-finite or shorter than tol.confusion().

pub fn from_coords(x: f64, y: f64, tol: Tolerances) -> OgeomResult<Self>

Normalize components into a direction.

Errors

As Direction2::new.

pub fn unit(v: Vector2, tol: Tolerances) -> OgeomResult<Self>

A direction from a vector that is already a unit vector.

As Direction::unit: it checks rather than normalizes, so a direction read back from a document is the one that was written and not something a bit or two away from it.

Errors

OgeomError::Construction if v is non-finite, or its length differs from one by more than tol.confusion().

pub fn from_angle(angle: f64) -> Self

The direction at angle radians counter-clockwise from +X.

pub const fn vector(self) -> Vector2

The underlying unit vector.

pub const fn x(self) -> f64

X component.

pub const fn y(self) -> f64

Y component.

pub const fn to_array(self) -> [f64; 2]

Components as an array.

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

Dot product: the cosine of the angle between the two.

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

Scalar cross product: the sine of the signed angle from self to other.

pub const fn perpendicular(self) -> Self

This direction rotated a quarter turn counter-clockwise. Exact.

pub fn to_angle(self) -> f64

Angle from +X, in (-π, π].

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

Signed angle to other, in (-π, π], positive counter-clockwise.

pub fn is_equal(self, other: Self, tol: Tolerances) -> bool

Whether the two point the same way, within tol.angular().

pub fn is_opposite(self, other: Self, tol: Tolerances) -> bool

Whether the two point opposite ways, within tol.angular().

pub fn is_parallel(self, other: Self, tol: Tolerances) -> bool

Whether the two are parallel, ignoring sense.

pub fn is_normal(self, other: Self, tol: Tolerances) -> bool

Whether the two are perpendicular, within tol.angular().

pub const fn reversed(self) -> Self

This direction reflected through the origin.

pub const fn to_3d(self) -> Direction

This direction embedded in the XY plane.

Trait Implementations

impl Clone for Direction2

fn clone(&self) -> Direction2

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Copy for Direction2

impl Debug for Direction2

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

Formats the value using the given formatter.

impl From<Direction2> for Vector2

fn from(d: Direction2) -> Self

Converts to this type from the input type.

impl Mul<Direction2> for f64

type Output = Vector2

The resulting type after applying the * operator.

fn mul(self, d: Direction2) -> Vector2

Performs the * operation.

impl Mul<f64> for Direction2

type Output = Vector2

The resulting type after applying the * operator.

fn mul(self, s: f64) -> Vector2

Performs the * operation.

impl Neg for Direction2

type Output = Direction2

The resulting type after applying the - operator.

fn neg(self) -> Self

Performs the unary - operation.

impl PartialEq for Direction2

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