fyrox_ui/thickness.rs
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155
//! Describes the thickness of a frame around a rectangle (for all four sides).
use crate::core::{algebra::Vector2, reflect::prelude::*, visitor::prelude::*};
/// Describes the thickness of a frame around a rectangle (for all four sides). It is primarily used to
/// define margins and to define stroke thickness for various widgets.
#[derive(Copy, Clone, PartialEq, Debug, Reflect, Visit)]
pub struct Thickness {
/// Thickness of the left side of a rectangle.
pub left: f32,
/// Thickness of the top side of a rectangle.
pub top: f32,
/// Thickness of the right side of a rectangle.
pub right: f32,
/// Thickness of the bottom side of a rectangle.
pub bottom: f32,
}
impl Default for Thickness {
fn default() -> Self {
Self::uniform(0.0)
}
}
impl Thickness {
/// Degenerate thickness that has no effect.
pub fn zero() -> Self {
Self {
left: 0.0,
top: 0.0,
right: 0.0,
bottom: 0.0,
}
}
/// Uniform thickness for all four sides of a rectangle.
pub fn uniform(v: f32) -> Self {
Self {
left: v,
top: v,
right: v,
bottom: v,
}
}
/// Thickness for the bottom side of a rectangle.
pub fn bottom(v: f32) -> Self {
Self {
left: 0.0,
top: 0.0,
right: 0.0,
bottom: v,
}
}
/// Thickness for the top side of a rectangle.
pub fn top(v: f32) -> Self {
Self {
left: 0.0,
top: v,
right: 0.0,
bottom: 0.0,
}
}
/// Thickness for the left side of a rectangle.
pub fn left(v: f32) -> Self {
Self {
left: v,
top: 0.0,
right: 0.0,
bottom: 0.0,
}
}
/// Thickness for the rigth side of a rectangle.
pub fn right(v: f32) -> Self {
Self {
left: 0.0,
top: 0.0,
right: v,
bottom: 0.0,
}
}
/// Thickness for the top and right sides of a rectangle.
pub fn top_right(v: f32) -> Self {
Self {
left: 0.0,
top: v,
right: v,
bottom: 0.0,
}
}
/// Thickness for the top and left sides of a rectangle.
pub fn top_left(v: f32) -> Self {
Self {
left: v,
top: v,
right: 0.0,
bottom: 0.0,
}
}
/// Thickness for the bottom and right sides of a rectangle.
pub fn bottom_right(v: f32) -> Self {
Self {
left: 0.0,
top: 0.0,
right: v,
bottom: v,
}
}
/// Thickness for the bottom and left sides of a rectangle.
pub fn bottom_left(v: f32) -> Self {
Self {
left: v,
top: 0.0,
right: 0.0,
bottom: v,
}
}
/// Thickness for the top and bottom sides of a rectangle.
pub fn top_bottom(v: f32) -> Self {
Self {
left: 0.0,
top: v,
right: 0.0,
bottom: v,
}
}
/// Thickness for the left and right sides of a rectangle.
pub fn left_right(v: f32) -> Self {
Self {
left: v,
top: 0.0,
right: v,
bottom: 0.0,
}
}
/// Returns an offset defined by this thickness. It is just a vector `(left, top)`.
pub fn offset(&self) -> Vector2<f32> {
Vector2::new(self.left, self.top)
}
/// Returns a margin for each axis (horizontal and vertical).
pub fn axes_margin(&self) -> Vector2<f32> {
Vector2::new(self.left + self.right, self.top + self.bottom)
}
}