Struct rust_3d::BoundingBox2D

pub struct BoundingBox2D { /* fields omitted */ }

BoundingBox2D, an axis aligned bounding box within 2D space

Implementations

impl BoundingBox2D

pub fn new<P1, P2>(min: &P1, max: &P2) -> Result<BoundingBox2D> where
    P1: Is2D,
    P2: Is2D, 

Creates a new BoundingBox2D with the given min and max positions

pub fn from_iterator<'a, It2D, P>(source: It2D) -> Result<BoundingBox2D> where
    It2D: IntoIterator<Item = &'a P>,
    P: 'a + Is2D + Sized, 

Creates a new BoundingBox2D which contains all the given positions

pub fn from_into_iterator<It2D, P>(source: It2D) -> Result<BoundingBox2D> where
    It2D: IntoIterator<Item = P>,
    P: Is2D + Sized, 

Creates a new BoundingBox2D which contains all the given positions

pub fn min_p(&self) -> Point2D

Returns the minimum position of the bounding box

pub fn max_p(&self) -> Point2D

Returns the maximum position of the bounding box

pub fn size_x(&self) -> Positive

Returns the size the bounding box within the x-dimension

pub fn size_y(&self) -> Positive

Returns the size the bounding box within the y-dimension

pub fn sizes(&self) -> [Positive; 2]

Returns the sizes of the bounding box

pub fn center_bb(&self) -> Point2D

Returns the center of the bounding box

pub fn is_inside(&self, other: &BoundingBox2D) -> bool

Tests whether this bounding box is within the other

pub fn contains<P>(&self, other: &P) -> bool where
    Self: Sized,
    P: Is2D, 

Tests whether this bounding box contains a position

pub fn has_inside(&self, other: &BoundingBox2D) -> bool

Tests whether this bounding box contains the other

pub fn collides_with(&self, other: &BoundingBox2D) -> bool

Tests whether this bounding box and the other overlap in any way

pub fn crossing_x_value(&self, x: f64) -> bool

Tests whether this bounding box crosses a certain x value

pub fn crossing_y_value(&self, y: f64) -> bool

Tests whether this bounding box crosses a certain y value

pub fn corners(&self) -> [Point2D; 4]

Returns the corner points of the bounding box

pub fn distance<P>(&self, other: &P) -> NonNegative where
    P: Is2D, 

Returns the distance to another Is2D

pub fn sqr_distance<P>(&self, other: &P) -> NonNegative where
    P: Is2D, 

Returns the square distance to another Is2D

Trait Implementations

impl Clone for BoundingBox2D

fn clone(&self) -> BoundingBox2D

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for BoundingBox2D

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

Formats the value using the given formatter.

impl Default for BoundingBox2D

fn default() -> Self

Returns the "default value" for a type.

impl Eq for BoundingBox2D

impl From<BoundingBox2D> for Box2D

fn from(x: BoundingBox2D) -> Self

Performs the conversion.

impl From<BoundingBox2D> for FilterBox2D

fn from(x: BoundingBox2D) -> Self

Performs the conversion.

impl HasBoundingBox2D for BoundingBox2D

fn bounding_box(&self) -> BoundingBox2D

Should return the bounding box if it can be calculated

impl HasBoundingBox2DMaybe for BoundingBox2D

fn bounding_box_maybe(&self) -> Result<BoundingBox2D>

Should return the bounding box if it can be calculated

impl HasDistanceTo<BoundingBox2D> for BoundingBox2D

fn sqr_distance(&self, other: &BoundingBox2D) -> NonNegative

Should return the sqr distance to other

fn distance(&self, other: &T) -> NonNegative

The distance to other

impl Hash for BoundingBox2D

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given [Hasher].

fn hash_slice<H>(data: &[Self], state: &mut H) where
    H: Hasher, 

Feeds a slice of this type into the given [Hasher].

impl Is2D for BoundingBox2D

fn x(&self) -> f64

Should return the x-coordinate

fn y(&self) -> f64

Should return the y-coordinate

fn xy(&self) -> [f64; 2]

Returns the Position as x,y array

fn dot(&self, other: &dyn Is2D) -> f64

Calculates the dot product with another Is2D

fn cross(&self, other: &dyn Is2D) -> f64

Calculates the cross product with another Is2D

fn abs(&self) -> NonNegative

The absolute / length of this position

fn rad_to(&self, other: &dyn Is2D) -> Rad

Calculates the angle to the other Is2D in radians

fn to_str(&self) -> String

Transforms the position in a "x y" string. E.g. "3.72 5.99"

impl IsMergeable for BoundingBox2D

fn consume(&mut self, other: Self)

Should merge other into this

fn combine(&self, other: &Self) -> Self

Should return a combination of this and other

impl IsMovable2D for BoundingBox2D

fn move_by(&mut self, x: f64, y: f64)

Should move the object by the given offset

impl IsND for BoundingBox2D

fn n_dimensions() -> usize

Should return the number of dimensions. E.g. 2 for points in 2D space, 3 for points in 3D space etc.

fn position_nd(&self, dimension: usize) -> Result<f64>

Should return the value of a given dimensions. E.g. for 2D position with x = 4.3, y = 1.8 the result for dimension = 1 should be 1.8

impl IsScalable for BoundingBox2D

fn scale(&mut self, factor: Positive)

Should scale by the given factor. 0.5 -> half size, 2.0 double the size without moving the position/center

impl Ord for BoundingBox2D

fn cmp(&self, other: &BoundingBox2D) -> Ordering

This method returns an [Ordering] between self and other.

#[must_use]fn max(self, other: Self) -> Self

Compares and returns the maximum of two values.

#[must_use]fn min(self, other: Self) -> Self

Compares and returns the minimum of two values.

#[must_use]fn clamp(self, min: Self, max: Self) -> Self

🔬 This is a nightly-only experimental API. (clamp)

Restrict a value to a certain interval.

impl PartialEq<BoundingBox2D> for BoundingBox2D

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

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

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

This method tests for !=.

impl PartialOrd<BoundingBox2D> for BoundingBox2D

fn partial_cmp(&self, other: &BoundingBox2D) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

fn lt(&self, other: &BoundingBox2D) -> bool

This method tests less than (for self and other) and is used by the < operator.

fn le(&self, other: &BoundingBox2D) -> bool

This method tests less than or equal to (for self and other) and is used by the <= operator.

fn gt(&self, other: &BoundingBox2D) -> bool

This method tests greater than (for self and other) and is used by the > operator.

fn ge(&self, other: &BoundingBox2D) -> bool

This method tests greater than or equal to (for self and other) and is used by the >= operator.

impl StructuralEq for BoundingBox2D

impl StructuralPartialEq for BoundingBox2D