Skip to main content

VarKeyframe

Struct VarKeyframe 

Source
pub struct VarKeyframe {
    pub at: TimePoint,
    pub to: f64,
    pub duration: TimePoint,
    pub easing: EasingType,
}
Expand description

One tween: hold at the running value until at, then ease to to over duration, then hold at to until the next keyframe fires (or forever, for the last one). See super::track’s module doc, “Value outside the keyframes”, for the exact before-first/after-last rule.

Fields§

§at: TimePoint

Where this segment starts, on the scenario’s absolute timeline. Resolved via TimePoint::resolve_absolute with scene_start pinned to 0.0 — a variable has no enclosing scene of its own, so the leading @ this grammar otherwise requires for an absolute reading is accepted but never changes anything here: "4b" and "@4b" resolve identically for a VarKeyframe.

§to: f64

The value this segment eases towards.

§duration: TimePoint

How long the ease from the running value to to takes.

Not resolved the way you’d expect from reading TimePoint’s own contract. TimePoint’s "b" unit is defined as a position on the beat grid — beat_offset + n * 60 / bpm, beat_offset included, by design, because every other TimePoint field in this schema (at, Scene::at, a shake impact’s at, …) names a point in time, where picking up the grid’s anchor is exactly right. duration is the one exception: it names a span — “3 beats long” — and a span must not shift just because the grid happens to start somewhere other than zero. Resolving "3b" through TimePoint::resolve_relative unchanged would compute beat_offset + 3 * 60 / bpm, silently stretching every tween by the scenario’s own beat_offset on top of its declared length. super::track::VarTrack::compile resolves this field against a copy of the scenario’s TimeCtx with beat_offset zeroed instead, so "3b" always means exactly 3 * 60 / bpm seconds — see that function’s doc, and super::track’s module doc, for the full reasoning and a test (beat_offset_does_not_leak_into_duration) pinning it down.

Defaults to an instant snap (0 seconds) when omitted.

§easing: EasingType

Defaults to EasingType::Linear — the same default EasingType’s own #[default] picks, deliberately not schema::animation::Animation’s node-animation default (EaseOut): a variable has no established “usual feel” the way an entrance animation does, so an un-set easing should be the arithmetically neutral choice.

Trait Implementations§

Source§

impl Clone for VarKeyframe

Source§

fn clone(&self) -> Self

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 VarKeyframe

Source§

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

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

impl<'de> Deserialize<'de> for VarKeyframe

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 JsonSchema for VarKeyframe

Source§

fn schema_name() -> String

The name of the generated JSON Schema. Read more
Source§

fn schema_id() -> Cow<'static, str>

Returns a string that uniquely identifies the schema produced by this type. Read more
Source§

fn json_schema(generator: &mut SchemaGenerator) -> Schema

Generates a JSON Schema for this type. Read more
Source§

fn is_referenceable() -> bool

Whether JSON Schemas generated for this type should be re-used where possible using the $ref keyword. Read more
Source§

impl PartialEq for VarKeyframe

Source§

fn eq(&self, other: &Self) -> bool

Equality operator ==. Read more
1.0.0 (const: unstable) · Source§

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

Inequality operator !=. Read more
Source§

impl Serialize for VarKeyframe

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 StructuralPartialEq for VarKeyframe

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> DeserializeOwned for T
where T: for<'de> Deserialize<'de>,

Source§

impl<T> DynClone for T
where T: Clone,

Source§

fn __clone_box(&self, _: Private) -> *mut ()

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

Source§

const ALIGN: usize

The alignment of pointer.
Source§

type Init = T

The type for initializers.
Source§

unsafe fn init(init: <T as Pointable>::Init) -> usize

Initializes a with the given initializer. Read more
Source§

unsafe fn deref<'a>(ptr: usize) -> &'a T

Dereferences the given pointer. Read more
Source§

unsafe fn deref_mut<'a>(ptr: usize) -> &'a mut T

Mutably dereferences the given pointer. Read more
Source§

unsafe fn drop(ptr: usize)

Drops the object pointed to by the given pointer. Read more
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 = !

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, !>

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.