Struct euclid::TypedRect
[−]
[src]
#[repr(C)]pub struct TypedRect<T, U = UnknownUnit> { pub origin: TypedPoint2D<T, U>, pub size: TypedSize2D<T, U>, }
A 2d Rectangle optionally tagged with a unit.
Fields
origin: TypedPoint2D<T, U>
size: TypedSize2D<T, U>
Methods
impl<T, U> TypedRect<T, U>
[src]
fn new(origin: TypedPoint2D<T, U>, size: TypedSize2D<T, U>) -> Self
[src]
Constructor.
impl<T, U> TypedRect<T, U> where
T: Copy + Clone + Zero + PartialOrd + PartialEq + Add<T, Output = T> + Sub<T, Output = T>,
[src]
T: Copy + Clone + Zero + PartialOrd + PartialEq + Add<T, Output = T> + Sub<T, Output = T>,
fn intersects(&self, other: &Self) -> bool
[src]
fn max_x(&self) -> T
[src]
fn min_x(&self) -> T
[src]
fn max_y(&self) -> T
[src]
fn min_y(&self) -> T
[src]
fn max_x_typed(&self) -> Length<T, U>
[src]
fn min_x_typed(&self) -> Length<T, U>
[src]
fn max_y_typed(&self) -> Length<T, U>
[src]
fn min_y_typed(&self) -> Length<T, U>
[src]
fn intersection(&self, other: &Self) -> Option<Self>
[src]
fn translate(&self, by: &TypedVector2D<T, U>) -> Self
[src]
Returns the same rectangle, translated by a vector.
fn contains(&self, other: &TypedPoint2D<T, U>) -> bool
[src]
Returns true if this rectangle contains the point. Points are considered in the rectangle if they are on the left or top edge, but outside if they are on the right or bottom edge.
fn contains_rect(&self, rect: &Self) -> bool
[src]
Returns true if this rectangle contains the interior of rect. Always returns true if rect is empty, and always returns false if rect is nonempty but this rectangle is empty.
fn inflate(&self, width: T, height: T) -> Self
[src]
fn inflate_typed(&self, width: Length<T, U>, height: Length<T, U>) -> Self
[src]
fn top_right(&self) -> TypedPoint2D<T, U>
[src]
fn bottom_left(&self) -> TypedPoint2D<T, U>
[src]
fn bottom_right(&self) -> TypedPoint2D<T, U>
[src]
fn translate_by_size(&self, size: &TypedSize2D<T, U>) -> Self
[src]
fn from_points(points: &[TypedPoint2D<T, U>]) -> Self
[src]
Returns the smallest rectangle containing the four points.
impl<T, U> TypedRect<T, U> where
T: Copy + One + Add<Output = T> + Sub<Output = T> + Mul<Output = T>,
[src]
T: Copy + One + Add<Output = T> + Sub<Output = T> + Mul<Output = T>,
fn lerp(&self, other: Self, t: T) -> Self
[src]
Linearly interpolate between this rectangle and another rectange.
t
is expected to be between zero and one.
impl<T, U> TypedRect<T, U> where
T: Copy + Clone + PartialOrd + Add<T, Output = T> + Sub<T, Output = T> + Zero,
[src]
T: Copy + Clone + PartialOrd + Add<T, Output = T> + Sub<T, Output = T> + Zero,
impl<T, U> TypedRect<T, U>
[src]
fn scale<Scale: Copy>(&self, x: Scale, y: Scale) -> Self where
T: Copy + Clone + Mul<Scale, Output = T>,
[src]
T: Copy + Clone + Mul<Scale, Output = T>,
impl<T: Copy + PartialEq + Zero, U> TypedRect<T, U>
[src]
fn zero() -> Self
[src]
Constructor, setting all sides to zero.
fn is_empty(&self) -> bool
[src]
Returns true if the size is zero, regardless of the origin's value.
impl<T: Copy, Unit> TypedRect<T, Unit>
[src]
fn to_untyped(&self) -> Rect<T>
[src]
Drop the units, preserving only the numeric value.
fn from_untyped(r: &Rect<T>) -> TypedRect<T, Unit>
[src]
Tag a unitless value with units.
impl<T0: NumCast + Copy, Unit> TypedRect<T0, Unit>
[src]
fn cast<T1: NumCast + Copy>(&self) -> Option<TypedRect<T1, Unit>>
[src]
Cast from one numeric representation to another, preserving the units.
When casting from floating point to integer coordinates, the decimals are truncated as one would expect from a simple cast, but this behavior does not always make sense geometrically. Consider using round(), round_in or round_out() before casting.
impl<T: Floor + Ceil + Round + Add<T, Output = T> + Sub<T, Output = T>, U> TypedRect<T, U>
[src]
fn round(&self) -> Self
[src]
Return a rectangle with edges rounded to integer coordinates, such that the returned rectangle has the same set of pixel centers as the original one. Edges at offset 0.5 round up. Suitable for most places where integral device coordinates are needed, but note that any translation should be applied first to avoid pixel rounding errors. Note that this is not rounding to nearest integer if the values are negative. They are always rounding as floor(n + 0.5).
fn round_in(&self) -> Self
[src]
Return a rectangle with edges rounded to integer coordinates, such that the original rectangle contains the resulting rectangle.
fn round_out(&self) -> Self
[src]
Return a rectangle with edges rounded to integer coordinates, such that the original rectangle is contained in the resulting rectangle.
impl<T: NumCast + Copy, Unit> TypedRect<T, Unit>
[src]
fn to_f32(&self) -> TypedRect<f32, Unit>
[src]
Cast into an f32
rectangle.
fn to_f64(&self) -> TypedRect<f64, Unit>
[src]
Cast into an f64
rectangle.
fn to_usize(&self) -> TypedRect<usize, Unit>
[src]
Cast into an usize
rectangle, truncating decimals if any.
When casting from floating point rectangles, it is worth considering whether
to round()
, round_in()
or round_out()
before the cast in order to
obtain the desired conversion behavior.
fn to_i32(&self) -> TypedRect<i32, Unit>
[src]
Cast into an i32
rectangle, truncating decimals if any.
When casting from floating point rectangles, it is worth considering whether
to round()
, round_in()
or round_out()
before the cast in order to
obtain the desired conversion behavior.
fn to_i64(&self) -> TypedRect<i64, Unit>
[src]
Cast into an i64
rectangle, truncating decimals if any.
When casting from floating point rectangles, it is worth considering whether
to round()
, round_in()
or round_out()
before the cast in order to
obtain the desired conversion behavior.
Trait Implementations
impl<T: HeapSizeOf, U> HeapSizeOf for TypedRect<T, U>
[src]
fn heap_size_of_children(&self) -> usize
[src]
Measure the size of any heap-allocated structures that hang off this value, but not the space taken up by the value itself (i.e. what size_of:: measures, more or less); that space is handled by the implementation of HeapSizeOf for Box below. Read more
impl<'de, T: Copy + Deserialize<'de>, U> Deserialize<'de> for TypedRect<T, U>
[src]
fn deserialize<D>(deserializer: D) -> Result<Self, D::Error> where
D: Deserializer<'de>,
[src]
D: Deserializer<'de>,
Deserialize this value from the given Serde deserializer. Read more
impl<T: Serialize, U> Serialize for TypedRect<T, U>
[src]
fn serialize<S>(&self, serializer: S) -> Result<S::Ok, S::Error> where
S: Serializer,
[src]
S: Serializer,
Serialize this value into the given Serde serializer. Read more
impl<T: Hash, U> Hash for TypedRect<T, U>
[src]
fn hash<H: Hasher>(&self, h: &mut H)
[src]
Feeds this value into the given [Hasher
]. Read more
fn hash_slice<H>(data: &[Self], state: &mut H) where
H: Hasher,
1.3.0[src]
H: Hasher,
Feeds a slice of this type into the given [Hasher
]. Read more
impl<T: Copy, U> Copy for TypedRect<T, U>
[src]
impl<T: Copy, U> Clone for TypedRect<T, U>
[src]
fn clone(&self) -> Self
[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<T: PartialEq, U> PartialEq<TypedRect<T, U>> for TypedRect<T, U>
[src]
fn eq(&self, other: &Self) -> bool
[src]
This method tests for self
and other
values to be equal, and is used by ==
. Read more
fn ne(&self, other: &Rhs) -> bool
1.0.0[src]
This method tests for !=
.
impl<T: Eq, U> Eq for TypedRect<T, U>
[src]
impl<T: Debug, U> Debug for TypedRect<T, U>
[src]
impl<T: Display, U> Display for TypedRect<T, U>
[src]
fn fmt(&self, formatter: &mut Formatter) -> Result
[src]
Formats the value using the given formatter. Read more
impl<T: Copy + Mul<T, Output = T>, U> Mul<T> for TypedRect<T, U>
[src]
type Output = Self
The resulting type after applying the *
operator.
fn mul(self, scale: T) -> Self
[src]
Performs the *
operation.
impl<T: Copy + Div<T, Output = T>, U> Div<T> for TypedRect<T, U>
[src]
type Output = Self
The resulting type after applying the /
operator.
fn div(self, scale: T) -> Self
[src]
Performs the /
operation.
impl<T: Copy + Mul<T, Output = T>, U1, U2> Mul<ScaleFactor<T, U1, U2>> for TypedRect<T, U1>
[src]
type Output = TypedRect<T, U2>
The resulting type after applying the *
operator.
fn mul(self, scale: ScaleFactor<T, U1, U2>) -> TypedRect<T, U2>
[src]
Performs the *
operation.