Struct trackball::Orbit

source ·
pub struct Orbit<N: Copy + RealField> { /* 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<f32>

source

pub fn compute( &mut self, pos: &Point2<f32>, max: &Point2<f32> ) -> Option<UnitQuaternion<f32>>

Computes rotation between previous and current cursor/finger position.

Normalization 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.

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,
  • in the unlikely case that a position event fires twice resulting in zero displacements.
source

pub fn discard(&mut self)

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

source

pub fn cast<M: Copy + RealField>(self) -> Orbit<M>
where f32: SubsetOf<M>,

Casts components to another type, e.g., to f64.

source§

impl Orbit<f64>

source

pub fn compute( &mut self, pos: &Point2<f64>, max: &Point2<f64> ) -> Option<UnitQuaternion<f64>>

Computes rotation between previous and current cursor/finger position.

Normalization 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.

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,
  • in the unlikely case that a position event fires twice resulting in zero displacements.
source

pub fn discard(&mut self)

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

source

pub fn cast<M: Copy + RealField>(self) -> Orbit<M>
where f64: SubsetOf<M>,

Casts components to another type, e.g., to f32.

Trait Implementations§

source§

impl<N: Clone + Copy + RealField> Clone for Orbit<N>

source§

fn clone(&self) -> Orbit<N>

Returns a copy of the value. Read more
1.0.0 · source§

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

Performs copy-assignment from source. Read more
source§

impl<N: Debug + Copy + RealField> Debug for Orbit<N>

source§

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

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

impl<N: Default + Copy + RealField> Default for Orbit<N>

source§

fn default() -> Orbit<N>

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

Auto Trait Implementations§

§

impl<N> RefUnwindSafe for Orbit<N>
where N: RefUnwindSafe,

§

impl<N> Send for Orbit<N>

§

impl<N> Sync for Orbit<N>

§

impl<N> Unpin for Orbit<N>
where N: Unpin,

§

impl<N> UnwindSafe for Orbit<N>
where N: UnwindSafe,

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> ArchivePointee for T

§

type ArchivedMetadata = ()

The archived version of the pointer metadata for this type.
source§

fn pointer_metadata( _: &<T as ArchivePointee>::ArchivedMetadata ) -> <T as Pointee>::Metadata

Converts some archived metadata to the pointer metadata for itself.
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<F, W, T, D> Deserialize<With<T, W>, D> for F
where W: DeserializeWith<F, T, D>, D: Fallible + ?Sized, F: ?Sized,

source§

fn deserialize( &self, deserializer: &mut D ) -> Result<With<T, W>, <D as Fallible>::Error>

Deserializes using the given deserializer
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> Pointee for T

§

type Metadata = ()

The type for metadata in pointers and references to Self.
source§

impl<T> Same for T

§

type Output = T

Should always be Self
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,

§

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>,

§

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>,

§

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.