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 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382
use geom::{Angle, Bounds, GPSBounds, Polygon, Pt2D, Tessellation};
use crate::{
svg, Color, DeferDraw, Drawable, EventCtx, Fill, GfxCtx, JustDraw, Prerender, ScreenDims,
Widget,
};
pub mod geom_batch_stack;
/// A mutable builder for a group of colored tessellated polygons.
#[derive(Clone)]
pub struct GeomBatch {
// f64 is the z-value offset. This must be in (-1, 0], with values closer to -1.0
// rendering above values closer to 0.0.
pub(crate) list: Vec<(Fill, Tessellation, f64)>,
pub autocrop_dims: bool,
}
impl std::fmt::Debug for GeomBatch {
fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result {
f.debug_struct("GeomBatch")
.field("bounds", &self.get_bounds())
.field("items", &self.list.len())
.field("autocrop_dims", &self.autocrop_dims)
.finish()
}
}
impl GeomBatch {
/// Creates an empty batch.
pub fn new() -> GeomBatch {
GeomBatch {
list: Vec::new(),
autocrop_dims: true,
}
}
/// Adds a single tessellated polygon, painted according to `Fill`
pub fn push<F: Into<Fill>, T: Into<Tessellation>>(&mut self, fill: F, p: T) {
self.push_with_z(fill, p, 0.0);
}
/// Offset z value to render above/below other polygons.
/// z must be in (-1, 0] to ensure we don't traverse layers of the UI - to make
/// sure we don't inadvertently render something *above* a tooltip, etc.
pub fn push_with_z<F: Into<Fill>, T: Into<Tessellation>>(
&mut self,
fill: F,
p: T,
z_offset: f64,
) {
debug_assert!(z_offset > -1.0);
debug_assert!(z_offset <= 0.0);
self.list.push((fill.into(), p.into(), z_offset));
}
/// Adds a single polygon to the front of the batch, painted according to `Fill`
pub fn unshift<F: Into<Fill>, T: Into<Tessellation>>(&mut self, fill: F, p: T) {
self.list.insert(0, (fill.into(), p.into(), 0.0));
}
/// Removes the first polygon in the batch.
pub fn shift(&mut self) {
self.list.remove(0);
}
/// Applies one Fill to many polygons.
pub fn extend<F: Into<Fill>, T: Into<Tessellation>>(&mut self, fill: F, polys: Vec<T>) {
let fill = fill.into();
for p in polys {
self.list.push((fill.clone(), p.into(), 0.0));
}
}
/// Appends all colored polygons from another batch to the current one.
pub fn append(&mut self, other: GeomBatch) {
self.list.extend(other.list);
}
/// Returns the colored polygons in this batch, destroying the batch.
pub fn consume(self) -> Vec<(Fill, Tessellation, f64)> {
self.list
}
/// Draws the batch, consuming it. Only use this for drawing things once.
pub fn draw(self, g: &mut GfxCtx) {
let obj = g.prerender.upload_temporary(self);
g.redraw(&obj);
}
/// Upload the batch of polygons to the GPU, returning something that can be cheaply redrawn
/// many times later.
pub fn upload(self, ctx: &EventCtx) -> Drawable {
ctx.prerender.upload(self)
}
/// Wrap in a Widget for layouting, so this batch can become part of a larger one.
pub fn batch(self) -> Widget {
DeferDraw::new_widget(self)
}
/// Wrap in a Widget, so the batch can be drawn as part of a Panel.
pub fn into_widget(self, ctx: &EventCtx) -> Widget {
JustDraw::wrap(ctx, self)
}
/// Compute the bounds of all polygons in this batch.
pub fn get_bounds(&self) -> Bounds {
let mut bounds = Bounds::new();
for (_, poly, _) in &self.list {
bounds.union(poly.get_bounds());
}
if !self.autocrop_dims {
bounds.update(Pt2D::new(0.0, 0.0));
}
bounds
}
/// Sets the top-left to 0, 0. Not sure exactly when this should be used.
pub fn autocrop(mut self) -> GeomBatch {
let bounds = self.get_bounds();
if bounds.min_x == 0.0 && bounds.min_y == 0.0 {
return self;
}
for (_, poly, _) in &mut self.list {
poly.translate(-bounds.min_x, -bounds.min_y);
}
self
}
/// True when the batch is empty.
pub fn is_empty(&self) -> bool {
self.list.is_empty()
}
/// Returns the width and height of all geometry contained in the batch.
pub fn get_dims(&self) -> ScreenDims {
// TODO Maybe warn about this happening and avoid in the first place? Sometimes we wind up
// trying to draw completely empty text.
if self.is_empty() {
return ScreenDims::new(0.0, 0.0);
}
let bounds = self.get_bounds();
ScreenDims::new(bounds.width(), bounds.height())
}
/// Returns a batch containing an SVG from a file.
pub fn load_svg<P: AsRef<Prerender>, I: AsRef<str>>(prerender: &P, filename: I) -> GeomBatch {
svg::load_svg(prerender.as_ref(), filename.as_ref()).0
}
/// Returns a GeomBatch from the bytes of a utf8 encoded SVG string.
pub fn load_svg_bytes<P: AsRef<Prerender>>(
prerender: &P,
labeled_bytes: (&str, &[u8]),
) -> GeomBatch {
svg::load_svg_bytes(prerender.as_ref(), labeled_bytes.0, labeled_bytes.1)
.expect("invalid svg bytes")
.0
}
/// Returns a GeomBatch from the bytes of a utf8 encoded SVG string.
///
/// Prefer to use `load_svg_bytes`, which caches the parsed SVG, unless
/// the SVG was dynamically generated, or is otherwise unlikely to be
/// reused.
pub fn load_svg_bytes_uncached(raw: &[u8]) -> GeomBatch {
svg::load_svg_from_bytes_uncached(raw).unwrap().0
}
/// Transforms all colors in a batch.
pub fn color(mut self, transformation: RewriteColor) -> GeomBatch {
for (fancy, _, _) in &mut self.list {
if let Fill::Color(ref mut c) = fancy {
*c = transformation.apply(*c);
}
}
self
}
/// Translates the batch to be centered on some point.
pub fn centered_on(self, center: Pt2D) -> GeomBatch {
let dims = self.get_dims();
let dx = center.x() - dims.width / 2.0;
let dy = center.y() - dims.height / 2.0;
self.translate(dx, dy)
}
/// Translates the batch by some offset.
pub fn translate(mut self, dx: f64, dy: f64) -> GeomBatch {
for (_, poly, _) in &mut self.list {
poly.translate(dx, dy);
}
self
}
/// Rotates each polygon in the batch relative to the center of that polygon.
pub fn rotate(mut self, angle: Angle) -> GeomBatch {
for (_, poly, _) in &mut self.list {
poly.rotate(angle);
}
self
}
/// Rotates each polygon in the batch relative to the center of the entire batch.
pub fn rotate_around_batch_center(mut self, angle: Angle) -> GeomBatch {
// Bounds won't be defined if so
if self.list.is_empty() {
return self;
}
let center = self.get_bounds().center();
for (_, poly, _) in &mut self.list {
poly.rotate_around(angle, center);
}
self
}
/// Equivalent to
/// `self.scale(scale).centered_on(center_on).rotate_around_batch_center(rotate)`, but faster.
pub fn multi_transform(mut self, scale: f64, center_on: Pt2D, rotate: Angle) -> GeomBatch {
if self.list.is_empty() {
return self;
}
let bounds = self.get_bounds().scale(scale);
let dx = center_on.x() - bounds.width() / 2.0;
let dy = center_on.y() - bounds.height() / 2.0;
let rotate_around_pt = bounds.center().offset(dx, dy);
for (_, poly, _) in &mut self.list {
poly.inplace_multi_transform(scale, dx, dy, rotate, rotate_around_pt);
}
self
}
/// Scales the batch by some factor.
pub fn scale(self, factor: f64) -> GeomBatch {
self.scale_xy(factor, factor)
}
pub fn scale_xy(mut self, x_factor: f64, y_factor: f64) -> GeomBatch {
#[allow(clippy::float_cmp)]
if x_factor == 1.0 && y_factor == 1.0 {
return self;
}
for (_, poly, _) in &mut self.list {
poly.scale_xy(x_factor, y_factor);
}
self
}
/// Scales the batch so that the width matches something, preserving aspect ratio.
pub fn scale_to_fit_width(self, width: f64) -> GeomBatch {
let ratio = width / self.get_bounds().width();
self.scale(ratio)
}
/// Scales the batch so that the height matches something, preserving aspect ratio.
pub fn scale_to_fit_height(self, height: f64) -> GeomBatch {
let ratio = height / self.get_bounds().height();
self.scale(ratio)
}
/// Scales the batch so that the width and height do not exceed some maximum, preserving aspect ratio.
pub fn scale_to_fit_square(self, dims: f64) -> GeomBatch {
let ratio1 = dims / self.get_bounds().width();
let ratio2 = dims / self.get_bounds().height();
self.scale(ratio1.min(ratio2))
}
/// Overrides the Z-ordering offset for the batch. Must be in (-1, 0], with values closer to -1
/// rendering on top.
pub fn set_z_offset(mut self, offset: f64) -> GeomBatch {
if offset <= -1.0 || offset > 0.0 {
panic!("set_z_offset({}) must be in (-1, 0]", offset);
}
for (_, _, z) in &mut self.list {
*z = offset;
}
self
}
/// Exports the batch to a list of GeoJSON features, labeling each colored triangle. Note the
/// result will be very large and kind of meaningless -- individual triangles are returned; any
/// original polygons are lost. Z-values, alpha values from the color, and non-RGB fill
/// patterns are lost. The world-space coordinates are optionally translated back to GPS.
pub fn into_geojson(self, gps_bounds: Option<&GPSBounds>) -> Vec<geojson::Feature> {
let mut features = Vec::new();
for (fill, polygon, _) in self.list {
if let Fill::Color(color) = fill {
let mut properties = serde_json::Map::new();
properties.insert("color".to_string(), color.as_hex().into());
for triangle in polygon.triangles() {
features.push(geojson::Feature {
bbox: None,
// TODO We could do a bit better and at least emit a MultiPolygon
geometry: Some(Polygon::from_triangle(&triangle).to_geojson(gps_bounds)),
id: None,
properties: Some(properties.clone()),
foreign_members: None,
});
}
}
}
features
}
pub fn build(self, ctx: &EventCtx) -> Drawable {
ctx.upload(self)
}
}
impl Default for GeomBatch {
fn default() -> Self {
GeomBatch::new()
}
}
impl<F: Into<Fill>, T: Into<Tessellation>> From<Vec<(F, T)>> for GeomBatch {
/// Creates a batch of filled polygons.
fn from(list: Vec<(F, T)>) -> GeomBatch {
GeomBatch {
list: list
.into_iter()
.map(|(c, p)| (c.into(), p.into(), 0.0))
.collect(),
autocrop_dims: true,
}
}
}
/// A way to transform all colors in a GeomBatch.
#[derive(Debug, Clone, Copy, PartialEq, serde::Serialize, serde::Deserialize)]
pub enum RewriteColor {
/// Don't do anything
NoOp,
/// Change every instance of the first color to the second
Change(Color, Color),
/// Change all colors to the specified value. For this to be interesting, the batch shouldn't
/// be a solid block of color. This does not modify Color::CLEAR.
ChangeAll(Color),
/// Change the alpha value of all colors to this value.
ChangeAlpha(f32),
/// Convert all colors to greyscale.
MakeGrayscale,
}
impl std::convert::From<Color> for RewriteColor {
fn from(color: Color) -> RewriteColor {
RewriteColor::ChangeAll(color)
}
}
impl RewriteColor {
fn apply(&self, c: Color) -> Color {
match self {
RewriteColor::NoOp => c,
RewriteColor::Change(from, to) => {
if c == *from {
*to
} else {
c
}
}
RewriteColor::ChangeAll(to) => {
if c == Color::CLEAR {
c
} else {
*to
}
}
RewriteColor::ChangeAlpha(alpha) => c.alpha(*alpha),
RewriteColor::MakeGrayscale => {
let avg = (c.r + c.g + c.b) / 3.0;
Color::grey(avg).alpha(c.a)
}
}
}
}