Commit graph reanimate/docs
Author SHA1 Message Date
Paul Gardiner
ed1c0ba6c1
Hierarchical sprites and objects (#269)
* Separate sprite creation from adding to scene

This is work towards supporting hierarchical sprites and objects:
the Sprite data definition is updated to include it's generator and
a new function newSpritePart is added to create a sprite without
adding the generator to the scene, making it invisible. Later commits
will provide a way for sprites created by newSpritePart to be used
in the definitions of other sprites.

* Support use of one sprite within another

This is work towards supporting hierarchical sprites and objects.
A new function, renderSprite, is defined that exposes its generator
in the form of a Frame context that can be used in the definitions
of other sprites.

Some internal types have had to be changed to support renderSprite. The
frame context created by renderSprite runs the sprite's generator, and must
supply the scene duration to it, and so the frame type has had to be updated
also to be dependent on the scene duration. In turn, a sprite's effects
mapping needs to be able to interpret a frame context in the implementation
of spriteModify, and so the effects mapping has also had to be made
dependent on the scene duration.

* Support use of objects within hierarchical sprites

Allow use of objects as leaves within a hierarchically
defined sprite. Two new functions are added:

  The function newObjectPart creates an object, not immediately
  added to the scene, so invisible even after calls to oShow, and
  mainfesting only if used within the definition of a sprite.

  The function renderObject exposes the generator of the object's
  internal sprite in the form of a frame context that can be used
  in the definitions of other sprites.

* Add example script showing use of newObjectPart and renderObject

This is a slightly contrived example, chosen to show an animation that
is difficult to contruct other than hiearchically. Two strings are placed
one over the other. They are shown using oDraw which requires their being
Objects. The overlapping strings are faded out, which requires
opacity to be applied at the group level: fading each individually would
lead to the lower string becoming visible through the upper one as opacity
is decreased.
2022-06-02 15:40:56 +02:00
Mike Pilgrem
f53332f93b Add documentation on obtaining dependencies on Windows
This pull request proposes an additional subsection in the documentation explaining to Windows users how they can obtain the FFmpeg, dvisvgm, POV-Ray, Blender, rsvg-convert, Inkscape, ImageMagick and LaTeX/XeLaTex dependencies.
2021-10-17 10:13:42 +08:00
David Himmelstrup
8e2b32ba7a Fix doc references. 2021-07-04 23:23:46 +08:00
David Himmelstrup
8f36b657b9 Update getting-started section of docs. 2021-03-11 16:18:54 +08:00
Nick Bathum
df8e63e9b6 Typo: text is left-aligned. 2021-03-11 14:59:16 +08:00
David Himmelstrup
e7bce27d12 Switch back to stylish-haskell and enumerate imports. 2020-10-10 18:17:01 +08:00
David Himmelstrup
96cd95f865 Add logos from svgporn.com 2020-10-10 17:25:15 +08:00
David Himmelstrup
edd776beac
Add a few more built-in font configurations. (#179) 2020-10-08 15:26:19 +08:00
David Himmelstrup
54652dd51f
SimpleIcons.org external data set. (#178)
* Add 'simpleIcons' external icon set.

* Add complete support for Simple Icons.

* Add documentation gif.
2020-10-08 15:26:02 +08:00
David Himmelstrup
5ec3ef8af4 Add chalkduster to changelog. 2020-10-07 13:48:09 +08:00
David Himmelstrup
ac5f40e5e7
Add monthly changelog entries to docs. (#176) 2020-10-05 15:35:19 +08:00
David Himmelstrup
554eda594f
How-To: Use system fonts (#175)
* Import Reanimate.External in the playground.

* Add draft for How-To article about system fonts.

* Finish system font how-to.
2020-10-05 11:43:15 +08:00
David Himmelstrup
3a1c6e4166
How-To article about the LaTeX font catalogue (#174) 2020-10-04 00:17:15 +08:00
lemmih
5cc47478a6 Use https when possible. 2020-10-01 14:40:05 +08:00
David Himmelstrup
009a9e2188
Support multiple latex configurations. (#173)
* Support multiple latex configurations.

* Don't look for pdf2svg/dvisvgm unless they are actually required.
2020-10-01 14:26:45 +08:00
David Himmelstrup
2e7e0eb3f6 Fix width of tut GIF for mobile viewers. 2020-09-24 09:37:51 +08:00
Jan Hrcek
0aca2333e2
Fix some hlint warnings, and more consistency in examples (#167)
* Remove redundant brackets

* Various hlint fixes

* Remove unused language pragrams and other fixes

* Use addStatic more consistently in examples

* Rename remaining usages of sceneAnimation to scene
2020-09-20 22:51:22 +08:00
David Himmelstrup
da9be65841 Tutorial: Refer to latest documentation. 2020-09-20 10:11:48 +08:00
David Himmelstrup
c1ea440903 Docs: Don't justify navigation. 2020-09-20 09:31:36 +08:00
David Himmelstrup
a634e4ad87
LaTeX and objects tutorial (#156) 2020-09-20 09:08:18 +08:00
David Himmelstrup
217c54ab38
cleanup (#166)
* Remove unused import.

* Add missing documentation.
2020-09-19 22:18:21 +08:00
David Himmelstrup
755fb02c6c Rewamp object effects. 2020-09-01 14:15:06 +08:00
David Himmelstrup
3f5c240757 Update doc gif. 2020-08-27 17:42:57 +08:00
David Himmelstrup
aed34fb5d9 Yet more haddock documentation. 2020-08-27 16:46:53 +08:00
David Himmelstrup
aa4656d77d Update stylish preferences. 2020-08-27 13:42:59 +08:00
David Himmelstrup
0ea12c58f9 More API docs. 2020-08-27 11:13:45 +08:00
David Himmelstrup
0e58fc66e6 Write API documentation for cameras. 2020-08-25 18:16:25 +08:00
David Himmelstrup
41d6a1d9f1 Write more API documentation. 2020-08-25 16:38:29 +08:00
David Himmelstrup
f0313ea14b Document the GeoJSON module. 2020-08-25 15:49:06 +08:00
David Himmelstrup
83e4ecd987
Polish object interface (#138) 2020-08-25 13:51:32 +08:00
David Himmelstrup
9cf33b9444 Remove link to gallery and disable link to morphology article. 2020-08-11 15:33:07 +08:00
David Himmelstrup
b6975d705d Don't build gh-pages for PRs. 2020-08-07 09:15:50 +08:00
David Himmelstrup
63a4b918b1 docs: justify text. 2020-07-29 16:12:59 +08:00
David Himmelstrup
1d7f7acdf1 Fix ctex doc gif. 2020-07-20 17:39:12 +08:00
David Himmelstrup
05b7516f30
Discord bot article (#111) 2020-07-16 22:55:34 +08:00
Mike Pilgrem
4b338de094 Prefer 'magick' command to 'convert', if available
ImageMagick version 7 provides command 'magick' (as well as legacy 'convert'), is readily available on Windows but is not, currently, readily available on Ubuntu.

On Windows, the name of ImageMagick's `convert` utility clashes with Microsoft's `C:\Windows\System32\convert.exe` utility. Using `magick`, if available, avoids the conflict.

For clarity and to be command name-agnostic, the raster option name is changed from 'convert' (the command) to 'imagemagick' (the name of the software).

For consistency with the version 7 command name, references in the code to 'convert' are changed to 'magick', throughout.
2020-07-07 09:02:17 +08:00
David Himmelstrup
d731dcb383 Update repository references. 2020-06-25 09:37:14 +08:00
David Himmelstrup
3e3212d3f6 Reduce test fidelity from 50 frames to 10 frames.
Former-commit-id: d47a8a4d3f2b650927999fe10d6eddbb8e3da8fb
2020-06-24 22:36:56 +08:00
David Himmelstrup
c8d9fa6204 Draft article about fonts (#95)
Former-commit-id: 002f55748d12811f0c8bf0d9b3df9a6674274cdd
2020-06-24 22:02:09 +08:00
David Himmelstrup
3bc6cb0ab5 Make video sizes responsive.
Former-commit-id: 88534639c2b375d648b46ad7ac8690ddad8b4721
2020-06-15 14:37:28 +08:00
David Himmelstrup
2a6e0eb4ce Removed gallery files.
Former-commit-id: 75817c3feeaa913ba4810ce3c5d27ad63ced805b
2020-06-15 14:26:16 +08:00
David Himmelstrup
fe1a2e9ee9 Move glue tutorial to imgur.
Former-commit-id: c67a532677c00d7ce65727abc2898db5448d2a96
2020-06-15 14:26:16 +08:00
David Himmelstrup
56624665ca Fix yet another typo.
Former-commit-id: f0a40b100a1e5ae7dc9532c978da9b7be57023fb
2020-06-04 20:15:46 +08:00
David Himmelstrup
de9f8eaf1a Fix typo
Former-commit-id: c36db694cf76ec80785a28a0ce8a743756f7f657
2020-06-04 19:40:02 +08:00
David Himmelstrup
6d7e2e47f0 Improve color-theory article.
Former-commit-id: 7c4fde1fd725bac2a92aa7a44e9f4e86a1202456
2020-06-04 18:46:59 +08:00
David Himmelstrup
1e924c54e9 Add showcase article about color-theory.
Former-commit-id: 6697c9842f0b85f31bfdfa9b56ad78f074488b96
2020-06-04 18:24:31 +08:00
David Himmelstrup
354d3485a7 Voice control: Fix grammar.
Former-commit-id: 3ac9c5bcf46f9a6915f17e726d22d108fb516b6f
2020-05-23 15:01:52 +08:00
David Himmelstrup
d02a63b962 Try to force plaintext formatting.
Former-commit-id: 3a5878e60d27723855be89c0ca351e45561cc4bb
2020-05-23 10:21:52 +08:00
David Himmelstrup
4e566ef95e Fix formatting for plaintext.
Former-commit-id: c8968042e8d17328518f6fc191272e7a9fd2fc24
2020-05-23 09:56:32 +08:00
David Himmelstrup
7e1c7ea511 Voice control (#75)
Add voice control via Reanimate.Voice.
Include rtfd article.

Former-commit-id: f80bb58031f6dfbb83bc8f188c17013afcb2dfd9
2020-05-22 23:30:44 +08:00