Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Adding a tour through manim #3495

Draft
wants to merge 50 commits into
base: main
Choose a base branch
from
Draft

Conversation

MrDiver
Copy link
Collaborator

@MrDiver MrDiver commented Dec 5, 2023

@MrDiver MrDiver marked this pull request as draft December 5, 2023 18:15
@KonstantinDjairo
Copy link

.

loved the challenge at the end, a good way of ensuring that the reader is learning

@MrDiver MrDiver linked an issue Dec 9, 2023 that may be closed by this pull request
@MrDiver
Copy link
Collaborator Author

MrDiver commented Dec 10, 2023

Next step adding the rate_function overview and group overview of animation categories

@JasonGrace2282
Copy link
Member

Also on the list:
Add VGroup and updaters.

@MrDiver
Copy link
Collaborator Author

MrDiver commented Dec 19, 2023

For the updaters i already have a good idea!

@MrDiver MrDiver marked this pull request as ready for review December 19, 2023 08:20
@MrDiver
Copy link
Collaborator Author

MrDiver commented Dec 19, 2023

I officially hate the github app

@JasonGrace2282
Copy link
Member

Do we want to replace the current quickstart with this?

@JasonGrace2282 JasonGrace2282 self-assigned this Dec 20, 2023
@JasonGrace2282 JasonGrace2282 added the documentation Improvements or additions to documentation label Dec 20, 2023
@JasonGrace2282 JasonGrace2282 added this to the v0.18.1 milestone Dec 20, 2023
@JasonGrace2282 JasonGrace2282 marked this pull request as draft December 20, 2023 20:41
@JasonGrace2282
Copy link
Member

You can now find the docs here:
https://manimce--3495.org.readthedocs.build/en/3495/adventure/index.html

JasonGrace2282 and others added 3 commits February 2, 2024 16:34
Bumps [github/codeql-action](https://github.com/github/codeql-action) from 2 to 3.
- [Release notes](https://github.com/github/codeql-action/releases)
- [Changelog](https://github.com/github/codeql-action/blob/main/CHANGELOG.md)
- [Commits](github/codeql-action@v2...v3)

---
updated-dependencies:
- dependency-name: github/codeql-action
  dependency-type: direct:production
  update-type: version-update:semver-major
...

Signed-off-by: dependabot[bot] <[email protected]>
Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>
@JasonGrace2282 JasonGrace2282 force-pushed the guide branch 2 times, most recently from 2caa4e8 to 95f7d0c Compare March 31, 2024 17:57
Alternatively, you can create your own. A rate function takes in a value between 0 and 1 representing the "progress" of the animation. You can think of this as the
ratio of the time passed since the animation started, to the runtime of the animation. It should return how much of the animation should have been completed by that time.

As an example, check out the rate function below.
Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Explanation for example missing

self.play(Create(c, run_time=2), Create(s, run_time=1))
# in this call, the individual runtimes of each animation
# are overridden by the runtime in the self.play call
self.play(FadeOut(c, run_time=2), FadeOut(s, run_time=1), run_time=1.5)
Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think setting both the animation time and global run_time is a bit confusing. Is there a good way to explain what hapens there ? Because it think it just overwrites the values set in the animations?




For a list of all Mobjects you can look at the :doc:`/reference_index/mobjects` Documentation Page. There are many more to explore and you can even create your own Mobjects, which we will cover later.
Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Reference to Custom Mobjects chapter needed

self.play(FadeOut(c))
self.wait(0.5) # wait half a second

A little bit later on, we will learn how to leverage the ``stop_condition`` parameter to stop after a certain event happens.
Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Reference needed

docs/source/adventure/basics.rst Outdated Show resolved Hide resolved
.. note::
From now onwards, if we refer to a group we are referring to a ``VGroup``, unless specifically stated otherwise.

Groups also have a bunch of methods to make your life easier. Take a look at some in the example below:
Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Maybe a bit more text to get the point across, additonally i would also state that animations work on groups as well as all the other mobjects because they are indifferent to each other

ValueTrackers
=============

ValueTrackers are the real things that allow you to synchronize multiple animations at once.
Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

TODO: A way for manim have controlled values in the animations


##################
Syncing Animations
##################
Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I would probably switch value trackers and updaters

Introduction
############
Throughout this guide, we'll walk you through how to create a simple 30 second video about vector addition. If you don't
already know what that is, it's recommended you watch `this<https://youtu.be/fNk_zzaMoSs?si=fQDML214IeNl0OZ1>`_ video
Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Broken link

docs/source/adventure/project.rst Outdated Show resolved Hide resolved
@MrDiver
Copy link
Collaborator Author

MrDiver commented Apr 4, 2024

TODO: Chapter on custom Mobjects, overhaul updaters and value trackers

@MrDiver
Copy link
Collaborator Author

MrDiver commented Apr 12, 2024

Todo highlighting individual letters in equations using indices

@behackl behackl modified the milestones: v0.18.1, v0.19.0 Apr 23, 2024
@JasonGrace2282 JasonGrace2282 modified the milestones: v0.19.0, v0.20.0 Jul 23, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
Status: 🏗 In progress
Development

Successfully merging this pull request may close these issues.

Manimlings? An easier and effective way of learning manim
5 participants