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

Add usage hints to vector-math integrations. #66

Closed
wants to merge 2 commits into from

Conversation

JacksonCampolattaro
Copy link
Contributor

This PR request adds short explanations of the functionality included in GlmIntegration and EigenIntegration. This should make it more obvious that both allow for casting to and from Magnum's native vector types. It should also make it more clear which headers must be included to take advantage of this functionality.

Short examples of the syntax are adapted from the blog post that explained the integration features when they were first introduced.

@codecov-io
Copy link

Codecov Report

Merging #66 into master will not change coverage.
The diff coverage is n/a.

Impacted file tree graph

@@          Coverage Diff           @@
##           master     #66   +/-   ##
======================================
  Coverage    74.5%   74.5%           
======================================
  Files          21      21           
  Lines         914     914           
======================================
  Hits          681     681           
  Misses        233     233

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update 8ab81bf...d0fdcb1. Read the comment docs.

@mosra mosra added this to the 2020.0a milestone Jan 26, 2020
@mosra mosra added this to TODO in Math via automation Jan 26, 2020
@mosra
Copy link
Owner

mosra commented Jan 26, 2020

Thank you! :) Merged as a4e3263, I just converted the code snippets to be checked for compile errors (which uncovered an accidentally reversed order of arguments in rotation(), yay!).

@mosra mosra closed this Jan 26, 2020
Math automation moved this from TODO to Done Jan 26, 2020
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
Math
  
Done
Development

Successfully merging this pull request may close these issues.

None yet

3 participants