Struct octree::BoundingBox

pub struct BoundingBox { /* private fields */ }

Bounding box defines a 3D space.

Implementations

impl BoundingBox

pub fn new<L>(points: Vec<&L>) -> Selfwhere L: Locatable,

Construct a new BoundingBox which can hold all given points.

Example

use octree::point::Point3D;
use octree::BoundingBox;

let point1 = Point3D::new(0.0, 0.0, 0.0);
let point2 = Point3D::new(10.0, 10.0, 10.0);
let bounding_box = BoundingBox::new(vec![point1, point2].iter().collect());

pub fn covers(&self, point: &[f32; 3]) -> bool

Check if a point can be covered by this BoundingBox.

Example

use octree::point::Point3D;
use octree::{BoundingBox, Locatable};

let point1 = Point3D::new(0.0, 0.0, 0.0);
let point2 = Point3D::new(10.0, 10.0, 10.0);
let point3 = Point3D::new(5.0, 5.0, 5.0);
let point4 = Point3D::new(20.0, 20.0, 20.0);
let bounding_box = BoundingBox::new(vec![point1, point2].iter().collect());

assert!(bounding_box.covers(&point3.get_location()));
assert!(!bounding_box.covers(&point4.get_location()));

pub fn overlaps(&self, other: &BoundingBox) -> bool

Check if two BoundingBoxes overlap.

pub fn get_centre(&self) -> [f32; 3]

Getter for BoundingBox centre coordination.

pub fn get_min(&self) -> &[f32; 3]

Getter for BoundingBox min corner coordination.

pub fn get_max(&self) -> &[f32; 3]

Getter for BoundingBox max corner coordination.

pub fn split(&self) -> [Self; 8]

Split the BoundingBox into 8 sub BoundingBoxes.

Trait Implementations

impl Clone for BoundingBox

fn clone(&self) -> BoundingBox

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for BoundingBox

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

Formats the value using the given formatter.

impl Default for BoundingBox

fn default() -> Self

Construct a default BoundingBox, covers the whole space which can be represented by f32.

impl PartialEq<BoundingBox> for BoundingBox

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

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

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

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl StructuralPartialEq for BoundingBox