-
Notifications
You must be signed in to change notification settings - Fork 2.6k
Add VectorNDLike type aliases
#4068
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
Merged
Merged
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
3 tasks
3 tasks
for more information, see https://pre-commit.ci
…o vectorndlike
JasonGrace2282
approved these changes
Aug 1, 2025
Member
JasonGrace2282
left a comment
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Sorry to get back to this so late!
Contributor
Author
|
Thanks! 🎉 |
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.
As mentioned in PR #4027, type aliases such as
VectorNDLikeandVectorNDLike_Arraywere necessary, because there were many functions and methods in which we can represent some direction using a tuple/list of floats.The clearest example would be the
VectorMobject. It accepts adirectionas a parameter, which was typehinted as aPoint2DLike | Point3DLikebecauseVector2D | Vector3Dcan only represent a NumPy array, whereasPoint2DLike | Point3DLikecan also represent a tuple or list. This is inconsistent and signals us that we actually needVector2DLikeandVector3DLiketype aliases.TODOs in follow-up PRs:
path_ops.py,space_ops.pyandthree_dimensions.py, among others. Many parameters are simply typed asnp.ndarray. I detected that thePathFuncTypeactually seems to interpolate twoPoint3D_Arrayobjects, notPoint3DLike.Quaterniontype alias, and maybe alsoMatrix3x3.OpenGLMobject.wag(), becauseMobject.wag()was deprecated and removed.Links to added or changed documentation pages
Reviewer Checklist