Adding :class: ManimColor to manim and converting all types (#3020)

* first draft of color class + starting library conversion

* [pre-commit.ci] auto fixes from pre-commit.com hooks

for more information, see https://pre-commit.ci

* [pre-commit.ci] auto fixes from pre-commit.com hooks

for more information, see https://pre-commit.ci

* changed everything to Manim color todo: figure out circular dependency in utils

* [pre-commit.ci] auto fixes from pre-commit.com hooks

for more information, see https://pre-commit.ci

* first working draft of new color version

* resolving conflicts

* resolving conflicts

* resolving conflicts

* resolving conflicts

* resolving conflicts

* changed default internal value of ManimColor to np.ndarray[float]

* starting to fix tests

* fixed more tests and changed precision of manim color

* removed premature color conversion

* fixed some more tests

* final test changes

* fix doctests

* fix for 3.8

* fixing ManimColor string representation

* removing some unneccesary conversions

* moved community constants to manim_colors.py and added more color standards

* broke some too long lines

* added fallback: check whether passed object has get_hex method

* actually fix _internal_from_string

* added hsv support

* [pre-commit.ci] auto fixes from pre-commit.com hooks

for more information, see https://pre-commit.ci

* remove dependency on colour

* fixed DARK_EARTH being assigned twice

* fixed double assignment

* remove more duplicated colour names

* raise NotImplementedError for ManimColor.gradient

* removed unused import

* remove superfluous ManimColor import

* fix circular import, remove dependency of space_ops on config

* one more Color -> ParseableManimColor

* removed one *-import

* somewhat unrelated fixed type hint

* -1 *-import

* fixed change of logic in CoordinateSystem.get_graph_label

* removed debug print; fixed type hint in mobject.py

* some fixes and improvements to text_mobject.py

* update three_dimensions

* fixes for rendered documentation of utils.color.*

* substantial improvements to documentation, including new Sphinx directive

Co-authored-by: MrDiver <[email protected]>

* Rewrite of the sphinx directive to use docutils nodes and 2 column design

* I just had to do it

* Improve the color table

* minor cleanup

* fixed ColorOverview example

* documentation improvements

* [pre-commit.ci] auto fixes from pre-commit.com hooks

for more information, see https://pre-commit.ci

* Update manim/mobject/mobject.py

Co-authored-by: Benjamin Hackl <[email protected]>

* [pre-commit.ci] auto fixes from pre-commit.com hooks

for more information, see https://pre-commit.ci

* fix flake8 errors

* Removed test in test_text_mobject

* Improved Documentation of core.py and added private members in sphinx so that internal methods can be documented

* Change color types of labeled.py

* removed some unused imports

* turned docstring into comment

* _colors  -> _all_manim_colors; move to manim_color module

* [pre-commit.ci] auto fixes from pre-commit.com hooks

for more information, see https://pre-commit.ci

* fixed typing

* rewrite import

---------

Co-authored-by: pre-commit-ci[bot] <66853113+pre-commit-ci[bot]@users.noreply.github.com>
Co-authored-by: Benjamin Hackl <[email protected]>
Co-authored-by: Naveen M K <[email protected]>

Author: 4 people

.mypy.ini

@@ -23,6 +23,9 @@ ignore_errors = True
 [mypy-manim.utils.*]
 ignore_errors = True
 
+[mypy-manim.utils.color]
+ignore_errors = False
+
 [mypy-manim.animation.*]
 ignore_errors = True
 

docs/source/_templates/autosummary/class.rst

@@ -7,6 +7,8 @@ Qualified name: ``{{ fullname | escape }}``
 .. autoclass:: {{ objname }}
    :show-inheritance:
    :members:
+   :private-members:
+
 
    {% block methods %}
    {%- if methods %}

docs/source/conf.py

@@ -43,6 +43,7 @@
     "sphinx.ext.viewcode",
     "sphinxext.opengraph",
     "manim.utils.docbuild.manim_directive",
+    "manim.utils.docbuild.autocolor_directive",
     "sphinx.ext.graphviz",
     "sphinx.ext.inheritance_diagram",
     "sphinxcontrib.programoutput",

manim/_config/utils.py

@@ -23,11 +23,11 @@
 from pathlib import Path
 from typing import Any, Iterable, Iterator
 
-import colour
 import numpy as np
 
 from .. import constants
 from ..constants import RendererType
+from ..utils.color import ManimColor
 from ..utils.tex import TexTemplate, TexTemplateFromFile
 from ..utils.tex_templates import TexTemplateLibrary
 
@@ -1096,7 +1096,7 @@ def format(self, val: str) -> None:
 
     background_color = property(
         lambda self: self._d["background_color"],
-        lambda self, val: self._d.__setitem__("background_color", colour.Color(val)),
+        lambda self, val: self._d.__setitem__("background_color", ManimColor(val)),
         doc="Background color of the scene (-c).",
     )
 

manim/animation/changing.py

@@ -6,12 +6,17 @@
 
 from typing import Callable
 
-from colour import Color
-
 from manim._config import config
 from manim.mobject.opengl.opengl_compatibility import ConvertToOpenGL
 from manim.mobject.types.vectorized_mobject import VGroup, VMobject
-from manim.utils.color import BLUE_B, BLUE_D, BLUE_E, GREY_BROWN, WHITE
+from manim.utils.color import (
+    BLUE_B,
+    BLUE_D,
+    BLUE_E,
+    GREY_BROWN,
+    WHITE,
+    ParsableManimColor,
+)
 from manim.utils.rate_functions import smooth
 
 
@@ -140,7 +145,7 @@ def __init__(
         self,
         traced_point_func: Callable,
         stroke_width: float = 2,
-        stroke_color: Color = WHITE,
+        stroke_color: ParsableManimColor | None = WHITE,
         dissipating_time: float | None = None,
         **kwargs,
     ):

manim/animation/creation.py

@@ -77,13 +77,13 @@ def construct(self):
 from typing import TYPE_CHECKING, Callable, Iterable, Sequence
 
 import numpy as np
-from colour import Color
 
 if TYPE_CHECKING:
     from manim.mobject.text.text_mobject import Text
 
 from manim.mobject.opengl.opengl_surface import OpenGLSurface
 from manim.mobject.opengl.opengl_vectorized_mobject import OpenGLVMobject
+from manim.utils.color import ManimColor
 
 from .. import config
 from ..animation.animation import Animation
@@ -259,7 +259,7 @@ def get_outline(self) -> Mobject:
             sm.set_stroke(color=self.get_stroke_color(sm), width=self.stroke_width)
         return outline
 
-    def get_stroke_color(self, vmobject: VMobject | OpenGLVMobject) -> Color:
+    def get_stroke_color(self, vmobject: VMobject | OpenGLVMobject) -> ManimColor:
         if self.stroke_color:
             return self.stroke_color
         elif vmobject.get_stroke_width() > 0:

manim/animation/indication.py

@@ -40,7 +40,6 @@ def construct(self):
 from typing import Callable, Iterable, Optional, Tuple, Type, Union
 
 import numpy as np
-from colour import Color
 
 from manim.mobject.geometry.arc import Circle, Dot
 from manim.mobject.geometry.line import Line
@@ -58,7 +57,7 @@ def construct(self):
 from ..mobject.mobject import Mobject
 from ..mobject.types.vectorized_mobject import VGroup, VMobject
 from ..utils.bezier import interpolate, inverse_interpolate
-from ..utils.color import GREY, YELLOW
+from ..utils.color import GREY, YELLOW, ParsableManimColor
 from ..utils.deprecation import deprecated
 from ..utils.rate_functions import smooth, there_and_back, wiggle
 from ..utils.space_ops import normalize
@@ -609,7 +608,7 @@ def __init__(
         fade_out=False,
         time_width=0.3,
         buff: float = SMALL_BUFF,
-        color: Color = YELLOW,
+        color: ParsableManimColor = YELLOW,
         run_time=1,
         stroke_width=DEFAULT_STROKE_WIDTH,
         **kwargs

manim/camera/camera.py

@@ -24,7 +24,7 @@
 from ..mobject.types.image_mobject import AbstractImageMobject
 from ..mobject.types.point_cloud_mobject import PMobject
 from ..mobject.types.vectorized_mobject import VMobject
-from ..utils.color import color_to_int_rgba
+from ..utils.color import ManimColor, ParsableManimColor, color_to_int_rgba
 from ..utils.family import extract_mobject_family_members
 from ..utils.images import get_full_raster_image_path
 from ..utils.iterables import list_difference_update
@@ -75,6 +75,8 @@ def __init__(
         frame_height: float | None = None,
         frame_width: float | None = None,
         frame_rate: float | None = None,
+        background_color: ParsableManimColor | None = None,
+        background_opacity: float | None = None,
         **kwargs,
     ):
         self.background_image = background_image
@@ -106,9 +108,14 @@ def __init__(
             frame_rate = config["frame_rate"]
         self.frame_rate = frame_rate
 
-        # TODO: change this to not use kwargs.get
-        for attr in ["background_color", "background_opacity"]:
-            setattr(self, f"_{attr}", kwargs.get(attr, config[attr]))
+        if background_color is None:
+            self._background_color = ManimColor.parse(config["background_color"])
+        else:
+            self._background_color = ManimColor.parse(background_color)
+        if background_opacity is None:
+            self._background_opacity = config["background_opacity"]
+        else:
+            self._background_opacity = background_opacity
 
         # This one is in the same boat as the above, but it doesn't have the
         # same name as the corresponding key so it has to be handled on its own

manim/communitycolors.py

@@ -48,7 +48,6 @@ def construct(self):
 from typing import TYPE_CHECKING, Sequence
 
 import numpy as np
-from colour import Color
 
 from manim.constants import *
 from manim.mobject.opengl.opengl_compatibility import ConvertToOpenGL
@@ -492,7 +491,7 @@ def construct(self):
     def __init__(
         self,
         radius: float | None = None,
-        color: Color | str = RED,
+        color: ParsableManimColor = RED,
         **kwargs,
     ):
         super().__init__(
@@ -658,7 +657,7 @@ def __init__(
         radius: float = DEFAULT_DOT_RADIUS,
         stroke_width: float = 0,
         fill_opacity: float = 1.0,
-        color: Color | str = WHITE,
+        color: ParsableManimColor = WHITE,
         **kwargs,
     ):
         super().__init__(