Differential D13441 Diff 35949 reference_manual/dockers/timeline.rst

Changeset View

Standalone View

reference_manual/dockers/timeline.rst

1	.. meta::	1		.. meta::
2	:description:	2		:description:
3	Overview of the timeline docker.	3		Overview of the timeline docker.
4		4
5	.. metadata-placeholder	5		.. metadata-placeholder
6		6
7	:authors: - Wolthera van Hövell tot Westerflier <griffinvalley@gmail.com>	7		:authors: - Wolthera van Hövell tot Westerflier <griffinvalley@gmail.com>
8	- Dmitry Kazakov	8		- Dmitry Kazakov
		9		- Emmet O'Neill
9	:license: GNU free documentation license 1.3 or later.	10		:license: GNU free documentation license 1.3 or later.
10		11
11	.. index:: Animation, Timeline, Frame	12		.. index:: Animation, Timeline, Frame
12	.. _timeline_docker:	13		.. _timeline_docker:
13		14
14	===============	15		===============
15	Timeline Docker	16		Timeline Docker
16	===============	17		===============
17		18
		19		The Timeline Docker works in tandem with the :ref:`animation_docker` at the heart of :program:`Krita`'s animation tools. While the Animation Docker provides access to the fundamental controls for playing back and editing animations, the Timeline Docker contains the layered frames and specific timings that define your animation. In other words, the Timeline Docker is the digital equivalent to a traditional animator's "dope sheet".
			woltheravUnsubmitted Done See if replacing Animation Docker with :ref:`animation_docker` might be a better idea. The latter is the label set to the animation docker page and thus will link to it! woltherav: See if replacing Animation Docker with :ref:`animation_docker` might be a better idea. The…
		20
18	.. image:: /images/en/Timeline_docker.png	21		.. image:: /images/en/Timeline_docker.png
19	:align: center	22		:align: center
20		23
21	Legend:	24		Legend:
22	-------	25		-------
23		26
24	#. A -- layers in timeline -- layers can be shown or hidden from the timeline by selecting the corresponding item in the right-click menu	27		A. Layer List -- This area contains some subset of the layers of your current document. The currently active layer is always shown and can be "pinned" to the timeline using the :guilabel:`Show in Timeline` menu action. Also, Layers that are created via the Timeline or added using the :guilabel:`Add Existing Layer` submenu are automatically pinned to the timeline. Each layer has properties that can also be toggled here (visible, locked, show onion skins, etc.).
			woltheravUnsubmitted Done Layers Header, doesn't a header imply something horizontal at the top? Maybe Layer List is better? woltherav: Layers Header, doesn't a header imply something horizontal at the top? Maybe Layer List is…
25	#. B -- The Frame Table
26		28
27	Active Layer	29		* Active Layer
28	A highlighted row in the table. One can change active layer by clicking on the layer's name at the left header. It is not possible to change a layer by clicking inside the table for not disturbing user when scrubbing on the timeline	30		A highlighted row in the table show the currently active layer. One can change which layer is active by clicking on the layer's name within the left header. It is not possible to change active layer by clicking inside the table in order to not disturb the user when scrubbing and editing frame positions on the timeline.
29	Current Selection
30	Just a selection. Can be created by mouse or keyboard. One can right-click on it to get a context menu to add/remove frames at that position. WARNING: active frame should not necessarily be a part of the selection; painting happens in the active frame, not in the selection
31	#. C -- Current Time -- a highlighted column in the table. Shows current image time.
32
33	Active frame
34	A frame of the active layer at the current time position. Active frame is always marked with a small circle inside. All editing operations happen with this frame only! WARNING: don't mix it with current selection!
35
36	#. D -- Cached Frames -- the gray rectangles at the top header show if the corresponding image frame is cached or not. Cache is used for 1, playback; 2, scrubbing.
37	#. E - The frame count header
38
39	Framerate
40	The ruler at the top is divided into small sections, multiples of the framerate. Multiples of the framerate has double-line mark, and smaller counts have small single-line marks
41	#. G -- The Frame Resizer. -- This allows you to resize frames in their width.
42	#. F -- The Menu. -- You can set 'show in timeline' here for the active layer.
43		31
44	The timeline docker is not immediately obvious, because when you start drawing, this doesn't automatically create a key frame out of your drawing.	32		B. Frame Table -- The Frame Table is a large grid of cells which can either hold a single frame or be empty. Each row of the Frame Table represents an animation layer and each column represents a frame timing. Just like the Layer List, the active layer is highlighted across the entire Frame Table. It's important to understand that frame timings are not based on units of time like seconds, but are based on frames which can then be played back at any speed, depending on the :ref:`animation_docker`'s frame rate and play speed settings.
45	In fact, until you make a key frame on a layer, Krita assumes that there's no animation going on at all on the layer and it'll keep the layer static over the whole animation.
46		33
47	So, to make our first animated layer, we need to make a key frame!	34		Frames can be moved around the timeline by simply left-clicking and dragging from one frame to another slot, even across layers. Furthermore, holding :kbd:`ctrl` while moving creates a copy. Right-clicking anywhere in the Frame Table will bring up a helpful context menu for adding, removing, copying, and pasting frames or adjusting timing with holds.
			woltheravUnsubmitted Done This should be tabbed to avoid interupting the list. We can actually replace each time it does '#. A' with 'A.' to turn it into a lettered-ordered list, but that might be a bit finicky to do if you haven't got Sphinx running. woltherav: This should be tabbed to avoid interupting the list. We can actually replace each time it does…
