Consolidate Scene3D with ign-gazebo's GzScene3D

[chapulina]

We currently have 2 separate scene plugins in the Ignition ecosystem, one in ign-gui and one in ign-gazebo. The split into 2 scene plugins was something we did to move forward quickly, but the long-term goal is to combine those into a single plugin in a way that all Gazebo-independent features can be pushed into ign-gui so all downstream projects can take advantage of it and there's less duplication to maintain.

Some possible ways to achieve this:

• Move all Gazebo-specific features to separate plugins that interact with the 3D scene
• Make the ign-gui plugin extensible, similar to how we have ignition::gui::TransportPlotting and ignition::gazebo::Plotting.

[scpeters]

we are using the Scene3D plugin in the delphyne project and have noticed some errors when loading mesh materials, but I believe this has already been fixed in ign-gazebo, so I'm cross-porting the fix from ign-gazebo's SceneManager in #191

[ahcorde]

Related PRs

• MoveToHelper (ign-rendering) Include MoveTo Helper class to ign-rendering gz-rendering#311
• New Scene3D interface Consolidate scene3D with ign-gui #217
• New Scene3D plugin using the interface provided in ign-gui Consolidate scene3D with ign-gui gz-sim#798

[ahcorde]

@chapulina, I have been working in adding small plugins to ign-gazebo and ign-gui. I updated the ign-gazebo PR with some of the plugins.

• ign-gui

  • view_control Added Interactive view control plugin #231
  • Move to / follow Added camera tracking #226

• ign-gazebo

  • Select Added transform control and select entities GUI plugins gz-sim#854
  • Transform controls Added transform control and select entities GUI plugins gz-sim#854

[ahcorde]

I have created some branches to test this (Fortress). Because it requires some cherry picks:

• ign-gazebo https://github.com/ignitionrobotics/ign-gazebo/tree/ahcorde/6/scene_manager_test
• ign-gui https://github.com/ignitionrobotics/ign-gui/tree/ahcorde/6/new_scene_test

Run the demo:

ign gazebo --gui-config src/ign-gazebo/src/gui/gui.config shapes.sdf -v 4

[chapulina]

some branches to test this

Nice, I see the 3D scene is updated!

I assume all the plugins above should work with this combination of branches?

view_control #231

The ViewControl plugin is empty for me, no buttons

Move to / follow #226

Right-clicking the 3D scene doesn't give me a context menu to be able to choose these options.

Choosing them from the entity tree doesn't seem to work.

Select gazebosim/gz-sim#854

I can select entities on the 3D scene and they get highlighted, but I don't see them highlighted on the entity tree. The same for the other direction.

Transform controls gazebosim/gz-sim#854

They work if I:

1. Deselect all entities
2. Choose translate mode
3. Select entity

But don't work if I do:

1. Select entity
2. Choose translate mode

[ahcorde]

The ViewControl plugin is empty for me, no buttons

I called view_control but it's the plugin to move the camera with the mouse.

Right-clicking the 3D scene doesn't give me a context menu to be able to choose these options.

The Scene3D it's on ign-gui, the context menu is part of ignition-gazebo, I didn't find a way (yet) to modify the qml of the scene3d from ign-gazebo and include the.

[chapulina]

Outstanding issue:

• How to choose what camera plugins are being attached to, see Added Interactive view control plugin #231 (comment))

[chapulina]

Main PRs splitting the functionality:

• Split transport scene manager into a plugin outside Scene3D #221
• New scene manager GUI plugin that works with ign-gui's MinimalScene gz-sim#813
• Added camera tracking #226
• Added Interactive view control plugin #231
• Added MarkerManager Plugin  #247
• Added transform control and select entities GUI plugins gz-sim#854
• Added VisualizationCapabilities plugin gz-sim#988
• Make Video recorder plugin work with MinimalScene gz-sim#900
• Added Spawn plugin gz-sim#983
• Make ViewAngle work with MinimalScene gz-sim#1016
• Use MinimalScene by default gz-sim#1014

TODO

• Drag & drop from Fuel / meshes
• Context menu
• Port rendering fixes from GzScene3D to MinimalScene, such as Fix race condition when rendering the UI gz-sim#774
• Choose a render engine from the command line (this information needs to be sent to MinimalScene before it creates a scene.)

[ahcorde]

Drag & drop

• ign-gui PR Added drop event #282
• Still a branch https://github.com/ignitionrobotics/ign-gazebo/tree/ahcorde/plugin%2Fdrop_from_fuel

Context Menu

• Added in this draft PR Use MinimalScene by default gz-sim#1014

Port rendering fixes from GzScene3D to MinimalScene

• Added in this draft PR Use MinimalScene by default gz-sim#1014
• Fix race condition when rendering the UI #285

[ahcorde]

Choose a render engine from the command line (this information needs to be sent to MinimalScene before it creates a scene.)

• Fix minimal scene render engine gui name from command line arg gz-sim#1034
• Fix render engine GUI name argument to be setted in the minimal scene #286

[ahcorde]

@chapulina can we consider this as done ?

[chapulina]

Yes! 🎉