Struct Rangef

#[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§

impl Rangef

pub const EVERYTHING: Rangef = _

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

pub const NOTHING: Rangef = _

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

pub const NAN: Rangef = _

An invalid Rangef filled with f32::NAN.

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

pub fn point(min_and_max: f32) -> Rangef

pub fn span(self) -> f32

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

pub fn center(self) -> f32

The center of the range

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

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

Equivalent to x.clamp(min, max)

pub fn as_positive(self) -> Rangef

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

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

Shrink by this much on each side, keeping the center

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

Expand by this much on each side, keeping the center

pub fn flip(self) -> Rangef

Flip the min and the max

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

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);

pub fn intersects(self, other: Rangef) -> 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§

impl Clone for Rangef

fn clone(&self) -> Rangef

Returns a copy of the value. Read more

1.6.0 · source§

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

Performs copy-assignment from source. Read more

impl Debug for Rangef

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

Formats the value using the given formatter. Read more

impl<'de> Deserialize<'de> for Rangef

fn deserialize<D>( deserializer: D, ) -> Result<Rangef, <D as Deserializer<'de>>::Error>
where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer. Read more

impl From<&RangeFrom<f32>> for Rangef

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

Converts to this type from the input type.

impl From<&RangeFull> for Rangef

fn from(_: &RangeFull) -> Rangef

Converts to this type from the input type.

impl From<&RangeInclusive<f32>> for Rangef

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

Converts to this type from the input type.

impl From<RangeFrom<f32>> for Rangef

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

Converts to this type from the input type.

impl From<RangeFull> for Rangef

fn from(_: RangeFull) -> Rangef

Converts to this type from the input type.

impl From<RangeInclusive<f32>> for Rangef

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

Converts to this type from the input type.

impl From<RangeToInclusive<f32>> for Rangef

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

Converts to this type from the input type.

impl PartialEq<RangeInclusive<f32>> for Rangef

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

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

1.6.0 · source§

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 PartialEq for Rangef

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

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

1.6.0 · source§

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 Serialize for Rangef

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. Read more

impl Zeroable for Rangef

fn zeroed() -> Self

Calls zeroed. Read more

impl Copy for Rangef

impl Pod for Rangef

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§

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

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more

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

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more

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

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

Mutably borrows from an owned value. Read more

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.

fn is_valid_bit_pattern(_bits: &T) -> bool

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

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

unsafe fn clone_to_uninit(&self, dst: *mut T)

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

Performs copy-assignment from self to dst. Read more

impl<T> From<T> for T

fn from(t: T) -> T

Returns the argument unchanged.

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

fn into(self) -> U

Calls U::from(self).

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

impl<T> IntoEither for T

fn into_either(self, into_left: bool) -> Either<Self, Self>

Converts self into a Left variant of Either<Self, Self> if into_left is true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
where F: FnOnce(&Self) -> bool,

Converts self into a Left variant of Either<Self, Self> if into_left(&self) returns true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more

impl<T> Pointable for T

const ALIGN: usize = _

The alignment of pointer.

type Init = T

The type for initializers.

unsafe fn init(init: <T as Pointable>::Init) -> usize

Initializes a with the given initializer. Read more

unsafe fn deref<'a>(ptr: usize) -> &'a T

Dereferences the given pointer. Read more

unsafe fn deref_mut<'a>(ptr: usize) -> &'a mut T

Mutably dereferences the given pointer. Read more

unsafe fn drop(ptr: usize)

Drops the object pointed to by the given pointer. Read more

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

type Owned = T

The resulting type after obtaining ownership.

fn to_owned(&self) -> T

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

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

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

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

type Error = Infallible

The type returned in the event of a conversion error.

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

Performs the conversion.

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.

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

Performs the conversion.

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

impl<T> DeserializeOwned for T
where T: for<'de> Deserialize<'de>,

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

impl<T> SerializableAny for T
where T: 'static + Any + Clone + Serialize + for<'a> Deserialize<'a> + Send + Sync,