48	\|mouseright\| the square on the timeline docker to add a :guilabel:`new frame` .
49		35
50	To keep a layer visible in the timeline docker regardless of which layer is selected, select the layer in the layerdocker so it shows up in the docker, the \|mouseright\| it on the docker-layer list and select :guilabel:`show in timeline` . This way you can choose which layers are important and which are only minor.	36		* Current Selection:
		37		Frames highlighted in orange represent a selection or multiple selections, which can be created by mouse or keyboard. While multiple frames are selected, right-clicking anywhere in the Frame Table will bring up a context menu that will allow for adding or removing frames or holds within the currently selection. Finally, it is also possible to have multiple non-contiguous/separate selections if needed.
51		38
52	You can :kbd:`drag and drop` the frame around to a different empty frame entry.	39		WARNING: Painting always happens only in the active frame (represented by a small dot), which is not necessarily part of your current selection.
53		40
54	To add a new frame, either right click an empty frame entry to either add a new frame, or to copy the visible frame into a new frame.	41		* Keys, Blanks, and Holds:
		42		The Timeline Docker now shows us even more useful information about both what is there as well as what is not. Key frames which contain drawings are still displayed as filled blocks within a cell, while blank or empty key frames are shown as a hollow outline. In Krita, every drawn frame is automatically held until the next frame; these holds are now clearly shown with a colored line across all held frames. The color of frames can be set per-frame by the animator using the right-click menu, and is a matter of personal workflow.
