Skip to content

Commit

Permalink
Add highlight for specifying plugins in SDF without overriding default
Browse files Browse the repository at this point in the history
plugins

Signed-off-by: Addisu Z. Taddese <[email protected]>
  • Loading branch information
azeey committed Sep 23, 2024
1 parent 932268b commit b1d8755
Show file tree
Hide file tree
Showing 2 changed files with 55 additions and 1 deletion.
52 changes: 51 additions & 1 deletion highlights.md
Original file line number Diff line number Diff line change
Expand Up @@ -42,7 +42,6 @@
convex decomposition to split the mesh into multiple submeshes.
Example SDF usage:


```xml
<collision>
<mesh optimization="convex_decomposition">
Expand All @@ -55,6 +54,57 @@
</collision>
```

- [Support specifying plugins in SDF files without overriding default
plugins](https://github.com/gazebosim/gz-sim/pull/2497) and [gz-gui#631](https://github.com/gazebosim/gz-gui/pull/631)

- In prior Gazebo versions, if a user specified a server plugin at the
world level, it would override all default plugins. This required
users to have in-depth knowledge and specify every plugin necessary
for a simulation to run correctly. Omitting critical plugins would
lead to unexpected simulation behavior, causing confusion,
particularly for new Gazebo users.

- Gazebo Ionic addresses this issue by loading default plugins even when
users specify additional plugins. Gazebo Ionic also introduces
`<gz:policy>` settings to revert this behavior to how it functioned in
previous Gazebo versions, if desired. For example, the
`contact_sensor.sdf` example can now include just the additional Contact
system:

```xml
<world name="contact_sensor">
<plugin filename="gz-sim-contact-system" name="gz::sim::systems::Contact"/>
...
</world>

```

whereas previously, the SDF file has all the default plugins:

```xml
<world name="contact_sensor">
<plugin
filename="gz-sim-physics-system"
name="gz::sim::systems::Physics">
</plugin>
<plugin
filename="gz-sim-contact-system"
name="gz::sim::systems::Contact">
</plugin>
<plugin
filename="gz-sim-user-commands-system"
name="gz::sim::systems::UserCommands">
</plugin>
<plugin
filename="gz-sim-scene-broadcaster-system"
name="gz::sim::systems::SceneBroadcaster">
</plugin>

...
</world>

```

## Bug Fixes

## Breaking Changes
Expand Down
4 changes: 4 additions & 0 deletions release_notes.md
Original file line number Diff line number Diff line change
Expand Up @@ -32,11 +32,15 @@

- [Adds new function in MeshManager for performing convex decomposition](https://github.com/gazebosim/gz-common/pull/585)

## gazebosim/gz-gui:

- [Add a flexible mechanism to combine user and default plugins](https://github.com/gazebosim/gz-gui/pull/631)

## gazebosim/gz-sim:

- [Support visualizing mesh collisions with convex decomposition](https://github.com/gazebosim/gz-sim/pull/2352)
- [Support mesh optimization when using AttachMeshShapeFeature](https://github.com/gazebosim/gz-sim/pull/2417)
- [Add a flexible mechanism to combine user and default plugins](https://github.com/gazebosim/gz-sim/pull/2497)


## gazebosim/sdformat:
Expand Down

0 comments on commit b1d8755

Please sign in to comment.