summaryrefslogtreecommitdiff
path: root/macros/latex/contrib/animate/animate.tex
diff options
context:
space:
mode:
authorNorbert Preining <norbert@preining.info>2020-08-30 03:01:16 +0000
committerNorbert Preining <norbert@preining.info>2020-08-30 03:01:16 +0000
commitc6a1b1f6422e10f363a9de80c4f103f0c155d8bb (patch)
tree1389e67a96950e5a44d635efc31a6bb4f7528511 /macros/latex/contrib/animate/animate.tex
parent84ead792ae29b5dcefb36517d42178c278b8cb9b (diff)
CTAN sync 202008300301
Diffstat (limited to 'macros/latex/contrib/animate/animate.tex')
-rw-r--r--macros/latex/contrib/animate/animate.tex7
1 files changed, 7 insertions, 0 deletions
diff --git a/macros/latex/contrib/animate/animate.tex b/macros/latex/contrib/animate/animate.tex
index 14316a68dd..1cabe9c9fe 100644
--- a/macros/latex/contrib/animate/animate.tex
+++ b/macros/latex/contrib/animate/animate.tex
@@ -235,6 +235,11 @@ and the environment
\newframe
\multiframe{<number of frames>}{[<variables>]}{
... repeated (parameterized) material ...
+ \multiframebreak % optional!
+}
+\newframe*[...] % some \newframe variant required
+\multiframe{...}{...}{ % between two \multiframes
+ ...
}
\end{animateinline}
\end{verbatim}
@@ -249,6 +254,8 @@ The \verb+\multiframe+ command allows the construction of loops around pictures.
\end{verbatim}
\verb+<variable name>+ is a sequence of one or more letters \emph{without} a leading backslash\footnote{This is different from {\tt\string\multido} (package `multido') where variable names have a leading `{\tt\textbackslash}' in the declaration.}. The first (and possibly only) letter of the variable name determines the type of the variable. There are three different types: integers (`\verb+i+', `\verb+I+'), reals (`\verb+n+', `\verb+N+', `\verb+r+', `\verb+R+') and dimensions or \LaTeX{} lengths (`\verb+d+', `\verb+D+'). Upon first execution of the loop body, the variable takes the value \verb+<initial value>+. Each further iteration increments the variable by \verb+<increment>+. Negative increments must be preceded by `\verb+-+'. Here are some examples: `\verb:i=1+2:', `\verb:Rx=10.0+-2.25:', `\verb:dim=20pt+1ex:'. Within the loop body, variables are expanded to their current value by prepending a backslash to the variable name, that is \verb+\i+, \verb+\Rx+ and \verb+\dim+ according to the previous examples. \verb+\multiframe+ must be surrounded by \verb+\begin{animateinline}+ and \verb+\end{animateinline}+ or by any of the \verb+\newframe+ variants. Two consecutive \verb+\multiframe+ commands must be separated by one of the \verb+\newframe+ variants.
+\verb+\multiframebreak+ can be called to terminate a \verb+\multiframe+ loop prematurely, usually as part of a conditional statement. This command should preferably be placed near the end of the loop body in order not to produce an empty animation frame.
+
By default, the animation is built frame by frame in the order of inclusion of the embedded material. However, extended control of the order of appearance, superposition and repetition of the material is available through the `\verb+timeline+' option (see Section~\ref{sect:timeline}).
\myparagraph*{Sets of graphics files}