Project AngelHUD #2490

ohlidalp · 2020-03-04T10:18:18Z

This is a replacement for our MyGUI-based custom HUD system. Goal: Allow modders to create and test custom vehicle HUD in-game using AngelScript + DearIMGUI.

User scenario:

enter simulation and create a project using top menubar. Projects are created in "MyDocuments\MyGames\RigsOfRods\projects" as subdirectories, each containing project JSON and truckfiles (dubbed snapshots). Unlike regular mods, all resources within a project are always fully reloaded from disk, allowing modder to add/remove/change data on the go.
add angelscript file to the truckfile using button "+ Add example script" in projects top menu. Details: Project AngelHUD #2490 (comment)
within the angelscript, define function int setup(string arg) to be invoked once and function int loop() to be invoked on each rendered frame.
within the angelscript function, draw the HUD using DearIMGUI, reading data from simbuffer (see example code). The simbuffer contains all data described in https://docs.rigsofrods.org/vehicle-creation/making-custom-hud/ and a lot more, allowing modder to create truly diagnostic GUI - DearIMGUI is packed with very capable widgets and a flexible drawing API. Graphical HUD can be done simply by calling ImGui::Image() with texture name.

Notes:

These scripts are executed separately from the classic RoR scripting subsystem - the "GameObject" interface is not available. The reason is multithreading - a script drawing HUD (or doing other visuals) should run on a rendering thread, while the classic scripts must run when both sim+rendering(main) threads are halted.

tritonas00 · 2020-03-04T10:29:31Z

Impressive! Why not use this logic to draw the default HUD also?

ohlidalp · 2020-03-04T10:36:43Z

I absolutely intend to do that - in fact, it's necessary because the default truck HUD is made via the MyGUI-based HUD system, so it must go away before we port to OGRE 1.12. The airplane HUD, in contrast, is hardcoded, which is also not optimal.

I'll also make ImGui available to terrain scripts - custom race scoreboards etc...

CuriousMike56 · 2020-03-05T03:17:40Z

Pretty sweet. Might be a bit of a stretch, but would vehicles dashboards be able to draw IMGUI? (similar to renderdash). Would be awesome to finally be able to create digital dashboards.

ohlidalp · 2020-03-05T22:49:08Z

@CuriousMike56 Not at all, in fact it's mandatory since the current MyGUI-HUD can also render to texture and some mods rely on it. Not to mention I want the feature, too. It should be pretty straightforward to implement.

I added initial bindings to SimBuffer - most of these fields are available, see screenshot on top or commit message for example use.

tritonas00 · 2020-03-06T16:22:51Z

Got this warning when compiling

In file included from /home/babis/Downloads/ror-dependencies/rigs-of-rods/source/main/cotire/RoR_CXX_prefix.cxx:39,
                 from /home/babis/Downloads/ror-dependencies/rigs-of-rods/source/main/cotire/RoR_CXX_prefix.hxx:4:
/home/babis/Downloads/ror-dependencies/rigs-of-rods/source/main/scripting/ImGuiAngelscript.cpp: In lambda function:
/home/babis/Downloads/ror-dependencies/rigs-of-rods/source/main/scripting/ImGuiAngelscript.cpp:169:35: warning: cast to pointer from integer of different size [-Wint-to-pointer-cast]
  169 |         ImGui::Image((ImTextureID)u, ImVec2(v.x, v.y));

ohlidalp · 2020-03-06T20:21:25Z

@tritonas00 Something goes wrong outside AngelScript, otherwise you'd see more detailed error messages from AngelScript itself. I'll tighten the surrounding checks and fix the warning.
EDIT - I just noticed it - you must use int loop(GfxActor@) as in the 2nd screenshot, the 1st is outdated. AngelScript doesn't report anything because the failing operation is RoR trying to find the function by signature. I'll add a console message for that.

tritonas00 · 2020-03-06T20:46:02Z

Yes it works now, thanks!

Epic! Now need to find a way to use data.engine_rpm as an imgui histogram or progressbar input lol

Also @only-a-ptr have you seen this? http://floooh.github.io/oryol-sticky-tests/imgui-highdpi-sapp.html

ohlidalp · 2020-03-07T12:04:48Z

I ❤️ AngelScript! I just register the internals 1:1 and it... just works. ☺️

ohlidalp · 2020-03-14T19:11:06Z

I added an in-game example script. When you load a project-truck and click the "+ add example script" button in the projects menu, RoR will put the script to the project directory, assign it to the truck and reload the truck to activate it.

ohlidalp · 2020-03-18T23:52:17Z

ohlidalp · 2020-03-19T12:05:44Z

@tritonas00 Segfault on import is fixed

tritonas00 · 2020-03-19T13:38:19Z

Oh god, you rock! 👏👏👏

tritonas00 · 2020-03-20T13:20:05Z

