Struct emath::range::Rangef

source ·
#[repr(C)]
pub struct Rangef { pub min: f32, pub max: f32, }
Expand description

Inclusive range of floats, i.e. min..=max, but more ergonomic than RangeInclusive.

Fields§

§min: f32§max: f32

Implementations§

source§

impl Rangef

source

pub const EVERYTHING: Self = _

Infinite range that contains everything, from -∞ to +∞, inclusive.

source

pub const NOTHING: Self = _

The inverse of Self::EVERYTHING: stretches from positive infinity to negative infinity. Contains nothing.

source

pub const NAN: Self = _

An invalid Rangef filled with f32::NAN.

source

pub fn new(min: f32, max: f32) -> Self

source

pub fn point(min_and_max: f32) -> Self

source

pub fn span(self) -> f32

The length of the range, i.e. max - min.

source

pub fn center(self) -> f32

The center of the range

source

pub fn contains(self, x: f32) -> bool

source

pub fn clamp(self, x: f32) -> f32

Equivalent to x.clamp(min, max)

source

pub fn as_positive(self) -> Self

Flip min and max if needed, so that min <= max after.

source

pub fn shrink(self, amnt: f32) -> Self

Shrink by this much on each side, keeping the center

source

pub fn expand(self, amnt: f32) -> Self

Expand by this much on each side, keeping the center

source

pub fn flip(self) -> Self

Flip the min and the max

source

pub fn intersection(self, other: Self) -> Self

The overlap of two ranges, i.e. the range that is contained by both.

If the ranges do not overlap, returns a range with span() < 0.0.

assert_eq!(Rangef::new(0.0, 10.0).intersection(Rangef::new(5.0, 15.0)), Rangef::new(5.0, 10.0));
assert_eq!(Rangef::new(0.0, 10.0).intersection(Rangef::new(10.0, 20.0)), Rangef::new(10.0, 10.0));
assert!(Rangef::new(0.0, 10.0).intersection(Rangef::new(20.0, 30.0)).span() < 0.0);
source

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

Do the two ranges intersect?

assert!(Rangef::new(0.0, 10.0).intersects(Rangef::new(5.0, 15.0)));
assert!(Rangef::new(0.0, 10.0).intersects(Rangef::new(5.0, 6.0)));
assert!(Rangef::new(0.0, 10.0).intersects(Rangef::new(10.0, 20.0)));
assert!(!Rangef::new(0.0, 10.0).intersects(Rangef::new(20.0, 30.0)));

Trait Implementations§

source§

impl Clone for Rangef

source§

fn clone(&self) -> Rangef

Returns a copy of the value. Read more
1.0.0 · source§

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

Performs copy-assignment from source. Read more
source§

impl Debug for Rangef

source§

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

Formats the value using the given formatter. Read more
source§

impl From<&RangeFrom<f32>> for Rangef

source§

fn from(range: &RangeFrom<f32>) -> Self

Converts to this type from the input type.
source§

impl From<&RangeFull> for Rangef

source§

fn from(_: &RangeFull) -> Self

Converts to this type from the input type.
source§

impl From<&RangeInclusive<f32>> for Rangef

source§

fn from(range: &RangeInclusive<f32>) -> Self

Converts to this type from the input type.
source§

impl From<&Rangef> for RangeInclusive<f32>

source§

fn from(_: &Rangef) -> Self

Converts to this type from the input type.
source§

impl From<RangeFrom<f32>> for Rangef

source§

fn from(range: RangeFrom<f32>) -> Self

Converts to this type from the input type.
source§

impl From<RangeFull> for Rangef

source§

fn from(_: RangeFull) -> Self

Converts to this type from the input type.
source§

impl From<RangeInclusive<f32>> for Rangef

source§

fn from(range: RangeInclusive<f32>) -> Self

Converts to this type from the input type.
source§

impl From<RangeToInclusive<f32>> for Rangef

source§

fn from(range: RangeToInclusive<f32>) -> Self

Converts to this type from the input type.
source§

impl From<Rangef> for RangeInclusive<f32>

source§

fn from(_: Rangef) -> Self

Converts to this type from the input type.
source§

impl PartialEq<RangeInclusive<f32>> for Rangef

source§

fn eq(&self, other: &RangeInclusive<f32>) -> bool

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

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.
source§

impl PartialEq<Rangef> for RangeInclusive<f32>

source§

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

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

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.
source§

impl PartialEq for Rangef

source§

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

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

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.
source§

impl Zeroable for Rangef

source§

fn zeroed() -> Self

source§

impl Copy for Rangef

source§

impl Pod for Rangef

source§

impl StructuralPartialEq for Rangef

Auto Trait Implementations§

§

impl Freeze for Rangef

§

impl RefUnwindSafe for Rangef

§

impl Send for Rangef

§

impl Sync for Rangef

§

impl Unpin for Rangef

§

impl UnwindSafe for Rangef

Blanket Implementations§

source§

impl<T> Any for T
where T: 'static + ?Sized,

source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
source§

impl<T> Borrow<T> for T
where T: ?Sized,

source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
source§

impl<T> CheckedBitPattern for T
where T: AnyBitPattern,

§

type Bits = T

Self must have the same layout as the specified Bits except for the possible invalid bit patterns being checked during is_valid_bit_pattern.
source§

fn is_valid_bit_pattern(_bits: &T) -> bool

If this function returns true, then it must be valid to reinterpret bits as &Self.
source§

impl<T> From<T> for T

source§

fn from(t: T) -> T

Returns the argument unchanged.

source§

impl<T, U> Into<U> for T
where U: From<T>,

source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

source§

impl<T> ToOwned for T
where T: Clone,

§

type Owned = T

The resulting type after obtaining ownership.
source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

§

type Error = Infallible

The type returned in the event of a conversion error.
source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
source§

impl<T> AnyBitPattern for T
where T: Pod,

source§

impl<T> NoUninit for T
where T: Pod,