bevy_trackball::prelude

Struct Frame

Source
pub struct Frame<N>
where N: Copy + RealField,
{ /* private fields */ }
Expand description

Frame wrt camera eye and target.

Implementations§

Source§

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

Source

pub fn look_at( target: OPoint<N, Const<3>>, eye: &OPoint<N, Const<3>>, up: &Matrix<N, Const<3>, Const<1>, ArrayStorage<N, 3, 1>>, ) -> Frame<N>

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

Source

pub fn eye(&self) -> OPoint<N, Const<3>>

Eye position in world space.

Source

pub fn set_eye( &mut self, eye: &OPoint<N, Const<3>>, up: &Matrix<N, Const<3>, Const<1>, ArrayStorage<N, 3, 1>>, )

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

Source

pub const fn target(&self) -> &OPoint<N, Const<3>>

Target position in world space.

Source

pub fn set_target(&mut self, pos: OPoint<N, Const<3>>)

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: &OPoint<N, Const<3>>)

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

Source

pub fn scale_around(&mut self, rat: N, pos: &OPoint<N, Const<3>>)

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

Source

pub fn local_slide( &mut self, vec: &Matrix<N, Const<3>, Const<1>, ArrayStorage<N, 3, 1>>, )

Slides camera eye and target by vector in camera space.

Source

pub fn slide( &mut self, vec: &Matrix<N, Const<3>, Const<1>, ArrayStorage<N, 3, 1>>, )

Slides camera eye and target by vector in world space.

Source

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

Orbits eye by rotation in camera space around target.

Source

pub fn local_orbit_around( &mut self, rot: &Unit<Quaternion<N>>, pos: &OPoint<N, Const<3>>, )

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

Source

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

Orbits eye by rotation in world space around target.

Source

pub fn orbit_around( &mut self, rot: &Unit<Quaternion<N>>, pos: &OPoint<N, Const<3>>, )

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<Matrix<N, Const<3>, Const<1>, ArrayStorage<N, 3, 1>>>, )

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<Matrix<N, Const<3>, Const<1>, ArrayStorage<N, 3, 1>>>

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

Source

pub fn local_yaw_axis( &self, ) -> Unit<Matrix<N, Const<3>, Const<1>, ArrayStorage<N, 3, 1>>>

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

Source

pub fn local_roll_axis( &self, ) -> Unit<Matrix<N, Const<3>, Const<1>, ArrayStorage<N, 3, 1>>>

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

Source

pub fn pitch_axis( &self, ) -> Unit<Matrix<N, Const<3>, Const<1>, ArrayStorage<N, 3, 1>>>

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

Source

pub fn yaw_axis( &self, ) -> Unit<Matrix<N, Const<3>, Const<1>, ArrayStorage<N, 3, 1>>>

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

Source

pub fn roll_axis( &self, ) -> Unit<Matrix<N, Const<3>, Const<1>, ArrayStorage<N, 3, 1>>>

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

Source

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

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) -> Isometry<N, Unit<Quaternion<N>>, 3>

View transformation from camera to world space.

Source

pub fn inverse_view(&self) -> Isometry<N, Unit<Quaternion<N>>, 3>

Inverse view transformation from world to camera space.

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

Source

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

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

Trait Implementations§

Source§

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

Source§

type Epsilon = <N as AbsDiffEq>::Epsilon

Used for specifying relative comparisons.
Source§

fn default_epsilon() -> <N as AbsDiffEq>::Epsilon

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

