Struct Frame2 

pub struct Frame2 { /* private fields */ }

A local coordinate system in the plane.

Implementations

impl Frame2

pub const WORLD: Self

The identity frame.

pub const fn new(origin: Point2, x: Direction2) -> Self

A right-handed frame from an origin and a first axis.

pub fn from_axes( origin: Point2, x: Direction2, y: Direction2, tol: Tolerances, ) -> OgeomResult<Self>

A frame with an explicit second axis, whose handedness is inferred.

Errors

OgeomError::Construction if the two axes are not perpendicular within tol.angular().

pub const fn origin(&self) -> Point2

The frame’s origin.

pub const fn x(&self) -> Direction2

The first axis.

pub const fn y(&self) -> Direction2

The second axis.

pub const fn handedness(&self) -> Handedness

This frame’s handedness.

pub const fn mirrored(&self) -> Self

This frame with its handedness flipped.

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

Local coordinates of a point given in world coordinates.

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

World coordinates of a point given in local coordinates.

pub fn vector_to_local(&self, v: Vector2) -> Vector2

Local components of a world-space vector.

pub fn vector_to_world(&self, v: Vector2) -> Vector2

World components of a vector given in local coordinates.

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

Whether two frames agree in origin and both directions.

Trait Implementations

impl Clone for Frame2

fn clone(&self) -> Frame2

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 Default for Frame2

fn default() -> Self

Returns the “default value” for a type.

impl PartialEq for Frame2

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