Krita/Animation/Requirements

What user expects to see from the animation?

See also Usecases (seperated because is was so long)

General

1. An image consists of frames, which are just a sequence of images. The user can switch current frame, play all the frames at specified speed or play current selection (on a timeline) only.
2. Every layer of the image has a set of keyframes, which are sparse and are switched according to the current time value.
3. When rendering the final image for each frame, keyframes are interpolated according to a blending rule.
4. Default blending rule is a linear combination of two nearest keyframes using COMPOSITE_COPY + linear opacity blending mode.
5. The user should be able to choose blending rule from a set of predefined values and/or custom curve.
6. Painting or modifying the image is allowed on key frames only. Though the key frames can be created automatically on demand.
7. The final sequence of frames should be exported into a sequence of files supported by Krita, e.g. into a set of PNG images.

What will we NOT do?

What are our limits, we need to make these on the basis that we can tell when the animation plug-in is still within the boundaries of being an extension of Krita or whether we are better off splitting it off as a dedicated application or directing people to other applications like synfig, to maintain the scope.

1. Advanced Bone Systems - These require dependancy graphs, which are very complex bits of code. I think the user is better off going to synfig or blender where these systems are already well in place and maintained.
   1. In contrast, we should look to improving our file-exchange with these programs instead. Better interoperability between krita and foss programs or even krita and propriatary programs can only benefit it's adoption.

Special usecases

1. SU1. The user wants to animate a boy playing with a ball. The boy moves the bally around himself, that is belly -> right side -> back -> left side -> belly again. It means that the position of the ball in the layer stack should change with time.
2. SU2. The user should be able to edit transform mask for a layer, then bake it for this only frame and paint/edit the baked projection to fix transformation artifacts.
3. SU3. Two animated are shaking hands to each other. Illustration. It means that the contents of two layers should interleave.
4. SU4. Reference sequence of images should be loaded into Krita and an animator will paint his character over it

< troy_s> Simple example:
< troy_s> 1) Layer of person jumping for reference for rotoscoping. 
< troy_s> 2) Reference of object falling and hitting ground. 3) Work layer for tracing.
< troy_s> (2) would likely require alignment / offsetting / transform to make it line up correctly with (1)

Definition of a keyframe for different types of layers

All layer types

1. Opacity change

   Blending rule: interpolates new opacity value

2. Composite Op change

   Blending rule: default

3. Offset change (motion - with pan and/or transform tool?)

   Blending rule: interpolates new position

4. [NOT_NEEDED] Ordering change (SU1) --Not really needed, easier to use two layers-- When ordering change keyframe appears the layers starts painting below previous or above next layer. (?) FIXME: can be done somehow easier?

   Blending rule: some weird opacity interpolation

5. Visibility change NOTE: The main purpose is to solve absence of opacity oftion for masks. It might happen that it is easier to implement opacity option for masks.

   Blending rule: (?) FIXME: can it have it?

Paint Layer

1. Switches content of all embedded paint devices

   Blending rule: default

2. Switches its default pixel value

   Blending rule: default

3. Bake masks and start painting (SU2)

   Blending rule: default

Vector Layer

1. Switches content o the vector layer

Blending rule: default

Transformation Mask

1. Switches number and position of control points for all transformation types.

   Blending :

   • position change: interpolate position of the control points

   • number change: (?) FIXME: how?

File layer

1. Switches files it links to according to current frame id

   Blending rule: default

Other types of layers and masks

All other types of layers are static, therefore do not change, except of changes described in paragraph ‘All layer types’.

Edit the layer between keyframes

1. By default one cannot edit the layer in any position outside a keyframe, except the next rule.
2. In ‘Auto keyframe mode’ a corresponding keyframe is created automatically when the user tries to change some aspect of layer while not being on any existing keyframe.

Onion skins

1. Onion skins a special ghost images that are painted below (previous frame) and above (next frame) current layer to let the user compare the current frame to its neighbours easily.
2. Onion skins can be applied to:
   • a separate layer
   • entire image (?) FIXME: do we need it?
3. Onion skins can show:
   • next/previous keyframe
   • next/previous frame (?) FIXME: do we need it?
4. The user chould be able to configure in preferences:
   • opacity of onion skins
   • different color overlay for previous and next frame/keyframe

Requirements for Timeline GUI

1. The user should be able to select Project frame rate. Key frames should be linked to time value, not frame id, that is when changing frame rate value, the speed of the playback should not change.

   Note: internally, keyframes can be attributed to the frame ids, but be recalculated on frame rate change.

2. Currently selected layer should be in sync between Layers Docker and Timeline Docker

3. Timeline Docker should contain only layers explicitly added to it (and internally converted to support animation features).

4. The color/shape/icon of keyframes should show which keyframe type it is: offset, opacity, visibility and etc.

5. Keyframes should support Drag&Drop operations for Move and Copy actions.

6. The context menu for an empty area should have the following actions

   • add new keyframe

   • extract frame into a separate layer

   • split layer into two epoches: before and after this keyframe

7. The context menu for a keyframe should provide the following capabilities:

   • delete keyframe

   • duplicate keyframe (FIXME: needed?)

   • extract frame into a separate layer

   • split layer into two epoches: before and after this keyframe

8. The user should be able to activate/configure onion skins for a chosen layer easily.

9. If blending rule for a key frame is not default, then it should be painted on a timeline. Either with the exact blending curve, or with a simple solid color.

10. The user should be able to select a range on timeline and apply the following actions to it:

    • repeat

    • delete keyframes in the range

    • Drag&Drop the seleciton to move or copy

    • play selection only

Requirements for Layers Docker

1. Context menu of a layer supporting animation should provide ‘Add to Timeline’ action, which activates animation features of the layer.