Default HUD layout remake is almost ready, missing the coding stuff (rotated needles, on/off statements) and i think some icons

ohlidalp · 2020-05-05T12:11:14Z

I'm on the way to add support for multiple fonts (meaning also multiple sizes of the same font) loadable via AngelScript (for dashboards). In the process I updated imgui to 1.75 (was: 1.50WIP) which caused some positioning glitches. I'll work it out.

Added directory ROR_HOME/projects. Each subdir contains 'project.json', resources (meshes, materials, textures) and one or more truckfiles. The ingame top menubar contains 'Projects' menu to spawn modified truckfiles and to import existing ones.

Status: import/export for nodes and beams Added option to accept all ; as ;grp:

Goal: Allow modders to create and test custom vehicle HUD in-game using AngelScript + DearIMGUI. User scenario: 1. enter simulation and create a project using top menubar. Projects are created in "MyDocuments\MyGames\RigsOfRods\projects" as subdirectories, each containing project JSON and truckfiles (dubbed snapshots). Unlike regular mods, all resources within a project are always fully reloaded from disk, allowing modder to add/remove/change data on the go. 2. add angelscript file to the truckfile via section 'scripts' (to be implemented) 3. within the angelscript, define a function to be invoked on each rendered frame. 4. within the angelscript function, draw the HUD using DearIMGUI (bindings partially implemented, see ImGuiAngelscript.cpp) reading data from simbuffer (bindings partially implemented, see GameScript.cpp). The simbuffer contains all data described in https://docs.rigsofrods.org/vehicle-creation/making-custom-hud/ and a lot more, allowing modder to create truly giagnostic GUI - DearIMGUI is packed by very capable widgets and a flexible drawing API. Graphical HUD can be done simply by calling ImGui::Image() with texture name. -- TEST SCRIPT -- int setup(string arg) { string msg; msg = "setup() works! arg: " + arg; log(msg); return 0; } int frame_num = 0; int loop() { string msg; msg = "Frame: " + frame_num; // Opens window "Debug" (DearIMGUI feat) ImGui::Text(msg); frame_num++; return 0; } -- TEST TRUCK -- scripts frame-step: test_script_filename.as, Any text (including spaces) passed to `setup()` as `arg`

// ----- Example script ----- int setup(string arg) { return 0; } int loop(GfxActor@ actor) { ImGui::Begin("SimBuffer test", true); ActorSimBuffer@ data = actor.GetSimDataBuffer(); string str; str = "Pos: X" + data.pos.x + ", Y" + data.pos.y + ", Z" + data.pos.z; ImGui::Text(str); ImGui::End(); return 0; }

Added enums PropAnim[Flag|Mode] - copypastes from BeamData.h but used for different purpose (rendering vs. simulation)

Also fixed "color" (Ogre::ColourValue) not registered properly.

@tritonas00

Thanks to @tritonas00 for the base layout.

Think of this as an excercise in understanding OGRE internals :) I'd like to use OGRE 1.12x's builtin imgui support, but it seems it only supports one font, and I'd like fonts to be loadable ad-hoc via AngelScript. Thus, I'm doing this middle-step where I copy OGRE code to RoR (see gui/imgui/README for all details) to experiment with it, develop a solution and contribute it back to OGRE.

ohlidalp · 2021-09-02T12:30:52Z

Superseded by #2709 (project directories), #2786 (imgui), #2788 (cvars) and #2750 (addons).

ohlidalp force-pushed the angelhud branch from 59e1aba to 55af75a Compare March 4, 2020 10:38

ohlidalp force-pushed the angelhud branch from 55af75a to 236491c Compare March 5, 2020 14:30

ohlidalp force-pushed the angelhud branch from e8b5744 to 54fdd6b Compare March 5, 2020 22:57

ohlidalp force-pushed the angelhud branch from 9d490ec to 2110d2d Compare March 18, 2020 23:50

ohlidalp closed this Mar 18, 2020

ohlidalp reopened this Mar 18, 2020

RigsOfRods deleted a comment from tritonas00 Mar 19, 2020

ohlidalp force-pushed the angelhud branch from 87751ae to 21aa50c Compare March 20, 2020 12:22

ohlidalp force-pushed the angelhud branch 3 times, most recently from 821bf36 to 025c0c1 Compare March 26, 2020 04:16

ohlidalp force-pushed the angelhud branch 3 times, most recently from 403bd35 to 8f49029 Compare May 5, 2020 12:05

ohlidalp added 2 commits May 8, 2020 19:06

✨ Added project directories

e0c0d5c

Added directory ROR_HOME/projects. Each subdir contains 'project.json', resources (meshes, materials, textures) and one or more truckfiles. The ingame top menubar contains 'Projects' menu to spawn modified truckfiles and to import existing ones.

✨ Truckfile: support for ';grp:NAME' grouping comments

20a8ea1

