Add Index skeleton + catchup minor changes
[goodguy/cin-manual-latex.git] / parts / Windows.tex
index 0670298456f1d5ebbd79185f61cddf7f07baceb9..40b0894bd0e8a26ab8d7463db306bc03f03e295a 100644 (file)
@@ -68,6 +68,69 @@ the keyboard to navigate.  Many of the key equivalences are listed in each of th
 navigation (\nameref{cha:shortcuts}). This includes, for example, shortcuts like the \texttt{Home} and \texttt{End} keys to go to the beginning or end of the timeline.  
 Another example is in the default cut and paste mode, hold down \texttt{Shift} while pressing \texttt{Home} or \texttt{End} in order to select the region of the timeline between the insertion point and the key pressed.
 
+\subsection{Transport and Buttons Bar}%
+\label{sub:transport_buttons}
+
+This is a short description of what is contained on the \textit{Transport and Buttons Bar} as seen in
+figure~\ref{fig:insertion-points}.
+Each of the symbols has an associated tooltip as an easy reminder of its function.  The usage of
+several is described in a little more detail in other areas of this manual. 
+
+\vspace{2ex}
+\begin{tabular}{ll}
+   \hline
+       First set of 3 symbols & Move in the reverse direction on the timeline \\
+        4th symbol & Stop play \\
+       Third set of 3 symbols & Move in the forward direction on the timeline \\
+       Next 2 symbols & Set editing mode \\
+       Generate keyframes while tweaking & Explained in \ref{sec:generate_keyframe_tweaking}\\
+       Allow keyframe spanning & Explained in \ref{sec:allow_keyframes_spanning}\\
+       Lock labels from moving with edits & Toggle to lock or not lock labels from moving \\
+       Next 2 are In and Out pointers & Set or unset In and Out to define an area \\
+       To Clip & Create a clip of the designated area \\
+       Split / Cut & Split/Cut at insertion or selected area \\
+       Next 2 symbols & Usual Copy and Paste functions \\
+       Next 3 symbols & Label manipulation functions  \\
+       Next 2 symbols & Used to move to other edits  \\
+       Next 2 symbols & Fitting video to the display  \\
+       Next 2 symbols & Undo and Redo last operation  \\
+       Manual Go To & Explanation after this table  \\
+       Set Timecode & Explained in \ref{sub:align_timecodes}  \\
+       Gang Modes & Explained in \ref{sub:displaying_tracks_ganged} \\
+   \hline
+\end{tabular}
+
+The \textit{Manual Go To} menu is quite versatile as you can see in figure~\ref{fig:goto_menu}.  The
+options of \textit{=} represents goto the position indicated in the textbox; \textit{+} indicates
+to goto forward the additional number in the textbox; and \textit{-} means to go in the reverse
+direction the number in the textbox.  If you use \textit{Enter} in the textbox, the menu will stay
+up so that you can use it without having to continuously pop it up.  If you use the OK check instead, 
+the menu will be taken down.  The pulldown arrow to the right of the textbox sets the
+\textit{Time Format} for the units to be used for position changing.  This lets you change the units
+without having to modify your Preference. 
+
+\begin{figure}[htpb]
+    \centering
+    \includegraphics[width=0.4\linewidth]{goto.png}
+    \caption{Goto position menu}
+    \label{fig:goto_menu}
+\end{figure}
+
+\textit{Time Format} options are:
+
+\begin{tabular}{ll}
+   \hline
+        h:mm:ss.sss & hours minutes seconds milliseconds  \\
+        h:mm:ss:ff & hours minutes seconds frames  \\
+        timecode  \\
+        video frames  \\ 
+        audio samples  \\
+        audio samples (hex)  \\
+        ssss.sss & milliseconds.xx  \\
+        video frames (feet)  \\
+   \hline
+\end{tabular}
+
 \subsection{Zoom Panel}%
 \label{sub:zoom_panel}
 
@@ -138,8 +201,12 @@ The Track Menu contains a number of options:
 
 \begin{description}
     \item[Attach Effect] opens a dialog box of effects applicable to the type of track of audio or video.
-    \item[Move up] moves the tracks one step up in the stack with the top track going to the bottom.  This is applicable to all armed and disarmed tracks.
-    \item[Move down]  moves the tracks one step down in the stack with the
+    \item[Move up] allows for changing the order of the tracks up; the actual code refers
+to this as a swap. Disarmed tracks affect the results.
+    \item[Move down]  allow for changing the order of the tracks down; the actual code refers
+to this as a swap.  Disarmed tracks affect the results.
+    \item[Roll up] moves the tracks one step up in the stack with the top track going to the bottom.  This is applicable to all armed and disarmed tracks.
+    \item[Roll down]  moves the tracks one step down in the stack with the
 bottom track going to the top.  This is applicable to all armed and disarmed tracks.
     \item[Delete track]  removes the track from the timeline.
     \item[Add Track]  adds a track of the same media type as the one selected, audio or video, above the selected track.
