Rename MultiSphereShape to MultiSphereConvexHullShape #865
Conversation
* MultiSphereShape is deprecated
| @@ -8,6 +8,8 @@ dart_add_core_sources(${srcs} ${detail_srcs}) | |||
|
|
|||
| # Generate header for this namespace | |||
| dart_get_filename_components(header_names "dynamics headers" ${hdrs}) | |||
| # TODO: remove below line once the files are completely removed. | |||
| list(REMOVE_ITEM header_names "MultiSphereShape.hpp") | |||
There was a problem hiding this comment.
This excludes MultiSphereShape.hpp from the generated header dart/dynamics/dynamics.hpp so that it suppresses the warning of including the deprecated header.
|
|
||
| }; | ||
|
|
||
| using MultiSphereShape = MultiSphereConvexHullShape; |
There was a problem hiding this comment.
I think we can also mark this using alias as deprecated:
Indicates that the use of the name or entity declared with this attribute is allowed, but discouraged for some reason. This attribute is allowed in declarations of classes, typedef-names, variables, non-static data members, functions, enumerations, and template specializations. A name declared non-deprecated may be redeclared deprecated. A name declared deprecated cannot be un-deprecated by redeclaring it without this attribute.
There was a problem hiding this comment.
We probably should stay with DART_DEPRECATED(...) until DART uses C++14 because [[deprecated]] is available since C++14.
By the way, maybe I'm missing something here, but it seems DART_DEPRECATED(...) is not available on typedef using using:
DART_DEPRECATED(6.2)
using MultiSphereShape = MultiSphereConvexHullShape; // can't compile
DART_DEPRECATED(6.2)
typedef MultiSphereConvexHullShape MultiSphereShape; // okayThere was a problem hiding this comment.
That might be true. That webpage only mentions typedef. While I generally favor using directives to typedefs, I am slightly in favor of using DART_DEPRECATED(6.2) typedef here since this is a temporary workaround that will only last until the next major revision.
This PR renames
MultiSphereShapetoMultiSphereConvexHullShapeas suggested in this comment.