RanimScene

Struct RanimScene 

Source
pub struct RanimScene {
    pub(crate) timelines: Vec<Timeline>,
    pub(crate) time_marks: Vec<(f64, TimeMark)>,
}
Expand description

The main struct that offers the ranim’s API, and encodes animations

Fields§

§timelines: Vec<Timeline>§time_marks: Vec<(f64, TimeMark)>

Implementations§

Source§

impl RanimScene

Source

pub fn seal(self) -> SealedRanimScene

Seals the scene to SealedRanimScene.

Source

pub fn new() -> Self

Create a new RanimScene

Source

pub fn insert_empty(&mut self) -> TimelineId

Insert an empty timeline.

Source

pub fn insert_empty_at(&mut self, sec: f64) -> TimelineId

Insert an empty timeline and forward it to the given sec.

Source

pub fn insert<T: Extract<Target = CoreItem> + Clone + 'static>( &mut self, item: T, ) -> TimelineId

Insert a timeline at 0.0 sec and play StaticAnim::show on it.

Source

pub fn insert_at<T: Extract<Target = CoreItem> + Clone + 'static>( &mut self, item: T, sec: f64, ) -> TimelineId

Insert a timeline at the given sec and play StaticAnim::show on it.

Source

pub fn insert_with(&mut self, f: impl FnMut(&mut Timeline)) -> TimelineId

Insert a empty timeline and call f on it.

Source

pub fn timelines(&self) -> &[Timeline]

Get reference of all timelines

Source

pub fn timelines_mut(&mut self) -> &mut [Timeline]

Get mutable reference of all timelines

Source

pub fn timeline<'a, T: TimelineIndex<'a>>(&'a self, index: T) -> T::RefOutput

Get the reference of timeline(s) by the TimelineIndex.

Source

pub fn timeline_mut<'a, T: TimelineIndex<'a>>( &'a mut self, index: T, ) -> T::MutOutput

Get the mutable reference of timeline(s) by the TimelineIndex.

Source

pub fn insert_time_mark(&mut self, sec: f64, time_mark: TimeMark)

Inserts an TimeMark

Trait Implementations§

Source§

impl Debug for RanimScene

Source§

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

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

impl Default for RanimScene

Source§

fn default() -> RanimScene

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

Auto Trait Implementations§

Blanket Implementations§

§

impl<T> Any for T
where T: 'static + ?Sized,

§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
§

impl<T> Borrow<T> for T
where T: ?Sized,

§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
§

impl<T> BorrowMut<T> for T
where T: ?Sized,

§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> Discard for T

Source§

fn discard(&self)

Simply returns ()
§

impl<T> From<T> for T

§

fn from(t: T) -> T

Returns the argument unchanged.

§

impl<T> Instrument for T

§

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

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

fn in_current_span(self) -> Instrumented<Self>

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

impl<T, U> Into<U> for T
where U: From<T>,

§

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
§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

§

type Error = Infallible

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

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
§

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

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
Source§

impl<T> With for T

Source§

fn with(self, f: impl Fn(&mut Self)) -> Self
where Self: Sized,

Mutating a value in place
§

impl<T> WithSubscriber for T

§

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
§

fn with_current_subscriber(self) -> WithDispatch<Self>

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