Skip to content

armgit / manim

Public Imported from GitHub
0

A community-maintained Python framework for creating mathematical animations.

Added new metaclass ConvertToOpenGL (replacing MetaVMobject), restore IntelliSense (#1577)

Max Stoumen8d327075565d
diff --git a/manim/mobject/geometry.py b/manim/mobject/geometry.py
index 09239d9c7..4ccfded4d 100644
--- a/manim/mobject/geometry.py
+++ b/manim/mobject/geometry.py
@@ -71,12 +71,7 @@ from colour import Color
from .. import config, logger
from ..constants import *
from ..mobject.mobject import Mobject
-from ..mobject.types.vectorized_mobject import (
- DashedVMobject,
- MetaVMobject,
- VGroup,
- VMobject,
-)
+from ..mobject.types.vectorized_mobject import DashedVMobject, VGroup, VMobject
from ..utils.color import *
from ..utils.iterables import adjacent_n_tuples, adjacent_pairs
from ..utils.simple_functions import fdiv
@@ -89,9 +84,10 @@ from ..utils.space_ops import (
regular_vertices,
rotate_vector,
)
+from .opengl_compatibility import ConvertToOpenGL
-class TipableVMobject(metaclass=MetaVMobject):
+class TipableVMobject(VMobject, metaclass=ConvertToOpenGL):
"""
Meant for shared functionality between Arc and Line.
Functionality can be classified broadly into these groups:
@@ -1124,7 +1120,7 @@ class TangentLine(Line):
self.scale(self.length / self.get_length())
-class Elbow(metaclass=MetaVMobject):
+class Elbow(VMobject, metaclass=ConvertToOpenGL):
"""Two lines that create a right angle about each other: L-shape.
Parameters
@@ -1464,7 +1460,7 @@ class DoubleArrow(Arrow):
self.add_tip(at_start=True, tip_shape=tip_shape_start)
-class CubicBezier(metaclass=MetaVMobject):
+class CubicBezier(VMobject, metaclass=ConvertToOpenGL):
"""
Example
-------
@@ -1492,7 +1488,7 @@ class CubicBezier(metaclass=MetaVMobject):
self.add_cubic_bezier_curve(start_anchor, start_handle, end_handle, end_anchor)
-class Polygram(metaclass=MetaVMobject):
+class Polygram(VMobject, metaclass=ConvertToOpenGL):
"""A generalized :class:`Polygon`, allowing for disconnected sets of edges.
Parameters
@@ -1932,7 +1928,7 @@ class Star(Polygon):
super().__init__(*vertices, **kwargs)
-class ArcPolygon(metaclass=MetaVMobject):
+class ArcPolygon(VMobject, metaclass=ConvertToOpenGL):
"""A generalized polygon allowing for points to be connected with arcs.
This version tries to stick close to the way :class:`Polygon` is used. Points
@@ -2042,7 +2038,7 @@ class ArcPolygon(metaclass=MetaVMobject):
self.arcs = arcs
-class ArcPolygonFromArcs(metaclass=MetaVMobject):
+class ArcPolygonFromArcs(VMobject, metaclass=ConvertToOpenGL):
"""A generalized polygon allowing for points to be connected with arcs.
This version takes in pre-defined arcs to generate the arcpolygon and introduces
@@ -2340,7 +2336,7 @@ class RoundedRectangle(Rectangle):
self.round_corners(self.corner_radius)
-class ArrowTip(metaclass=MetaVMobject):
+class ArrowTip(VMobject, metaclass=ConvertToOpenGL):
r"""Base class for arrow tips.
See Also
@@ -2580,7 +2576,7 @@ class ArrowSquareFilledTip(ArrowSquareTip):
super().__init__(fill_opacity=fill_opacity, stroke_width=stroke_width, **kwargs)
-class Cutout(metaclass=MetaVMobject):
+class Cutout(VMobject, metaclass=ConvertToOpenGL):
"""A shape with smaller cutouts.
.. warning::
@@ -2626,7 +2622,7 @@ class Cutout(metaclass=MetaVMobject):
self.append_points(mobject.force_direction(sub_direction).get_points())
-class Angle(metaclass=MetaVMobject):
+class Angle(VMobject, metaclass=ConvertToOpenGL):
"""A circular arc or elbow-type mobject representing an angle of two lines.
Parameters
diff --git a/manim/mobject/graph.py b/manim/mobject/graph.py
index 1c0c4c4e9..c3b60beb3 100644
--- a/manim/mobject/graph.py
+++ b/manim/mobject/graph.py
@@ -15,8 +15,9 @@ from ..animation.creation import Create, Uncreate
from ..utils.color import BLACK
from .geometry import Dot, LabeledDot, Line
from .mobject import Group, Mobject, override_animate
+from .opengl_compatibility import ConvertToOpenGL
from .svg.tex_mobject import MathTex
-from .types.vectorized_mobject import MetaVMobject
+from .types.vectorized_mobject import VMobject
def _determine_graph_layout(
@@ -152,7 +153,7 @@ def _tree_layout(
}
-class Graph(metaclass=MetaVMobject):
+class Graph(VMobject, metaclass=ConvertToOpenGL):
"""An undirected graph (that is, a collection of vertices connected with edges).
Graphs can be instantiated by passing both a list of (distinct, hashable)
diff --git a/manim/mobject/opengl_compatibility.py b/manim/mobject/opengl_compatibility.py
new file mode 100644
index 000000000..9cd713754
--- /dev/null
+++ b/manim/mobject/opengl_compatibility.py
@@ -0,0 +1,31 @@
+from abc import ABCMeta
+
+from .. import config
+from .opengl_mobject import OpenGLMobject
+from .types.opengl_vectorized_mobject import OpenGLVMobject
+
+
+class ConvertToOpenGL(ABCMeta):
+ """Metaclass for swapping (V)Mobject with its OpenGL counterpart at runtime
+ depending on config.renderer. This metaclass should only need to be inherited
+ on the lowest order inheritance classes such as Mobject and VMobject.
+
+ Note that with this implementation, changing the value of ``config.renderer``
+ after Manim has been imported won't have the desired effect and will lead to
+ spurious errors.
+ """
+
+ def __new__(cls, name, bases, namespace):
+ if config.renderer == "opengl":
+ # Must check class names to prevent
+ # cyclic importing.
+ base_names_to_opengl = {
+ "Mobject": OpenGLMobject,
+ "VMobject": OpenGLVMobject,
+ }
+
+ bases = tuple(
+ base_names_to_opengl.get(base.__name__, base) for base in bases
+ )
+
+ return super().__new__(cls, name, bases, namespace)
diff --git a/manim/mobject/svg/svg_mobject.py b/manim/mobject/svg/svg_mobject.py
index a475552e8..b7d01d808 100644
--- a/manim/mobject/svg/svg_mobject.py
+++ b/manim/mobject/svg/svg_mobject.py
@@ -18,14 +18,13 @@ import numpy as np
from ... import config, logger
from ...constants import *
from ...mobject.geometry import Circle, Line, Rectangle, RoundedRectangle
-from ...mobject.opengl_geometry import OpenGLRectangle, OpenGLRoundedRectangle
-from ...mobject.types.opengl_vectorized_mobject import OpenGLVGroup
-from ...mobject.types.vectorized_mobject import MetaVMobject, VGroup, VMobject
+from ...mobject.types.vectorized_mobject import VMobject
+from ..opengl_compatibility import ConvertToOpenGL
from .style_utils import cascade_element_style, parse_style
from .svg_path import SVGPathMobject, string_to_numbers
-class SVGMobject(metaclass=MetaVMobject):
+class SVGMobject(VMobject, metaclass=ConvertToOpenGL):
"""A SVGMobject is a Vector Mobject constructed from an SVG (or XDV) file.
SVGMobjects are constructed from the XML data within the SVG file
@@ -203,15 +202,11 @@ class SVGMobject(metaclass=MetaVMobject):
pass # TODO
result = [m for m in result if m is not None]
- if config["renderer"] == "opengl":
- self.handle_transforms(element, OpenGLVGroup(*result))
- else:
- self.handle_transforms(element, VGroup(*result))
+ group_cls = self.get_group_class()
+
+ self.handle_transforms(element, group_cls(*result))
if len(result) > 1 and not self.unpack_groups:
- if config["renderer"] == "opengl":
- result = [OpenGLVGroup(*result)]
- else:
- result = [VGroup(*result)]
+ result = [group_cls(*result)]
if within_defs and element.hasAttribute("id"):
# it seems wasteful to throw away the actual element,
@@ -357,33 +352,18 @@ class SVGMobject(metaclass=MetaVMobject):
parsed_style["stroke_width"] = stroke_width
if corner_radius == 0:
- if config["renderer"] == "opengl":
- mob = OpenGLRectangle(
- width=self.attribute_to_float(rect_element.getAttribute("width")),
- height=self.attribute_to_float(rect_element.getAttribute("height")),
- **parsed_style,
- )
- else:
- mob = Rectangle(
- width=self.attribute_to_float(rect_element.getAttribute("width")),
- height=self.attribute_to_float(rect_element.getAttribute("height")),
- **parsed_style,
- )
+ mob = Rectangle(
+ width=self.attribute_to_float(rect_element.getAttribute("width")),
+ height=self.attribute_to_float(rect_element.getAttribute("height")),
+ **parsed_style,
+ )
else:
- if config["renderer"] == "opengl":
- mob = OpenGLRoundedRectangle(
- width=self.attribute_to_float(rect_element.getAttribute("width")),
- height=self.attribute_to_float(rect_element.getAttribute("height")),
- corner_radius=corner_radius,
- **parsed_style,
- )
- else:
- mob = RoundedRectangle(
- width=self.attribute_to_float(rect_element.getAttribute("width")),
- height=self.attribute_to_float(rect_element.getAttribute("height")),
- corner_radius=corner_radius,
- **parsed_style,
- )
+ mob = RoundedRectangle(
+ width=self.attribute_to_float(rect_element.getAttribute("width")),
+ height=self.attribute_to_float(rect_element.getAttribute("height")),
+ corner_radius=corner_radius,
+ **parsed_style,
+ )
mob.shift(mob.get_center() - mob.get_corner(UP + LEFT))
return mob
diff --git a/manim/mobject/svg/svg_path.py b/manim/mobject/svg/svg_path.py
index 116213ee5..f255a5f2b 100644
--- a/manim/mobject/svg/svg_path.py
+++ b/manim/mobject/svg/svg_path.py
@@ -12,8 +12,9 @@ import numpy as np
from ... import config
from ...constants import *
-from ...mobject.types.vectorized_mobject import MetaVMobject
from ...utils.deprecation import deprecated
+from ..opengl_compatibility import ConvertToOpenGL
+from ..types.vectorized_mobject import VMobject
def correct_out_of_range_radii(rx, ry, x1p, y1p):
@@ -210,7 +211,7 @@ def string_to_numbers(num_string: str) -> List[float]:
return float_results
-class SVGPathMobject(metaclass=MetaVMobject):
+class SVGPathMobject(VMobject, metaclass=ConvertToOpenGL):
def __init__(self, path_string, **kwargs):
self.path_string = path_string
if config.renderer == "opengl":
diff --git a/manim/mobject/types/vectorized_mobject.py b/manim/mobject/types/vectorized_mobject.py
index dc70ec5b9..450ce05ec 100644
--- a/manim/mobject/types/vectorized_mobject.py
+++ b/manim/mobject/types/vectorized_mobject.py
@@ -36,6 +36,7 @@ from ...utils.color import BLACK, WHITE, color_to_rgba
from ...utils.iterables import make_even, stretch_array_to_length, tuplify
from ...utils.simple_functions import clip_in_place
from ...utils.space_ops import rotate_vector, shoelace_direction
+from ..opengl_compatibility import ConvertToOpenGL
from .opengl_vectorized_mobject import OpenGLVMobject
# TODO
@@ -47,26 +48,6 @@ from .opengl_vectorized_mobject import OpenGLVMobject
# That's kind of weird.
-class MetaVMobject(ABCMeta):
- """Metaclass for initializing corresponding classes as either inheriting from
- VMobject or OpenGLVMobject, depending on the value of ``config.renderer`` at
- initialization time.
-
- Note that with this implementation, changing the value of ``config.renderer``
- after Manim has been imported won't have the desired effect and will lead to
- spurious errors.
- """
-
- def __new__(cls, name, bases, namespace):
- if len(bases) == 0:
- if config.renderer == "opengl":
- bases = (OpenGLVMobject,)
- else:
- bases = (VMobject,)
-
- return super().__new__(cls, name, bases, namespace)
-
-
class VMobject(Mobject):
def __init__(
self,
@@ -1975,7 +1956,7 @@ class VDict(VMobject):
super().add(value)
-class VectorizedPoint(metaclass=MetaVMobject):
+class VectorizedPoint(VMobject, metaclass=ConvertToOpenGL):
def __init__(
self,
location=ORIGIN,
@@ -2040,7 +2021,7 @@ class CurvesAsSubmobjects(VGroup):
self.add(part)
-class DashedVMobject(metaclass=MetaVMobject):
+class DashedVMobject(VMobject, metaclass=ConvertToOpenGL):
def __init__(
self, vmobject, num_dashes=15, positive_space_ratio=0.5, color=WHITE, **kwargs
):