Copy local state in AudioRegionView copy constructor. Fixes #4047.
[ardour2.git] / manual / xml / editor_window_controls.xml
blob092a4ce6b75244683512d818df4e31355c16b7e1
1 <?xml version="1.0" standalone="no"?>
3 <!DOCTYPE section PUBLIC "-//OASIS//DTD DocBook XML V4.4//EN" "http://www.oasis-open.org/docbook/xml/4.4/docbookx.dtd" [
5 ]>
7 <section id="editor-window-controls">
8   <title>Editor Controls</title>
9   <para>
10     The editor controls are in a tearoff window, which you can use in the
11     usual way.
12   </para>
14   <section id="editor-edit-cursor-clock">
15     <title>Edit cursor clock</title>
16     <para>
17       This clock shows the current position of the edit cursor. You can edit
18       the position using the clock if you wish.
19     </para>
20   </section>
22   <section id="editor-zoom-buttons">
23     <title>Zoom buttons</title>
24     <para>
25       The zoom buttons allow you to see more ("zoom out") or less ("zoom
26       in") of the session timeline in the track display area. Click on the
27       zoom out button to zoom out, and the zoom in button to zoom in.
28     </para>
29   </section>
31   <section id="editor-zoom-range-clock">
32     <title>Zoom range clock</title>
33     <para>
34       The zoom range clock shows the current duration of the timeline that
35       is visible in the track display area. It does not indicate the
36       location of the visible section of the timeline, only its length. You
37       can zoom in and out by editing this clock directly, which may be
38       useful if you want to see a precise duration within the editor.
39     </para>
40   </section>
42   <section id="editor-zoom-selectors">
43     <title>Zoom selectors</title>
44     <para>
45       The two zoom select buttons allow you to go to the maximum and minimum
46       zoom levels with a single button click. The "1:1" button zooms all the
47       way into single sample level, where each pixel on the screen
48       represents a single sample. The "whole session button" zooms out to
49       show the entire session in the track display area.
50     </para>
51   </section>
53   <section id="editor-zoom-focus-control">
54     <title>Zoom focus control</title>
55     <para>
56       When zooming, there is always a change in what is displayed in the
57       track display area. However, one position in the display will continue
58       to correspond to the same point in the timeline, and there are several
59       choices of how to define that point. The default behaviour is to keep
60       the left edge of the track display area constant. If it was at a
61       position 1:12:14 into the session timeline before zooming, then it
62       will continue to be at that position after zooming. Other points in
63       the display that you can ensure are in the same position while zooming
64       include the right edge of the track display, the center of the track
65       display, the playhead and the edit cursor. Whichever of these is
66       selected is known as the current zoom focus.
67     </para>
69     <para>
70       To change the current zoom focus, click on the combo box to see the
71       list of available choices. Click on the zoom focus you wish to use.
72       The list of choices will disappear, and the new zoom focus choice will
73       be in effect.
74     </para>
75   </section>
77   <section id="editor-snap-control">
78     <title>Snap control</title>
79     <para>
80       When moving objects around in the track display area, you have the
81       choice of moving them freely or having their positions be limited to
82       certain points along the timeline. This applies to region, the
83       playhead, the edit cursor, curve control points and markers, among
84       others. If you want the positions of objects to be limited, then you
85       can choose from several different possibilities. We call this "snap
86       to" because when moving objects around with the mouse, they appear to
87       "snap to" various positions.
88     </para>
90     <para>
91       The most obvious source of "snap to" positions is the tempo map, but
92       ardour offers many different possibilities:
93     </para>
95     <table id="tbl-snap-control">
96       <title>Snap Control</title>
97       <tgroup cols = "2">
98         <colspec colnum="1" colname="Snap Option" colwidth="1"/>
99         <colspec colnum="2" colname="Action" colwidth= "2"/>
100         <thead>
101           <row>
102             <entry>
103               Snap Option
104             </entry>
106             <entry>
107               Action
108             </entry>
109           </row>
110         </thead>
111         <tbody>
112           <row>
113             <entry>
114               BBT
115             </entry>
117             <entry>
118               you can select 64th,32nd,16th,8th,quarter and whole beat
119               positions, as well as beat triplets and whole bars (measures).
120             </entry>
121           </row>
123           <row>
124             <entry>
125               Region beginnings
126             </entry>
127           </row>
129           <row>
130             <entry>
131               Region ends
132             </entry>
133           </row>
135           <row>
136             <entry>
137               Region sync points
138             </entry>
139           </row>
141           <row>
142             <entry>
143               Region boundaries
144             </entry>
146             <entry>
147               (combines regions beginnings and ends)
148             </entry>
149           </row>
151           <row>
152             <entry>
153               Marks
154             </entry>
155           </row>
157           <row>
158             <entry>
159               Edit Cursor
160             </entry>
162             <entry>
163               a single snap-to point. This is useful when aligning several
164               objects at the same point. Set the edit cursor to the desired
165               position, then select this snap setting, and then move the
166               objects, which will immediately snap to the chosen position.
167             </entry>
168           </row>
169         </tbody>
170       </tgroup>
171     </table>
172   </section>
174   <section id="editor-edit-mode-control">
175     <title>Edit mode control</title>
176     <para>
177       When moving regions around in a track, it is sometimes desirable to
178       leave spaces between regions and sometimes to force regions to always
179       be placed directly next to their neighbours. Which is more appropriate
180       depends a lot on the nature of the project and the regions themselves.
181     </para>
183     <para>
184       By default, Ardour uses slide mode which allows you to freely place
185       regions in a track (subject to the current snap setting, of course).
186       If you cut part of region, an empty space will remain where the part
187       you removed used to be. If you move a region along the timeline, it
188       will move independently of other regions, and will stay wherever you
189       place it.
190     </para>
192     <para>
193       If you are editing a session and require behaviour where regions are
194       forced to always to be directly adjacent, you can switch to splice
195       maybe. In this mode, cutting part of region will cause all later
196       regions in the track to move up (earlier) the timeline so that there
197       is no intervening space between them. Moving a region will cause other
198       regions to move around so that the moved region fits "between" them.
199     </para>
200   </section>
202   <section id="editor-window-nudge-buttons">
203     <title>Nudge buttons</title>
204     <para>
205       Sometimes when editing its nice to be able to move objects by
206       predefined amounts rather than just positioning them freely or using
207       snap-to. This kind of motion is called nudging. At the present time,
208       only the playhead, playlists and regions can be nudged. The distance
209       an object is nudged is set by the nudge clock (see below).
210     </para>
212     <para>
213       To nudge one or more regions forward by 1 second, first edit the nudge
214       clock so that it specifies that time. Then select the region(s) by
215       clicking on them, and finally click the nudge forward button.
216     </para>
218     <para>
219       Nudging backwards is identical to nudging forwards, except that you
220       should click on the nudge backwards button.
221     </para>
223     <para>
224       To nudge a playlist forward or backwards, first set the nudge clock to
225       the desired nudge distance. Then in the track that is using the
226       playlist. Choose Nudge Nudge entire track fwd or Nudge nudge entire
227       track bwd as desired.
228     </para>
230     <para>
231       You can also nudge all regions in the playlist positioned after (later
232       than) the edit cursor. To do this, follow the steps for nudging the
233       playlist, but choose Nudge nudge track after edit cursor fwd or Nudge
234       nudge track after edit cursor bwd, as appropriate.
235     </para>
236   </section>
238   <section id="editor-window-nudge-clock">
239     <title>Nudge clock</title>
240     <para>
241       You can edit the clock value to alter the distance that
242       regions/playlists will be nudged. (see <xref linkend="sn-clocks"/> for
243       instructions).
244     </para>
245   </section>
247   <section id="editor-window-tool-selector">
248     <title>Tool Selector</title>
249     <para>
250       The editor tool selector is in a tearoff window, and contains a series
251       of buttons used to select what the mouse (and often the keyboard) will
252       do when editing tracks. The tools include:
253     </para>
255     <table id="tbl-editor-window-mouse-modes">
256       <title>Snap Control</title>
257       <tgroup cols = "2">
258         <colspec colnum="1" colname="Snap Option" colwidth="1"/>
259         <colspec colnum="2" colname="Action" colwidth= "2"/>
260         <thead>
261           <row>
262             <entry>
263               Mouse Mode
264             </entry>
266             <entry>
267               Description
268             </entry>
269           </row>
270         </thead>
271         <tbody>
272           <row>
273             <entry>
274               object
275             </entry>
277             <entry>
278               <para>
279                 Left-clicking Object will place the mouse in object mode.
280                 When in object mode, the mouse pointer appears as a hand
281                 whenever it is over the track canvas or the rulers. The
282                 mouse can now be used to select and perform operations on
283                 objects such as regions, markers etc.
284               </para>
285             </entry>
286           </row>
288           <row>
289             <entry>
290               range
291             </entry>
293             <entry>
294               <para>
295                 Left-clicking Range will place the mouse in range mode. When
296                 in range mode, the mouse pointer appears as a vertical line
297                 whenever it is over the track canvas or the rulers. The
298                 mouse will now be able to select a point or range of time.
299                 Time ranges can be selected over one or several tracks.
300               </para>
301             </entry>
302           </row>
304           <row>
305             <entry>
306               gain
307             </entry>
308           </row>
310           <row>
311             <entry>
312               zoom
313             </entry>
315             <entry>
316               <para>
317                 Left-clicking Zoom will place the mouse in zoom mode. When
318                 in zoom mode, the mouse pointer appears as a magnifying
319                 glass whenever it is over the track canvas or the rulers.
320                 This mode is used to zoom the display to any range that is
321                 subsequently set using the mouse.
322               </para>
323             </entry>
324           </row>
326           <row>
327             <entry>
328               timefx
329             </entry>
331             <entry>
332               <para>
333                 Left-clicking Timefx will place the mouse in timefx mode.
334                 When in timefx mode, the mouse pointer appears as a
335                 distinctive 'expanding' illustration whenever it is over the
336                 track canvas or the rulers. This mode is used to resize
337                 regions using a timestretch algorithm.
338               </para>
339             </entry>
340           </row>
341         </tbody>
342       </tgroup>
343     </table>
344   </section>
345 </section>