forestia/bevy
2
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Document collide args (#2721)

Browse Source 
Fixes https://github.com/bevyengine/bevy/issues/2720#issuecomment-904623168

Possibly we should omit the extra bit in brackets, not sure if its warranted.
This commit is contained in:
Lucas Kent 2021-08-24 18:07:51 +00:00
parent 47ccebf486
commit c5717b5a91
1 changed files with 2 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
crates/bevy_sprite/src/collide_aabb.rs
View File

@ -12,6 +12,8 @@ pub enum Collision {
// TODO: ideally we can remove this once bevy gets a physics system // TODO: ideally we can remove this once bevy gets a physics system
/// Axis-aligned bounding box collision with "side" detection /// Axis-aligned bounding box collision with "side" detection
/// * a_pos and b_pos are the center positions of the rectangles, typically obtained by extracting the `translation` field from a `Transform` component
/// * a_size and b_size are the dimensions (width and height) of the rectangles.
pub fn collide(a_pos: Vec3, a_size: Vec2, b_pos: Vec3, b_size: Vec2) -> Option<Collision> { pub fn collide(a_pos: Vec3, a_size: Vec2, b_pos: Vec3, b_size: Vec2) -> Option<Collision> {
let a_min = a_pos.truncate() - a_size / 2.0; let a_min = a_pos.truncate() - a_size / 2.0;
let a_max = a_pos.truncate() + a_size / 2.0; let a_max = a_pos.truncate() + a_size / 2.0;