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

Adds RollPitchYaw and Rotation bindings and Rust API #44

Merged

Conversation

francocipollone
Copy link
Contributor

@francocipollone francocipollone commented Mar 19, 2024

🎉 New feature

Goes on top of #43

Related to #11 #14 #17 #28

Checklist

  • Signed all commits for DCO
  • Added tests
  • Added example and/or tutorial
  • Updated documentation (as needed)
  • Updated migration guide (as needed)
  • Consider updating Python bindings (if it affects the public API)

Copy link
Contributor

@agalbachicar agalbachicar left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM

@@ -416,6 +416,91 @@ impl std::fmt::Debug for Quaternion {
}
}

/// This class represents the orientation between two arbitrary frames A and D
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Willing to reduce labor, shall we point code documentation to the C++ doxygen code instead of copy-pasting here all the stuff? I think it makes more sense given that it'll be a maintenance burden to have duplicated docs for the bindings. It just simply doesn't scale IMO.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Context:

  • With cargo the creation of the documentation is trivial. (cargo doc).
  • The cargo packages being pushed to crate.io automatically create online documentation at: https://docs.rs/

It is a trade-off at the end but I do see value on having populated documentation on the rust side even though it may require some extra effort for maintenance.

@francocipollone
Copy link
Contributor Author

I will proceed with this and merge it however we can tackle this discussion F2F.

@francocipollone francocipollone merged commit 64129f5 into francocipollone/more_math_covering Mar 25, 2024
3 checks passed
@francocipollone francocipollone deleted the francocipollone/rotation branch March 25, 2024 22:03
@francocipollone francocipollone restored the francocipollone/rotation branch March 25, 2024 22:05
@francocipollone francocipollone deleted the francocipollone/rotation branch March 25, 2024 22:08
francocipollone added a commit that referenced this pull request Mar 25, 2024
…dings (#43)

* Adds Vector4 bindings
* Adds FFI bindings for Matrix3.
* Adds Rust API for Matrix3
* Adds FFI bindings for Quaternion class.
* Adds Rust API of Quaternion class.
* Adds RollPitchYaw and Rotation bindings and Rust API (#44)

Signed-off-by: Franco Cipollone <[email protected]>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants