Skip to main content

Frame3

Struct Frame3 

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

An orthonormal reference frame: origin + three mutually perpendicular unit axes (x, y, z).

The z axis is the primary direction (surface normal, curve axis, etc.). x and y span the plane perpendicular to z.

Fields§

§origin: Point3

Frame origin.

§x: Vec3

First axis in the perpendicular plane.

§y: Vec3

Second axis in the perpendicular plane.

§z: Vec3

Primary axis / normal.

Implementations§

Source§

impl Frame3

Source

pub fn from_normal(origin: Point3, normal: Vec3) -> Result<Self, MathError>

Build an orthonormal frame from an origin and a primary axis (normal).

x and y are chosen arbitrarily in the plane perpendicular to z. The input normal is normalized internally.

§Errors

Returns MathError::ZeroVector if normal is zero-length.

Source

pub fn from_normal_and_ref( origin: Point3, normal: Vec3, ref_dir: Vec3, ) -> Result<Self, MathError>

Build an orthonormal frame from an origin, a primary axis, and a preferred reference direction for x.

ref_dir is projected onto the plane perpendicular to z to produce x. If ref_dir is (nearly) parallel to z, the frame falls back to an arbitrary perpendicular choice.

§Errors

Returns MathError::ZeroVector if normal is zero-length.

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

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

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

Inequality operator !=. Read more
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.