Struct Interval

pub struct Interval<S> { /* private fields */ }

1D interval

Implementations

impl<S> Interval<S>

where S: Ring,

pub fn with_minmax(min: S, max: S) -> Interval<S>

where S: Debug,

Construct a new AABB with given min and max points.

Debug panic if points are not min/max:

let b = Interval::with_minmax (1.0, 0.0);  // panic!

Debug panic if points are identical:

let b = Interval::with_minmax (0.0, 0.0);  // panic!

pub fn from_points(a: S, b: S) -> Interval<S>

where S: Debug,

Construct a new AABB using the two given points to determine min/max.

Panic if points are identical:

let b = Interval::from_points (0.0, 0.0);  // panic!

pub fn containing(points: &[S]) -> Interval<S>

where S: Debug,

Construct the minimum AABB containing the given set of points.

Debug panic if fewer than 2 points are given:

let b = Interval::<f32>::containing (&[]);  // panic!

let b = Interval::containing (&[0.0]);  // panic!

pub fn numcast<T>(self) -> Option<Interval<T>>

where S: ToPrimitive, T: NumCast,

pub fn union(a: &Interval<S>, b: &Interval<S>) -> Interval<S>

where S: Debug,

Create a new AABB that is the union of the two input AABBs

pub fn min(&self) -> S

pub fn max(&self) -> S

pub fn width(&self) -> NonNegative<S>

pub fn contains(&self, point: &S) -> bool

pub fn clamp(&self, point: &S) -> S

Clamp a given point to the AABB interval.

let b = Interval::from_points (-1.0, 1.0);
assert_eq!(b.clamp (&-2.0), -1.0);
assert_eq!(b.clamp ( &2.0),  1.0);
assert_eq!(b.clamp ( &0.0),  0.0);

pub fn rand_point<R>(&self, rng: &mut R) -> S

where S: SampleUniform, R: Rng,

Generate a random point contained in the AABB

use rand_xorshift;
use rand::SeedableRng;
// random sequence will be the same each time this is run
let mut rng = rand_xorshift::XorShiftRng::seed_from_u64 (0);
let aabb = Interval::<f32>::with_minmax (-10.0, 10.0);
let point = aabb.rand_point (&mut rng);
assert!(aabb.contains (&point));
let point = aabb.rand_point (&mut rng);
assert!(aabb.contains (&point));
let point = aabb.rand_point (&mut rng);
assert!(aabb.contains (&point));
let point = aabb.rand_point (&mut rng);
assert!(aabb.contains (&point));
let point = aabb.rand_point (&mut rng);
assert!(aabb.contains (&point));

pub fn intersects(&self, other: &Interval<S>) -> bool

pub fn intersection(self, other: Interval<S>) -> Option<Interval<S>>

where S: Debug,

pub fn dilate(self, amount: S) -> Interval<S>

Increase or decrease each endpoint by the given amount.

Debug panic if the interval width is less than or equal to twice the given amount:

let x = Interval::<f32>::with_minmax (-1.0, 1.0);
let y = x.dilate (-1.0); // panic!

Trait Implementations

impl<S> Add<S> for Interval<S>

where S: Field + VectorSpace<S>, Interval<S>: Primitive<S, S>,

type Output = Interval<S>

The resulting type after applying the + operator.

fn add(self, displacement: S) -> Interval<S>

Performs the + operation.

impl<S> Clone for Interval<S>

where S: Clone,

fn clone(&self) -> Interval<S>

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<S> Debug for Interval<S>

where S: Debug,

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

Formats the value using the given formatter.

impl<'de, S> Deserialize<'de> for Interval<S>

where S: Deserialize<'de>,

fn deserialize<__D>( __deserializer: __D, ) -> Result<Interval<S>, <__D as Deserializer<'de>>::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl<S> PartialEq for Interval<S>

where S: PartialEq,

fn eq(&self, other: &Interval<S>) -> bool

Tests for self and other values to be equal, and is used by ==.

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

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

impl<S> Primitive<S, S> for Interval<S>

where S: Field + VectorSpace<S>,

fn translate(self, displacement: S) -> Interval<S>

fn scale(self, scale: NonZero<S>) -> Interval<S>

impl<S> Serialize for Interval<S>

where S: Serialize,

fn serialize<__S>( &self, __serializer: __S, ) -> Result<<__S as Serializer>::Ok, <__S as Serializer>::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl<S> Sub<S> for Interval<S>

where S: Field + VectorSpace<S>, Interval<S>: Primitive<S, S>,

type Output = Interval<S>

The resulting type after applying the - operator.

fn sub(self, displacement: S) -> Interval<S>

Performs the - operation.

impl<S> Copy for Interval<S>

where S: Copy,

impl<S> StructuralPartialEq for Interval<S>