Skip to content

Commit 293a977

Browse files
ign -> gz Namespace Migration : sdformat (#1022)
* Migrate namespaces Signed-off-by: methylDragon <methylDragon@gmail.com> * Add migration line Signed-off-by: methylDragon <methylDragon@gmail.com> * Migrate includes to gz Signed-off-by: methylDragon <methylDragon@gmail.com> * Mention gz headers in migration Signed-off-by: methylDragon <methylDragon@gmail.com> * Update config.hh and migrate Export.hh macros Signed-off-by: methylDragon <methylDragon@gmail.com> * Migrate namespaces Signed-off-by: methylDragon <methylDragon@gmail.com> * Greedy macro migration Signed-off-by: methylDragon <methylDragon@gmail.com> * Migrate more namespaces Signed-off-by: methylDragon <methylDragon@gmail.com> * `ignitionrobotics` -> `gazebosim` and `Ignition Robotics` -> `Gazebo` Signed-off-by: methylDragon <methylDragon@gmail.com> * Update github links Signed-off-by: methylDragon <methylDragon@gmail.com> * Add in and migrate material forward ports Signed-off-by: methylDragon <methylDragon@gmail.com> * gz for new tests Signed-off-by: Louise Poubel <louise@openrobotics.org> Co-authored-by: Louise Poubel <louise@openrobotics.org>
1 parent 8a9c631 commit 293a977

245 files changed

Lines changed: 2917 additions & 2893 deletions

File tree

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

.github/ci/before_cmake.sh

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@ BUILD_DIR=`pwd`
77
cd /tmp
88

99
# check that we can compile USD from sources (only Focal)
10-
# see https://github.com/ignitionrobotics/sdformat/issues/869
10+
# see https://github.com/gazebosim/sdformat/issues/869
1111
return_code=0
1212
if [ "$(lsb_release -r -s)" != "20.04" ]; then
1313
return_code=$(($return_code + 1))

CMakeLists.txt

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -65,7 +65,7 @@ if (BUILD_SDF)
6565

6666
#################################################
6767
# Find ign command line utility:
68-
find_program(IGN_PROGRAM ign)
68+
find_program(GZ_PROGRAM ign)
6969

7070
#################################################
7171
# Copied from catkin/cmake/empy.cmake

CODE_OF_CONDUCT.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -56,7 +56,7 @@ further defined and clarified by project maintainers.
5656
## Enforcement
5757

5858
Instances of abusive, harassing, or otherwise unacceptable behavior may be
59-
reported by contacting the project team at [https://ignitionrobotics.org/support](https://ignitionrobotics.org/support). All
59+
reported by contacting the project team at [https://gazebosim.org/support](https://gazebosim.org/support). All
6060
complaints will be reviewed and investigated and will result in a response that
6161
is deemed necessary and appropriate to the circumstances. The project team is
6262
obligated to maintain confidentiality with regard to the reporter of an incident.

CONTRIBUTING.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,3 @@
11
See the
2-
[Ignition Robotics contributing guide](https://ignitionrobotics.org/docs/all/contributing)
2+
[Gazebo contributing guide](https://gazebosim.org/docs/all/contributing)
33
for how to contribute to SDFormat.

Changelog.md

Lines changed: 325 additions & 325 deletions
Large diffs are not rendered by default.

Migration.md

Lines changed: 45 additions & 35 deletions
Original file line numberDiff line numberDiff line change
@@ -12,6 +12,16 @@ forward programmatically.
1212
This document aims to contain similar information to those files
1313
but with improved human-readability..
1414

15+
## libsdformat 12.x to 13.x
16+
17+
### Deprecations
18+
19+
- The `ignition` namespace is deprecated and will be removed in future versions.
20+
Use `gz` instead.
21+
22+
- Header files under `ignition/...` are deprecated and will be removed in future versions.
23+
Use `gz/...` instead.
24+
1525
## libsdformat 11.x to 12.0
1626

1727
An error is now emitted instead of a warning for a file containing more than
@@ -65,8 +75,8 @@ one root level model, actor or light.
6575
+ void SetLocalModelName(const std::string &)
6676
+ const std::optional<bool> &IsStatic() const
6777
+ void SetIsStatic(bool)
68-
+ const std::optional<ignition::math::Pose3d> &IncludeRawPose() const
69-
+ void SetIncludeRawPose(const ignition::math::Pose3d &includeRawPose)
78+
+ const std::optional<gz::math::Pose3d> &IncludeRawPose() const
79+
+ void SetIncludeRawPose(const gz::math::Pose3d &includeRawPose)
7080
+ const std::optional<std::string> &IncludePoseRelativeTo() const
7181
+ void SetIncludePoseRelativeTo(const std::string &)
7282
+ const std::optional<std::string> &PlacementFrame() const
@@ -81,19 +91,19 @@ one root level model, actor or light.
8191
+ bool IgnoresParentElementAttribute() const;
8292

8393
1. **sdf/World.hh**:
84-
+ const ignition::math::SphericalCoordinates * SphericalCoordinates() const;
85-
+ void SetSphericalCoordinates(const ignition::math::SphericalCoordinates &);
94+
+ const gz::math::SphericalCoordinates * SphericalCoordinates() const;
95+
+ void SetSphericalCoordinates(const gz::math::SphericalCoordinates &);
8696

8797
### Modifications
8898

89-
1. **sdf/Element.hh**: The following methods now have an additional parameter of
99+
1. **sdf/Element.hh**: The following methods now have an additional parameter of
90100
type `PrintConfig` with a default value
91101
+ void PrintValues(std::string, const PrintConfig &\_config = PrintConfig()) const
92102
+ void PrintValues(const std::string, bool, bool, const PrintConfig &\_config = PrintConfig()) const
93103
+ std::string ToString(const std::string &, const PrintConfig &\_config = PrintConfig()) const
94104
+ std::string ToString(const std::string &, bool, bool ,const PrintConfig &\_config = PrintConfig()) const
95105

96-
1. **sdf/Param.hh**: The following methods now have an additional parameter of
106+
1. **sdf/Param.hh**: The following methods now have an additional parameter of
97107
type `PrintConfig` with a default value
98108
+ std::string GetAsString(const PrintConfig &\_config = PrintConfig()) const
99109
+ std::string GetDefaultAsString(const PrintConfig &\_config = PrintConfig()) const
@@ -103,14 +113,14 @@ one root level model, actor or light.
103113
The following now has an additional bool parameter
104114
+ bool SetFromString(const std::string &, bool \_ignoreParentAttributes);
105115

106-
1. **sdf/SDFImpl.hh**: The following methods now have an additional parameter of
116+
1. **sdf/SDFImpl.hh**: The following methods now have an additional parameter of
107117
type `PrintConfig` with a default value
108118
+ void PrintValues(const PrintConfig &\_config = PrintConfig())
109119
+ std::string ToString(const PrintConfig &\_config = PrintConfig()) const
110120

111-
1. The string literals used to indicate non-file sources have been changed to
112-
`<data-string>` and `<urdf-string>` for SDFormat and URDF source
113-
respectively. Users are encouraged to use the constants `kSdfStringSource`
121+
1. The string literals used to indicate non-file sources have been changed to
122+
`<data-string>` and `<urdf-string>` for SDFormat and URDF source
123+
respectively. Users are encouraged to use the constants `kSdfStringSource`
114124
and `kUrdfStringSource` instead of hard-coding the string literals.
115125

116126
### Removals
@@ -141,8 +151,8 @@ The following deprecated methods and classes have been removed.
141151

142152
### Deprecations
143153

144-
1. **sdf/InterfaceElements.hh**: The struct `NestedInclude` has been converted
145-
to a class. Accessing data members directly is deprecated. Instead use the
154+
1. **sdf/InterfaceElements.hh**: The struct `NestedInclude` has been converted
155+
to a class. Accessing data members directly is deprecated. Instead use the
146156
corresponding member functions.
147157

148158
## libsdformat 11.1.0 to 11.2.0
@@ -256,8 +266,8 @@ ABI was broken for `sdf::Element`, and restored on version 11.2.1.
256266
+ [Pull request 276](https://github.com/osrf/sdformat/pull/276)
257267

258268
1. + Removed the deprecated `Pose()`, `SetPose()`, and `*PoseFrame()` API's in all DOM classes:
259-
+ const ignition::math::Pose3d &Pose()
260-
+ void SetPose(const ignition::math::Pose3d &)
269+
+ const gz::math::Pose3d &Pose()
270+
+ void SetPose(const gz::math::Pose3d &)
261271
+ const std::string &PoseFrame()
262272
+ void SetPoseFrame(const std::string &)
263273

@@ -332,7 +342,7 @@ ABI was broken for `sdf::Element`, and restored on version 11.2.1.
332342
+ sdf::SemanticPose SemanticPose() const
333343

334344
1. **sdf/JointAxis.hh**
335-
+ Errors ResolveXyz(ignition::math::Vector3d &, const std::string &) const
345+
+ Errors ResolveXyz(gz::math::Vector3d &, const std::string &) const
336346

337347
1. **sdf/Light.hh**
338348
+ sdf::SemanticPose SemanticPose() const
@@ -384,12 +394,12 @@ ABI was broken for `sdf::Element`, and restored on version 11.2.1.
384394
+ ***Replacement:*** None. Use the functions sdf::readFile or sdf::readString, which automatically convert URDF to SDFormat.
385395

386396
1. All DOM classes with `Pose()` and `PoseFrame()` API's:
387-
+ ***Deprecation:*** const ignition::math::Pose3d &Pose()
388-
+ ***Replacement:*** const ignition::math::Pose3d &RawPose()
397+
+ ***Deprecation:*** const gz::math::Pose3d &Pose()
398+
+ ***Replacement:*** const gz::math::Pose3d &RawPose()
389399
+ ***Deprecation:*** const std::string &PoseFrame()
390400
+ ***Replacement:*** const std::string &PoseRelativeTo()
391-
+ ***Deprecation:*** void SetPose(const ignition::math::Pose3d &)
392-
+ ***Replacement:*** void SetRawPose(const ignition::math::Pose3d &)
401+
+ ***Deprecation:*** void SetPose(const gz::math::Pose3d &)
402+
+ ***Replacement:*** void SetRawPose(const gz::math::Pose3d &)
393403
+ ***Deprecation:*** void SetPoseFrame(const std::string &)
394404
+ ***Replacement:*** void SetPoseRelativeTo(const std::string &)
395405

@@ -418,7 +428,7 @@ ABI was broken for `sdf::Element`, and restored on version 11.2.1.
418428

419429
1. **sdf/Types.hh**
420430
+ ***Deprecated:*** sdf::Color class
421-
+ ***Replacement:*** ignition::math::Color class
431+
+ ***Replacement:*** gz::math::Color class
422432

423433
## SDFormat 4.x to 5.x
424434

@@ -448,15 +458,15 @@ ABI was broken for `sdf::Element`, and restored on version 11.2.1.
448458

449459
1. **sdf/Types.hh**
450460
+ ***Deprecation:*** sdf::Vector2i
451-
+ ***Replacement:*** ignition::math::Vector2i
461+
+ ***Replacement:*** gz::math::Vector2i
452462
+ ***Deprecation:*** sdf::Vector2d
453-
+ ***Replacement:*** ignition::math::Vector2d
463+
+ ***Replacement:*** gz::math::Vector2d
454464
+ ***Deprecation:*** sdf::Vector3
455-
+ ***Replacement:*** ignition::math::Vector3d
465+
+ ***Replacement:*** gz::math::Vector3d
456466
+ ***Deprecation:*** sdf::Quaternion
457-
+ ***Replacement:*** ignition::math::Quaterniond
467+
+ ***Replacement:*** gz::math::Quaterniond
458468
+ ***Deprecation:*** sdf::Pose
459-
+ ***Replacement:*** ignition::math::Pose3d
469+
+ ***Replacement:*** gz::math::Pose3d
460470

461471
## SDFormat 3.x to 4.x
462472

@@ -481,35 +491,35 @@ ABI was broken for `sdf::Element`, and restored on version 11.2.1.
481491
### Additions
482492

483493
1. **camera.sdf**: New elements to configure segmentation and boundingbox cameras
484-
+ `//sensor/camera/segmentation_type`
494+
+ `//sensor/camera/segmentation_type`
485495
+ `//sensor/camera/box_type`
486-
+ [Pull request #592](https://github.com/ignitionrobotics/sdformat/pull/592)
496+
+ [Pull request #592](https://github.com/gazebosim/sdformat/pull/592)
487497

488498
1. **forcetorque.sdf**: New elements to specify the noise characteristics of the force-torque sensor
489499
+ `//sensor/force_torque/force`
490-
+ `//sensor/force_torque/torque`
491-
+ [Pull request #669](https://github.com/ignitionrobotics/sdformat/pull/669)
500+
+ `//sensor/force_torque/torque`
501+
+ [Pull request #669](https://github.com/gazebosim/sdformat/pull/669)
492502

493503
1. **model.sdf**: `//model/include/@merge` for merging included nested models into the containing model
494-
+ [Pull request #659](https://github.com/ignitionrobotics/sdformat/pull/659)
504+
+ [Pull request #659](https://github.com/gazebosim/sdformat/pull/659)
495505

496506
1. **pose.sdf**: New attributes to support specifying angles in degrees and specifying rotations in quaternions
497507
+ `//pose/@rotation_format`
498508
+ `//pose/@degrees`
499-
+ [Pull request #690](https://github.com/ignitionrobotics/sdformat/pull/690)
500-
+ [Pull request #589](https://github.com/ignitionrobotics/sdformat/pull/589)
509+
+ [Pull request #690](https://github.com/gazebosim/sdformat/pull/690)
510+
+ [Pull request #589](https://github.com/gazebosim/sdformat/pull/589)
501511

502512
1. **sensor.sdf**: New sensor types `boundingbox_camera`, `segmentation_camera`, and `custom`.
503-
+ [Pull request #592](https://github.com/ignitionrobotics/sdformat/pull/592)
513+
+ [Pull request #592](https://github.com/gazebosim/sdformat/pull/592)
504514

505515
### Removals
506516

507517
1. **joint.sdf**
508518
+ Deprecated elements `//joint/axis/initial_position` and `//joint/axis2/initial_position` have been removed
509-
* [Pull request #622](https://github.com/ignitionrobotics/sdformat/pull/622)
519+
* [Pull request #622](https://github.com/gazebosim/sdformat/pull/622)
510520

511521
1. **spherical_coordinates**: Unsupported options `NED` and `NWU` have been removed from `//spherical_coordinates/world_frame_orientation`
512-
* [Pull request #685](https://github.com/ignitionrobotics/sdformat/pull/685)
522+
* [Pull request #685](https://github.com/gazebosim/sdformat/pull/685)
513523

514524
## SDFormat specification 1.7 to 1.8
515525

README.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -32,7 +32,7 @@ TODO(eric.cousineau): Move terminology section to sdf_tutorials?
3232
## Test coverage
3333

3434
<!-- Note: The branch name in the codecov URL should be updated when forward porting -->
35-
[![codecov](https://codecov.io/gh/ignitionrobotics/sdformat/branch/main/graph/badge.svg)](https://codecov.io/gh/ignitionrobotics/sdformat/branch/main)
35+
[![codecov](https://codecov.io/gh/gazebosim/sdformat/branch/main/graph/badge.svg)](https://codecov.io/gh/gazebosim/sdformat/branch/main)
3636

3737
# Installation
3838

@@ -143,7 +143,7 @@ make uninstall
143143

144144
Clone the repository
145145
```sh
146-
git clone https://github.com/ignitionrobotics/sdformat -b sdf<#>
146+
git clone https://github.com/gazebosim/sdformat -b sdf<#>
147147
```
148148
Be sure to replace `<#>` with a number value, such as 1 or 2, depending on
149149
which version you need.

doc/header.html

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -41,7 +41,7 @@ <h2 style="text-align:center;">
4141
<dd><a href="http://sdf.com/wiki/Tutorials">Tutorials</a></dd>
4242
<dd><a href="http://sdf.com/downloads.html">Download</a></dd>
4343
-->
44-
<dd><a href="https://github.com/ignitionrobotics/sdformat/issues/new">Report Documentation Issues</a></dd>
44+
<dd><a href="https://github.com/gazebosim/sdformat/issues/new">Report Documentation Issues</a></dd>
4545
</dl>
4646
</div>
4747
<div>

doc/mainpage.html

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@
55
Desctiption Format API. The code reference is divided into the groups below.
66
Should you find problems with this documentation - typos, unclear phrases,
77
or insufficient detail - please create a <a
8-
href="https://github.com/ignitionrobotics/sdformat/issues/new">new GitHub issue</a>.
8+
href="https://github.com/gazebosim/sdformat/issues/new">new GitHub issue</a>.
99
Include sufficient detail to quickly locate the problematic documentation,
1010
and set the issue's fields accordingly: Assignee - blank; Kind - bug;
1111
Priority - minor; Version - blank.

examples/python/README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@
33
This example shows how to use sdformat's Python API.
44

55
In the
6-
[examples/python](https://github.com/ignitionrobotics/sdformat/blob/main/examples/python)
6+
[examples/python](https://github.com/gazebosim/sdformat/blob/main/examples/python)
77
folder there is a Python script that shows how to make use of this API.
88

99
> If you compiled sdformat from source you should modify your `PYTHONPATH`:

0 commit comments

Comments
 (0)