opensim-org / opensim-core

SimTK OpenSim C++ libraries and command-line applications, and Java/Python wrapping.
https://opensim.stanford.edu
Apache License 2.0
800 stars 323 forks source link

Clean up OpenSim::PointForceDirection #3890

Closed adamkewley closed 2 months ago

adamkewley commented 2 months ago

Minor clean-up. The motivation for doing so is that I'm currently working on a new ForceEmitter base class, which can re-use PointForceDirection, rather than (e.g.) having to introduce its own point-force holding class.

Fixes issue N/A

Brief summary of changes

Testing I've completed

Looking for feedback on...

CHANGELOG.md (choose one)


This change is Reviewable

adamkewley commented 2 months ago

Do you think it's worth it to upgrade this to a Socket?

Not in this particular case: the class is a plain C++ class, rather than an OpenSim::Component, so it doesn't have (e.g.) the socket table that's used to store socket declarations - it's essentially an internal struct for the C++ API that seems to mostly just be used by GeometryPath

adamkewley commented 2 months ago

Thanks for the comments @nickbianco and @tkuchida - I've addressed them as best as possible, including rewriting some of the documentation.

Since this is a minor change, I'll go ahead and merge it, rather than doing multiple rounds