qt_target_qml_from_lottie

Generates QML code based on an Lottie file.

The command is defined in the LottieTools component of the Qt6 package, which can be loaded like this:

find_package(Qt6 REQUIRED COMPONENTS LottieTools)

This command was introduced in Qt 6.11.

Synopsis

qt_target_qml_from_lottie(target
                          [CURVE_RENDERER]
                          [OPTIMIZE_PATHS]
                          [OUTLINE_STROKE_MODE]
                          [TYPE_NAME "MyShapeName"]
                          [COPYRIGHT_STATEMENT "Copyright © Company1"]
                          FILES file1.json [file2.json ...]
                          OUTPUTS File1.qml [File2.qml ...]
                          )

If versionless commands are disabled, use qt6_target_qml_from_lottie() instead. It supports the same set of arguments as this command.

Example:

qt_target_qml_from_lottie(applottietoqmlexample
    CURVE_RENDERER
    OPTIMIZE_PATHS
    FILES
        original/FingerprintIcon.json
        original/GoogleIcons.json
        original/HappyStar.json
        original/HeartMedical.json
        original/SurprisedBoy.json
        original/USAMapWithOutlines.json
        original/UserAuthentication.json
        original/UserInteractionAnimation.json
        original/UserInterface.json
    OUTPUTS
        generated/FingerprintIcon.qml
        generated/GoogleIcons.qml
        generated/HappyStar.qml
        generated/HeartMedical.qml
        generated/SurprisedBoy.qml
        generated/USAMapWithOutlines.qml
        generated/UserAuthentication.qml
        generated/UserInteractionAnimation.qml
        generated/UserInterface.qml
)

Description

qt_target_qml_from_lottie() creates the build steps to run lottietoqml on the list of Lottie images in FILES. The names of the generated files should be specified in OUTPUTS. The length of this list must be the same as FILES, and the first element corresponds to the first element in FILES and so forth. The names provided in OUTPUTS will be the names of the QML types as they appear in the module. These can in turn be instantiated in the application code.

The generated QML files will be added to the QML module of target. You must use qt_add_qml_module() to define a module for the target first.

Optionally, a COPYRIGHT_STATEMENT argument can be provided to insert copyright information into the generated files.

TYPE_NAME is also optional, and can be used to replace all instances of the Shape type in the generated file with a custom type. This can be useful to make general customizations to all the shapes in the provided Lottie files. The TYPE_NAME should refer to a QML type which is available in the target QML module.

The options CURVE_RENDERER, OPTIMIZE_PATHS and OUTLINE_STROKE_MODE correspond to the --curve-renderer, --optimize-paths and --outline-stroke-mode in lottietoqml respectively.