rlottie
rlottie is a platform independent standalone c++ library for rendering vector based animations and art in realtime.
Lottie loads and renders animations and vectors exported in the bodymovin JSON format. Bodymovin JSON can be created and exported from After Effects with bodymovin, Sketch with Lottie Sketch Export, and from Haiku.
For the first time, designers can create and ship beautiful animations without an engineer painstakingly recreating it by hand. Since the animation is backed by JSON they are extremely small in size but can be large in complexity!
Here are small samples of the power of Lottie.
Contents
- Building Lottie
- Demo
- Previewing Lottie JSON Files
- Quick Start
- Dynamic Property
- Supported After Effects Features
- Issues or Feature Requests?
Building Lottie
rottie supports meson and cmake build system. rottie is written in C++14. and has a public header dependancy of C++11
Meson Build
install meson and ninja if not already installed.
Run meson to configure rlottie
meson build
Run ninja to build rlottie
ninja -C build
Cmake Build
Install cmake if not already installed
Create a build directory for out of source build
mkdir build
Run cmake command inside build directory to configure rlottie.
cd build
cmake ..
# install in a different path. eg ~/test/usr/lib
cmake -DCMAKE_INSTALL_PREFIX=~/test ..
Run make to build rlottie
make -j 2
To install rlottie library
make install
Test
Configure to build test
meson configure -Dtest=true
Build test suit
ninja
Run test suit
ninja test
Demo
If you want to see rlottie librray in action without building it please visit rlottie online viewer
While building rlottie library it generates a simple lottie to GIF converter which can be used to convert lottie json file to GIF file.
Run Demo
lottie2gif [lottie file name]
Previewing Lottie JSON Files
Please visit rlottie online viewer
rlottie online viewer uses rlottie wasm library to render the resource locally in your browser. To test your JSON resource drag and drop it to the browser window.
Quick Start
Lottie loads and renders animations and vectors exported in the bodymovin JSON format. Bodymovin JSON can be created and exported from After Effects with bodymovin, Sketch with Lottie Sketch Export, and from Haiku.
You can quickly load a Lottie animation with:
std::unique_ptr<rlottie::Animation> animation =
rlottie::loadFromFile(std::string("absolute_path/test.json"));You can load a lottie animation from raw data with:
std::unique_ptr<rlottie::Animation> animation = rlottie::loadFromData(std::string(rawData),
std::string(cacheKey));Properties like frameRate , totalFrame , duration can be queried with:
# get the frame rate of the resource.
double frameRate = animation->frameRate();
#get total frame that exists in the resource
size_t totalFrame = animation->totalFrame();
#get total animation duration in sec for the resource
double duration = animation->duration();Render a particular frame in a surface buffer immediately with:
rlottie::Surface surface(buffer, width , height , stride);
animation->renderSync(frameNo, surface); Render a particular frame in a surface buffer asyncronousely with:
rlottie::Surface surface(buffer, width , height , stride);
# give a render request
std::future<rlottie::Surface> handle = animation->render(frameNo, surface);
...
#when the render data is needed
rlottie::Surface surface = handle.get();Dynamic Property
Update me.
Supported After Effects Features
| Shapes | Supported |
|---|---|
| Shape | 👍 |
| Ellipse | 👍 |
| Rectangle | 👍 |
| Rounded Rectangle | 👍 |
| Polystar | 👍 |
| Group | 👍 |
| Trim Path (individually) | 👍 |
| Trim Path (simultaneously) | 👍 |
| Renderable | Supported |
| Fill | 👍 |
| Stroke | 👍 |
| Radial Gradient | 👍 |
| Linear Gradient | 👍 |
| Gradient Stroke | 👍 |
| Transforms | Supported |
| Position | 👍 |
| Position (separated X/Y) | 👍 |
| Scale | 👍 |
| Skew | ⛔️ |
| Rotation | 👍 |
| Anchor Point | 👍 |
| Opacity | 👍 |
| Parenting | 👍 |
| Auto Orient | 👍 |
| Interpolation | Supported |
| Linear Interpolation | 👍 |
| Bezier Interpolation | 👍 |
| Hold Interpolation | 👍 |
| Spatial Bezier Interpolation | 👍 |
| Rove Across Time | 👍 |
| Masks | Supported |
| Mask Path | 👍 |
| Mask Opacity | 👍 |
| Add | 👍 |
| Subtract | 👍 |
| Intersect | 👍 |
| Lighten | ⛔️ |
| Darken | ⛔️ |
| Difference | ⛔️ |
| Expansion | ⛔️ |
| Feather | ⛔️ |
| Mattes | Supported |
| Alpha Matte | 👍 |
| Alpha Inverted Matte | 👍 |
| Luma Matte | 👍 |
| Luma Inverted Matte | 👍 |
| Merge Paths | Supported |
| Merge | ⛔️ |
| Add | ⛔️ |
| Subtract | ⛔️ |
| Intersect | ⛔️ |
| Exclude Intersection | ⛔️ |
| Layer Effects | Supported |
| Fill | ⛔️ |
| Stroke | ⛔️ |
| Tint | ⛔️ |
| Tritone | ⛔️ |
| Levels Individual Controls | ⛔️ |
| Text | Supported |
| Glyphs | ⛔️ |
| Fonts | ⛔️ |
| Transform | ⛔️ |
| Fill | ⛔️ |
| Stroke | ⛔️ |
| Tracking | ⛔️ |
| Anchor point grouping | ⛔️ |
| Text Path | ⛔️ |
| Per-character 3D | ⛔️ |
| Range selector (Units) | ⛔️ |
| Range selector (Based on) | ⛔️ |
| Range selector (Amount) | ⛔️ |
| Range selector (Shape) | ⛔️ |
| Range selector (Ease High) | ⛔️ |
| Range selector (Ease Low) | ⛔️ |
| Range selector (Randomize order) | ⛔️ |
| expression selector | ⛔️ |
| Other | Supported |
| Expressions | ⛔️ |
| Images | 👍 |
| Precomps | 👍 |
| Time Stretch | 👍 |
| Time remap | 👍 |
| Markers | ⛔️ |
Issues or Feature Requests?
File github issues for anything that is broken. Be sure to check the list of supported features before submitting. If an animation is not working, please attach the After Effects file to your issue. Debugging without the original can be very difficult. For immidiate assistant or support please reach us in Gitter