👼Script: OGRE bindings for editing scene, meshes and textures - with examples #3030

AngelScript API changes: + `ImGuiCond` enum + `ImGui::SetNextItemOpen()` func + `Ogre::Node` object + `Ogre::SceneNode` object Code changes: * CReadonlyScriptDictView moved to ScriptUtils.h * created CReadonlyScriptArrayView in ScriptUtils.h ogre_demo.as changes: * codechange: added class OgreInspector, draw funcs made methods. * ability to traverse scene node graph (using scenemanager.getRootSceneNode() and scenenode.getChildren())

….as' New script API: + `Ogre::MovableObject` + `Ogre::MovableObjectArray` - returned by `SceneNode::getAttachedObjects()` Codechanges: * CReadonlyScriptDictView - removed Get() funcs - useless here, this object stores only 1 predetermined object type. * CReadonlyScriptDictView + CReadonlyScriptArrayView: removed static const char* VALUE_DECL; using just a parameter to Register*() * OgreAngelscript.cpp: major tidy-up, new funcs use same style as old funcs, helpers moved among older helpers, base class regs extracted to `register*Base()` methods because the duplicity was growing and growing. * ogre_demo.as - added MovableObject listing under SceneNodes, added checkboxes to set Visibility and CastShadows of the movables.

See 'ogre_demo.as'

Updated ogre_demo.as to use it - look for the 'Character#0' scene node.

'ogre_demo.as' now has "Pose Demo" panel which loads up a character and draws anim controls.

* added `assert(r>=0)` where missing. * `TexturePtr` and `TextureManager` regs unified with the others * function `registerOgreTextureManager()` separated out from `registerOgreTexture()`

Added dummy namespace `AngelOgre` to avoid mixing up OGRE-AngelScript exports with actual C++ objects. * Doxyfile.conf.in upgraded using `doxygen -u` * MainPage.h - fixed warnings about "unknown command \My \Rigs" etc... unescaped slashes :)

New script API: * `class Ogre::OverlayManager` * `class Ogre::Overlay` * `class Ogre::OverlayElement` * `enum Ogre::GuiMetricsMode` * `enum Ogre::GuiHorizontalAlignment` New example script: example_ogre_overlays.as - a test script I used while developing, creates 1 "Panel" overlay with material "tracks/wheelface" and some GUI controls. # Conflicts: # source/main/scripting/bindings/OgreAngelscript.cpp

….as'

multiple fixes: clashing name of new element, missing PushID in lists which broke buttons, typos in detail tooltips.

This has no effect on rendering, it just helps users to diagnose the scene graph.

Prettier and more uniform object names - Helper func `ActorSpawner::ComposeName()` is now smarter, outputs nicer IDs and is used even more. This has no effect on rendering, it just helps users to diagnose the scene graph using the inspector script.

2 new example scripts. New script API: * `enum Ogre::RenderOperation` * `class Ogre::ManualObject` REF | NOCOUNT object type. This is castable to MovableObject. Official tutorial for Ogre::ManualObject: https://ogrecave.github.io/ogre/api/latest/manual-mesh-creation.html * Functions in OGRE SceneManager: `createManualObject()`, `getManualObject()`, `destroyManualObject()` * Extra feature: function `TerrainClass::getHeightAt()` for the MeshedConcrete example to work.

NOTE: the example script only blits to topmost mipmap, so to see the effect, you must be close to the object! This will be improved. New Angelscript API: * `game.loadImageResource(filename, rg)` - see GameScript.cpp & GameScriptAngelscript.cpp * `ImDrawList::AddImage()` - see ImGuiAngelscript.cpp * Ogre objects: `box; PixelBox; HardwarePixelBufferSharedPtr`, Texture functions `getBuffer(); getNumMipmaps()` Example code: ``` // src image Ogre::Image gSrcImg = game.loadImageResource("sign-roadnarrows.dds", "TexturesRG"); // dst texture Ogre::TexturePtr gDstTex = Ogre::TextureManager::getSingleton().load("character.dds", "TexturesRG"); // let the MAGIC happen Ogre::HardwarePixelBufferPtr pixbuf = gDstTex.getBuffer(/*cubemap face index:*/0, /*mipmap:*/0); Ogre::PixelBox srcPixbox = gSrcImg.getPixelBox(0,0); // getPixelBox(cubemapFaceIndex, mipmapIndex); box gDstBox; // where you want to put it. pixbuf.blitFromMemory(srcPixbox, gDstBox); ``` New/updated scripts: * new 'example_ogre_textureBlitting.as' - draws UI using GridViewer and lets user mouse-draw destination pixelbox. Hardcoded to use character.dds as destination. * 'gridviewer_utils.as' - added 'zoomMin' config, new func `screenToLocalPos()` to enable mouse-interactions with the viewed data.

