Struct nannou::geom::range::Range
[−]
[src]
pub struct Range<S = DefaultScalar> { pub start: S, pub end: S, }
Some start and end position along a single axis.
As an example, a Rect is made up of two Ranges; one along the x axis, and one along the y axis.
Fields
start: S
The start of some Range
along an axis.
end: S
The end of some Range
along an axis.
Methods
impl<S> Range<S> where
S: BaseNum,
[src]
S: BaseNum,
pub fn new(start: S, end: S) -> Self
[src]
Construct a new Range
from a given range, i.e. Range::new(start, end)
.
Examples
use nannou::geom::Range; assert_eq!(Range { start: 0.0, end: 10.0 }, Range::new(0.0, 10.0));
pub fn from_pos_and_len(pos: S, len: S) -> Self
[src]
Construct a new Range
from a given length and its centered position.
Examples
use nannou::geom::Range; assert_eq!(Range::new(0.0, 10.0), Range::from_pos_and_len(5.0, 10.0)); assert_eq!(Range::new(-5.0, 1.0), Range::from_pos_and_len(-2.0, 6.0)); assert_eq!(Range::new(-100.0, 200.0), Range::from_pos_and_len(50.0, 300.0));
pub fn magnitude(&self) -> S
[src]
The start
value subtracted from the end
value.
Examples
use nannou::geom::Range; assert_eq!(Range::new(-5.0, 5.0).magnitude(), 10.0); assert_eq!(Range::new(5.0, -5.0).magnitude(), -10.0); assert_eq!(Range::new(15.0, 10.0).magnitude(), -5.0);
pub fn len(&self) -> S where
S: Neg<Output = S>,
[src]
S: Neg<Output = S>,
The absolute length of the Range aka the absolute magnitude.
Examples
use nannou::geom::Range; assert_eq!(Range::new(-5.0, 5.0).len(), 10.0); assert_eq!(Range::new(5.0, -5.0).len(), 10.0); assert_eq!(Range::new(15.0, 10.0).len(), 5.0);
pub fn middle(&self) -> S
[src]
Return the value directly between the start and end values.
Examples
use nannou::geom::Range; assert_eq!(Range::new(-5.0, 5.0).middle(), 0.0); assert_eq!(Range::new(5.0, -5.0).middle(), 0.0); assert_eq!(Range::new(10.0, 15.0).middle(), 12.5); assert_eq!(Range::new(20.0, 40.0).middle(), 30.0); assert_eq!(Range::new(20.0, -40.0).middle(), -10.0);
pub fn invert(self) -> Self
[src]
The current range with its start and end values swapped.
Examples
use nannou::geom::Range; assert_eq!(Range::new(-5.0, 5.0).invert(), Range::new(5.0, -5.0)); assert_eq!(Range::new(-10.0, 10.0).invert(), Range::new(10.0, -10.0)); assert_eq!(Range::new(0.0, 7.25).invert(), Range::new(7.25, 0.0)); assert_eq!(Range::new(5.0, 1.0).invert(), Range::new(1.0, 5.0));
pub fn map_value(&self, value: S, other: &Self) -> S
[src]
Map the given scalar from Self
to some other given Range
.
Examples
use nannou::geom::Range; let a = Range::new(0.0, 5.0); let b = Range::new(0.0, 10.0); assert_eq!(a.map_value(2.5, &b), 5.0); assert_eq!(a.map_value(0.0, &b), 0.0); assert_eq!(a.map_value(5.0, &b), 10.0); assert_eq!(a.map_value(-5.0, &b), -10.0); assert_eq!(a.map_value(10.0, &b), 20.0); let c = Range::new(10.0, -10.0); assert_eq!(a.map_value(2.5, &c), 0.0); assert_eq!(a.map_value(0.0, &c), 10.0); assert_eq!(a.map_value(5.0, &c), -10.0); assert_eq!(a.map_value(-5.0, &c), 30.0); assert_eq!(a.map_value(10.0, &c), -30.0);
pub fn lerp(&self, amount: S) -> S
[src]
Interpolates the Range using the given weight
.
Examples
use nannou::geom::Range; let r = Range::new(-5.0, 5.0); assert_eq!(r.lerp(0.0), -5.0); assert_eq!(r.lerp(1.0), 5.0); assert_eq!(r.lerp(0.5), 0.0);
pub fn shift(self, amount: S) -> Self
[src]
Shift the Range
start and end points by a given scalar.
Examples
use nannou::geom::Range; assert_eq!(Range::new(0.0, 5.0).shift(5.0), Range::new(5.0, 10.0)); assert_eq!(Range::new(0.0, 5.0).shift(-5.0), Range::new(-5.0, 0.0)); assert_eq!(Range::new(5.0, -5.0).shift(-5.0), Range::new(0.0, -10.0));
pub fn direction(&self) -> S where
S: Neg<Output = S> + One + Zero,
[src]
S: Neg<Output = S> + One + Zero,
The direction of the Range represented as a normalised scalar.
Examples
use nannou::geom::Range; assert_eq!(Range::new(0.0, 5.0).direction(), 1.0); assert_eq!(Range::new(0.0, 0.0).direction(), 0.0); assert_eq!(Range::new(0.0, -5.0).direction(), -1.0);
pub fn undirected(self) -> Self
[src]
Converts the Range to an undirected Range. By ensuring that start
<= end
.
If start
> end
, then the start and end points will be swapped.
Examples
use nannou::geom::Range; assert_eq!(Range::new(0.0, 5.0).undirected(), Range::new(0.0, 5.0)); assert_eq!(Range::new(5.0, 1.0).undirected(), Range::new(1.0, 5.0)); assert_eq!(Range::new(10.0, -10.0).undirected(), Range::new(-10.0, 10.0));
pub fn absolute(self) -> Self
[src]
Converts the Range to an absolute Range by ensuring that start
<= end
.
If start
> end
, then the start and end points will be swapped.
Examples
use nannou::geom::Range; assert_eq!(Range::new(0.0, 5.0).absolute(), Range::new(0.0, 5.0)); assert_eq!(Range::new(5.0, 1.0).absolute(), Range::new(1.0, 5.0)); assert_eq!(Range::new(10.0, -10.0).absolute(), Range::new(-10.0, 10.0));
pub fn max(self, other: Self) -> Self where
S: Float,
[src]
S: Float,
The Range that encompasses both self and the given Range.
The returned Range's start
will always be <= its end
.
Examples
use nannou::geom::Range; let a = Range::new(0.0, 3.0); let b = Range::new(7.0, 10.0); assert_eq!(a.max(b), Range::new(0.0, 10.0)); let c = Range::new(-20.0, -30.0); let d = Range::new(5.0, -7.5); assert_eq!(c.max(d), Range::new(-30.0, 5.0));
pub fn overlap(self, other: Self) -> Option<Self>
[src]
The Range that represents the range of the overlap between two Ranges if there is some.
Note that If one end of self
aligns exactly with the opposite end of other
, Some
Range
will be returned with a magnitude of 0.0
. This is useful for algorithms that
involve calculating the visibility of widgets, as it allows for including widgets whose
bounding box may be a one dimensional straight line.
The returned Range
's start
will always be <= its end
.
Examples
use nannou::geom::Range; let a = Range::new(0.0, 6.0); let b = Range::new(4.0, 10.0); assert_eq!(a.overlap(b), Some(Range::new(4.0, 6.0))); let c = Range::new(10.0, -30.0); let d = Range::new(-5.0, 20.0); assert_eq!(c.overlap(d), Some(Range::new(-5.0, 10.0))); let e = Range::new(0.0, 2.5); let f = Range::new(50.0, 100.0); assert_eq!(e.overlap(f), None);
pub fn max_directed(self, other: Self) -> Self where
S: Float,
[src]
S: Float,
The Range that encompasses both self and the given Range.
The same as Range::max but retains self
's original
direction.
Examples
use nannou::geom::Range; let a = Range::new(0.0, 3.0); let b = Range::new(7.0, 10.0); assert_eq!(a.max_directed(b), Range::new(0.0, 10.0)); let c = Range::new(-20.0, -30.0); let d = Range::new(5.0, -7.5); assert_eq!(c.max_directed(d), Range::new(5.0, -30.0));
pub fn contains(&self, pos: S) -> bool
[src]
Is the given scalar within our range.
Examples
use nannou::geom::Range; let range = Range::new(0.0, 10.0); assert!(range.contains(5.0)); assert!(!range.contains(12.0)); assert!(!range.contains(-1.0)); assert!(range.contains(0.0)); assert!(range.contains(10.0));
pub fn round(self) -> Self where
S: Float,
[src]
S: Float,
Round the values at both ends of the Range and return the result.
Examples
use nannou::geom::Range; assert_eq!(Range::new(0.25, 9.5).round(), Range::new(0.0, 10.0)); assert_eq!(Range::new(4.95, -5.3).round(), Range::new(5.0, -5.0));
pub fn floor(self) -> Self where
S: Float,
[src]
S: Float,
Floor the values at both ends of the Range and return the result.
Examples
use nannou::geom::Range; assert_eq!(Range::new(0.25, 9.5).floor(), Range::new(0.0, 9.0)); assert_eq!(Range::new(4.95, -5.3).floor(), Range::new(4.0, -6.0));
pub fn pad_start(self, pad: S) -> Self where
S: Neg<Output = S>,
[src]
S: Neg<Output = S>,
The Range with some padding given to the start
value.
Examples
use nannou::geom::Range; assert_eq!(Range::new(0.0, 10.0).pad_start(2.0), Range::new(2.0, 10.0)); assert_eq!(Range::new(10.0, 0.0).pad_start(2.0), Range::new(8.0, 0.0));
pub fn pad_end(self, pad: S) -> Self where
S: Neg<Output = S>,
[src]
S: Neg<Output = S>,
The Range with some padding given to the end
value.
Examples
use nannou::geom::Range; assert_eq!(Range::new(0.0, 10.0).pad_end(2.0), Range::new(0.0, 8.0)); assert_eq!(Range::new(10.0, 0.0).pad_end(2.0), Range::new(10.0, 2.0));
pub fn pad(self, pad: S) -> Self where
S: Neg<Output = S>,
[src]
S: Neg<Output = S>,
The Range with some given padding to be applied to each end.
Examples
use nannou::geom::Range; assert_eq!(Range::new(0.0, 10.0).pad(2.0), Range::new(2.0, 8.0)); assert_eq!(Range::new(10.0, 0.0).pad(2.0), Range::new(8.0, 2.0));
pub fn pad_ends(self, start: S, end: S) -> Self where
S: Neg<Output = S>,
[src]
S: Neg<Output = S>,
The Range with some padding given for each end.
Examples
use nannou::geom::Range; assert_eq!(Range::new(0.0, 10.0).pad_ends(1.0, 2.0), Range::new(1.0, 8.0)); assert_eq!(Range::new(10.0, 0.0).pad_ends(4.0, 3.0), Range::new(6.0, 3.0));
pub fn clamp_value(&self, value: S) -> S
[src]
Clamp the given value to the range.
Examples
use nannou::geom::Range; assert_eq!(Range::new(0.0, 5.0).clamp_value(7.0), 5.0); assert_eq!(Range::new(5.0, -2.5).clamp_value(-3.0), -2.5); assert_eq!(Range::new(5.0, 10.0).clamp_value(0.0), 5.0);
pub fn stretch_to_value(self, value: S) -> Self
[src]
Stretch the end that is closest to the given value only if it lies outside the Range.
The resulting Range will retain the direction of the original range.
Examples
use nannou::geom::Range; let a = Range::new(2.5, 5.0); assert_eq!(a.stretch_to_value(10.0), Range::new(2.5, 10.0)); assert_eq!(a.stretch_to_value(0.0), Range::new(0.0, 5.0)); let b = Range::new(0.0, -5.0); assert_eq!(b.stretch_to_value(10.0), Range::new(10.0, -5.0)); assert_eq!(b.stretch_to_value(-10.0), Range::new(0.0, -10.0));
pub fn has_same_direction(self, other: Self) -> bool
[src]
Does self
have the same direction as other
.
Examples
use nannou::geom::Range; assert!(Range::new(0.0, 1.0).has_same_direction(Range::new(100.0, 200.0))); assert!(Range::new(0.0, -5.0).has_same_direction(Range::new(-2.5, -6.0))); assert!(!Range::new(0.0, 5.0).has_same_direction(Range::new(2.5, -2.5)));
pub fn align_start_of(self, other: Self) -> Self
[src]
Align the start
of self
to the start
of the other
Range.
If the direction of other
is different to self
, self
's end
will be aligned to the
start
of other
instead.
Examples
use nannou::geom::Range; let a = Range::new(2.5, 7.5); let b = Range::new(0.0, 10.0); assert_eq!(a.align_start_of(b), Range::new(0.0, 5.0)); assert_eq!(b.align_start_of(a), Range::new(2.5, 12.5)); let c = Range::new(2.5, -2.5); let d = Range::new(-5.0, 5.0); assert_eq!(c.align_start_of(d), Range::new(0.0, -5.0)); assert_eq!(d.align_start_of(c), Range::new(-7.5, 2.5));
pub fn align_end_of(self, other: Self) -> Self
[src]
Align the end
of self
to the end
of the other
Range.
If the direction of other
is different to self
, self
's start
will be aligned to the
end
of other
instead.
Examples
use nannou::geom::Range; let a = Range::new(2.5, 7.5); let b = Range::new(0.0, 10.0); assert_eq!(a.align_end_of(b), Range::new(5.0, 10.0)); assert_eq!(b.align_end_of(a), Range::new(-2.5, 7.5)); let c = Range::new(2.5, -2.5); let d = Range::new(-5.0, 5.0); assert_eq!(c.align_end_of(d), Range::new(5.0, 0.0)); assert_eq!(d.align_end_of(c), Range::new(-2.5, 7.5));
pub fn align_middle_of(self, other: Self) -> Self
[src]
Align the middle of self
to the middle of the other
Range.
Examples
use nannou::geom::Range; let a = Range::new(0.0, 5.0); let b = Range::new(0.0, 10.0); assert_eq!(a.align_middle_of(b), Range::new(2.5, 7.5)); assert_eq!(b.align_middle_of(a), Range::new(-2.5, 7.5)); let c = Range::new(2.5, -2.5); let d = Range::new(-10.0, 0.0); assert_eq!(c.align_middle_of(d), Range::new(-2.5, -7.5)); assert_eq!(d.align_middle_of(c), Range::new(-5.0, 5.0));
pub fn align_after(self, other: Self) -> Self
[src]
Aligns the start
of self
with the end
of other
.
If the directions are opposite, aligns the end
of self with the end
of other
.
Examples
use nannou::geom::Range; let a = Range::new(2.5, 7.5); let b = Range::new(0.0, 10.0); assert_eq!(a.align_after(b), Range::new(10.0, 15.0)); assert_eq!(b.align_after(a), Range::new(7.5, 17.5)); let c = Range::new(2.5, -2.5); let d = Range::new(-5.0, 5.0); assert_eq!(c.align_after(d), Range::new(10.0, 5.0)); assert_eq!(d.align_after(c), Range::new(-12.5, -2.5));
pub fn align_before(self, other: Self) -> Self
[src]
Aligns the end
of self
with the start
of other
.
If the directions are opposite, aligns the start
of self with the start
of other
.
Examples
use nannou::geom::Range; let a = Range::new(2.5, 7.5); let b = Range::new(0.0, 10.0); assert_eq!(a.align_before(b), Range::new(-5.0, 0.0)); assert_eq!(b.align_before(a), Range::new(-7.5, 2.5)); let c = Range::new(2.5, -2.5); let d = Range::new(-5.0, 5.0); assert_eq!(c.align_before(d), Range::new(-5.0, -10.0)); assert_eq!(d.align_before(c), Range::new(2.5, 12.5));
pub fn align_to(self, align: Align, other: Self) -> Self
[src]
Align self
to other
along the x axis in accordance with the given Align
variant.
pub fn closest_edge(&self, scalar: S) -> Edge
[src]
The closest Edge of self
to the given scalar
.
Returns Start if the distance between both Edges is equal.
Examples
use nannou::geom::{Edge, Range}; assert_eq!(Range::new(0.0, 10.0).closest_edge(4.0), Edge::Start); assert_eq!(Range::new(0.0, 10.0).closest_edge(7.0), Edge::End); assert_eq!(Range::new(0.0, 10.0).closest_edge(5.0), Edge::Start);
Trait Implementations
impl<S: Copy> Copy for Range<S>
[src]
impl<S: Clone> Clone for Range<S>
[src]
fn clone(&self) -> Range<S>
[src]
Returns a copy of the value. Read more
fn clone_from(&mut self, source: &Self)
1.0.0[src]
Performs copy-assignment from source
. Read more
impl<S: Debug> Debug for Range<S>
[src]
fn fmt(&self, __arg_0: &mut Formatter) -> Result
[src]
Formats the value using the given formatter. Read more
impl<S: PartialEq> PartialEq for Range<S>
[src]
fn eq(&self, __arg_0: &Range<S>) -> bool
[src]
This method tests for self
and other
values to be equal, and is used by ==
. Read more
fn ne(&self, __arg_0: &Range<S>) -> bool
[src]
This method tests for !=
.
impl<S: PartialOrd> PartialOrd for Range<S>
[src]
fn partial_cmp(&self, __arg_0: &Range<S>) -> Option<Ordering>
[src]
This method returns an ordering between self
and other
values if one exists. Read more
fn lt(&self, __arg_0: &Range<S>) -> bool
[src]
This method tests less than (for self
and other
) and is used by the <
operator. Read more
fn le(&self, __arg_0: &Range<S>) -> bool
[src]
This method tests less than or equal to (for self
and other
) and is used by the <=
operator. Read more
fn gt(&self, __arg_0: &Range<S>) -> bool
[src]
This method tests greater than (for self
and other
) and is used by the >
operator. Read more
fn ge(&self, __arg_0: &Range<S>) -> bool
[src]
This method tests greater than or equal to (for self
and other
) and is used by the >=
operator. Read more