Struct Axis 

pub struct Axis {
    pub location: Point,
    pub direction: Direction,
}

A point and a direction: an oriented line through space.

Fields

location: Point

A point on the axis.

direction: Direction

The axis direction.

Implementations

impl Axis

pub const X: Self

The X axis through the origin.

pub const Y: Self

The Y axis through the origin.

pub const Z: Self

The Z axis through the origin.

pub const fn new(location: Point, direction: Direction) -> Self

An axis from a point and a direction.

pub fn through(from: Point, to: Point, tol: Tolerances) -> OgeomResult<Self>

The axis through two distinct points, directed from from to to.

Errors

OgeomError::Construction if the points coincide.

pub const fn reversed(self) -> Self

This axis with its direction reversed.

pub fn point_at(self, t: f64) -> Point

The point at parameter t, measured from Axis::location in units of length along the direction.

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

The parameter of the projection of p onto this axis.

pub fn project(self, p: Point) -> Point

The closest point on this axis to p.

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

The perpendicular distance from p to this axis.

pub fn contains(self, p: Point, tol: Tolerances) -> bool

Whether p lies on this axis within tol.confusion().

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

Whether two axes are the same line with the same sense.

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

Whether two axes lie on the same line, ignoring sense.

Trait Implementations

impl Clone for Axis

fn clone(&self) -> Axis

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Copy for Axis

impl Debug for Axis

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

Formats the value using the given formatter.

impl PartialEq for Axis

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