Using Animations.jl

[Wikunia]

PR Checklist

If you are contributing to Javis.jl, please make sure you are able to check off each item on this list:

• Did I update CHANGELOG.md with whatever changes/features I added with this PR?
• Did I update the TODO.md (if applicable)?
• Did I make sure to only change the part of the file where I introduced a new change/feature?
• Did I cover all corner cases to be close to 100% test coverage (if applicable)?
  • Needs one for error checking
• Did I properly add test dependencies to the test directory (if applicable)?
  • Added Animations.jl
• Did I check relevant tutorials that may be affected by changes in this PR?
  • Would be awesome if you can do this @TheCedarPrince
• Did I clearly articulate why this PR was made the way it was and how it was made?

Link to relevant issue(s)
Closes #42

How did you address these issues with this PR? What methods did you use?
Currently the following syntax is used to define the easing function for interpolation:

• Use linear as default which makes this non-breaking

video = Video(1000, 700)
javis(
    video, [
        BackgroundAction(1:150, ground),
        Action((args...)->circle(Point(-300, -300), 25, :fill); subactions=[
            SubAction(1:50, sineio(), Translation(500, 0))
            SubAction(51:100, polyin(2), Translation(0, 500))
            SubAction(101:150, expin(8), Translation(-500, -500))
        ])
    ], pathname="current/sine_trans.gif"
)

with the result:

or similarly:

javis(
    video, [
        BackgroundAction(1:150, ground),
        Action((args...)->circle(Point(-300, -300), 25, :fill), sineio(), Translation(500, 0))
    ], pathname="current/sine_trans.gif"
)

if one doesn't work with subactions.

The appear, disappear and transformation functions now access the interpolation value t via get_interpolation(action, frame).

This does currently not contain tests but contains a bugfix which is also available in #121 which defines the linear interpolation in appear and disappear which was wrong before.

I would like to be able to write something like:

circle_anim = Animation(
    [0, 0.3, 0.6, 1], # must go from 0 to 1
    [O, Point(500, 0), Point(500, 500), O],
    [sineio(), polyin(5), expin(8)],
)
javis(
    video, [
        BackgroundAction(1:150, ground),
        Action((args...)->circle(Point(-300, -300), 25, :fill); subactions=[
            SubAction(1:150, circle_anim, translate())
        ])
    ], pathname="current/sine_trans.gif"
)

this will be done in the next step. Anything against this syntax? @TheCedarPrince

Additional Info about v0.2
This PR introduces Animations.jl therefore merging is done into v0.2 and not master.

[codecov]

Codecov Report

Merging #125 into v0.2 will increase coverage by 0.47%.
The diff coverage is 100.00%.

@@            Coverage Diff             @@
##             v0.2     #125      +/-   ##
==========================================
+ Coverage   97.44%   97.91%   +0.47%     
==========================================
  Files           7        7              
  Lines         508      719     +211     
==========================================
+ Hits          495      704     +209     
- Misses         13       15       +2     

Impacted Files	Coverage Δ
src/Javis.jl	97.46% <100.00%> (+1.15%)	⬆️
src/luxor_overrides.jl	100.00% <100.00%> (ø)
src/subaction_animations.jl	100.00% <100.00%> (ø)
src/util.jl	100.00% <100.00%> (ø)

---

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update b5fc3dd...7ebc34f. Read the comment docs.

[Wikunia]

The last commit makes the following reality:

A section from the docs:

translate()

Translate a function defined inside an Action using an Animation defined
with Animations.jl.

If you're used to working with Animations.jl this should feel quite natural.
Instead of defining each movement in its own subaction it's possible to define it in one
by using an Animation.

Example

using Javis, Animations

function ground(args...)
    background("black")
    sethue("white")
end

video = Video(500, 500)
circle_anim = Animation(
    [0.0, 0.3, 0.6, 1.0], # must go from 0 to 1
    # the circle will move from the origin to `Point(150, 0)` then `Point(150, 150)`
    # and back to the origin `O`.
    [O, Point(150, 0), Point(150, 150), O],
    [sineio(), polyin(5), expin(8)],
)
javis(
    video, [
        BackgroundAction(1:150, ground),
        Action((args...)->circle(O, 25, :fill); subactions=[
            SubAction(1:150, circle_anim, translate())
        ])
    ], pathname="moving_a_circle.gif"
)

Here circle_anim defines the movement of the circle. The most important part is that the
time in animations has to be from 0.0 to 1.0.

[TheCedarPrince]

I really like how you handled this. I was originally somewhat confused by what this is all doing, but now I understand what Animations.jl is exactly doing. Really like the way you can preserve Animations.jl syntax while also providing Javis.jl syntax. I feel like it offers a lot of flexibility to the user. Cool stuff man!

[Wikunia]

If you think the translate function makes sense I would add the same for scale and rotate.

[TheCedarPrince]

I think the translate function makes sense so feel free to add the other two @Wikunia! Otherwise, I just finished doing a review this and you have my approval to merge when ready.

[Wikunia]

Can be done with:

using Javis, Animations

function ground(args...)
    background("black")
    sethue("white")
end



video = Video(500, 500)
translate_anim = Animation(
    [0, 1], # must go from 0 to 1
    [O, Point(150, 0)],
    [sineio()],
)

translate_back_anim = Animation(
    [0, 1], # must go from 0 to 1
    [O, Point(-150, 0)],
    [sineio()],
)

rotate_anim = Animation(
    [0, 1], # must go from 0 to 1
    [0, 2π],
    [linear()],
)

javis(
    video,
    [
        BackgroundAction(1:150, ground),
        Action(
            (args...) -> circle(O, 25, :fill);
            subactions = [
                SubAction(1:10, sineio(), scale()),
                SubAction(11:50, translate_anim, translate()),
                SubAction(51:100, rotate_anim, rotate_around(Point(-150, 0))),
                SubAction(101:140, translate_back_anim, translate()),
                SubAction(141:150, rev(sineio()), scale()),
            ],
        ),
    ],
    pathname = "current/animations.gif",
)

[Wikunia]

Oh I think I should add some more coverage before merging and it would be nice to also have
this functionality for sethue to interpolate colors. @experimentMartin wants to see more weird colors on my stream.

[TheCedarPrince]

Just one typo but also check out luxor_overrides and subaction_animations. Code coverage picked up that there are some lines not being covered in our tests there. :P

[Wikunia]

This is what we can create now with sethue.

[TheCedarPrince]

Everything works on my end as expected. Feel free to merge when ready!