{
 "cells": [
  {
   "cell_type": "code",
   "execution_count": 1,
   "id": "71f0a675",
   "metadata": {
    "tags": [
     "remove-cell"
    ]
   },
   "outputs": [],
   "source": [
    "import diplotocus as dpl"
   ]
  },
  {
   "cell_type": "markdown",
   "id": "f88ac3fe",
   "metadata": {},
   "source": [
    "# Timeline\n",
    "\n",
    "The `Timeline` object is the main object of an animation. It renders frames, video files and loads and saves projects.\n",
    "\n",
    "```{eval-rst}\n",
    ".. autoclass:: diplotocus.Timeline\n",
    "    :noindex:\n",
    "```\n",
    "<br/><br/>\n",
    "Once created, a `Timeline` is used to render animations of plot objects via `Timeline().animate(plot_objects)`:\n",
    "```{eval-rst}\n",
    ".. automethod:: diplotocus.Timeline.animate\n",
    "    :noindex:\n",
    "```\n",
    "<br/><br/>\n",
    "To include frames without any changes, you can call `Timeline().wait(duration)`:\n",
    "```{eval-rst}\n",
    ".. automethod:: diplotocus.Timeline.wait\n",
    "    :noindex:\n",
    "```\n",
    "<br/><br/>\n",
    "To render your animation to a video file, you can call `Timeline().save_video(path=None,speed=1,ffmpeg_path='ffmpeg',multialpha=False,prerendered=False,clean=True)`:\n",
    "```{eval-rst}\n",
    ".. automethod:: diplotocus.Timeline.save_video\n",
    "    :noindex:\n",
    "```"
   ]
  }
 ],
 "metadata": {
  "kernelspec": {
   "display_name": "Python 3",
   "language": "python",
   "name": "python3"
  },
  "language_info": {
   "codemirror_mode": {
    "name": "ipython",
    "version": 3
   },
   "file_extension": ".py",
   "mimetype": "text/x-python",
   "name": "python",
   "nbconvert_exporter": "python",
   "pygments_lexer": "ipython3",
   "version": "3.13.3"
  }
 },
 "nbformat": 4,
 "nbformat_minor": 5
}