Gizmo Arrows #10550

SIGSTACKFAULT · 2023-11-14T03:13:08Z

Objective

Add an arrow gizmo as suggested by Tracking issue: Amazing Gizmos #9400

Solution

(excuse my Protomen music)

2023-11-13.22-30-00.mp4

Wasn't horribly hard when i remembered i can change coordinate systems whenever I want. Gave them four tips (as suggested by @alice-i-cecile in discord) instead of trying to decide what direction the tips should point.

Made the tip length default to 1/10 of the arrow's length, which looked good enough to me. Hard-coded the angle from the body to the tips to 45 degrees.

Still TODO

actual doc comments
doctests
ArrowBuilder.with_tip_length()

Changelog

Added gizmos.arrow() and gizmos.arrow_2d()
Added arrows to 2d_gizmos and 3d_gizmos examples

Migration Guide

N/A

alice-i-cecile · 2023-11-14T03:28:15Z

Basically looks good once the TODOs are addressed. Can you grab a screenshot or video for reviewers and the curious passer-by to check out and add it to your PR description?

SIGSTACKFAULT · 2023-11-14T03:32:39Z

Can you grab a screenshot or video for reviewers and the curious passer-by to check out and add it to your PR description?

was already doing it <3

SIGSTACKFAULT · 2023-11-14T03:47:23Z

Basically looks good once the TODOs are addressed.

ready!

IceSentry · 2023-11-14T06:00:42Z

The size of the arrow head should probably be clamped. 1/10 does make sense, but if someone makes a really long arrow it will definitely end up looking weird. It's a bit hard to tell what should be the limit though.

Would be interesting to see how it looks if you also connect the base of the arrow head. To me it looks like there's something missing without a base.

nicopap · 2023-11-14T09:20:20Z

I think it makes sense to keep the head proportional to the arrow length. In 3D, consider an arrow that is very far away, if you clamp the head size, it will look tinny. There is no good general algorithm to figure out a "good" clamped arrow head size. In any case, this PR allow controlling the "tip length".

nicopap

Looks good, just a minor grip.

crates/bevy_gizmos/src/arrows.rs

@nicopap

suggested by @nicopap Co-authored-by: Nicola Papale <nicopap@users.noreply.github.com>

Co-authored-by: Nicola Papale <nicopap@users.noreply.github.com>

remove "which is sufficient for most applications." Co-authored-by: Nicola Papale <nicopap@users.noreply.github.com>

so their lenth is actually `tip_length` and not `sqrt(2)*tip_length`

IceSentry · 2023-11-14T17:48:12Z

I think it makes sense to keep the head proportional to the arrow length

Yeah, I didn't mean to not keep it proportional. Just limit how big it can get, but that was before I saw that you can specify a size manually so this can just be ignored.

SIGSTACKFAULT · 2023-11-14T18:27:34Z

build on macos-latest just says "this job failed" with no explanation or retry button

alice-i-cecile · 2023-11-14T19:39:05Z

Rerunning CI for you: it's been failing all over the place for no good reason.

IceSentry · 2023-11-14T20:59:21Z

For consistency, I think I'd prefer keeping arrows inside the gizmos file. If we want to go with separate files per shape I'd prefer if this was done in a separate PR. Not a blocker, just voicing my preference.

SIGSTACKFAULT · 2023-11-14T21:07:18Z

For consistency, I think I'd prefer keeping arrows inside the gizmos file.

I figured the next thing I would do would be to start splitting out the different shapes into their own files

IceSentry · 2023-11-14T21:22:46Z

Yeah, that's fair, I'd prefer if it was done in a separate PR to make sure people can voice their opinions separately to this PR.

IceSentry

Like mentioned earlier, I'd like to have the tips connected at the base, but it's not a blocker and can be implemented in a future PR.

SIGSTACKFAULT · 2023-11-15T03:30:22Z

are we waiting for me? or for someone else to hit the merge button

IceSentry · 2023-11-15T03:42:12Z

Bevy PRs require 2 community approvals for a maintainer to then be allowed to do a final review pass and it the merge button.

There's more detail here: https://github.com/bevyengine/bevy/blob/main/CONTRIBUTING.md#making-changes-to-bevy

So we still need another review and a maintainer to hit merge

SIGSTACKFAULT · 2023-11-15T14:36:10Z

So we still need another review and a maintainer to hit merge

Just paranoid that y'all were waiting for me and i hadn't realized <3

@alice-i-cecile

## Objective - Add an arrow gizmo as suggested by bevyengine#9400 ## Solution (excuse my Protomen music) https://github.com/bevyengine/bevy/assets/14184826/192adf24-079f-4a4b-a17b-091e892974ec Wasn't horribly hard when i remembered i can change coordinate systems whenever I want. Gave them four tips (as suggested by @alice-i-cecile in discord) instead of trying to decide what direction the tips should point. Made the tip length default to 1/10 of the arrow's length, which looked good enough to me. Hard-coded the angle from the body to the tips to 45 degrees. ## Still TODO - [x] actual doc comments - [x] doctests - [x] `ArrowBuilder.with_tip_length()` --- ## Changelog - Added `gizmos.arrow()` and `gizmos.arrow_2d()` - Added arrows to `2d_gizmos` and `3d_gizmos` examples ## Migration Guide N/A --------- Co-authored-by: Nicola Papale <nicopap@users.noreply.github.com>

