Skip to main content

CodeHandle

Struct CodeHandle 

Source
pub struct CodeHandle(pub AnimObj);
Expand description

Wrapper around the AnimObj struct that allows for clean animation construction for specific AnimObj kind.

Tuple Fields§

§0: AnimObj

Implementations§

Source§

impl CodeHandle

Source

pub fn instantiate(&self) -> AnimOP

Returns an animation that instantly adds that object to the scene.

let pointer = svg()
    .path("./pointer-tool.svg")
    .build();
Project {
   scene_settings,
   timeline: timeline![
       cw.instantiate(),
    ]
}
Source

pub const fn add_lines(&self) -> CodeAddLinesBuilder

Returns a builder for an animation of adding code lines to the code block.

               code.add_lines()
                   .str(
                       r"
fn fib(n: u32) -> u32 {
   match n {
       0 => 0,
       1 => 1,
       _ => fib(n - 1) + fib(n - 2),
   }
}
               "
                   )
                   .over(5.s())
                   .style(CodeAnimationStyle::TypeWriter),
Source

pub const fn modify_line(&self) -> CodeModifyLineBuilder

Returns a builder for an animation of modifying a line of code.

               code.modify_line()
                   .str("New Line Contents")
                   .line(25)
                   .over(5.s())
                   .style(CodeAnimationStyle::TypeWriter),
Source

pub fn highlight(&self) -> CodeHighlightBuilder

Returns a builder for an animation of highlighting code by line range or regex pattern.

               code.highlight()
                   .lines(3..6)
                   .color(Color::new(1.0, 1.0, 0.0, 0.3))
                   .over(1.s())
                   .ease(Ease::InOutCubic),
Source

pub const fn remove_lines(&self) -> CodeRemoveLinesBuilder

Returns a builder for an animation of removing lines form a code block.

               code.remove_lines()
                   .range(0..25)
                   .over(5.s())
                   .style(CodeAnimationStyle::TypeWriter),

Methods from Deref<Target = AnimObj>§

Source

pub fn instantiate(&self) -> AnimOP

Returns an animation that instantly adds that object to the scene.

let pointer = svg()
    .path("./pointer-tool.svg")
    .build();
Project {
   scene_settings,
   timeline: timeline![
       cw.instantiate(),
    ]
}

Trait Implementations§

Source§

impl Deref for CodeHandle

Source§

type Target = AnimObj

The resulting type after dereferencing.
Source§

fn deref(&self) -> &AnimObj

Dereferences the value.

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> 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<P, T> Receiver for P
where P: Deref<Target = T> + ?Sized, T: ?Sized,

Source§

type Target = T

🔬This is a nightly-only experimental API. (arbitrary_self_types)
The target type on which the method may be called.
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.