Struct Frame2 

pub struct Frame2 { /* private fields */ }

An orthonormal frame in a surface’s (u, v) plane, of either handedness. A pcurve placed by a left-handed Frame2 is traversed clockwise in (u, v) — the case of a circle shared by a cap and a wall whose normal opposes the circle’s Z (docs/DATA-MODEL.md §Pcurves).

use arris_math::{Frame2, Handedness, Point2, Vec2};

let f = Frame2::new(Point2::new(1.0, 1.0), Vec2::new(0.0, 2.0), Handedness::Left).unwrap();
assert!(!f.is_right_handed());
assert_eq!(f.y().into_inner(), Vec2::new(1.0, 0.0));
assert_eq!(f.to_world(Point2::new(1.0, 1.0)), Point2::new(2.0, 2.0));

Implementations

impl Frame2

pub fn identity() -> Self

Origin at zero, x along u, y along v: right-handed.

pub fn new( origin: Point2, x: Vec2, handedness: Handedness, ) -> Result<Self, FrameError>

A frame with x along x (normalised) and y perpendicular to it on the side handedness says. Errors: a non-finite input or a zero x.

pub fn from_orthonormal( origin: Point2, x: Vec2, y: Vec2, ) -> Result<Self, FrameError>

A frame from axes that already are one — each unit and perpendicular to rounding (crate::RELATIVE_ROUNDING), of either handedness — stored bit for bit; what the native format reads a Frame2 back through. Errors: a non-finite input, or FrameError::NotOrthonormal.

pub const fn origin(&self) -> Point2

The origin.

pub fn translated(&self, by: Vec2) -> Frame2

The same axes at the origin moved by by.

use arris_math::{Frame2, Point2, Vec2};

let f = Frame2::identity().translated(Vec2::new(1.0, 2.0));
assert_eq!(f.origin(), Point2::new(1.0, 2.0));
assert_eq!(f.x(), Frame2::identity().x());

pub const fn x(&self) -> UnitVec2

The x axis.

pub const fn y(&self) -> UnitVec2

The y axis: x rotated by ±90° according to the handedness.

pub fn handedness(&self) -> Handedness

Which way y turns from x.

pub fn is_right_handed(&self) -> bool

true when x × y > 0, the (u, v) plane’s own orientation.

pub fn to_local(&self, p: Point2) -> Point2

The coordinates of a (u, v) point in this frame.

pub fn to_world(&self, p: Point2) -> Point2

The (u, v) point at local coordinates p.

pub fn vec_to_local(&self, v: Vec2) -> Vec2

The components of a (u, v) vector along the axes.

pub fn vec_to_world(&self, v: Vec2) -> Vec2

The (u, v) vector with local components v.

Trait Implementations

impl Clone for Frame2

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Copy for Frame2

impl Debug for Frame2

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

Formats the value using the given formatter.

impl PartialEq for Frame2

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

Equality operator ==.

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

Inequality operator !=.

impl StructuralPartialEq for Frame2