Implement From trait for cpVect ⟷ tuple and array #5
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
The following functions do not perform any mutation, so they can take const pointers instead of mut pointers: - cpArbiterGetSurfaceVelocity - cpBodyGetType - cpShapeGetArea - cpShapeGetCenterOfGravity - cpSpaceContainsShape - cpSpaceContainsBody - cpSpaceContainsConstraint - cpArrayContains This allows the bindings to be called with an immutable reference. The following functions were also considered, but they perform some internal mutation (locking), so the bindings were not changed: - cpSpacePointQuery - cpSpacePointQueryNearest - cpSpaceSegmentQuery - cpSpaceSegmentQueryFirst - cpSpaceBBQuery - cpSpaceShapeQuery
Cargo does not use the package.lib key, and it is not necessary because Cargo compiles the crate as chipmunk_sys anyway.
The naming style is intended to match the C library, so it is okay not to follow Rust naming conventions.
- (cpFloat, cpFloat) can be created from cpVect or &cpVect. - cpVect can be created from (cpFloat, cpFloat). Implementing From automatically gives us Into for free. cpVect::to_tuple() is now deprecated. Use `v.into()` or `From::from(v)` instead. cpVect::to_tuple() never existed in a release of this crate, but the master branch of the chipmunk crate uses it, so I deprecated it instead of simply removing it.
- [cpFloat; 2] can be created from cpVect or &cpVect. - cpVect can be created from [cpFloat; 2]. This gives users more flexibility. For example, the nalbegra crate has a Vector2 type which can easily be created from [f64; 2], but does not support (f64, f64).
jacius
changed the title
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
I have implemented the standard From trait for converting a
cpVector&cpVectinto a(cpFloat, cpFloat)tuple or[cpFloat; 2]array, which are the same as(f64, f64)and[f64; 2]. I have also implemented the trait for the opposite direction, converting a tuple or array into a cpVect. This makes it very easy to convert back and forth, which can simplify a lot of code in the chipmunk crate, or anyone who uses the chipmunk-sys crate directly.Implementing the From trait also gives us the Into trait automatically.
This makes the
cpVect::to_tuple()function obsolete. You can writev.into()or<(f64, f64)>::from(v)instead ofv.to_tuple(). I have markedcpVect::to_tuple()as deprecated. It doesn't exist in any released version of this crate, but it is used by the master branch of the chipmunk crate, so I didn't want to remove it completely yet.This pull request is based on the commits in pull request #2. I recommend merging that pull request first.