Struct trackball::Frame

source ·
pub struct Frame<N: Copy + RealField> { /* private fields */ }
Expand description

Frame wrt camera eye and target.

Implementations§

source§

impl<N: Copy + RealField> Frame<N>

source

pub fn look_at(target: Point3<N>, eye: &Point3<N>, up: &Vector3<N>) -> Self

Sets eye position inclusive its roll attitude and target position in world space.

source

pub fn eye(&self) -> Point3<N>

Eye position in world space.

source

pub fn set_eye(&mut self, eye: &Point3<N>, up: &Vector3<N>)

Sets eye position inclusive its roll attitude in world space preserving target position.

source

pub const fn target(&self) -> &Point3<N>

Target position in world space.

source

pub fn set_target(&mut self, pos: Point3<N>)

Sets target position in world space preserving eye position inclusive its roll attitude.

Allows to track a moving object.

source

pub const fn distance(&self) -> N

Distance between eye and target.

source

pub fn set_distance(&mut self, zat: N)

Sets distance between eye and target preserving target position.

source

pub fn scale(&mut self, rat: N)

Scales distance between eye and target by ratio preserving target position.

source

pub fn local_scale_around(&mut self, rat: N, pos: &Point3<N>)

Scales distance between eye and point in camera space by ratio preserving target position.

source

pub fn scale_around(&mut self, rat: N, pos: &Point3<N>)

Scales distance between eye and point in world space by ratio preserving target position.

source

pub fn local_slide(&mut self, vec: &Vector3<N>)

Slides camera eye and target by vector in camera space.

source

pub fn slide(&mut self, vec: &Vector3<N>)

Slides camera eye and target by vector in world space.

source

pub fn local_orbit(&mut self, rot: &UnitQuaternion<N>)

Orbits eye by rotation in camera space around target.

source

pub fn local_orbit_around(&mut self, rot: &UnitQuaternion<N>, pos: &Point3<N>)

Orbits eye by rotation in camera space around point in camera space.

source

pub fn orbit(&mut self, rot: &UnitQuaternion<N>)

Orbits eye by rotation in world space around target.

source

pub fn orbit_around(&mut self, rot: &UnitQuaternion<N>, pos: &Point3<N>)

Orbits eye by rotation in world space around point in world space.

source

pub fn look_around(&mut self, pitch: N, yaw: N, yaw_axis: &Unit<Vector3<N>>)

Orbits target around eye by pitch and yaw preserving roll attitude aka first person view.

Use fixed Self::yaw_axis() by capturing it when entering first person view.

source

pub fn local_pitch_axis(&self) -> Unit<Vector3<N>>

Positive x-axis in camera space pointing from left to right.

source

pub fn local_yaw_axis(&self) -> Unit<Vector3<N>>

Positive y-axis in camera space pointing from bottom to top.

source

pub fn local_roll_axis(&self) -> Unit<Vector3<N>>

Positive z-axis in camera space pointing from back to front.

source

pub fn pitch_axis(&self) -> Unit<Vector3<N>>

Positive x-axis in world space pointing from left to right.

source

pub fn yaw_axis(&self) -> Unit<Vector3<N>>

Positive y-axis in world space pointing from bottom to top.

source

pub fn roll_axis(&self) -> Unit<Vector3<N>>

Positive z-axis in world space pointing from back to front.

source

pub fn try_lerp_slerp(&self, other: &Self, t: N, epsilon: N) -> Option<Self>

Attempts to interpolate between two frames using linear interpolation for the translation part, and spherical linear interpolation for the rotation part.

Returns None if the angle between both rotations is 180 degrees (in which case the interpolation is not well-defined).

Arguments
  • self: The initial frame to interpolate from.
  • other: The final frame to interpolate toward.
  • t: The interpolation parameter between 0 and 1.
  • epsilon: The value below which the sinus of the angle separating both quaternion must be to return None.
source

pub fn renormalize(&mut self) -> N

Renormalizes eye rotation and returns its norm.

source

pub fn view(&self) -> Isometry3<N>

View transformation from camera to world space.

source

pub fn inverse_view(&self) -> Isometry3<N>

Inverse view transformation from world to camera space.

Uses less computations than Self::view().inverse().

source

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

Casts components to another type, e.g., between f32 and f64.

Trait Implementations§

source§

impl<N: Copy + RealField + AbsDiffEq> AbsDiffEq for Frame<N>
where N::Epsilon: Copy,

§

type Epsilon = <N as AbsDiffEq>::Epsilon

Used for specifying relative comparisons.
source§

fn default_epsilon() -> N::Epsilon

The default tolerance to use when testing values that are close together. Read more
source§

fn abs_diff_eq(&self, other: &Self, epsilon: N::Epsilon) -> bool

A test for equality that uses the absolute difference to compute the approximate equality of two numbers.
source§

fn abs_diff_ne(&self, other: &Rhs, epsilon: Self::Epsilon) -> bool