… empty. The OGRE version we use (11.6) crashes anyway when normalheight parameter is blank, although for OGRE13+ it's supposed to be okay (regarding to Paroj @ GitterChat)

There are now 2 funcs: * `localToScreenPos()` - originally `projectPos()`, renamed to align with the below. * `screenToLocalPos()` - added recently to make texture-blitting example work.

Task 3/3 from RigsOfRods#3030. This means I can start writing a script to batch together terrain objects (meshes+textures) for performance - especially for Community Map New script API: * objects: `MeshPtr, SubMesh, MeshManager` * to get vert positions, use "array<vector3>@ __getVertexPositions()" on SubMesh * ditto for vert texcoords, note the extra index param because mesh can have more than 1 texcoord layer: "array<vector2>@ __getVertexTexcoords(uint index)" See example script "example_ogre_vertexData.as"

If you loaded a document with regions, their recorded character count would be stuck on the original value, so if you added/removed characters the folding would break. This was fixed. There is still a bug - orphan regions don't resurface as expected.

Problem: The `restoreRegionFoldStates()` didn't actually modify buffer, just restored the flag.

This introduces 'example_ogre_terrnBatcher.as' which shows how Mesh/Material API works and will evolve into a production tool. this will conclude RigsOfRods#3030. THE INTENDED USE of the future completed TERRN BATCHER: 1. You start with a list of OGRE SceneNodes - see green box. 2. you pick those you want to batch together - see orange box. 3. [WIP] The tool generates one mesh which contains all those picked (keeping position, scale and rotation) and cover them in single material containing all the textures. 4. [TBD] The tool remembers what batches were done as a 'schedule', and allows saving/loading the schedule as file. Modders can share and improve the schedules. 5. [TBD] Modders can launch the tool directly from .terrn2 and auto-execute a schedule on map load. 6. Profit

Problem: The character offsets weren't updated, so when you edited text above a folded region, it's content would come out corrupted after unfolding. This also factors out helper function `mergeCollectedFoldingRegionsWithExisting()` with extra commentary.

I really suspected the `array<dictionary> bufferLinesMeta` to be the culprit. When that was disproved, I thought collecting regions or merging region info could be it. Both were disproved too. To my surprise it was the `isChar()` helper. Profiling results [in microseconds] opening 'example_ogre_terrnBatcher.as': * Before: PROFILING analyzeBuffer(): total 205834us (CPU 206000us) regions 324us (CPU 0us) dict 15805us (CPU 17000us) merging 151us (CPU 1000us) * After: PROFILING analyzeBuffer() : total 32313us (CPU 32000us) regions 280us (CPU 0us) dict 15653us (CPU 16000us) merging 146us (CPU 0us)

… option.

// New Script API: // -- `BeamClass.getManagedMaterialNames()` -> `array<string>@` // -- `BeamClass.getManagedMaterialInstance()` -> `Ogre::MaterialPtr` // -- `Ogre::Pass.__getNamedConstants()` -> `array<string>@` // -- `Ogre::Pass.getFragmentProgramParameters()` -> `Ogre::GpuProgramParametersPtr` New internal API, `class Actor`: - getManagedMaterialInstance(const std::string& orig_name); --> Ogre::MaterialPtr - getManagedMaterialNames(); --> std::vector<std::string>

The 'example_ogre_terrnBatcher.as' script was updated - Use the new indexBuffer bindings - Perform merging of selected meshes (buggy at the moment) - Display an inline control for scene node visibility - useful to compare original vs. generated meshes

Script 'example_ogre_terrnBatcher.as' updates: - Added [dump] button to inspector scenegraph - tested to work also for ManualObjects - Fixed mesh generation (I forgot to offset indices for every new appended mesh) - Reduced debug outputs Code changes: - added RGN_LOGS, auto-created at startup (along with other resource groups) - the actor-dump code now uses RGN_LOGS - moved RGN_ defs from ResourceManager.h to Application.h

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

👼Script: OGRE bindings for editing scene, meshes and textures - with examples #3030

👼Script: OGRE bindings for editing scene, meshes and textures - with examples #3030

Commits on Mar 11, 2024