Skip to content

Commit

Permalink
Document collide args (#2721)
Browse files Browse the repository at this point in the history
Fixes #2720 (comment)

Possibly we should omit the extra bit in brackets, not sure if its warranted.
  • Loading branch information
rukai committed Aug 24, 2021
1 parent 47ccebf commit c5717b5
Showing 1 changed file with 2 additions and 0 deletions.
2 changes: 2 additions & 0 deletions crates/bevy_sprite/src/collide_aabb.rs
Original file line number Diff line number Diff line change
Expand Up @@ -12,6 +12,8 @@ pub enum Collision {

// TODO: ideally we can remove this once bevy gets a physics system
/// 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> {
let a_min = a_pos.truncate() - a_size / 2.0;
let a_max = a_pos.truncate() + a_size / 2.0;
Expand Down

0 comments on commit c5717b5

Please sign in to comment.