Skip to main content

AnimationOptions

Struct AnimationOptions 

#[non_exhaustive]
pub struct AnimationOptions { pub duration_ms: Option<f64>, pub velocity: Option<f64>, pub min_zoom: Option<f64>, pub easing: Option<UnitBezier>, pub transition_id: Option<u64>, }
Expand description

Optional animation controls for camera transitions.

Fields (Non-exhaustive)§

This struct is marked as non-exhaustive
Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.
§duration_ms: Option<f64>§velocity: Option<f64>§min_zoom: Option<f64>§easing: Option<UnitBezier>§transition_id: Option<u64>

Caller-chosen identity for the transition these options start.

When set, the transition emits exactly one runtime event of type RuntimeEventType::MapCameraTransitionFinished carrying this value in its CameraTransitionFinishedEvent payload. The value passes through uninterpreted, so callers pick their own scheme, such as a monotonically increasing counter.

The event arrives for every terminal outcome: running to completion, being superseded by a later camera command, being cancelled by cancel_transitions, or completing instantly as a zero-duration jump. A command this API rejects, such as one carrying a non-finite enabled camera field, starts no transition and emits no such event. MapLibre Native reports the moment the transition releases the camera without naming which outcome occurred, so the event establishes transition identity rather than a completion reason. A host that needs to tell completion from cancellation compares the resulting camera against the requested one, or tracks which transition ID is current.

Leaving this field absent emits no such event.

Trait Implementations§

§

impl Clone for AnimationOptions

§

fn clone(&self) -> AnimationOptions

Returns a duplicate of the value. Read more
1.0.0 · Source§

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

Performs copy-assignment from source. Read more
§

impl Debug for AnimationOptions

§

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

Formats the value using the given formatter. Read more
§

impl Default for AnimationOptions

§

fn default() -> AnimationOptions

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

impl PartialEq for AnimationOptions

§

fn eq(&self, other: &AnimationOptions) -> 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.
§

impl StructuralPartialEq for AnimationOptions

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.