Skip to content

Commit

Permalink
Update supported features; Update path to layer parameters in Lottie
Browse files Browse the repository at this point in the history
  • Loading branch information
AnishGG authored and morevnaproject committed Jul 24, 2019
1 parent 1ac60f0 commit 87a4b85
Show file tree
Hide file tree
Showing 6 changed files with 220 additions and 0 deletions.
40 changes: 40 additions & 0 deletions docs/projects/lottie/layers/group.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,40 @@
Group Layer
============

+------------------+------------------------------------------------------------------+
| Property | Path to Property in lottie |
+==================+==================================================================+
| Z depth | Depends on ordering of layers in lottie format |
+------------------+------------------------------------------------------------------+
| Amount | layers/preComp.json -> "ks" -> helpers/transform.json -> "o" |
+------------------+------------------------------------------------------------------+
| Blend_method | layers/preComp.json -> “bm” -> helpers/blendMode.json |
+------------------+------------------------------------------------------------------+
| Origin | layers/preComp.json -> "ks" -> helpers/transform.json -> "p"/"a" |
+------------------+------------------------------------------------------------------+
| Transformation | layers/preComp.json -> "ks" -> helpers/transform.json |
+------------------+------------------------------------------------------------------+
| Canvas | sources/preComp.json |
+------------------+------------------------------------------------------------------+
| Speed | layers/preComp.json -> "tm"(time remapping) |
+------------------+------------------------------------------------------------------+
| Time Offset | layer/preComp.json -> "tm"(time remapping) |
+------------------+------------------------------------------------------------------+
| Lock selection | Not needed |
+------------------+------------------------------------------------------------------+
| Outline Grow | Global parameter -> ``settings.OUTLINE_GROW`` |
+------------------+------------------------------------------------------------------+
| Z Range | Opacity of layers in canvas is modified accordingly |
+------------------+------------------------------------------------------------------+
| Z Range Position | Opacity of layers in canvas is modified accordingly |
+------------------+------------------------------------------------------------------+
| Z Range Depth | Opacity of layers in canvas is modified accordingly |
+------------------+------------------------------------------------------------------+
| Z Range Blur | Not Supported |
+------------------+------------------------------------------------------------------+

Important points
----------------

- In Lottie, all the parts of shapes/elements lying outside a precomposition are cut off and never displayed. Hence the over all size of a pre-comp is increased by some amount as a precaution. Some part which is outside a pre-comp might come inside the overall canvas after some transformations(rotation/translation/scale). This increase is given by:
``ADDITIONAL_PRECOMP_WIDTH`` and ``ADDITIONAL_PRECOMP_HEIGHT``
17 changes: 17 additions & 0 deletions docs/projects/lottie/layers/rotate.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,17 @@
Rotate Layer
============

+----------+------------------------------------------------------------------+
| Property | Path to Property in lottie |
+==========+==================================================================+
| Origin | layers/preComp.json -> "ks" -> helpers/transform.json -> "p"/"a" |
+----------+------------------------------------------------------------------+
| Amount | layers/preComp.json -> "ks" -> helpers/transform.json -> "r" |
+----------+------------------------------------------------------------------+


Important points
----------------

- In Lottie, all the parts of shapes/elements lying outside a precomposition are cut off and never displayed. Hence the over all size of a pre-comp is increased by some amount as a precaution. Some part which is outside a pre-comp might come inside the overall canvas after some transformations(rotation/translation/scale). This increase is given by:
``ADDITIONAL_PRECOMP_WIDTH`` and ``ADDITIONAL_PRECOMP_HEIGHT``
17 changes: 17 additions & 0 deletions docs/projects/lottie/layers/scale.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,17 @@
Scale Layer
============

+----------+------------------------------------------------------------------+
| Property | Path to Property in lottie |
+==========+==================================================================+
| Origin | layers/preComp.json -> "ks" -> helpers/transform.json -> "p"/"a" |
+----------+------------------------------------------------------------------+
| Amount | layers/preComp.json -> "ks" -> helpers/transform.json -> "s" |
+----------+------------------------------------------------------------------+


Important points
----------------

- In Lottie, all the parts of shapes/elements lying outside a precomposition are cut off and never displayed. Hence the over all size of a pre-comp is increased by some amount as a precaution. Some part which is outside a pre-comp might come inside the overall canvas after some transformations(rotation/translation/scale). This increase is given by:
``ADDITIONAL_PRECOMP_WIDTH`` and ``ADDITIONAL_PRECOMP_HEIGHT``
34 changes: 34 additions & 0 deletions docs/projects/lottie/layers/switch.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,34 @@
Switch Group Layer
==================

+-------------------+-----------------------------------------------------------------------+
| Property | Path to Property in lottie |
+===================+=======================================================================+
| Z depth | Depends on ordering of layers in lottie format |
+-------------------+-----------------------------------------------------------------------+
| Amount | layers/preComp.json -> "ks" -> helpers/transform.json -> "o" |
+-------------------+-----------------------------------------------------------------------+
| Blend_method | layers/preComp.json -> “bm” -> helpers/blendMode.json |
+-------------------+-----------------------------------------------------------------------+
| Origin | layers/preComp.json -> "ks" -> helpers/transform.json -> "p"/"a" |
+-------------------+-----------------------------------------------------------------------+
| Transformation | layers/preComp.json -> "ks" -> helpers/transform.json |
+-------------------+-----------------------------------------------------------------------+
| Canvas | sources/preComp.json |
+-------------------+-----------------------------------------------------------------------+
| Speed | layers/preComp.json -> "tm"(time remapping) |
+-------------------+-----------------------------------------------------------------------+
| Time Offset | layer/preComp.json -> "tm"(time remapping) |
+-------------------+-----------------------------------------------------------------------+
| Lock selection | Not needed |
+-------------------+-----------------------------------------------------------------------+
| Outline Grow | Global parameter -> settings.OUTLINE_GROW |
+-------------------+-----------------------------------------------------------------------+
| Active Layer Name | Opacity of layers in canvas is modified according to the active layer |
+-------------------+-----------------------------------------------------------------------+

