@@ -12,6 +12,16 @@ forward programmatically.
1212This document aims to contain similar information to those files
1313but 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
1727An 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
83931 . ** 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
2582681 . + 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
3343441 . ** sdf/JointAxis.hh**
335- + Errors ResolveXyz(ignition ::math::Vector3d &, const std::string &) const
345+ + Errors ResolveXyz(gz ::math::Vector3d &, const std::string &) const
336346
3373471 . ** 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
3863961 . 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
4194291 . ** 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
4494591 . ** 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
4834931 . ** 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
4884981 . ** 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
4935031 . ** 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
4965061 . ** 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
5025121 . ** 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
5075171 . ** 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
5115211 . ** 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
0 commit comments