migrations/egui
1
0
Fork 0
mirror of https://github.com/emilk/egui.git synced 2026-08-29 04:40:03 -04:00
Code Activity

Documentation improvements

Browse Source
This commit is contained in:
Emil Ernerfeldt
2022-01-26 22:09:19 +01:00
parent 0d00185d9f
commit 1134258441
5 changed files with 28 additions and 22 deletions
Download Patch File Download Diff File Expand all files Collapse all files

32
emath/src/rect.rs
View File

@@ -5,18 +5,29 @@ use crate::*;
/// A rectangular region of space.
///
/// Normally given in points, e.g. logical pixels.
/// Usually a `Rect` has a positive (or zero) size,
/// and then [`Self::min`] `<=` [`Self::max`].
/// In these cases [`Self::min`] is the left-top corner
/// and [`Self::max`] is the right-bottom corner.
///
/// A rectangle is allowed to have a negative size, which happens when the order
/// of `min` and `max` are swapped. These are usually a sign of an error.
///
/// Normally the unit is points (logical pixels) in screen space coordinates.
#[repr(C)]
#[derive(Clone, Copy, Eq, PartialEq)]
#[cfg_attr(feature = "serde", derive(serde::Deserialize, serde::Serialize))]
#[cfg_attr(feature = "bytemuck", derive(bytemuck::Pod, bytemuck::Zeroable))]
pub struct Rect {
/// One of the corners of the rectangle, usually the left top one.
pub min: Pos2,
/// The other corner, opposing [`Self::min`]. Usually the right bottom one.
pub max: Pos2,
}
impl Rect {
/// Infinite rectangle that contains everything.
/// Infinite rectangle that contains every point.
pub const EVERYTHING: Self = Self {
min: pos2(-INFINITY, -INFINITY),
max: pos2(INFINITY, INFINITY),
@@ -25,19 +36,14 @@ impl Rect {
/// The inverse of [`Self::EVERYTHING`]: stretches from positive infinity to negative infinity.
/// Contains no points.
///
/// This is useful as the seed for bounding bounding boxes.
///
/// ```
/// # use emath::*;
/// let inf = f32::INFINITY;
/// assert!(Rect::NOTHING.size() == Vec2::splat(-inf));
/// assert!(Rect::NOTHING.contains(pos2(0.0, 0.0)) == false);
/// ```
/// This is useful as the seed for bounding boxes.
///
/// # Example:
/// ```
/// # use emath::*;
/// let mut rect = Rect::NOTHING;
/// assert!(rect.size() == Vec2::splat(-f32::INFINITY));
/// assert!(rect.contains(pos2(0.0, 0.0)) == false);
/// rect.extend_with(pos2(2.0, 1.0));
/// rect.extend_with(pos2(0.0, 3.0));
/// assert_eq!(rect, Rect::from_min_max(pos2(0.0, 1.0), pos2(2.0, 3.0)))
@@ -50,7 +56,7 @@ impl Rect {
/// An invalid `Rect` filled with [`f32::NAN`];
pub const NAN: Self = Self {
min: pos2(f32::NAN, f32::NAN),
max: pos2(-f32::NAN, -f32::NAN),
max: pos2(f32::NAN, f32::NAN),
};
#[inline(always)]
@@ -58,6 +64,7 @@ impl Rect {
Rect { min, max }
}
/// left-top corner plus a size (stretching right-down).
#[inline(always)]
pub fn from_min_size(min: Pos2, size: Vec2) -> Self {
Rect {
@@ -82,6 +89,7 @@ impl Rect {
}
}
/// Returns the bounding rectangle of the two points.
#[inline]
pub fn from_two_pos(a: Pos2, b: Pos2) -> Self {
Rect {
@@ -90,7 +98,7 @@ impl Rect {
}
}
/// Bounding-box around the points
/// Bounding-box around the points.
pub fn from_points(points: &[Pos2]) -> Self {
let mut rect = Rect::NOTHING;
for &p in points {