README.md

ScenesAnimations

ScenesAnimations is a library built on top of Igis and Scenes with added support for running animations.

Table of Content

• Setup
• Documentation
• Project Roadmap

Setup

To use the ScenesAnimations library in your existing Scenes project, add the following line to your dylib.manifest file:

ScenesAnimations          <version>

Then, run the following commands on the command line:

rm dir-locals.el
dylibEmacs
build

Documentation

Overview

ScenesAnimations provides numerous Animation types which can modify graphical objects. Each Animation must be registered to an AnimationController before it can be played. This can be done with the register() method available through the AnimationController type. It's also important that each animation is unregistered no later than their Scenes parent object teardown() method.

ScenesAnimations provides a default AnimationController accessible through the animationController variable in the Director, Scene, Layer, and RenderableEntity classes.

override func setup(canvasSize: Size, canvas: Canvas) {
    animationController.register(animation: myAnimation)
}

override func teardown() {
    animationController.unregister(animation: myAnimation)
}

Animation Types

Their are several types of Animations provided by the ScenesAnimations library:

Animation Type	Description
Tween	Tween's are the most basic type of animation, and can animate one property between 2 values

Tween

Project Roadmap

• Add Documentation to README.
• Add Interpolatable support for characters and strings.
• Add support for animating along a path.
• Add simplified declarative syntax for animating properties.
• Add Animation Timelines.
• Add prefabricated animations