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

Add docstring to family_members_with_points method in Mobject class #4128

Open
wants to merge 15 commits into
base: main
Choose a base branch
from
Open
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
19 changes: 19 additions & 0 deletions manim/mobject/mobject.py
Original file line number Diff line number Diff line change
Expand Up @@ -2339,6 +2339,25 @@ def get_family(self, recurse: bool = True) -> list[Self]:
return remove_list_redundancies(all_mobjects)

def family_members_with_points(self) -> list[Self]:
"""Filters the list of family members (generated by :meth:`.get_family`) to include only mobjects with points.

Returns
-------
list
A list of mobjects that have points.

Examples
--------
::

>>> from manim import Square, Rectangle, VGroup, Group, Mobject, VMobject
>>> s, r, m, v = Square(), Rectangle(), Mobject(), VMobject()
>>> vg = VGroup(s, r)
>>> gr = Group(vg, m, v)
>>> gr.family_members_with_points()
[Square, Rectangle]

"""
return [m for m in self.get_family() if m.get_num_points() > 0]

def arrange(
Expand Down
Loading