Skip to main content

Isometry

Struct Isometry 

Source
pub struct Isometry { /* private fields */ }
Expand description

A rigid motion: a rotation followed by a translation, p ↦ R p + t. Lengths and angles are preserved, so a Frame moved by one is still a frame and geometry moved by one is the same geometry in another place (docs/DATA-MODEL.md §Conventions: a transform is a frame change).

use arris_math::{Isometry, Point3, Vec3, nalgebra::UnitQuaternion};
use core::f64::consts::FRAC_PI_2;

let quarter_turn = UnitQuaternion::from_axis_angle(&Vec3::z_axis(), FRAC_PI_2);
let m = Isometry::new(quarter_turn, Vec3::new(1.0, 0.0, 0.0));
let p = m.apply(Point3::new(1.0, 0.0, 0.0));
assert!((p - Point3::new(1.0, 1.0, 0.0)).norm() < 1e-15);
let back = m.inverse().apply(p);
assert!((back - Point3::new(1.0, 0.0, 0.0)).norm() < 1e-15);

Implementations§

Source§

impl Isometry

Source

pub fn new(rotation: UnitQuaternion<f64>, translation: Vec3) -> Self

p ↦ rotation · p + translation.

Source

pub fn identity() -> Self

The motion that moves nothing.

Source

pub fn from_translation(v: Vec3) -> Self

A pure translation by v.

Source

pub fn from_rotation(rotation: UnitQuaternion<f64>) -> Self

A pure rotation about the origin.

Source

pub fn rotation(&self) -> UnitQuaternion<f64>

The rotation part.

Source

pub fn translation(&self) -> Vec3

The translation part: where the origin goes.

Source

pub fn apply(&self, p: Point3) -> Point3

R p + t.

Source

pub fn apply_vec(&self, v: Vec3) -> Vec3

R v: a vector is a difference of points, so the translation does not act on it.

Source

pub fn apply_unit(&self, u: UnitVec3) -> UnitVec3

R u, re-normalised so the result is unit to rounding.

Source

pub fn apply_frame(&self, frame: &Frame) -> Frame

The frame moved by this motion; the same as Frame::transformed.

Source

pub fn then(&self, next: &Isometry) -> Isometry

The motion that is self first, then next: a.then(&b).apply(p) == b.apply(a.apply(p)) to rounding.

Source

pub fn inverse(&self) -> Isometry

The motion that undoes this one: m.inverse().apply(m.apply(p)) == p to rounding.

Trait Implementations§

Source§

impl Clone for Isometry

Source§

fn clone(&self) -> Self

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Copy for Isometry

Source§

impl Debug for Isometry

Source§

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

Formats the value using the given formatter. Read more
Source§

impl Default for Isometry

Source§

fn default() -> Self

Returns the “default value” for a type. Read more
Source§

impl PartialEq for Isometry

Source§

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

Equality operator ==. Read more
1.0.0 (const: unstable) · Source§

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

Inequality operator !=. Read more
Source§

impl StructuralPartialEq for Isometry

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> Same for T

Source§

type Output = T

Should always be Self
Source§

impl<T> Scalar for T
where T: 'static + Clone + PartialEq + Debug,

Source§

impl<SS, SP> SupersetOf<SS> for SP
where SS: SubsetOf<SP>,

Source§

fn to_subset(&self) -> Option<SS>

The inverse inclusion map: attempts to construct self from the equivalent element of its superset. Read more
Source§

fn is_in_subset(&self) -> bool

Checks if self is actually part of its subset T (and can be converted to it).
Source§

fn to_subset_unchecked(&self) -> SS

Use with care! Same as self.to_subset but without any property checks. Always succeeds.
Source§

fn from_subset(element: &SS) -> SP

The inclusion map: converts self to the equivalent element of its superset.
Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = !

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, !>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.