55		43
56	In 3.0.2 you can also add color markers to frames so that you can find important frames back easily. The current color selection is remembered for new frames so that you can easily make a set of colored frames and then switch to another color.	44		C. Frame Timing Header -- The Frame Timing Header is a ruler at the top of the Frame Table. This header is divided into small notched sections which are based on the current frame rate (set in the :ref:`animation_docker`). Integer multiples of the frame rate have a subtle double-line mark, while smaller subdivisions have small single-line marks. Each major notch is marked with a helpful frame number.
57		45
58	GUI actions	46		* Cached Frames:
59	-----------	47		The Frame Timing Header also shows important information about which frames are currently cached. When something is said to be "cached", that means that it is stored in your device's working memory (RAM) for extra fast access. Cached frames are shown by the header with a small light-gray rectangle in each column. While this information isn't always critical for us artists, it's helpful to know that Krita is working behind the curtains to cache our animation frames for the smoothest possible experience when scrubbing through or playing back your animation.
60		48
61	#. Horizontal header	49		D. Current Time Scrubber -- A highlighted column in the Frame Table which controls the current frame time and, as such, what is currently displayed in the viewport.
62		50
63	* \|mouseleft\| : switch time + select frame of the active layer	51		* Active Frame:
64	* \|mouseright\| : menu (insert/remove/clear columns)	52		A frame of the active layer at the current time position. The active frame is always marked with a small circle inside. All drawing, painting, and image editing operations happen on this frame only!
65	* \|mouseleft\| +drag: switch time + select frame of the current layer (scrub)
66	* :kbd:`shift` + \|mouseleft\| : select column
67	* :kbd:`shift` + \|mouseleft\| +drag: selection multiple columns
68		53
69	#. Vertical layers in timeline	54		WARNING: Don't mix the active frame up with the current selection!
70		55
71	* \|mouseleft\| : select layer	56		E. Layer Menu -- A small menu for manipulating animation layers. You can create new layers, add or remove existing ones, and you can set 'Show in Timeline' here to pin the active layer to the Timeline. (This menu also shows up when right-clicking on layers inside of the Layer List.)
72	* \|mouseright\| : menu (add/remove layer, show/hide layer)
73		57
74	#. Frames Table: empty area.	58		F. Audio Menu: Another small menu for animating along with audio sources. This is where you can open or close audio sources and control output volume/muting.
75		59
76	* \|mouseleft\| : select single frame + switch time + don't switch layer	60		G. Zoom Handle: This allows you to zoom in and out on the Frame Table, centered around the current frame time. Click-dragging starting on the zoom handle controls the zoom level.
77	* \|mouseright\| : menu (insert/copy frame)
78	* \|mouseleft\| + drag: select multiple frames + switch time to the latest + don't switch layer
79	* :kbd:`shift` + \|mouseleft\| to select all frames between the active and the clicked frame.
80	* :kbd:`ctrl` + \|mouseleft\| to select individual frames together. :kbd:`click+drag` them into place.
81		61
82	#. Frames Table: area on existent frame.	62		Usage:
		63		------
83		64
84	* \|mouseleft\| : select single frame + switch time + don't switch layer	65		How to use the Timeline Docker is not immediately obvious because :program:`Krita` doesn't automatically create a key frame out of your initial drawing. In fact, until you make a key frame on a layer, Krita assumes that there's no animation going on at all on that layer and it will keep the image static over the whole animation.
85	* \|mouseright\| : menu (remove frame)
86	* \|mouseleft\| + drag: move a frame or multiple frames
87	* :kbd:`ctrl` + \|mouseleft\| + drag on any frame(or set of) to copy said frame(s) and drag it into a spot.
88	* :kbd:`alt` + drag on any given frame will move that frame and all the frames to the right of it. This is useful for when you need to clear up some space in your animation, but don't want to select all the frame to the right of a particular frame.
89		66
90	#. Frames Table: all	67		So, to make our first animated layer, we need to make a key frame!
91	* :kbd:`space` + \|mouseleft\| : pan	68
			woltheravUnsubmitted Done it doesn't make much sense to use kbd for drag and drop, does it? It's really intended for textual input. woltherav: it doesn't make much sense to use kbd for drag and drop, does it? It's really intended for…