Status: import/export for nodes and beams Added option to accept all ; as ;grp:

ohlidalp added 22 commits May 8, 2020 19:07

📐 Introduced 'GfxData.h', moved VideoCamera

5702321

♻️ Factored-out 'struct prop_anim_t' from 'struct prop_t'

9d0e409

📐 Props moved to 'GfxData.h'

7cc3d21

Added enums PropAnim[Flag|Mode] - copypastes from BeamData.h but used for different purpose (rendering vs. simulation)

🔧 Added console msg if script lacks req. function(s)

9e7fab8

📐 Prop cleanup - fields renamed to standard

521a810

📐 GfxActor cleanup - misc structs moved to GfxData.h

f8f2df0

✨ AngelScript: CVar bindings

06d5726

📐 Rem. leftover code (old minimap)

1a32b66

📚 Added framestep demo script

be2522a

📚 Script 'framestep_demo.as': added SimBuf window

6bbe01a

📐 Rem. deadcode

76e474a

✨ AngelScript: ImGui::Draw() working with Ogre::Texture

797c1a5

✨ AngelScript: rotated image support with ImGui

78bd4ef

✨ AngelScript: Added ImGui color/window flags & IO

e24dc32

Also fixed "color" (Ogre::ColourValue) not registered properly.

📐 SimBuffer: Added initializers for everything

6730302

✨ Angelscript: Added left/right blinker to SimBuffer

ba32594

📜 Added prototype dashboard script

045f5ec

Thanks to @tritonas00 for the base layout.

✨ AngelScript: added ignition + starter to SimBuffer

bfe6611

📜 Prototyope dashboard: animated turbo gauge, parkbrake+headlight lamps

055b5a0

📜 Prototype dash script completed

7bc7b5e

ohlidalp force-pushed the angelhud branch 2 times, most recently from 5a0bc37 to 60f8419 Compare May 8, 2020 17:23

ohlidalp added 2 commits May 11, 2020 22:11

🐛 GUI fixes after DearIMGUI upgrade

ec32e37

ohlidalp force-pushed the angelhud branch from cbc2888 to ec32e37 Compare May 11, 2020 20:12

ohlidalp mentioned this pull request May 7, 2021

[Alpha!] Addon API #2750

Closed

ohlidalp closed this Sep 2, 2021

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Project AngelHUD #2490

Project AngelHUD #2490

ohlidalp commented Mar 4, 2020 •

edited

Loading

tritonas00 commented Mar 4, 2020

ohlidalp commented Mar 4, 2020 •

edited

Loading

CuriousMike56 commented Mar 5, 2020

ohlidalp commented Mar 5, 2020

tritonas00 commented Mar 6, 2020 •

edited

Loading

ohlidalp commented Mar 6, 2020 •

edited

Loading

tritonas00 commented Mar 6, 2020 •

edited

Loading

ohlidalp commented Mar 7, 2020

ohlidalp commented Mar 14, 2020 •

edited

Loading

ohlidalp commented Mar 18, 2020

ohlidalp commented Mar 19, 2020

tritonas00 commented Mar 19, 2020 •

edited

Loading

tritonas00 commented Mar 20, 2020 •

edited

Loading

ohlidalp commented May 5, 2020

ohlidalp commented Sep 2, 2021 •

edited

Loading

Project AngelHUD #2490

Project AngelHUD #2490

Conversation

ohlidalp commented Mar 4, 2020 • edited Loading

tritonas00 commented Mar 4, 2020

ohlidalp commented Mar 4, 2020 • edited Loading

CuriousMike56 commented Mar 5, 2020

ohlidalp commented Mar 5, 2020

tritonas00 commented Mar 6, 2020 • edited Loading

ohlidalp commented Mar 6, 2020 • edited Loading

tritonas00 commented Mar 6, 2020 • edited Loading

ohlidalp commented Mar 7, 2020

ohlidalp commented Mar 14, 2020 • edited Loading

ohlidalp commented Mar 18, 2020

ohlidalp commented Mar 19, 2020

tritonas00 commented Mar 19, 2020 • edited Loading

tritonas00 commented Mar 20, 2020 • edited Loading

ohlidalp commented May 5, 2020

ohlidalp commented Sep 2, 2021 • edited Loading

ohlidalp commented Mar 4, 2020 •

edited

Loading

ohlidalp commented Mar 4, 2020 •

edited

Loading

tritonas00 commented Mar 6, 2020 •

edited

Loading

ohlidalp commented Mar 6, 2020 •

edited

Loading

tritonas00 commented Mar 6, 2020 •

edited

Loading

ohlidalp commented Mar 14, 2020 •

edited

Loading

tritonas00 commented Mar 19, 2020 •

edited

Loading

tritonas00 commented Mar 20, 2020 •

edited

Loading

ohlidalp commented Sep 2, 2021 •

edited

Loading