Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Joint naming inconsistency in Drake API #20841

Open
sherm1 opened this issue Jan 30, 2024 · 2 comments
Open

Joint naming inconsistency in Drake API #20841

sherm1 opened this issue Jan 30, 2024 · 2 comments
Assignees
Labels
component: multibody plant MultibodyPlant and supporting code type: cleanup

Comments

@sherm1
Copy link
Member

sherm1 commented Jan 30, 2024

(Capturing review discussion from #20827)

We have BallRpyJoint, QuaternionFloatingJoint, and RpyFloatingJoint (per #14949). Likely we'll have BallQuaternionJoint in the future.

The ideal names IMO would have been BallRpy, BallQuaternion, FloatingRpy, and FloatingQuaternion because then the joint variants would alphabetize together. We could move that way by renaming the existing floating joint to floating_quaternion_joint. But is this really going to solve any user problems? I'm guessing that people are able to find the joints they need. And the floating joints are most often added automatically under the covers without the user needing to name them.

Ideally we would name all the Drake joints consistently. However, my feeling now is that it isn't really worth the pain to rename existing joints. It may be enough to have Ball{Rpy,Quaternion}Joint and {Rpy,Quaternion}FloatingJoint.

I'm leaning towards "won't fix", but this is open for discussion.

@jwnimmer-tri
Copy link
Collaborator

I agree with "won't fix".

@amcastro-tri
Copy link
Contributor

The other option not mentioned here is to go from BallRpyJoint to RpyBallJoint so that all names are consistent. I agree this low priority though and I'd be ok with closing.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
component: multibody plant MultibodyPlant and supporting code type: cleanup
Projects
None yet
Development

No branches or pull requests

3 participants