92	* :kbd:`space` + \|mouseright\| : zoom	69		\|mouseright\| any square on the timeline docker and select :guilabel:`Create Blank Frame`. A blank frame (one that you haven't yet drawn anything in) appears as a hollow outline instead of a solid box, making that frame active and drawing on the canvas will make it appear as a solid, colored rectangle.
93		70
94	:program:`Krita` will only track key frames. This is unlike :program:`Flash` where you have to manually indicate how long a key frame will hold. Instead, :program:`Krita` just assumes that the space between key frame 1 and key frame 2 is supposed to be filled with key frame 1.	71		To keep a layer visible in the Timeline Docker regardless of which layer is selected, select the layer in the Layers Docker so it shows up in the docker, then \|mouseright\| it within the Timeline Docker's Layer List and select :guilabel:`Show in Timeline`. This way you can choose which layers are important and which are only minor.
95		72
96	To delete frames, \|mouseright\| the frame and press :guilabel:`delete frame` . This will delete all selected frames.	73		You can drag and drop the frame around to a different empty frame slot.
97		74
98	To manually play your animation by using the mouse, a concept called scrubbing, you click-drag on the frame-count header.	75		To add a single new frame, either right-click on an empty frame slot and select :guilabel:`Create Blank Frame` to create a fresh blank frame, or select :guilabel:`Create Duplicate Frame` to create a new copy of the previous frame.
99	You can also right click this header to add and remove whole columns from the animation over all visible layers.	76
		77		You can also change the color of frames so that you can easily identify important frames or distinguish between different sections of your animation. The current color selection is remembered for new frames so that you can easily make a set of colored frames and then switch to another color.
		78
		79		It's also possible to add multiple key frames by right-clicking inside the Frame Table and selecting :guilabel:`Keyframes>Insert Multiple Keyframes`. With this option you can specify a number of frames to add with the option of built in timing for quickly creating a series of 1s, 2s, 3s, etc. These settings are saved between uses.
		80
		81		Instead of the Frame Table, right-clicking within the Frame Timing Header gives you access to a few more options which allow you to add or remove entire columns of frames or holds at a time. For example, selecting :guilabel:`Keyframe Columns>Insert Keyframe Column Left` will add new frames to each layer that's currently visible in the Timeline Docker.
		82
		83		.. image:: /images/en/Timeline_insertkeys.png
		84		:align: center
100		85
101	The is a small area between the header and the frames where you can see whether a frame has been cached. This is important for playback.	86		:program:`Krita` only tracks key frame changes. This is unlike :program:`Flash` where you have to manually indicate how long a key frame will hold. Instead, :program:`Krita` just assumes that the space between key frame 1 and key frame 2 is supposed to be filled with key frame 1. Frames that are held in this way (a.k.a. "holds") are displayed as a continuous line in the Frame Table.
		87
		88		To delete frames, \|mouseright\| the frame and press :guilabel:`Remove Keyframes`. This will delete all selected frames. Similarly, selecting :guilabel:`Remove Frames and Pull` will delete the selected frames and pull or shift all subsequent frames back/left as much as possible.
			woltheravUnsubmitted Done Underlines should always be at the least as big as the text they're underlining. Sphinx will give errors if this is not the case. woltherav: Underlines should always be at the least as big as the text they're underlining. Sphinx will…
		89
		90		To manually play your animation back and forward using your mouse, a concept called scrubbing, you click-drag within the Frame Timing Header.
		91
		92		GUI Actions:
		93		------------
		94
		95		#. Layer List
		96
		97		* \|mouseleft\| : Select active layer.
		98		* \|mouseright\| : Layers Menu (add/remove/show layers, etc.).
		99
		100		#. Frame Timing Header
		101
		102		* \|mouseleft\| : Move to time and select frame of the active layer.
		103		* \|mouseleft\| :kbd:`drag` : Scrub through time and select frame of the active layer.
		104		* \|mouseright\| : Frame Columns Menu (insert/remove/copy/paste columns and hold columns).
		105
		106		#. Frames Table: all
		107		* \|mouseleft\| : Selects a single frame or slot and switches time, but does not switch active layer.
		108		* :kbd:`space` + \|mouseleft\| : Pan.
		109		* :kbd:`space` + \|mouseright\| : Zoom.
		110
		111		#. Frames Table (On Empty Slot).
		112
		113		* \|mouseright\| : Frames menu (insert/copy/paste frames and insert/remove holds).
		114		* \|mouseleft\| + :kbd:`drag` : Select multiple frames and switch time to the last selected, but does not switch active layer.
		115		* :kbd:`shift` + \|mouseleft\| : Select all frames between the active and the clicked frame.
		116		* :kbd:`ctrl` + \|mouseleft\| : Select individual frames together. :kbd:`click+drag` them into place.
		117
		118		#. Frames Table (On Existing Frame)
		119
		120		* \|mouseright\| : Frames menu (remove/copy/paste frames and insert/remove holds).
		121		* \|mouseleft\| + :kbd:`drag` : Move a frame or multiple frames.
		122		* :kbd:`ctrl` + \|mouseleft\| :kbd:`drag` : Copy a frame or multiple frames.
		123		* :kbd:`alt` + :kbd:`drag` : Move selected frame(s) and all the frames to the right of it. (This is useful for when you need to clear up some space in your animation, but don't want to select all the frame to the right of a particular frame!)