Struct physics2d::Bounds

pub struct Bounds { /* fields omitted */ }

A 2D bounding volume in space.

Bounding volumes are often used to cheaply approximate shapes and objects. The structure of a Bounds ensures that all operations - including expansion, intersection and overlap checks - are performed quickly and efficiently.

Methods

impl Bounds

pub fn new(min: Vec2, max: Vec2) -> Bounds

Creates a new Bounds from the given minimum and maximum corner points.

pub fn center_extents(center: Vec2, extents: Vec2) -> Bounds

Creates a new Bounds with the given center and extents. extents is the vector from the center to the farthest point (max) of the bounding volume. min and max of the created bounding volume are center - extents and center + extents respectively.

Example

let b = Bounds::center_extents(Vec2::ONE, Vec2::new(1.0, 3.0));
assert_eq!(b, Bounds::new(Vec2::new(0.0, -2.0), Vec2::new(2.0, 4.0)));

pub fn perimeter(&self) -> f32

Returns the perimeter of the given bounding volume.

Example

let b = Bounds::center_extents(Vec2::ONE, Vec2::new(2.0, 15.1));
assert_eq!(b.perimeter(), 2.0 * 2.0 * (2.0 + 15.1));

pub fn intersects(&self, other: &Bounds) -> bool

Checks whether two Bounds are intersecting.

Example

let b1 = Bounds::center_extents(Vec2::ONE, Vec2::ONE);
let b2 = Bounds::center_extents(Vec2::new(0.5, 0.5), Vec2::ONE);
assert!(b1.intersects(&b2));

pub fn contains(&self, other: &Bounds) -> bool

Checks whether this Bounds fully contains the other.

Example

let b1 = Bounds::center_extents(Vec2::ONE, Vec2::ONE);
let b2 = Bounds::center_extents(Vec2::new(0.5, 0.5), Vec2::new(0.5, 0.5));
assert!(b1.contains(&b2));

pub fn union(&self, other: &Bounds) -> Bounds

Returns a bounding volume that completely encompasses both the bounding volume represented by self and other.

Example

let b1 = Bounds::center_extents(Vec2::ONE, Vec2::ONE);
let b2 = Bounds::center_extents(Vec2::new(0.5, 0.5), Vec2::ONE);

let union = Bounds::new(Vec2::new(-0.5, -0.5), Vec2::new(2.0, 2.0));

assert_eq!(b1.union(&b2), union);

let b3 = Bounds::new(Vec2::new(-0.5, -0.5), Vec2::new(-0.4, -0.4));
let b4 = Bounds::new(Vec2::new(1.9, -0.325), Vec2::new(2.0, 2.0));

assert_eq!(b3.union(&b4), union);

pub fn expand(&self, margin: f32) -> Bounds

Expands the Bounds in all directions by margin.

Example

let b1 = Bounds::center_extents(Vec2::ONE, Vec2::new(0.5, 0.5));
let b2 = Bounds::center_extents(Vec2::ONE, Vec2::ONE);

assert_eq!(b1.expand(0.5), b2);

Trait Implementations

impl Copy for Bounds

impl Clone for Bounds

fn clone(&self) -> Bounds

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl PartialEq<Bounds> for Bounds

fn eq(&self, other: &Bounds) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Bounds) -> bool

This method tests for !=.

impl Debug for Bounds

fn fmt(&self, f: &mut Formatter) -> Result

Formats the value using the given formatter.