Skip to content
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

Provide keyboard/mouse/touch-pad/touch-screen instructions #320

Open
EricBoix opened this issue Mar 23, 2022 · 0 comments
Open

Provide keyboard/mouse/touch-pad/touch-screen instructions #320

EricBoix opened this issue Mar 23, 2022 · 0 comments
Labels
documentation enhancement examples This issue require changes in examples priority-high @ud-viz This issue requires changes in the mono repo
Milestone

Comments

@EricBoix
Copy link
Contributor

EricBoix commented Mar 23, 2022

Provide a widget (this could complement the about button?) that graphically and synthetically
documents the usages of the keyboard, mouse, touch-pad, touch-screen when interaction with
an UD-Viz scene.

In the keyboard section of that GUI documentation, don't forget to document the "point-and-space-bar"
feature.

Leave it to the application to start with this documentation displayed (requiring a action to close the sub-window) or not (just as the About does it)..

Notes

Interaction modes: fly-mode vs game-mode

Because UD-Viz blends two categories of users, they are probably implicitly two interactions modes:

  • a (kind of) fly mode: only the mouse is used to go forth and back in the scene (following the
    axis of of the camera) and turning around (the camera)
  • a game mode where
    • keyboard decides where to move (forth/back and sideways), jump, dodge ,run...
    • the mouse decides where to look at (direction of the camera)

Document the existence of those modes, offer a mode-toggle key and document everything.

Inspiration sources

UD-Viz documentation already has the following picture in docs/static/Doc/User/Pictures/UserDoc/controls.PNG

drawing

The following image source was lost (and might be copyrighted): take some inspiration but do not import it as-is within UD-Viz:
in this example
.

@EricBoix EricBoix modified the milestones: Not sorted out yet, Q2-2022 Mar 23, 2022
@DiegoVinasco DiegoVinasco added itowns This issue required changes in itowns priority-high documentation labels Jun 30, 2022
@valentinMachado valentinMachado added enhancement @ud-viz/browser @ud-viz This issue requires changes in the mono repo and removed enhancement itowns This issue required changes in itowns labels May 9, 2023
@valentinMachado valentinMachado added the examples This issue require changes in examples label Dec 6, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation enhancement examples This issue require changes in examples priority-high @ud-viz This issue requires changes in the mono repo
Projects
Development

No branches or pull requests

3 participants