Skip to main content

Timeline

Struct Timeline 

Source
pub struct Timeline { /* private fields */ }
Expand description

When each shot of a cinematic starts, and when the cinematic ends.

Implementations§

Source§

impl Timeline

Source

pub fn new(starts_ms: Vec<u32>, length_ms: u32) -> Self

A timeline of shots starting at starts_ms (in order, the first at 0, as a loaded cinematic has them) over length_ms (0 counts as 1).

Source

pub fn of<S>(def: &CinematicDef<S>) -> Self

The timeline of def’s shots.

Source

pub fn length_ms(&self) -> u32

The length, in milliseconds.

Source

pub fn last_start_ms(&self) -> u32

When the last shot starts, in milliseconds (0 with no shots).

Source

pub fn in_last_shot(&self, t_ms: u64) -> bool

Whether t_ms (wrapped at the length) falls in the last shot.

Source

pub fn shot_ms(&self, index: usize) -> u32

How long shot index lasts, in milliseconds: until the next one starts, the last until the end. 0 for a shot there isn’t.

Source

pub fn wrapped_ms(&self, t_ms: u64) -> u32

t_ms wrapped at the length: the cinematic loops.

Source

pub fn at_ms(&self, t_ms: u64) -> ShotAt

The shot t_ms milliseconds after the start falls in, wrapped at the length. A shot lasts until the next one starts, the last until the end; time before the first shot’s start is the first shot’s.

Source

pub fn into_shot(&self, t_ms: u64) -> (usize, u32)

The shot t_ms falls in (at_ms), counted from 0, and how many milliseconds into it that is.

Source

pub fn at(&self, t: f32) -> ShotAt

at_ms for t seconds (millis).

Source

pub fn moment(&self, t_ms: u64) -> Moment

Everything about the moment t_ms milliseconds after the start (wrapped at the length) that a shot is told.

Trait Implementations§

Source§

impl Clone for Timeline

Source§

fn clone(&self) -> Timeline

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 Timeline

Source§

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

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

impl Eq for Timeline

Source§

impl PartialEq for Timeline

Source§

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

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

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

Inequality operator !=. Read more
Source§

impl StructuralPartialEq for Timeline

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