Struct rust_3d::BoundingBox3D

pub struct BoundingBox3D { /* fields omitted */ }

BoundingBox3D, an axis aligned bounding box within 3D space

Implementations

impl BoundingBox3D

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

Creates a new BoundingBox3D with the given min and max positions

pub fn from_iterator<'a, It3D, P>(source: It3D) -> Result<BoundingBox3D> where
    It3D: IntoIterator<Item = &'a P>,
    P: 'a + Is3D + Sized, 

Creates a new BoundingBox3D which contains all the given positions

pub fn from_into_iterator<It3D, P>(source: It3D) -> Result<BoundingBox3D> where
    It3D: IntoIterator<Item = P>,
    P: Is3D + Sized, 

Creates a new BoundingBox3D which contains all the given positions

pub fn min_p(&self) -> Point3D

Returns the minimum position of the bounding box

pub fn max_p(&self) -> Point3D

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 size_z(&self) -> Positive

Returns the size the bounding box within the z-dimension

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

Returns the sizes of the bounding box

pub fn center_bb(&self) -> Point3D

Returns the center of the bounding box

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

Tests whether this bounding box is within the other

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

Tests whether this bounding box contains a position

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

Tests whether this bounding box contains the other

pub fn collides_with(&self, other: &BoundingBox3D) -> 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 crossing_z_value(&self, z: f64) -> bool

Tests whether this bounding box crosses a certain z value

pub fn corners(&self) -> [Point3D; 8]

Returns the corner points of the bounding box

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

Returns the distance to another Is3D

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

Returns the square distance to another Is3D

Trait Implementations

impl Clone for BoundingBox3D

fn clone(&self) -> BoundingBox3D

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for BoundingBox3D

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

Formats the value using the given formatter.

impl Default for BoundingBox3D

fn default() -> Self

Returns the "default value" for a type.

impl Eq for BoundingBox3D

impl From<BoundingBox3D> for Box3D

fn from(x: BoundingBox3D) -> Self

Performs the conversion.

impl From<BoundingBox3D> for FilterBox3D

fn from(x: BoundingBox3D) -> Self

Performs the conversion.

impl HasBoundingBox3D for BoundingBox3D

fn bounding_box(&self) -> BoundingBox3D

Should return the bounding box

impl HasBoundingBox3DMaybe for BoundingBox3D

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

Should return the bounding box if it can be calculated

impl HasDistanceTo<BoundingBox3D> for BoundingBox3D

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

Should return the sqr distance to other

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

The distance to other

impl Hash for BoundingBox3D

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 Is3D for BoundingBox3D

fn x(&self) -> f64

Should return the x-coordinate

fn y(&self) -> f64

Should return the y-coordinate

fn z(&self) -> f64

Should return the z-coordinate

fn xyz(&self) -> [f64; 3]

Returns the position as x,y,z array

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

Returns the components of the position as array

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

Returns the components of the position as array

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

Returns the components of the position as array

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

Calculates the dot product with another Is3D

fn abs(&self) -> NonNegative

The absolute / length of this position

fn rad_to(&self, other: &dyn Is3D) -> Result<Rad>

Calculates the angle to the other Is3D in radians

fn to_str(&self) -> String

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

impl IsMergeable for BoundingBox3D

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 IsMovable3D for BoundingBox3D

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

Should move the object by the given offset

impl IsND for BoundingBox3D

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 IsSATObject for BoundingBox3D

fn for_each_point<F>(&self, f: &mut F) where
    F: FnMut(&Point3D), 

fn for_each_axis<F>(&self, f: &mut F) where
    F: FnMut(&Norm3D), 

impl IsScalable for BoundingBox3D

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 BoundingBox3D

fn cmp(&self, other: &BoundingBox3D) -> 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<BoundingBox3D> for BoundingBox3D

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

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

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

This method tests for !=.

impl PartialOrd<BoundingBox3D> for BoundingBox3D

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

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

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

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

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

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

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

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

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

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

impl StructuralEq for BoundingBox3D

impl StructuralPartialEq for BoundingBox3D