https://github.com/k3rs3d/keranim

Animation library for Rust (WIP)
https://github.com/k3rs3d/keranim

Last synced: about 1 month ago
JSON representation

Animation library for Rust (WIP)

• Host: GitHub
• URL: https://github.com/k3rs3d/keranim
• Owner: k3rs3d
• License: gpl-3.0
• Created: 2023-11-22T23:27:19.000Z (about 1 year ago)
• Default Branch: main
• Last Pushed: 2023-11-27T20:25:10.000Z (about 1 year ago)
• Last Synced: 2023-12-13T21:11:27.237Z (about 1 year ago)
• Language: Rust
• Size: 21.5 KB
• Stars: 0
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# Rust Animation Library

A very early work-in-progress. This will hopefully become a flexible and powerful Rust library for animating arbitrary value types using keyframes on a timeline. 

## Features

- **Type-Agnostic Animations**: Animate any type that implements the `Animatable` trait.

- **Keyframe-Based**: Define animation steps with keyframes for precise control.

- **Flexible Timelines**: Compose multiple animation tracks in parallel with independent timelines.

- **Easing & Interpolation**: Support for linear and more advanced easing functions.

- **End Behaviors**: Customize the behavior of animations after they finish (including loop, reverse, stop, and more).

- **Macro Support**: Simplify animation setup with macros to reduce verbosity.

## Getting Started

Add the animation library to your project's `Cargo.toml`

## Usage 

```

use keranim::{Animatable, AnimationTrack, AnimationTimeline, EndBehavior};

// Implement Animatable for your custom type

#[derive(Clone, Debug)]

pub struct MyValueType {

    // Your fields

}

impl Animatable for MyValueType {

    // Your interpolation logic

}

// Set up your animation

let mut timeline = AnimationTimeline::new();

let mut track = AnimationTrack::new();

track.add_keyframe(0.0, MyValueType { /* initial state */ });

track.add_keyframe(1.0, MyValueType { /* final state */ });

timeline.add_track(track);

```

Includes a macro for less boilerplate:

```

create_animation_track!(

        track,

        MyValueType, 

        Stop,

        [

            (0.0, MyValueType::new(0.0,0.0)),

            (2.0, MyValueType::new(64.0,64.0)),

        ]

    );

timeline.add_track(track);

```

Update your animation somewhere in the application logic, such as a game update loop:

```

// Inside your update loop

let elapsed_time = app.elapsed_frames() as f64 / 60.0;

let positions = model.timeline.update(elapsed_time);

// Apply the animated properties to your objects

```