Struct Frame 

pub struct Frame { /* private fields */ }

A local coordinate system in space.

The z direction is primary: it is the axis of revolution for a cylinder, the normal of a plane, the axis of a circle. x fixes where parameterization starts. y is derived and always consistent with the handedness.

Implementations

impl Frame

pub const WORLD: Self

The identity frame: origin at the origin, axes along X, Y and Z.

pub fn new( origin: Point, z: Direction, x_reference: Direction, tol: Tolerances, ) -> OgeomResult<Self>

A right-handed frame from an origin, a primary direction and a reference for the first axis.

x_reference need not be perpendicular to z: its component along z is removed. It must not be parallel to z, since then there is nothing left to orient by.

Errors

OgeomError::Construction if z and x_reference are parallel.

pub fn about(origin: Point, z: Direction) -> Self

A right-handed frame with an arbitrary but deterministic first axis.

For geometry with rotational symmetry (a sphere, a full circle), the choice of x is immaterial, and requiring the caller to invent one is noise.

pub fn from_axes( origin: Point, x: Direction, y: Direction, z: Direction, tol: Tolerances, ) -> OgeomResult<Self>

A frame from three directions given explicitly.

Handedness is inferred from the triple product rather than asserted.

Errors

OgeomError::Construction if the three are not mutually perpendicular within tol.angular(), or if they are coplanar.

pub const fn origin(&self) -> Point

The frame’s origin.

pub const fn z(&self) -> Direction

The primary direction: the normal of a plane, the axis of a cylinder.

pub const fn x(&self) -> Direction

The first axis, fixing where parameterization starts.

pub const fn y(&self) -> Direction

The second axis.

pub const fn handedness(&self) -> Handedness

This frame’s handedness.

pub const fn axis(&self) -> Axis

The axis along the primary direction.

pub const fn with_origin(&self, origin: Point) -> Self

This frame moved to a new origin.

pub const fn mirrored(&self) -> Self

This frame with its handedness flipped, by reversing y.

pub const fn with_z_reversed(&self) -> Self

This frame with the primary direction reversed.

x is kept, so y must flip to preserve handedness; reversing a plane’s normal should not silently turn its parameterization inside out.

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

Local coordinates of a point given in world coordinates.

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

World coordinates of a point given in this frame’s local coordinates.

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

Local components of a world-space vector. Unaffected by the origin.

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

World components of a vector given in local coordinates.

pub fn to_matrix(&self) -> Matrix3

The rotation taking local coordinates to world coordinates.

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

Whether two frames agree in origin and all three directions.

pub fn signed_distance_to_plane(&self, p: Point) -> f64

The signed distance from p to this frame’s XY plane, positive on the side the primary direction points to.

Trait Implementations

impl Clone for Frame

fn clone(&self) -> Frame

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Copy for Frame

impl Debug for Frame

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

Formats the value using the given formatter.

impl Default for Frame

fn default() -> Self

Returns the “default value” for a type.

impl PartialEq for Frame

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