1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95
|
# Migration Guide for SDFormat Specification
This document contains information about migrating
between different versions of the SDFormat specification.
The SDFormat specification version number is specified in the `version` attribute
of the `sdf` element (1.4, 1.5, 1.6, etc.)
and is distinct from libsdformat library version
(2.3, 3.0, 4.0, etc.).
# Note on backward compatibility
There are `*.convert` files that allow old sdf files to be migrated
forward programmatically.
This document aims to contain similar information to those files
but with improved human-readability.
## SDFormat specification 1.6 to 1.7
## SDFormat specification 1.5 to 1.6
### Additions
1. **heightmap_shape.sdf** `sampling` element
+ description: Samples per heightmap datum.
For rasterized heightmaps, this indicates the number of samples to take per pixel.
Using a lower value, e.g. 1, will generally improve the performance
of the heightmap but lower the heightmap quality.
+ type: unsigned int
+ default: 2
+ required: 0
+ [Bitbucket pull request 293](https://osrf-migration.github.io/sdformat-gh-pages/#!/osrf/sdformat/pull-requests/293)
1. **link.sdf** `enable_wind` element
+ description: If true, the link is affected by the wind
+ type: bool
+ default: false
+ required: 0
+ [Bitbucket pull request 240](https://osrf-migration.github.io/sdformat-gh-pages/#!/osrf/sdformat/pull-requests/240)
1. **model.sdf** `enable_wind` element
+ description: If set to true, all links in the model
will be affected by the wind.
Can be overriden by the link wind property.
+ type: bool
+ default: false
+ required: 0
+ [Bitbucket pull request 240](https://osrf-migration.github.io/sdformat-gh-pages/#!/osrf/sdformat/pull-requests/240)
1. **model_state.sdf** `scale` element
+ description: Scale for the 3 dimensions of the model.
+ type: vector3
+ default: "1 1 1"
+ required: 0
+ [Bitbucket pull request 246](https://osrf-migration.github.io/sdformat-gh-pages/#!/osrf/sdformat/pull-requests/246)
1. **physics.sdf** `friction_model` element
+ description: Name of ODE friction model to use. Valid values include:
+ pyramid_model: (default) friction forces limited in two directions
in proportion to normal force.
+ box_model: friction forces limited to constant in two directions.
+ cone_model: friction force magnitude limited in proportion to normal force.
See [gazebo pull request 1522](https://osrf-migration.github.io/gazebo-gh-pages/#!/osrf/gazebo/pull-request/1522)
(merged in [gazebo 8c05ad64967c](https://github.com/osrf/gazebo/commit/968dccafdfbfca09c9b3326f855612076fed7e6f))
for the implementation of this feature.
+ type: string
+ default: "pyramid_model"
+ required: 0
+ [Bitbucket pull request 294](https://osrf-migration.github.io/sdformat-gh-pages/#!/osrf/sdformat/pull-requests/294)
1. **world.sdf** `wind` element
+ description: The wind tag specifies the type and properties of the wind.
+ required: 0
+ [Bitbucket pull request 240](https://osrf-migration.github.io/sdformat-gh-pages/#!/osrf/sdformat/pull-requests/240)
1. **world.sdf** `wind::linear_velocity` element
+ description: Linear velocity of the wind.
+ type: vector3
+ default: "0 0 0"
+ required: 0
+ [Bitbucket pull request 240](https://osrf-migration.github.io/sdformat-gh-pages/#!/osrf/sdformat/pull-requests/240)
### Modifications
1. `gravity` and `magnetic_field` elements are moved
from `physics` to `world`
+ [Bitbucket pull request 247](https://osrf-migration.github.io/sdformat-gh-pages/#!/osrf/sdformat/pull-requests/247)
+ [gazebo pull request 2090](https://osrf-migration.github.io/gazebo-gh-pages/#!/osrf/gazebo/pull-requests/2090)
1. A new style for representing the noise properties of an `imu` was implemented
in [Bitbucket pull request 199](https://osrf-migration.github.io/sdformat-gh-pages/#!/osrf/sdformat/pull-requests/199)
for sdf 1.5 and the old style was declared as deprecated.
The old style has been removed from sdf 1.6 with the conversion script
updating to the new style.
+ [Bitbucket pull request 199](https://osrf-migration.github.io/sdformat-gh-pages/#!/osrf/sdformat/pull-requests/199)
+ [Bitbucket pull request 243](https://osrf-migration.github.io/sdformat-gh-pages/#!/osrf/sdformat/pull-requests/243)
+ [Bitbucket pull request 244](https://osrf-migration.github.io/sdformat-gh-pages/#!/osrf/sdformat/pull-requests/244)
|