fn abs_diff_eq( &self, other: &Frame<N>, epsilon: <N as AbsDiffEq>::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> Clone for Frame<N>
where N: Clone + Copy + RealField,

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 for Frame<N>
where N: Debug + Copy + RealField,

Source§

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

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

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

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: Copy + RealField + Deserialize<'de>,

Source§

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

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

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

Source§

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

Tests for self and other values to be equal, and is used by ==.
1.0.0 · 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<N> RelativeEq for Frame<N>
where N: Copy + RealField + RelativeEq, <N as AbsDiffEq>::Epsilon: Copy,

Source§

fn default_max_relative() -> <N as AbsDiffEq>::Epsilon

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

fn relative_eq( &self, other: &Frame<N>, epsilon: <N as AbsDiffEq>::Epsilon, max_relative: <N as AbsDiffEq>::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<N> Serialize for Frame<N>
where N: Copy + RealField + Serialize,

Source§

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

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

impl<N> UlpsEq for Frame<N>
where N: Copy + RealField + UlpsEq, <N as AbsDiffEq>::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: &Frame<N>, epsilon: <N as AbsDiffEq>::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 for Frame<N>
where N: Copy + RealField,

Source§

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

Source§

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

Auto Trait Implementations§

§

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

§

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, U> AsBindGroupShaderType<U> for T
where U: ShaderType, &'a T: for<'a> Into<U>,

Source§

fn as_bind_group_shader_type(&self, _images: &RenderAssets<GpuImage>) -> U

Return the T ShaderType for self. When used in AsBindGroup derives, it is safe to assume that all images in self exist.
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, dst: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dst. Read more
Source§

impl<T> Downcast<T> for T

Source§

fn downcast(&self) -> &T

Source§

impl<T> Downcast for T
where T: Any,

Source§

fn into_any(self: Box<T>) -> Box<dyn Any>

Convert Box<dyn Trait> (where Trait: Downcast) to Box<dyn Any>. Box<dyn Any> can then be further downcast into Box<ConcreteType> where ConcreteType implements Trait.
Source§

fn into_any_rc(self: Rc<T>) -> Rc<dyn Any>

Convert Rc<Trait> (where Trait: Downcast) to Rc<Any>. Rc<Any> can then be further downcast into Rc<ConcreteType> where ConcreteType implements Trait.
Source§

fn as_any(&self) -> &(dyn Any + 'static)

Convert &Trait (where Trait: Downcast) to &Any. This is needed since Rust cannot generate &Any’s vtable from &Trait’s.
Source§

fn as_any_mut(&mut self) -> &mut (dyn Any + 'static)

Convert &mut Trait (where Trait: Downcast) to &Any. This is needed since Rust cannot generate &mut Any’s vtable from &mut Trait’s.
Source§

impl<T> DowncastSync for T
where T: Any + Send + Sync,

Source§

fn into_any_arc(self: Arc<T>) -> Arc<dyn Any + Sync + Send>

Convert Arc<Trait> (where Trait: Downcast) to Arc<Any>. Arc<Any> can then be further downcast into Arc<ConcreteType> where ConcreteType implements Trait.
Source§

impl<T> DynEq for T
where T: Any + Eq,

Source§

fn as_any(&self) -> &(dyn Any + 'static)

Casts the type to dyn Any.
Source§

fn dyn_eq(&self, other: &(dyn DynEq + 'static)) -> bool

This method tests for self and other values to be equal. Read more
Source§

impl<Q, K> Equivalent<K> for Q
where Q: Eq + ?Sized, K: Borrow<Q> + ?Sized,

Source§

fn equivalent(&self, key: &K) -> bool

Checks if this value is equivalent to the given key. Read more
Source§

impl<Q, K> Equivalent<K> for Q
where Q: Eq + ?Sized, K: Borrow<Q> + ?Sized,

Source§

fn equivalent(&self, key: &K) -> bool

Checks if this value is equivalent to the given key. Read more
Source§

impl<Q, K> Equivalent<K> for Q
where Q: Eq + ?Sized, K: Borrow<Q> + ?Sized,

Source§

fn equivalent(&self, key: &K) -> bool

Compare self to key and return true if they are equal.
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T> FromWorld for T
where T: Default,

Source§

fn from_world(_world: &mut World) -> T

Creates Self using default().

Source§

impl<T> Instrument for T

Source§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
Source§

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
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> IntoEither for T

Source§

fn into_either(self, into_left: bool) -> Either<Self, Self>

Converts self into a Left variant of Either<Self, Self> if into_left is true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
where F: FnOnce(&Self) -> bool,

Converts self into a Left variant of Either<Self, Self> if into_left(&self) returns true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

impl<T> Same for T

Source§

type Output = T

Should always be Self
Source§

impl<T> Serialize for T
where T: Serialize + ?Sized,

Source§

fn erased_serialize(&self, serializer: &mut dyn Serializer) -> Result<(), Error>

Source§

fn do_erased_serialize( &self, serializer: &mut dyn Serializer, ) -> Result<(), ErrorImpl>

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,

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.
Source§

impl<T> TypeData for T
where T: 'static + Send + Sync + Clone,

Source§

impl<T> Upcast<T> for T

Source§

fn upcast(&self) -> Option<&T>

Source§

impl<V, T> VZip<V> for T
where V: MultiLane<T>,

Source§

fn vzip(self) -> V

Source§

impl<T> WithSubscriber for T

Source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

impl<T> ConditionalSend for T
where T: Send,

Source§

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

Source§

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

Source§

impl<T> SerializableAny for T
where T: 'static + Any + Clone + for<'a> Send + Sync,

Source§

impl<T> Settings for T
where T: 'static + Send + Sync,

Source§

impl<T> WasmNotSend for T
where T: Send,

Source§

impl<T> WasmNotSendSync for T

Source§

impl<T> WasmNotSync for T
where T: Sync,