Two New Classes in geometry module: :class:.LabeledLine and :class:.LabeledArrow
#3264
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
…ry module testing suite
Merging changes into poetry config file from main branch
![github-advanced-security[bot]](https://avatars.githubusercontent.com/in/57789?s=60&v=4){kind=small}
andresberejnoi
changed the title
Co-authored-by: Jason Villanueva <a@jsonvillanueva.com>
Co-authored-by: Jason Villanueva <a@jsonvillanueva.com>
Co-authored-by: Jason Villanueva <a@jsonvillanueva.com>
Co-authored-by: Jason Villanueva <a@jsonvillanueva.com>
for more information, see https://pre-commit.ci
will change name of labeled_shapes.py to labeled.py
Changed name of file from labeled_shapes.py to labeled.py and updated __init__.py to import from the correct location.
jsonvillanueva
approved these changes
Jul 27, 2023
Removed color import line because of redundancy. Co-authored-by: Jason Villanueva <a@jsonvillanueva.com>
default label_color parameter is now set to `None` instead of `WHITE`.
Co-authored-by: Jason Villanueva <a@jsonvillanueva.com>
Co-authored-by: Jason Villanueva <a@jsonvillanueva.com>
jsonvillanueva
changed the title
.LabeledLine and :class:.LabeledArrow
SurroundingRectangle uses label_color as well and using a default of None removes the rectangle.
for more information, see https://pre-commit.ci
3 tasks
|
Also, thanks again @andresberejnoi for the contribution! If you're on the Manim Discord server and interested in having the |
|
Thank you, and I'm glad the contribution is useful. I will make sure to check out the Discord server again. |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Overview: What does this pull request change?
This PR adds two new classes:
LabeledLineandLabeledArrow.LabeledLineinherits fromLineand creates a line with a label and text box somewhere along its length. The position of the label, as well as the color and size can be controlled through parameters.LabeledArrowinherits fromLabeledLineandArrowand allows to create arrows with a label somewhere along its length.I also added some basic tests under
tests/test_graphical_units/test_geometry.py.I think these two classes belong in
line.py, however, since they make use ofSurroundingRectangleandBackgroundRectangle, there is a circular import problem.SurroundingRectangleandBackgroundRectangleare inshape_matchers.pywhich importsLinefromline.py. For this reason, I decided to create a new file containing my new classes:labeled.py.Motivation and Explanation: Why and how do your changes improve the library?
I added these classes because I needed to create neural network animations that show weights between neurons. None of the tools already available were suitable for this task if I wanted to easily automate them. I think that lines or arrows with labels are very useful for diagrams and figures, so it would be nice to have them as part of the default package.
Here is a short video of what I am using these classes for:
NetworkWithRandomWeights.mp4
The label box can be moved anywhere along the length of the arrow or line, and in this case, I left it near the beginning.
Links to added or changed documentation pages
Further Information and Comments
Reviewer Checklist