Struct Axis 

pub struct Axis {
    pub origin: Point3,
    pub direction: UnitVec3,
}

A point and a unit direction. A plain value, never a handle: a cylinder is built from an Axis and numbers, and only the result lives in the model. The direction is unit by construction — Axis::new normalises — and that is the only invariant it carries.

use arris_math::{Axis, Point3, Vec3};

let a = Axis::new(Point3::new(1.0, 2.0, 3.0), Vec3::new(0.0, 0.0, 5.0)).unwrap();
assert_eq!(a, Axis::z_at(Point3::new(1.0, 2.0, 3.0)));
assert!(Axis::new(Point3::origin(), Vec3::zeros()).is_err());

Fields

origin: Point3

A point on the axis.

direction: UnitVec3

The direction, unit.

Implementations

impl Axis

pub fn new(origin: Point3, direction: Vec3) -> Result<Self, FrameError>

The axis through origin along direction, normalised. Errors: a non-finite input or a zero direction.

pub fn z_at(origin: Point3) -> Self

The axis through origin along +z.

pub fn at(&self, t: f64) -> Point3

The point t along the axis from its origin.

Trait Implementations

impl Clone for Axis

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 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: &Self) -> bool

Equality operator ==.

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

Inequality operator !=.

impl StructuralPartialEq for Axis