"Usage" section of `pan_orbit_camera` does not mention input handling
Maintainers usually reply within 2 days
Nobody has claimed this yet.
Assessment
- Difficulty
- 2/5
- Estimated time
- 1-3 hours
- Newbie friendliness
- 62/100
- Issue type
- Documentation
- Clarity
- Mostly clear
- Activity status
- Active
- Tech stack
- rust
- Domain
- documentation
Research direction
Start with the module-level pan_orbit_camera docs, the PanOrbitCamera and MinimalPanOrbitCameraPlugin docs, and the Bevy examples that provide camera input; compare their descriptions with the Usage section. Clarify the input plugin requirement and whether bevy_picking is used by the controller itself, noting that the examples show one input approach and no officially endorsed plugin exists. Done when the documentation describes these requirements consistently.
Written by the indexing model from the issue text.
Description
bevy_pickingDefaultPanOrbitCameraPluginsPanOrbitCamera
This feels factually incorrect, as pan_orbit_camera seems to also require a custom (nontrivial) input plugin since https://github.com/bevyengine/bevy/pull/25465.
This is outlined nowhere besides a single line in MinimalPanOrbitCameraPlugin (which most users might never touch) and the bevy examples, with all other places (especially the module level docs) indicating that the aforementioned three parts are the only steps necessary for getting the camera controller to work.
EDIT: It also seems like the camera controller itself (without the custom input plugin from the examples) never actually interacts with bevy_picking, as stated in the module level docs and the docs of PanOrbitCamera.
I feel like these docs should be revised and mention the fact that no officially endorsed input plugin for the camera controller exists, and that the bevy examples showcase an input plugin that uses bevy_picking, until a proper input plugin exists as planned in https://github.com/bevyengine/bevy/issues/25458.
- Dominant language
- Rust
- Stars
- 49.3k
- Forks
- 5k
- Avg merge
- 4d 8h
- Merged PRs (30d)
- 158
Getting set up
- No Dockerfile or Docker Compose file
- Has a pull request template
- Read the contributing guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
More from bevyengine/bevy
-
A-Rendering C-Bug C-Performance S-Ready-For-Implementation
Difficulty 2/5 1-3 hours Newbie friendliness 78/100
bevyengine/bevy#26283 · 5 comments ·
Maintainers usually reply within 2 days
-
A-Dev-Tools C-Bug D-Straightforward S-Ready-For-Final-Review X-Uncontroversial
Difficulty 1/5 Under an hour Newbie friendliness 87/100
bevyengine/bevy#26275 · 1 comment ·
Maintainers usually reply within 2 days
-
Feathers number input keeps its editing text when editing ends without a changePossibly taken @femii1234 claimed this 6 days ago. OpenA-UI C-Bug D-Trivial S-Needs-Review
Difficulty 2/5 1-3 hours Newbie friendliness 72/100
bevyengine/bevy#26202 · 1 comment ·
Maintainers usually reply within 2 days
-
C-Feature S-Needs-Triage
Difficulty 2/5 1-3 hours Newbie friendliness 65/100
bevyengine/bevy#26153 ·
Maintainers usually reply within 2 days
-
A-UI C-Bug S-Needs-Triage
Difficulty 2/5 1-3 hours Newbie friendliness 78/100
bevyengine/bevy#26125 ·
Maintainers usually reply within 2 days
Similar issues
-
needs triage
Difficulty 2/5 1-3 hours Newbie friendliness 65/100
Maintainers usually reply within 1 day
-
Difficulty 2/5 1-3 hours Newbie friendliness 65/100
-
Difficulty 2/5 1-3 hours Newbie friendliness 72/100
mozilla-services/syncstorage-rs#2715 ·
Maintainers usually reply within 1 day
-
Difficulty 1/5 Under an hour Newbie friendliness 70/100
-
documentation
Difficulty 1/5 Under an hour Newbie friendliness 82/100
physicsdolphin/nv-uefi-unlocker#53 · 4 reactions ·
Maintainers usually reply within 1 day