summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorVolker Hilsheimer <volker.hilsheimer@qt.io>2021-03-08 14:34:30 +0100
committerQt Cherry-pick Bot <cherrypick_bot@qt-project.org>2021-03-08 21:58:01 +0000
commit250488347f66ece2b927e2ba210fd3799ed5edcd (patch)
tree22c66d5df7a8d8b452f88c33da453cc68e8109cf
parentab9fdaa47f7e65ac99e9336d45300c989f662bf1 (diff)
Move list of known limitations into documentation
Change-Id: Id5bcd4e38117a135efaa2e81cc5d7469bdcf6b7c Reviewed-by: Rebecca Worledge <rebecca.worledge@qt.io> (cherry picked from commit 5abb836d15b733fcddc0a5845d13c07b1e4c5a98) Reviewed-by: Qt Cherry-pick Bot <cherrypick_bot@qt-project.org>
-rw-r--r--src/imports/doc/src/external-resources.qdoc5
-rw-r--r--src/imports/doc/src/qtlottie.qdoc53
-rw-r--r--src/unsupported_features.txt41
3 files changed, 58 insertions, 41 deletions
diff --git a/src/imports/doc/src/external-resources.qdoc b/src/imports/doc/src/external-resources.qdoc
index 00ca58e..394ca78 100644
--- a/src/imports/doc/src/external-resources.qdoc
+++ b/src/imports/doc/src/external-resources.qdoc
@@ -34,3 +34,8 @@
\externalpage https://github.com/airbnb/lottie-web
\title Bodymovin Source
*/
+
+/*!
+ \externalpage https://github.com/airbnb/lottie-web/tree/master/docs/json
+ \title Bodymovin Specification
+*/
diff --git a/src/imports/doc/src/qtlottie.qdoc b/src/imports/doc/src/qtlottie.qdoc
index 9079b7b..9b534c4 100644
--- a/src/imports/doc/src/qtlottie.qdoc
+++ b/src/imports/doc/src/qtlottie.qdoc
@@ -48,6 +48,59 @@
See the \l {Bodymovin Source}{GitHub page for Bodymovin} for instructions
on how to download and install the plugin for Adobe After Effects.
+ \section1 Limitations
+
+ The implementation follows the \l {Bodymovin Specification}{master specification for bodymovin}.
+ Deviations in exported Bodymovin files compared to the specification are
+ taken into account as much as possible when differences are noticed.
+
+ \section2 General limitations
+
+ \list
+ \li \c precomps are not supported
+ \li expressions are not supported
+ \li the timeline only supports frame-mode, not time-mode
+ \endlist
+
+ \section2 Animation level limitations
+
+ The following properties are not supported:
+
+ \list
+ \li \c assets - reusable text and images
+ \li \c chars text
+ \endlist
+
+ \section2 Layers
+
+ Only the \c shape layer and the \c {alpha mask adjustment} layer are supported.
+
+ The following properties are not supported:
+
+ \list
+ \li \c ao (auto-orientation)
+ \li \c bm (blend mode)
+ \li \c maskProperties (masks)
+ \li \c sr (time stretch)
+ \endlist
+
+ \section2 Shapes
+
+ The following elements and shapes are not supported:
+
+ \list
+ \li the \c gstroke (group stroke) element
+ \li the \c star element
+ \li Nested Repeater shapes
+ \endlist
+
+ Also note that the behavior when using multiple active trim paths (e.g. trim
+ paths in nested groups) is unpredictable.
+
+ \section2 Effects
+
+ The only supported effects are \c Slide and \c {Layer Fill}.
+
\section1 Licenses
Qt Lottie Animation is available under commercial licenses from \l{The Qt Company}.
diff --git a/src/unsupported_features.txt b/src/unsupported_features.txt
deleted file mode 100644
index 1448804..0000000
--- a/src/unsupported_features.txt
+++ /dev/null
@@ -1,41 +0,0 @@
-1. General
-
-- The master specification for bodymovin that is obeyed is at
- https://github.com/airbnb/lottie-web/tree/master/docs/json
-- Deviations in exported Bodymovin files compared to the specification
- taken into account as much as possible (when differences noticed)
-- precomps not supported
-- expressions not supported
-- only frame-mode on the timeline supported (no time-mode)
-
-
-2. Animation level
-
-- unsupported properties
- - assets (reusable text and images)
- - chars (text)
-
-
-3. Layers
-
-- Only the shape layer supported
-- Only alpha mask adjustment layer supported
-- unsupported properties
- - ao (auto-orientation)
- - bm (blend mode)
- - maskProperties (masks)
- - sr (time stretch)
-
-
-4. Shapes
-
-- the gstroke (group stroke) element not supported
-- the star element not supported
-- Nested Repeater shapes not supported
-- multiple active trim paths behavior is unpredictable
- (e.g. trim paths in nested groups)
-
-
-5. Effects
-
-- Only Slide and Layer Fill effects supported