Skip to main content

Frame3

Struct Frame3 

Source
pub struct Frame3 {
    pub origin: Point3,
    pub x: UnitVec3,
    pub y: UnitVec3,
    pub z: UnitVec3,
}
Expand description

Right-handed orthonormal frame: origin + three unit axes.

x, y, z form a right-handed basis: x.cross(y) == z.

Fields§

§origin: Point3

Frame origin in world space.

§x: UnitVec3

Local X axis.

§y: UnitVec3

Local Y axis.

§z: UnitVec3

Local Z axis (= x × y).

Implementations§

Source§

impl Frame3

Source

pub const WORLD: Self

World frame: origin at (0,0,0), axes aligned with world axes.

Source

pub fn from_origin_z(origin: Point3, forward: UnitVec3) -> Self

Build a frame from an origin and a forward (+Z) direction.

The X axis is chosen to be perpendicular to forward (arbitrary but consistent). Y is derived as z × x (right-handed).

Source

pub fn from_origin_z_up( origin: Point3, forward: UnitVec3, up_hint: Vec3, ) -> Self

Build a frame from origin, forward (+Z), and a suggested up vector.

up_hint need not be perpendicular to forward; it is projected to produce the Y axis. Falls back to the arbitrary-perp method if up_hint is nearly parallel to forward.

Source

pub fn to_local_point(self, p: Point3) -> Point3

Express a world-space point in local coordinates.

Source

pub fn to_world_point(self, p: Point3) -> Point3

Express a local-space point in world coordinates.

Source

pub fn to_local_vec(self, v: Vec3) -> Vec3

Express a world-space vector in local coordinates.

Source

pub fn to_world_vec(self, v: Vec3) -> Vec3

Express a local-space vector in world coordinates.

Source

pub fn rotation(self) -> Mat3

Rotation matrix that maps world axes to local axes.

Source

pub fn translate(self, delta: Vec3) -> Self

Move the frame origin by delta (in world space).

Trait Implementations§

Source§

impl Clone for Frame3

Source§

fn clone(&self) -> Frame3

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 Frame3

Source§

impl Debug for Frame3

Source§

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

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

impl PartialEq for Frame3

Source§

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

Tests for self and other values to be equal, and is used by ==.
1.0.0 (const: unstable) · Source§

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.
Source§

impl StructuralPartialEq for Frame3

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> 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 = Infallible

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

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

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.