SIGSTACKFAULT added 4 commits November 13, 2023 21:59

Add gizmo arrows!

9bb474d

add an arrow to to 3d_gizmos example

839e3bf

add an arrow to 2d example

05057e1

add docs and doctests to arrow and arrow_2d

38a9462

alice-i-cecile added A-Gizmos Visual editor and debug gizmos C-Enhancement A new feature labels Nov 14, 2023

alice-i-cecile added this to the 0.13 milestone Nov 14, 2023

alice-i-cecile requested review from nicopap and IceSentry and removed request for nicopap November 14, 2023 03:26

update comment inside ArrowBuilder.drop

b145755

SIGSTACKFAULT added 2 commits November 13, 2023 22:43

add ArrowBuilder.with_tip_length and it's docs

a1147cb

add doc comment to ArrowBuilder

2a14edd

finish writing doc comment on ArrowBuilder.drop

26d0d31

nicopap mentioned this pull request Nov 14, 2023

Tracking issue: Amazing Gizmos #9400

Open

57 tasks

nicopap suggested changes Nov 14, 2023

View reviewed changes

SIGSTACKFAULT and others added 9 commits November 14, 2023 08:40

add arrow_head_length alias to with_tip_length

75e7752

suggested by @nicopap Co-authored-by: Nicola Papale <nicopap@users.noreply.github.com>

make the comment on ArrowBuilder.drop a bit more professional

a93dc95

Co-authored-by: Nicola Papale <nicopap@users.noreply.github.com>

capitalize "Example" in three places

dba55c8

Co-authored-by: Nicola Papale <nicopap@users.noreply.github.com>

Remove commented out dev code

d177593

Co-authored-by: Nicola Papale <nicopap@users.noreply.github.com>

Construct tips in a smarter way

d1ac848

Co-authored-by: Nicola Papale <nicopap@users.noreply.github.com>

format arrows.rs

e1bde5a

update doc comment on ArrowBuilder.with_tip_length

9bc4cff

remove "which is sufficient for most applications." Co-authored-by: Nicola Papale <nicopap@users.noreply.github.com>

Adjust comments inside ArrowBuilder.drop

a5e68cc

normalize the tips before multiplying by tip_length

583de5e

so their lenth is actually `tip_length` and not `sqrt(2)*tip_length`

IceSentry approved these changes Nov 14, 2023

View reviewed changes

nicopap approved these changes Nov 15, 2023

View reviewed changes

nicopap added the S-Ready-For-Final-Review This PR has been approved by the community. It's ready for a maintainer to consider merging it label Nov 15, 2023

alice-i-cecile added this pull request to the merge queue Nov 15, 2023

Merged via the queue into bevyengine:main with commit ab300d0 Nov 15, 2023
22 checks passed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Gizmo Arrows #10550

Gizmo Arrows #10550

SIGSTACKFAULT commented Nov 14, 2023 •

edited

alice-i-cecile commented Nov 14, 2023

SIGSTACKFAULT commented Nov 14, 2023

SIGSTACKFAULT commented Nov 14, 2023

IceSentry commented Nov 14, 2023

nicopap commented Nov 14, 2023

nicopap left a comment

IceSentry commented Nov 14, 2023

SIGSTACKFAULT commented Nov 14, 2023 •

edited

alice-i-cecile commented Nov 14, 2023

IceSentry commented Nov 14, 2023

SIGSTACKFAULT commented Nov 14, 2023

IceSentry commented Nov 14, 2023

IceSentry left a comment

SIGSTACKFAULT commented Nov 15, 2023

IceSentry commented Nov 15, 2023 •

edited

SIGSTACKFAULT commented Nov 15, 2023

Gizmo Arrows #10550

Gizmo Arrows #10550

Conversation

SIGSTACKFAULT commented Nov 14, 2023 • edited

Objective

Solution

Still TODO

Changelog

Migration Guide

alice-i-cecile commented Nov 14, 2023

SIGSTACKFAULT commented Nov 14, 2023

SIGSTACKFAULT commented Nov 14, 2023

IceSentry commented Nov 14, 2023

nicopap commented Nov 14, 2023

nicopap left a comment

Choose a reason for hiding this comment

IceSentry commented Nov 14, 2023

SIGSTACKFAULT commented Nov 14, 2023 • edited

alice-i-cecile commented Nov 14, 2023

IceSentry commented Nov 14, 2023

SIGSTACKFAULT commented Nov 14, 2023

IceSentry commented Nov 14, 2023

IceSentry left a comment

Choose a reason for hiding this comment

SIGSTACKFAULT commented Nov 15, 2023

IceSentry commented Nov 15, 2023 • edited

SIGSTACKFAULT commented Nov 15, 2023

SIGSTACKFAULT commented Nov 14, 2023 •

edited

SIGSTACKFAULT commented Nov 14, 2023 •

edited

IceSentry commented Nov 15, 2023 •

edited