Cleaning up geometry module: New Tipable module

[AntonBallmaier]

Enhancement proposal

New Module

The geometry module is extremely crowded (2558 lines, 39 classes).

Therefor I suggest moving the classes connected to arrows to a now module, which could be named tipable.py.
This should includes the following:

• TipableVMobject
• Arrow
• Vector
• DoubleArrow
• CurvedArrow
• CurvedDoubleArrow
• ArrowTip
• ArrowCircleFilledTip
• ArrowCircleTip
• ArrowSquareFilledTip
• ArrowSquareTip
• ArrowTriangleFilledTip
• ArrowTriangleTip

Combining classes

The number of classes is quite a bit over the top in my opinion. I feel like adding an aditional parameter wold be a better choice in many cases:

• Giving Arrow two parameters double and curved both defaulting to False would deprecate DoubleArrow, CurvedArrow and CurvedDoubleArrow (Imo whether CurvedArrow should be deprecated is debatable).
• The ArrowTip should get a parameter filled defaulting to False. This would deprecate the three filled variant classes.

Class renamings:

The (remaining) arrow tip classes ought to be renamed:

• ArrowCircleTip => CircleArrowTip
• ArrowSquareTip => SquareArrowTip
• ArrowTriangleTip => TriangleArrowTip, however it might also be a good idea to combine TriangleArrowTip and ArrowTip in ArrowTip.

Edit: Total Tippable breakdown

After having a chat with @XorUnison I might as well deprecate Tipable and the differnt ArrowTip subclasses all together - we'll see how that turns out :D

Additional comments

Please add a comment if you want to work on this issue, as it may well be I already started doing so :)

[behackl]

CC @XorUnison, you mentioned at some point that you are looking to rework arrows?

[AntonBallmaier]

CC @XorUnison, you mentioned at some point that you are looking to rework arrows?

Thanks for the tip - He has given me quite a few more ideas :)

[XorUnison]

CC @XorUnison, you mentioned at some point that you are looking to rework arrows?

Correct, although to my shame I will have to first complete Tiling/Honeycomb which uh... I should've done ages ago.
If someone else works on tips instead that's just fine, and there's some improvements here that I didn't plan on doing. Mainly the condensing of the different arrow classes.

As for what I was intending to do, here's the excerpt from our discord PMs:

My main idea for the tip itself was to break down the thing as much as possible, into 3 simple properties.
Position: Ranging from 0 to 1 in float it would determine where on the line the tip is
Rotation: In radians this would determine how much the tip is rotated away from the direction of the line segment it's placed on, and would be 0 by default
Tip: Since... the tip is basically just a VMobject, might as well cut out the middlemen and directly make it an accessible VMobject

That aside placing tips along lines/arcs and in far more general moving things along anything line-like such as more complicated functions could be condensed all into one central package of functionality. That'd require some more digging into those and how the community does that kind of stuff currently however.

[behackl]

Great! I like all the suggestions here. geometry desperately needs be cleaned up. :-)

[AntonBallmaier]

Ok - I'll probably start any time soon and keep you up to date how it's coming along 🙂

[hydrobeam]

Would Line also be included in tipable.py? It inherits from TipableVMobject

[citrusmunch]

i'd like to work on this