CTAN
Comprehensive TeX Archive Network

Direc­tory macros/latex/contrib/animate

README.md

The animate Pack­age

© 2007–\today Alexan­der Grahn

https://github.com/agrahn/an­i­mate

De­scrip­tion

This pack­age pro­vides an in­ter­face to cre­ate portable, JavaScript driven PDF an­i­ma­tions from sets of (vec­tor) graph­ics or ras­ter­ized im­age files or from in­line (vec­tor) graph­ics, such as -pic­ture, PSTricks or pgf/TikZ gen­er­ated pic­tures, or just from type­set text.

It sup­ports the usual PDF mak­ing work­flows, i. e. pdf, ⇒ dvips ⇒ ps2pdf (Ghostscript)/Dis­tiller and (Xe) ⇒ (x)dvipdfmx, Lua.

The re­sult­ing PDF with an­i­ma­tions can be viewed in Acro­bat Reader (ex­cept on mo­bile de­vices), in PDF-XChange and in Foxit Reader.

Note, this file only gives a sum­mary of us­age and avail­able pack­age and com­mand op­tions. Please re­fer to the doc­u­men­ta­tion animate.pdf for de­tails and ex­am­ples.

Key­words: in­clude portable PDF an­i­mated PDF an­i­ma­tion an­i­mat­ing em­bed an­i­mated graph­ics pdf PSTricks pgf TikZ -pic­ture in­line graph­ics vec­tor graph­ics an­i­mated GIF dvips ps2pdf dvipdfmx XeLaTeX JavaScript Acro­bat Reader PDF-XChange Foxit Reader

Usage

\usepackage[<package options>]{animate}

  • Pack­age op­tions:
width=<h-size>, height=<v-size>, totalheight=<v-size>,
keepaspectratio, scale=<factor>, nomouse,
autopause, autoplay, autoresume, controls[=all | none | ...],
final, draft,
buttonsize=<size>,
buttonbg=<colour>, buttonfg=<colour>, buttonalpha=<opacity>,
loop, palindrome, step,
poster[=first | <num> | last | none],
method=icon | widget | ocg, dvipdfmx, xetex,
type=[<file ext>]

  • User in­ter­face:
\animategraphics[<options>]{<frame rate>}{<file basename>}{<first>}{<last>}

\begin{animateinline}[<options>]{<frame rate>}
    ... typeset material ...
\newframe[<frame rate>]
    ... typeset material ...
\newframe*[<frame rate>]
    ... typeset material ...
\newframe
\multiframe{<number of frames>}{[<variables>]}{
    ... repeated (parameterized) material ...
}
\end{animateinline}

  • Com­mand op­tions:
width=<h-size>, height=<v-size>, totalheight=<v-size>,
keepaspectratio, scale=<factor>, nomouse,
autopause, autoplay, autoresume, final, draft,
controls[=all | none | ...],
buttonsize=<size>,
buttonbg=<colour>, buttonfg=<colour>, buttonalpha=<opacity>,
loop, palindrome, step, measure,
poster[=first | <num> | last | none],
begin={<begin text>}, end={<end text>},
timeline=<timeline file>,
method=icon | widget | ocg,
every=<number>, bb=<llx> <lly> <urx> <ury>,
viewport=<llx> <lly> <urx> <ury>,
trim=<left> <bottom> <right> <top>,
label=<label text>, type=[<file ext>]

Re­quire­ments

  • pdf, ver­sion >= 1.20
  • Ghostscript, ver­sion >= 9.15 or Adobe Dis­tiller
  • dvipdfmx, ver­sion >= 20080607
  • Acro­bat Reader (ver­sion >= 7), PDF-XChange, Foxit Reader

In­stal­la­tion

Unzip the file animate.tds.zip into the lo­cal TDS root di­rec­tory which can be found by run­ning

kpsewhich -var-value TEXMFLOCAL

on the com­mand line.

After in­stal­la­tion, up­date the file­name database by run­ning texhash on the com­mand line.

Live and MiK users should run the pack­age man­ager for in­stal­la­tion.

Li­cense

This ma­te­rial is sub­ject to the Project Public Li­cense.

Down­load the con­tents of this pack­age in one zip archive (3.1M).

an­i­mate – Create PDF an­i­ma­tions from graph­ics files and in­line graph­ics

The pack­age pro­vides an in­ter­face to cre­ate portable, JavaScript driven PDF an­i­ma­tions from sets of graph­ics files or from in­line graph­ics, such as pic­ture en­vi­ron­ment, PSTricks or pgf/TikZ gen­er­ated pic­tures, or just from type­set text.

Pack­agean­i­mate
Re­pos­i­toryhttps://github.com/agrahn/an­i­mate
Ver­sion 2017-09-29
Li­cense The Project Public Li­cense
Main­tainerAlexan­der Grahn
TDS archiveanimate.tds.zip
Con­tained inTeX Live as an­i­mate
MiKTeX as an­i­mate
Topics mo­tion graph­ics
...
Guest Book Sitemap Contact Contact Author