Skip to content

[WIP] Added docs for MovingCamera, MultiCamera and (soon) ImageMobjectFromCamera #3526

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

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

Conversation

chopan050
Copy link
Contributor

@chopan050 chopan050 commented Dec 13, 2023

Overview: What does this pull request change?

As requested by @MrDiver, I'm currently working on adding docs for MultiCamera (which inherits from MovingCamera) and soon ImageMobjectByCamera as well.

These classes seem to have the potential to be tremendously useful, but they're currently very undocumented and seemingly not really used by anyone.

THIS IS A WORK IN PROGRESS.

Links to added or changed documentation pages

Reviewer Checklist

  • The PR title is descriptive enough for the changelog, and the PR is labeled correctly
  • If applicable: newly added non-private functions and classes have a docstring including a short summary and a PARAMETERS section
  • If applicable: newly added functions and classes are tested

Copy link
Member

@JasonGrace2282 JasonGrace2282 left a comment

Choose a reason for hiding this comment

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

Looking forward to adding this to main!

@chopan050 chopan050 added the documentation Improvements or additions to documentation label Dec 21, 2023
from ...utils.bezier import interpolate
from ...utils.color import WHITE, ManimColor, color_to_int_rgb
from ...utils.images import change_to_rgba_array, get_full_raster_image_path
from manim.mobject.mobject import Mobject

Check failure

Code scanning / CodeQL

Module-level cyclic import Error

'Mobject' may not be defined if module
manim.mobject.mobject
is imported before module
manim.mobject.types.image_mobject
, as the
definition
of Mobject occurs after the cyclic
import
of manim.mobject.types.image_mobject.
'Mobject' may not be defined if module
manim.mobject.mobject
is imported before module
manim.mobject.types.image_mobject
, as the
definition
of Mobject occurs after the cyclic
import
of manim.mobject.types.image_mobject.
from manim.mobject.mobject import Mobject
from manim.utils.bezier import interpolate
from manim.utils.color import WHITE, ManimColor, color_to_int_rgb
from manim.utils.images import change_to_rgba_array, get_full_raster_image_path

Check failure

Code scanning / CodeQL

Module-level cyclic import Error

'change_to_rgba_array' may not be defined if module
manim.utils.images
is imported before module
manim.mobject.types.image_mobject
, as the
definition
of change_to_rgba_array occurs after the cyclic
import
of manim.mobject.types.image_mobject.
from manim.mobject.mobject import Mobject
from manim.utils.bezier import interpolate
from manim.utils.color import WHITE, ManimColor, color_to_int_rgb
from manim.utils.images import change_to_rgba_array, get_full_raster_image_path

Check failure

Code scanning / CodeQL

Module-level cyclic import Error

'get_full_raster_image_path' may not be defined if module
manim.utils.images
is imported before module
manim.mobject.types.image_mobject
, as the
definition
of get_full_raster_image_path occurs after the cyclic
import
of manim.mobject.types.image_mobject.
from typing_extensions import Self

from manim.typing import StrPath
from manim.camera.camera import Camera

Check failure

Code scanning / CodeQL

Module-level cyclic import Error

'Camera' may not be defined if module
manim.camera.camera
is imported before module
manim.mobject.types.image_mobject
, as the
definition
of Camera occurs after the cyclic
import
of manim.mobject.types.image_mobject.
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: 🆕 New
Development

Successfully merging this pull request may close these issues.

2 participants