Important points
----------------

- In Lottie, all the parts of shapes/elements lying outside a precomposition are cut off and never displayed. Hence the over all size of a pre-comp is increased by some amount as a precaution. Some part which is outside a pre-comp might come inside the overall canvas after some transformations(rotation/translation/scale). This increase is given by:
``ADDITIONAL_PRECOMP_WIDTH`` and ``ADDITIONAL_PRECOMP_HEIGHT``
17 changes: 17 additions & 0 deletions docs/projects/lottie/layers/transform.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,17 @@
Transform Layer
============

+----------+--------------------------------------------------------------+
| Property | Path to Property in lottie |
+==========+==============================================================+
| Origin | layers/preComp.json -> "ks" -> helpers/transform.json -> "p" |
+----------+--------------------------------------------------------------+


Important points
----------------

- In Lottie, all the parts of shapes/elements lying outside a precomposition are cut off and never displayed. Hence the over all size of a pre-comp is increased by some amount as a precaution. Some part which is outside a pre-comp might come inside the overall canvas after some transformations(rotation/translation/scale). This increase is given by:
``ADDITIONAL_PRECOMP_WIDTH`` and ``ADDITIONAL_PRECOMP_HEIGHT``

- Anchor point is always set to zero. But it is bound to change when the width and height of the pre-composition are changed
95 changes: 95 additions & 0 deletions docs/projects/lottie/supported.rst
Original file line number Diff line number Diff line change
Expand Up @@ -267,6 +267,101 @@ Outline Layer

- Animation of `Addition/Deletion` of vertices is not yet supported

Rotate Layer
------------

+-----------------+---------------------+---------------------------------------------+
| Property | Value | Type(Animation) |
+=================+=====================+=============================================+
| Origin | |tick| | |tick| |
+-----------------+---------------------+---------------------------------------------+
| Amount | |tick| | |tick| |
+-----------------+---------------------+---------------------------------------------+

Scale Layer
-----------

+-----------------+---------------------+---------------------------------------------+
| Property | Value | Type(Animation) |
+=================+=====================+=============================================+
| Origin | |tick| | |tick| |
+-----------------+---------------------+---------------------------------------------+
| Amount | |tick| | |tick| |
+-----------------+---------------------+---------------------------------------------+

Translate Layer
---------------

+-----------------+---------------------+---------------------------------------------+
| Property | Value | Type(Animation) |
+=================+=====================+=============================================+
| Origin | |tick| | |tick| |
+-----------------+---------------------+---------------------------------------------+

Group Layer
-----------

+------------------+---------------------+--------------------+
| Property | Value | Type(Animation) |
+==================+=====================+====================+
| Z depth | |tick| | |cross| |
+------------------+---------------------+--------------------+
| Amount | |tick| | |tick| |
+------------------+---------------------+--------------------+
| Blend_method | Partially supported | |minus| |
+------------------+---------------------+--------------------+
| Origin | |tick| | |tick| |
+------------------+---------------------+--------------------+
| Transformation | Skew not supported | Skew not supported |
+------------------+---------------------+--------------------+
| Canvas | |tick| | |tick| |
+------------------+---------------------+--------------------+
| Speed | |tick| | |tick| |
+------------------+---------------------+--------------------+
| Time Offset | |tick| | |tick| |
+------------------+---------------------+--------------------+
| Lock Selection | Not needed | Not needed |
+------------------+---------------------+--------------------+
| Outline Grow | |tick| | |tick| |
+------------------+---------------------+--------------------+
| Z Range | |tick| | Not needed |
+------------------+---------------------+--------------------+
| Z Range Position | |tick| | |tick| |
+------------------+---------------------+--------------------+
| Z Range Depth | |tick| | |tick| |
+------------------+---------------------+--------------------+
| Z Range Blur | |cross| | |cross| |
+------------------+---------------------+--------------------+

Switch Group Layer
------------------

+-------------------+---------------------+--------------------+
| Property | Value | Type(Animation) |
+===================+=====================+====================+
| Z depth | |tick| | |cross| |
+-------------------+---------------------+--------------------+
| Amount | |tick| | |tick| |
+-------------------+---------------------+--------------------+
| Blend_method | Partially supported | |minus| |
+-------------------+---------------------+--------------------+
| Origin | |tick| | |tick| |
+-------------------+---------------------+--------------------+
| Transformation | Skew not supported | Skew not supported |
+-------------------+---------------------+--------------------+
| Canvas | |tick| | |tick| |
+-------------------+---------------------+--------------------+
| Speed | |tick| | |tick| |
+-------------------+---------------------+--------------------+
| Time Offset | |tick| | |tick| |
+-------------------+---------------------+--------------------+
| Lock Selection | Not needed | Not needed |
+-------------------+---------------------+--------------------+
| Outline Grow | |tick| | |tick| |
+-------------------+---------------------+--------------------+
| Active Layer Name | |tick| | |tick| |
+-------------------+---------------------+--------------------+

Blend Methods
-------------
- The blend methods supported are: Composite, Difference, Multiply, Hard light, Luminance, Saturation, Hue, Color, Darken, Brighten, Overlay, Screen.
Expand Down

0 comments on commit 87a4b85

Please sign in to comment.