The inverse of AbsDiffEq::abs_diff_eq.
source§

impl<N: Copy + RealField> Archive for Frame<N>

§

type Archived = Frame<N>

The archived representation of this type. Read more
§

type Resolver = ()

The resolver for this type. It must contain all the additional information from serializing needed to make the archived type from the normal type.
source§

unsafe fn resolve(&self, _: usize, (): Self::Resolver, out: *mut Self::Archived)

Creates the archived version of this value at the given position and writes it to the given output. Read more
source§

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

source§

fn clone(&self) -> Frame<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 Frame<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 Frame<N>

source§

fn default() -> Frame<N>

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

impl<'de, N> Deserialize<'de> for Frame<N>
where N: Deserialize<'de> + Copy + RealField,

source§

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>
where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer. Read more
source§

impl<De: Fallible + ?Sized, N: Copy + RealField> Deserialize<Frame<N>, De> for Frame<N>

source§

fn deserialize(&self, _: &mut De) -> Result<Self, De::Error>

Deserializes using the given deserializer
source§

impl<N: PartialEq + Copy + RealField> PartialEq for Frame<N>

source§

fn eq(&self, other: &Frame<N>) -> bool

This method tests for self and other values to be equal, and is used by ==.
1.0.0 · source§

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

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.
source§

impl<N: Copy + RealField + RelativeEq> RelativeEq for Frame<N>
where N::Epsilon: Copy,

source§

fn default_max_relative() -> N::Epsilon

The default relative tolerance for testing values that are far-apart. Read more
source§

fn relative_eq( &self, other: &Self, epsilon: N::Epsilon, max_relative: N::Epsilon ) -> bool

A test for equality that uses a relative comparison if the values are far apart.
source§

fn relative_ne( &self, other: &Rhs, epsilon: Self::Epsilon, max_relative: Self::Epsilon ) -> bool

The inverse of RelativeEq::relative_eq.
source§

impl<Ser: Fallible + ?Sized, N: Copy + RealField> Serialize<Ser> for Frame<N>

source§

fn serialize(&self, _: &mut Ser) -> Result<Self::Resolver, Ser::Error>

Writes the dependencies for the object and returns a resolver that can create the archived type.
source§

impl<N> Serialize for Frame<N>
where N: Serialize + Copy + RealField,

source§

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>
where __S: Serializer,

Serialize this value into the given Serde serializer. Read more
source§

impl<N: Copy + RealField + UlpsEq> UlpsEq for Frame<N>
where N::Epsilon: Copy,

source§

fn default_max_ulps() -> u32

The default ULPs to tolerate when testing values that are far-apart. Read more
source§

fn ulps_eq(&self, other: &Self, epsilon: N::Epsilon, max_ulps: u32) -> bool

A test for equality that uses units in the last place (ULP) if the values are far apart.
source§

fn ulps_ne(&self, other: &Rhs, epsilon: Self::Epsilon, max_ulps: u32) -> bool

The inverse of UlpsEq::ulps_eq.
source§

impl<N: Copy + Copy + RealField> Copy for Frame<N>

source§

impl<N: Eq + Copy + RealField> Eq for Frame<N>

source§

impl<N: Copy + RealField> StructuralEq for Frame<N>

source§

impl<N: Copy + RealField> StructuralPartialEq for Frame<N>

Auto Trait Implementations§

§

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

§

impl<N> Send for Frame<N>

§

impl<N> Sync for Frame<N>

§

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

§

impl<N> UnwindSafe for Frame<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> ArchiveUnsized for T
where T: Archive,

§

type Archived = <T as Archive>::Archived

The archived counterpart of this type. Unlike Archive, it may be unsized. Read more
§

type MetadataResolver = ()

The resolver for the metadata of this type. Read more
source§

unsafe fn resolve_metadata( &self, _: usize, _: <T as ArchiveUnsized>::MetadataResolver, _: *mut <<T as ArchiveUnsized>::Archived as ArchivePointee>::ArchivedMetadata )

Creates the archived version of the metadata for this value at the given position and writes it to the given output. Read more
source§

unsafe fn resolve_unsized( &self, from: usize, to: usize, resolver: Self::MetadataResolver, out: *mut RelPtr<Self::Archived, <isize as Archive>::Archived> )

Resolves a relative pointer to this value with the given from and to and writes it to the given output. 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<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<T, S> SerializeUnsized<S> for T
where T: Serialize<S>, S: Serializer + ?Sized,

source§

fn serialize_unsized( &self, serializer: &mut S ) -> Result<usize, <S as Fallible>::Error>

Writes the object and returns the position of the archived type.
source§

fn serialize_metadata(&self, _: &mut S) -> Result<(), <S as Fallible>::Error>

Serializes the metadata for the given type.
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.
source§

impl<T> DeserializeOwned for T
where T: for<'de> Deserialize<'de>,

source§

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