@@ -152,8 +219,6 @@ bottom track going to the top.  This is applicable to all armed and disarmed tra
         media. In Drag and Drop editing mode, if you select multiple edits all of those clips will have
 their title name changed.
     \item[Bar color]  allows the user to select a specific color for the title bar.  This helps to more easily locate a piece of media.
-    \item[Swap up] allows for changing the order of the tracks up. Disarmed tracks affect the results.
-    \item[Swap down]  allow for changing the order of the tracks down.  Disarmed tracks affect the results.
     \item[Resize Track]  resizes the track; this is only applicable to video tracks.
     \item[Match Output Size]  resizes the track to match the current output size; this is only applicable to video tracks.
 \end{description}
@@ -619,7 +684,9 @@ in the window, scrollbars are automatically added as needed on the bottom, the r
 side, or both.
 Other options include \emph{Reset camera} and \emph{Reset projector} which obviously are used
 to reset the camera and the projector (reference~\ref{sub:camera_and_projector}).  And
-\emph{Camera/Projector keyframe} will create a keyframe at that point on the timeline.
+\emph{Camera/Projector keyframe} will create a keyframe at that point on the timeline for
+X,Y, and Z without the requirement of being in \textit{Automatic Keyframe Mode}.  More 
+information is described in the section \nameref{sec:compositor_keyframes}.
 The \emph{Hide controls/Show controls} option is great for hiding the left hand toolbar and
 bottom set of controls for a cleaner look. 
 
@@ -902,19 +969,16 @@ The camera and projector have shortcut operations that do not appear in the popu
 These are accessed in the \emph{Show tool info} window.
 Most operations in the Compositor window have a tool window which is enabled by activating the question mark icon (figure~\ref{fig:camera_tool}).
 
-\begin{wrapfigure}[10]{O}{0.45\linewidth} 
-       %\vspace{1ex}
-    \includegraphics[width=1.0\linewidth]{camera_tool.png}
-    \caption{Camera and Projector tool}
-    \label{fig:camera_tool}
-\end{wrapfigure}
+\begin{figure}[htpb]
+       \centering
+       \includegraphics[width=0.8\linewidth]{camera_tool.png}
+       \caption{Camera and Projector tool}
+       \label{fig:camera_tool}
+\end{figure}
+
+In the \textit{Position} section you can act on the $X$, $Y$ and $Z$ coordinates. By either tumbling or entering text directly or by using the slider, the camera and projector can be precisely positioned. There is also a reference to the color of the curve as we see it on the timeline. You can also define the \textit{range} of action which by default is [-100 to 100]. By pressing the Reset button for each coordinate, or the global Reset button, the range is automatically brought to the project size value (HD; 4k; etc), which are usually the most useful limits. Note that the range can also be changed in the \textit{Program} window, in the \textit{zoom bar}, where there are similar input fields to enter the chosen limits.
 
-In the case of the camera and projector, the tool window shows $x$, $y$, and $z$ coordinates. 
-By either tumbling or entering text directly, the camera and projector can be precisely positioned.  
-Justification types are also defined for easy access. 
-A popular justification operation is upper left projection after image reduction. 
-This is used when reducing the size of video with aspect ratio adjustment.  
-In the last figure you see the choices for justification as the location of the line in the 6 boxes in the order of left, center horizontal, right, top, center vertical, and bottom.
+In the \textit{Justify} section we can use automatic positioning in the 6 standard coordinates: Left, Horizontal, Right, Top, Center and Bottom.
 
 The translation effect allows simultaneous aspect ratio conversion and reduction but is easier to use if the reduced video is put in the upper left of the \textit{temporary} instead of in the center. 
 The track size is set to the original size of the video and the camera is centered. 
@@ -922,23 +986,21 @@ The output size is set to the reduced size of the video.
 Without any effects, this produces just the cropped center portion of the video in the output.
 
 The translation effect is dropped onto the video track. The input dimensions of the translation effect are set to the original size and the output dimensions are set to the reduced size. 
-To put the reduced video in the center subsection that the projector shows would require offsetting out $x$ and out $y$ by a complicated calculation. 
-Instead, we leave out $x$ and out $y$ at 0 and use the projector's tool window. 
+To put the reduced video in the center subsection that the projector shows would require offsetting out $X$ and out $Y$ by a complicated calculation. 
+Instead, we leave out $X$ and out $Y$ at 0 and use the projector's tool window. 
 By selecting left justify and top justify, the projector displays the reduced image from the top left corner of the \textit{temporary} in the center of the output.
 
