reanimate/playground

Reanimate

概述

Reanimate是一个用于编程生成动画的Haskell库，特别侧重于数学和2D矢量图形。灵感主要来自3b1b的manim库，旨在通过整合多种技术（SVG作为通用图像格式、LaTeX用于排版、ffmpeg用于视频编码、inkscape/imagemagick用于光栅化、potrace用于矢量化、blender/povray用于3D图形等），提供"开箱即用"的动画生成解决方案，使用Haskell进行脚本编写。

核心功能与特性

擅长领域

• 矢量图形与数学：支持复杂数学图形的动画展示，如切线/法线、傅里叶变换等。
• 映射与追踪：支持GeoJSON地图投影、图像追踪（PNG转SVG）等功能。
• 数学排版与效果：通过LaTeX实现高质量数学公式排版，并支持多种动画效果。
• 2D物理与3D图形：集成2D物理引擎和3D图形工具（如povray、blender），实现物理模拟和3D动画。

主要特性

• ✅ 跨平台：官方支持Linux、MacOS和Windows。
• ✅ 文档完善：API参考文档包含GIF示例，详细教程和解释文章托管于readthedocs.io。
• ✅ 高级排版：通过LaTeX实现数学公式和文本的高质量排版。
• ✅ 语音控制：支持将动画timing与脚本对齐。
• ✅ 3D图形：内置对povray和blender的集成支持。
• ✅ 映射功能：内置对GeoJSON和地图投影的支持。
• ✅ 在线playground：提供在线环境用于测试Reanimate脚本。

使用场景

• 数学概念可视化（如函数图像、几何证明、傅里叶变换等）
• 教育动画制作（用于教学视频、在线课程等）
• 技术演示（展示算法原理、数据结构等）
• 2D/3D图形动画（结合物理模拟、3D渲染等）

前提条件

Reanimate基于Haskell Tool Stack构建，安装说明见：[***]

可选安装以下程序以启用额外功能：

• ffmpeg：支持将动画渲染为视频文件。
• latex：支持数学排版。
• inkscape/imagemagick：支持SVG与PNG之间的转换。
• potrace：支持PNG转SVG追踪。
• povray：支持光线追踪。
• blender：支持3D图形。

建议至少安装ffmpeg和latex以获得基本功能。

使用方法

快速开始 / 运行示例

Reanimate提供stack模板用于快速开始，包含最小示例和自动代码重载。运行以下命令将在'animate'文件夹中创建单行动画，并在浏览器窗口中显示，编辑源代码后动画会实时更新：

console
$ stack new animate github:reanimate/plain
$ cd animate/
$ # 可使用'cabal repl'或'stack repl'：
$ cabal repl
:cmd reanimateLive

从仓库运行示例

Reanimate包含大量示例，用于回归测试和API文档中的GIF展示。可通过克隆仓库并将示例作为可执行文件运行：

console
$ git clone https://github.com/reanimate/reanimate.git
$ cd reanimate/
$ stack build
$ stack ./examples/doc_drawCircle.hs

这将在新浏览器窗口中渲染doc_drawCircle示例。若需自动代码重载，需从GHCi会话中运行:cmd reanimateLive。

使用Cabal运行仓库示例

也可使用cabal代替stack：

console
$ git clone https://github.com/reanimate/reanimate.git
$ cd reanimate/
$ cabal v2-build
$ # 解决cabal bug的临时方法：https://github.com/haskell/cabal/issues/6235
$ export reanimate_datadir=`pwd`
$ cabal v2-exec -- runhaskell examples/doc_drawCircle.hs

使用Nix

若使用nix构建包含所有系统依赖的环境：

console
$ git clone https://github.com/reanimate/reanimate.git
$ cd reanimate/
$ nix-shell
[nix-shell:./reanimate]$ cabal v2-build --write-ghc-environment-files=always

若安装了cachix，可先运行cachix use cdodev加速构建。构建后会生成类似.ghc.environment.x86_64-linux-8.8.3的文件，使runhaskell能识别Reanimate。在nix-shell中运行：

console
[nix-shell:./reanimate]$ reanimate_datadir=. runhaskell examples/doc_drawCircle.hs

文档

• API参考：[***]
• 核心概念：[***]
• 设计概述：[***]
• N-Queens教程（较旧，使用2019年10月版本的Reanimate）：[***]
• 可在频道提问：<[]>

路线图

• 支持latex/xelatex/luatex的易用字体选择
• 多边形变形框架，支持多种算法（线性插值、尽可能刚性插值、无交叠插值）
• 内置演示文稿创建工具

作者

• David Himmelstrup
• Jan Hrcek

许可证

本软件是免费且不受限制的，发布到公共领域。任何人都可以复制、修改、发布、使用、编译、销售或分发本软件，无论是源代码形式还是编译后的二进制形式，用于任何目的（商业或非商业），通过任何方式。

致谢

• 特别感谢3b1b的https://github.com/3b1b/manim%EF%BC%8C%E4%B8%BA%E6%9C%AC%E5%BA%93%E6%8F%90%E4%BE%9B%E4%BA%86%E7%81%B5%E6%84%9F%E3%80%82
• 感谢https://github.com/Twinside/svg-tree%E6%8F%90%E4%BE%9B%E7%9A%84SVG%E5%BA%93%E3%80%82
• 感谢https://github.com/CthulhuDen/chiphunk%E6%8F%90%E4%BE%9B%E7%9A%842D%E7%89%A9%E7%90%86%E5%BA%93%E3%80%82
• 感谢https://github.com/missinglink%E5%9C%A8GitHub%E4%B8%8A%E9%A2%84%E7%95%99%E4%BA%86'reanimate'%E7%BB%84%E7%BB%87%E3%80%82

***频道

完整动画上传至Reanimated Science频道。动画片段上传至Reanimated Science Shorts频道。