// Copyright (C) 2017 The Qt Company Ltd.
// SPDX-License-Identifier: LicenseRef-Qt-Commercial OR GFDL-1.3-no-invariants-only

/*!
\page qtquick-effects-sprites.html
\title Sprite Animations
\brief Sprite-based animations with flexible transitioning

\section1 Sprite Engine

The \l {Qt Quick} sprite engine is a stochastic state machine combined with the ability
to chop up images containing multiple frames of an animation.

\section2 State Machine

A primary function of the sprite engine is its internal state machine. This is not the same as
the states and transitions in Qt Quick, and is more like a conventional state machine. Sprites
can have weighted transitions to other sprites, or back to themselves. When a sprite animation
finishes, the sprite engine will choose the next sprite randomly, based on the weighted transitions
available for the sprite that just finished.

You can affect the currently playing sprite in two ways. You can arbitrarily force it to immediately
start playing any sprite, or you can tell it to gradually transition to a given sprite. If you
instruct it to gradually transition, then it will reach the target sprite by going through valid
state transitions using the fewest number of intervening sprites (but ignoring relative weightings).
This allows you to easily insert a transitional animation between two different sprites.

\image spriteenginegraph.png

As an example, consider the above diagram which illustrates the sprites for a hypothetical 2D
platform game character. The character starts by displaying the \e standing state. From this state,
barring external input, he will transition to either the \e waiting animation, the \e walking animation,
or play the \e standing animation again. Because the weights for those transitions are one, zero and three
respectively, he has a one in four chance of playing the \e waiting animation when the \e standing animation
finishes, and a three in four chance of playing the \e standing animation again. This allows for a character
who has a slightly animated and variable behavior while waiting.

Because there is a zero weight transition to the \e walking animation, the \e standing animation will not normally
transition there. But if you set the goal animation to be the \e walking animation, it would play the \e walking
animation when it finished the \e standing animation. If it was previously in the \e waiting animation, it would
finish playing that, then play the \e standing animation, then play the \e walking animation. It would then continue to
play the \e walking animation until the goal animation is unset, at which point it would switch to the \e standing
animation after finishing the \e walking animation.

If you then set the goal state to the \e jumping animation, it would finish the \e walking animation before
playing the \e jumping animation. Because the \e jumping animation does not transition to other states, it will still
keep playing the \e jumping animation until the state is forced to change. In this example, you could set it back to
\e walking and change the goal animation to \e walking or to nothing (which would lead it to play the \e standing animation
after the \e walking animation). Note that by forcibly setting the animation, you can start playing the animation
immediately.

\section2 Input Format

The file formats accepted by the sprite engine are the same as the file formats accepted by other QML types,
such as \l Image. In order to animate the image, however, the sprite engine requires the image file to contain
all of the frames of the animation. They should be arranged in a contiguous line, which may wrap from the right
edge of the file to a lower row starting from the left edge of the file (and which is placed directly below the
previous row).

\image spritecutting.png

As an example, take the above image. For now, just consider the black numbers, and assume the squares are 40x40 pixels.
Normally, the image is read from the top-left corner. If you specified the frame size as 40x40 pixels, and a frame count
of 8, then it would read in the frames as they are numbered. The frame in the top left would be the first frame, the frame
in the top right would be the fifth frame, and then it would wrap to the next row (at pixel location 0,40 in the file) to read
the sixth frame. It would stop reading after the frame marked 8, and if there was any image data in the square below frame four
then it would not be included in the animation.

It is possible to load animations from an arbitrary offset, but they will still follow the same pattern.
Consider now the red numbers. If we specify that the animation begins at pixel location 120,0, with a
frame count of 5 and the same frame size as before, then it will load the frames as they are numbered in red.
The first 120x40 of the image will not be used, as it starts reading 40x40 blocks from the location of 120,0.
When it reaches the end of the file at 160,0, it then starts to read the next row from 0,40.

The blue numbers show the frame numbers if you tried to load two frames of that size, starting from 40,40. Note
that it is possible to load multiple sprites from one image file. The red, blue and black numbers can all
be loaded as separate animations to the same sprite engine. The following code loads the animations as per the image.
It also specifies that animations are to be played at 20 frames per second.

\code
Sprite {
    name: "black"
    source: "image.png"
    frameCount: 8
    frameWidth: 40
    frameHeight: 40
    frameRate: 20
}
Sprite {
    name: "red"
    source: "image.png"
    frameX: 120
    frameCount: 5
    frameWidth: 40
    frameHeight: 40
    frameRate: 20
}
Sprite {
    name: "blue"
    source: "image.png"
    frameX: 40
    frameX: 40
    frameCount: 2
    frameWidth: 40
    frameHeight: 40
    frameRate: 20
}
\endcode

Frames within one animation must be the same size. However, multiple animations within the same file
do not. Sprites without a \l {Sprite::}{frameCount} specified assume that they take the entire file, and you must specify
the frame size. Sprites without a frame size assume that they are square and take the entire file without wrapping,
and you must specify a frame count.

The sprite engine internally copies and cuts up images to fit in an easier-to-read internal format, which leads
to some graphics memory limitations. Because it requires all the sprites for a single engine to be in the same
texture, attempting to load many different animations can run into texture memory limits on embedded devices. In
these situations, a warning will be output to the console containing the maximum texture size.

There are several tools to help turn a set of images into sprite sheets. Here are some examples:
\list
 \li Photoshop plugin: \l http://www.johnwordsworth.com/projects/photoshop-sprite-sheet-generator-script
 \li Gimp's SpriteSheet plugin
 \li Cmd-line tool: \l http://www.imagemagick.org/script/montage.php
\endlist

\section2 QML Types Using the Sprite Engine

Sprites for the sprite engine can be defined using the \l Sprite type. This type includes the input parameters,
as well as the length of the animation and weighted transitions to other animations. It is purely a data class, and
does not render anything.

\l SpriteSequence is a type which uses a sprite engine to draw the sprites defined in it. It is a single and
self-contained sprite engine, and does not interact with other sprite engines. \l Sprite types can be shared between
sprite engine-using types, but this is not done automatically. So, if you have defined a sprite in one \l SpriteSequence
you will need to redefine it (or reference the same \l Sprite type) in the sprites property of another \l SpriteSequence
in order to transition to that animation.

Additionally, \l ImageParticle can use \l Sprite types to define sprites for each particle. This is again a single
sprite engine per type. This works similarly to \c SpriteSequence, but it also has the parameterized variability provided
by the \l ImageParticle type.

\section1 AnimatedSprite Type

For use-cases which do not need to transition between animations, consider the \l AnimatedSprite type.
This type displays sprite animations with the same input format, but only one at a time. It also provides more fine-grained
manual control, as there is no sprite engine managing the timing and transitions behind the scenes.

*/