-\paragraph{Note:} To change the limits of the slider X, Y and Z, which by default are $-100 / +100$, we must intervene on the zoom bar at the bottom of the Program window. Select Zoom for Z; or X and Y and enter the desired values. Now the Camera/Projector tool will assume the new limits.
-
-Other buttons cover the 5 modes of curves interpolation: smooth, linear, tangent, free, bump.
+In the \textit{Curve type} section we can choose between various interpolation algorithms that determine the curve type:
 
 \begin{description}
        \item[smooth:] bezier interpolation which are flat at the endpts
        \item[linear:] piecewise linear curve.
        \item[tangent:] bezier interpolation with collinear endpts in a specified line.
-       \item[disjoint:] piecewise bezier, if there is such a thing.
+       \item[free:] piecewise bezier, if there is such a thing.
        \item[bump:] has 2 values, one viewed from the left/right, discontinuous.
 \end{description}
 
-Finally there are the 2 buttons for the bump curves: settings on Right/Left Edges and Span (see \nameref{sec:bump_autos}).
+In the \textit{Keyframe} section we can create new keyframes and set them as Bump autos (\textit{Right/Left edges} and \textit{Span} buttons). For further details see \nameref{sec:bump_autos}.
 
 \subsubsection*{Reset to Default}%
 \label{ssub:reset_default}
@@ -1098,12 +1160,13 @@ The next 6 symbols in 2 columns represent \textit{Smooth} and \textit{Linear} bu
 
 \textit{smooth curve}  $\rightarrow$ smooth all points on a mask edge curve.
 
-\textit{smooth all}    $\rightarrow$ smooth all active masks.
+\textit{smooth all}    $\rightarrow$ smooth all enabled masks on this track.
 
 Linear buttons of \textit{linear point}, \textit{linear curve}, and \textit{linear all}, perform the inverse of the smooth functions.
 The control point vectors on the bezier endpoints are set to zero magnitude.
 
-In addition there is a \textit{Markers} and a \textit{Boundary} checkbox which come in handy to turn off the display of the points and the outline of the mask.  Turning off \textit{Markers} is very useful when you have a lot of control points that clutter the display and make it more difficult to see the actual mask.  A helpful feature is available by disabling \textit{Markers} and enabling \textit{Boundary} which results in all masks being displayed in the viewer; for example you can then see mask 0, mask 1 \dots at the same time.
+In addition there is a \textit{Markers} and a \textit{Boundary} checkbox which come in handy to turn off the display of the points and the outline of the mask.  Turning off \textit{Markers} is very useful when you have a lot of control points that clutter the display and make it more difficult to see the actual mask.  A helpful feature is available by disabling \textit{Markers} and enabling \textit{Boundary} which results in all masks being displayed in the viewer
+even if they are not enabled; for example you can then see mask 0, mask 1 \dots at the same time.
 
 A \textit{gang} symbol on the right hand side of this section, tooltip of \textit{Gang points}, is another useful feature that makes it easy to drag a mask to an exact coordinate using the \textit{X} or \textit{Y} textbox for numerical input or the associated tumblers.  This works like the \texttt{Alt+LMB drag} translate but provides the ability to be precise.
 
@@ -1341,8 +1404,7 @@ The Viewer and Compositor each have a timebar control area with a red indicator
 line below the video output. The timebar shows the whole time covered by the
 resource. When a video resource is loaded in the main window and you move in the
 compositor, the insertion pointer in the main window will reflect those movements.
-But in the viewer only that specific media
-is shown and there is no corresponding movement on the timeline.
+But in the viewer only that specific media is shown and there is no corresponding movement on the timeline.
 
 \begin{figure}[htpb]
        \centering
@@ -1359,8 +1421,7 @@ in/out pointer in the compositor, the insertion point in the program window will
 go to that position.
 
 The timebar in the compositor and the viewer covers the whole length of the resource
-loaded in there. Moving the mouse with the LMB pressed moves the position in the
-resources as indicated by the indicator line. A complete mouse movement between left and right edges of the window moves the indicator line by default along the whole timebar. With long resources it can be difficult to precisely locate sections in the resource. To make this easier, you can limit the effect of the same window-wide mouse movement to a smaller area of the timebar, this area is defined as the preview region. This region can also be moved along the timebar.
+loaded in there. Moving the mouse with the LMB pressed moves the position in the resources as indicated by the indicator line. A complete mouse movement between left and right edges of the window moves the indicator line by default along the whole timebar. With long resources it can be difficult to precisely locate sections in the resource. To make this easier, you can limit the effect of the same window-wide mouse movement to a smaller area of the timebar, this area is defined as the preview region. This region can also be moved along the timebar.
 
 For instance, if you need to get a few 10 second clips from an 60 minute video, you could define a one-minute preview region, move it approximately to a place where a clip needs to be taken, and easily select with the mouse in and out points within the region, because the whole window mouse movement now covers 1 minute instead of 60 minutes.