Skip to main content

Orbit

Struct Orbit 

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

Orbit induced by displacement on screen.

Implements Default and can be created with Orbit::default().

Both its methods must be invoked on matching events fired by your 3D graphics library of choice.

Implementations§

Source§

impl Orbit

Source

pub fn compute(&mut self, pos: Vec2, max: Vec2) -> Option<Quat>

Computes rotation between previous and current cursor/finger position.

Trackball point of previous position is cached and has to be discarded on button/finger release via Self::discard(). Current position pos is clamped between origin and maximum position max as screen’s width and height.

Maps positions via the exponential map onto a target-centered trackball with radius of maximum of the screen’s width and height divided by π and rotates along the shortest arc between their trackball points so that the trackball’s point under the cursor/finger stays under it. Positions in screen corners beyond the trackball’s border are mapped beyond its equator.

Screen space with origin in top left corner:

  • x-axis from left to right,
  • y-axis from top to bottom.

Camera space with origin at its target, the trackball’s center:

  • x-axis from left to right,
  • y-axis from bottom to top,
  • z-axis from far to near.

Returns None:

  • on first invocation and after Self::discard() as there is no previous position yet,
  • for displacements resulting in the same trackball point, e.g., when a position event fires twice.
Source

pub const fn discard(&mut self)

Discards cached trackball point of previous cursor/finger position on button/finger release.

Trait Implementations§

Source§

impl Clone for Orbit

Source§

fn clone(&self) -> Orbit

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 Debug for Orbit

Source§

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

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

impl Default for Orbit

Source§

fn default() -> Orbit

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

Auto Trait Implementations§

§

impl Freeze for Orbit

§

impl RefUnwindSafe for Orbit

§

impl Send for Orbit

§

impl Sync for Orbit

§

impl Unpin for Orbit

§

impl UnsafeUnpin for Orbit

§

impl UnwindSafe for Orbit

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, W> HasTypeWitness<W> for T
where W: MakeTypeWitness<Arg = T>, T: ?Sized,

Source§

const WITNESS: W = W::MAKE

A constant of the type witness
Source§

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

Source§

const TYPE_EQ: TypeEq<T, <T as Identity>::Type> = TypeEq::NEW

Proof that Self is the same type as Self::Type, provides methods for casting between Self and Self::Type.
Source§

type Type = T

The same type as Self, used to emulate type equality bounds (T == U) with associated type equality constraints (T: Identity<Type = U>).
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.