(svn r27667) -Codechange: Add VehicleSpriteSeq::GetBounds and Draw.

11 files changed, 118 insertions, 73 deletions

diff --git a/src/aircraft_cmd.cpp b/src/aircraft_cmd.cpp
index c7cb5bbb2..28680ad92 100644
--- a/src/aircraft_cmd.cpp
+++ b/src/aircraft_cmd.cpp
@@ -202,17 +202,19 @@ void DrawAircraftEngine(int left, int right, int preferred_x, int y, EngineID en
 	VehicleSpriteSeq seq;
 	GetAircraftIcon(engine, image_type, &seq);
 
-	const Sprite *real_sprite = GetSprite(seq.sprite, ST_NORMAL);
+	Rect rect;
+	seq.GetBounds(&rect);
 	preferred_x = Clamp(preferred_x,
-			left - UnScaleGUI(real_sprite->x_offs),
-			right - UnScaleGUI(real_sprite->width) - UnScaleGUI(real_sprite->x_offs));
-	DrawSprite(seq.sprite, pal, preferred_x, y);
+			left - UnScaleGUI(rect.left),
+			right - UnScaleGUI(rect.right));
+
+	seq.Draw(preferred_x, y, pal, pal == PALETTE_CRASH);
 
 	if (!(AircraftVehInfo(engine)->subtype & AIR_CTOL)) {
 		VehicleSpriteSeq rotor_seq;
 		GetCustomRotorIcon(engine, image_type, &rotor_seq);
 		if (!rotor_seq.IsValid()) rotor_seq.Set(SPR_ROTOR_STOPPED);
-		DrawSprite(rotor_seq.sprite, PAL_NONE, preferred_x, y - ScaleGUITrad(5));
+		rotor_seq.Draw(preferred_x, y - ScaleGUITrad(5), PAL_NONE, false);
 	}
 }
 
@@ -230,12 +232,13 @@ void GetAircraftSpriteSize(EngineID engine, uint &width, uint &height, int &xoff
 	VehicleSpriteSeq seq;
 	GetAircraftIcon(engine, image_type, &seq);
 
-	const Sprite *spr = GetSprite(seq.sprite, ST_NORMAL);
+	Rect rect;
+	seq.GetBounds(&rect);
 
-	width  = UnScaleGUI(spr->width);
-	height = UnScaleGUI(spr->height);
-	xoffs  = UnScaleGUI(spr->x_offs);
-	yoffs  = UnScaleGUI(spr->y_offs);
+	width  = UnScaleGUI(rect.right - rect.left + 1);
+	height = UnScaleGUI(rect.bottom - rect.top + 1);
+	xoffs  = UnScaleGUI(rect.left);
+	yoffs  = UnScaleGUI(rect.top);
 }
 
 /**
diff --git a/src/aircraft_gui.cpp b/src/aircraft_gui.cpp
index 752e0da90..20fca9fc5 100644
--- a/src/aircraft_gui.cpp
+++ b/src/aircraft_gui.cpp
@@ -86,10 +86,11 @@ void DrawAircraftImage(const Vehicle *v, int left, int right, int y, VehicleID s
 	VehicleSpriteSeq seq;
 	v->GetImage(rtl ? DIR_E : DIR_W, image_type, &seq);
 
-	const Sprite *real_sprite = GetSprite(seq.sprite, ST_NORMAL);
+	Rect rect;
+	seq.GetBounds(&rect);
 
-	int width = UnScaleGUI(real_sprite->width);
-	int x_offs = UnScaleGUI(real_sprite->x_offs);
+	int width = UnScaleGUI(rect.right - rect.left + 1);
+	int x_offs = UnScaleGUI(rect.left);
 	int x = rtl ? right - width - x_offs : left - x_offs;
 	bool helicopter = v->subtype == AIR_HELICOPTER;
 
@@ -97,18 +98,18 @@ void DrawAircraftImage(const Vehicle *v, int left, int right, int y, VehicleID s
 	int heli_offs = 0;
 
 	PaletteID pal = (v->vehstatus & VS_CRASHED) ? PALETTE_CRASH : GetVehiclePalette(v);
-	DrawSprite(seq.sprite, pal, x, y + y_offs);
+	seq.Draw(x, y + y_offs, pal, v->vehstatus & VS_CRASHED);
 	if (helicopter) {
 		const Aircraft *a = Aircraft::From(v);
 		VehicleSpriteSeq rotor_seq;
 		GetCustomRotorSprite(a, true, image_type, &rotor_seq);
 		if (!rotor_seq.IsValid()) rotor_seq.Set(SPR_ROTOR_STOPPED);
 		heli_offs = ScaleGUITrad(5);
-		DrawSprite(rotor_seq.sprite, PAL_NONE, x, y + y_offs - heli_offs);
+		rotor_seq.Draw(x, y + y_offs - heli_offs, PAL_NONE, false);
 	}
 	if (v->index == selection) {
 		x += x_offs;
-		y += UnScaleGUI(real_sprite->y_offs) + y_offs - heli_offs;
-		DrawFrameRect(x - 1, y - 1, x + width + 1, y + UnScaleGUI(real_sprite->height) + heli_offs + 1, COLOUR_WHITE, FR_BORDERONLY);
+		y += UnScaleGUI(rect.top) + y_offs - heli_offs;
+		DrawFrameRect(x - 1, y - 1, x + width + 1, y + UnScaleGUI(rect.bottom - rect.top + 1) + heli_offs + 1, COLOUR_WHITE, FR_BORDERONLY);
 	}
 }
diff --git a/src/roadveh_cmd.cpp b/src/roadveh_cmd.cpp
index e956787b0..9b541a766 100644
--- a/src/roadveh_cmd.cpp
+++ b/src/roadveh_cmd.cpp
@@ -162,11 +162,13 @@ void DrawRoadVehEngine(int left, int right, int preferred_x, int y, EngineID eng
 	VehicleSpriteSeq seq;
 	GetRoadVehIcon(engine, image_type, &seq);
 
-	const Sprite *real_sprite = GetSprite(seq.sprite, ST_NORMAL);
+	Rect rect;
+	seq.GetBounds(&rect);
 	preferred_x = Clamp(preferred_x,
-			left - UnScaleGUI(real_sprite->x_offs),
-			right - UnScaleGUI(real_sprite->width) - UnScaleGUI(real_sprite->x_offs));
-	DrawSprite(seq.sprite, pal, preferred_x, y);
+			left - UnScaleGUI(rect.left),
+			right - UnScaleGUI(rect.right));
+
+	seq.Draw(preferred_x, y, pal, pal == PALETTE_CRASH);
 }
 
 /**
@@ -183,12 +185,13 @@ void GetRoadVehSpriteSize(EngineID engine, uint &width, uint &height, int &xoffs
 	VehicleSpriteSeq seq;
 	GetRoadVehIcon(engine, image_type, &seq);
 
-	const Sprite *spr = GetSprite(seq.sprite, ST_NORMAL);
+	Rect rect;
+	seq.GetBounds(&rect);
 
-	width  = UnScaleGUI(spr->width);
-	height = UnScaleGUI(spr->height);
-	xoffs  = UnScaleGUI(spr->x_offs);
-	yoffs  = UnScaleGUI(spr->y_offs);
+	width  = UnScaleGUI(rect.right - rect.left + 1);
+	height = UnScaleGUI(rect.bottom - rect.top + 1);
+	xoffs  = UnScaleGUI(rect.left);
+	yoffs  = UnScaleGUI(rect.top);
 }
 
 /**
diff --git a/src/roadveh_gui.cpp b/src/roadveh_gui.cpp
index 26027a889..c446db510 100644
--- a/src/roadveh_gui.cpp
+++ b/src/roadveh_gui.cpp
@@ -151,7 +151,7 @@ void DrawRoadVehImage(const Vehicle *v, int left, int right, int y, VehicleID se
 			PaletteID pal = (u->vehstatus & VS_CRASHED) ? PALETTE_CRASH : GetVehiclePalette(u);
 			VehicleSpriteSeq seq;
 			u->GetImage(dir, image_type, &seq);
-			DrawSprite(seq.sprite, pal, px + (rtl ? -offset.x : offset.x), ScaleGUITrad(6) + offset.y);
+			seq.Draw(px + (rtl ? -offset.x : offset.x), ScaleGUITrad(6) + offset.y, pal, u->vehstatus & VS_CRASHED);
 		}
 
 		px += rtl ? -width : width;
diff --git a/src/ship_cmd.cpp b/src/ship_cmd.cpp
index a4b84ae87..2a760e2ca 100644
--- a/src/ship_cmd.cpp
+++ b/src/ship_cmd.cpp
@@ -91,11 +91,13 @@ void DrawShipEngine(int left, int right, int preferred_x, int y, EngineID engine
 	VehicleSpriteSeq seq;
 	GetShipIcon(engine, image_type, &seq);
 
-	const Sprite *real_sprite = GetSprite(seq.sprite, ST_NORMAL);
+	Rect rect;
+	seq.GetBounds(&rect);
 	preferred_x = Clamp(preferred_x,
-			left - UnScaleGUI(real_sprite->x_offs),
-			right - UnScaleGUI(real_sprite->width) - UnScaleGUI(real_sprite->x_offs));
-	DrawSprite(seq.sprite, pal, preferred_x, y);
+			left - UnScaleGUI(rect.left),
+			right - UnScaleGUI(rect.right));
+
+	seq.Draw(preferred_x, y, pal, pal == PALETTE_CRASH);
 }
 
 /**
@@ -112,12 +114,13 @@ void GetShipSpriteSize(EngineID engine, uint &width, uint &height, int &xoffs, i
 	VehicleSpriteSeq seq;
 	GetShipIcon(engine, image_type, &seq);
 
-	const Sprite *spr = GetSprite(seq.sprite, ST_NORMAL);
+	Rect rect;
+	seq.GetBounds(&rect);
 
-	width  = UnScaleGUI(spr->width);
-	height = UnScaleGUI(spr->height);
-	xoffs  = UnScaleGUI(spr->x_offs);
-	yoffs  = UnScaleGUI(spr->y_offs);
+	width  = UnScaleGUI(rect.right - rect.left + 1);
+	height = UnScaleGUI(rect.bottom - rect.top + 1);
+	xoffs  = UnScaleGUI(rect.left);
+	yoffs  = UnScaleGUI(rect.top);
 }
 
 void Ship::GetImage(Direction direction, EngineImageType image_type, VehicleSpriteSeq *result) const
diff --git a/src/ship_gui.cpp b/src/ship_gui.cpp
index f827b0a31..c6bf342d9 100644
--- a/src/ship_gui.cpp
+++ b/src/ship_gui.cpp
@@ -38,19 +38,20 @@ void DrawShipImage(const Vehicle *v, int left, int right, int y, VehicleID selec
 	VehicleSpriteSeq seq;
 	v->GetImage(rtl ? DIR_E : DIR_W, image_type, &seq);
 
-	const Sprite *real_sprite = GetSprite(seq.sprite, ST_NORMAL);
+	Rect rect;
+	seq.GetBounds(&rect);
 
-	int width = UnScaleGUI(real_sprite->width);
-	int x_offs = UnScaleGUI(real_sprite->x_offs);
+	int width = UnScaleGUI(rect.right - rect.left + 1);
+	int x_offs = UnScaleGUI(rect.left);
 	int x = rtl ? right - width - x_offs : left - x_offs;
 
 	y += ScaleGUITrad(10);
-	DrawSprite(seq.sprite, GetVehiclePalette(v), x, y);
+	seq.Draw(x, y, GetVehiclePalette(v), false);
 
 	if (v->index == selection) {
 		x += x_offs;
-		y += UnScaleGUI(real_sprite->y_offs);
-		DrawFrameRect(x - 1, y - 1, x + width + 1, y + UnScaleGUI(real_sprite->height) + 1, COLOUR_WHITE, FR_BORDERONLY);
+		y += UnScaleGUI(rect.top);
+		DrawFrameRect(x - 1, y - 1, x + width + 1, y + UnScaleGUI(rect.bottom - rect.top + 1) + 1, COLOUR_WHITE, FR_BORDERONLY);
 	}
 }
 
diff --git a/src/train_cmd.cpp b/src/train_cmd.cpp
index 34e7ef254..550253223 100644
--- a/src/train_cmd.cpp
+++ b/src/train_cmd.cpp
@@ -536,24 +536,27 @@ void DrawTrainEngine(int left, int right, int preferred_x, int y, EngineID engin
 		GetRailIcon(engine, false, yf, image_type, &seqf);
 		GetRailIcon(engine, true, yr, image_type, &seqr);
 
-		const Sprite *real_spritef = GetSprite(seqf.sprite, ST_NORMAL);
-		const Sprite *real_spriter = GetSprite(seqr.sprite, ST_NORMAL);
+		Rect rectf, rectr;
+		seqf.GetBounds(&rectf);
+		seqr.GetBounds(&rectr);
 
 		preferred_x = Clamp(preferred_x,
-				left - UnScaleGUI(real_spritef->x_offs) + ScaleGUITrad(14),
-				right - UnScaleGUI(real_spriter->width) - UnScaleGUI(real_spriter->x_offs) - ScaleGUITrad(15));
+				left - UnScaleGUI(rectf.left) + ScaleGUITrad(14),
+				right - UnScaleGUI(rectr.right) - ScaleGUITrad(15));
 
-		DrawSprite(seqf.sprite, pal, preferred_x - ScaleGUITrad(14), yf);
-		DrawSprite(seqr.sprite, pal, preferred_x + ScaleGUITrad(15), yr);
+		seqf.Draw(preferred_x - ScaleGUITrad(14), yf, pal, pal == PALETTE_CRASH);
+		seqr.Draw(preferred_x + ScaleGUITrad(15), yr, pal, pal == PALETTE_CRASH);
 	} else {
 		VehicleSpriteSeq seq;
 		GetRailIcon(engine, false, y, image_type, &seq);
 
-		const Sprite *real_sprite = GetSprite(seq.sprite, ST_NORMAL);
+		Rect rect;
+		seq.GetBounds(&rect);
 		preferred_x = Clamp(preferred_x,
-				left - UnScaleGUI(real_sprite->x_offs),
-				right - UnScaleGUI(real_sprite->width) - UnScaleGUI(real_sprite->x_offs));
-		DrawSprite(seq.sprite, pal, preferred_x, y);
+				left - UnScaleGUI(rect.left),
+				right - UnScaleGUI(rect.right));
+
+		seq.Draw(preferred_x, y, pal, pal == PALETTE_CRASH);
 	}
 }
 
@@ -573,22 +576,23 @@ void GetTrainSpriteSize(EngineID engine, uint &width, uint &height, int &xoffs,
 	VehicleSpriteSeq seq;
 	GetRailIcon(engine, false, y, image_type, &seq);
 
-	const Sprite *real_sprite = GetSprite(seq.sprite, ST_NORMAL);
+	Rect rect;
+	seq.GetBounds(&rect);
 
-	width  = UnScaleGUI(real_sprite->width);
-	height = UnScaleGUI(real_sprite->height);
-	xoffs  = UnScaleGUI(real_sprite->x_offs);
-	yoffs  = UnScaleGUI(real_sprite->y_offs);
+	width  = UnScaleGUI(rect.right - rect.left + 1);
+	height = UnScaleGUI(rect.bottom - rect.top + 1);
+	xoffs  = UnScaleGUI(rect.left);
+	yoffs  = UnScaleGUI(rect.top);
 
 	if (RailVehInfo(engine)->railveh_type == RAILVEH_MULTIHEAD) {
 		GetRailIcon(engine, true, y, image_type, &seq);
-		real_sprite = GetSprite(seq.sprite, ST_NORMAL);
+		seq.GetBounds(&rect);
 
 		/* Calculate values relative to an imaginary center between the two sprites. */
-		width = ScaleGUITrad(TRAININFO_DEFAULT_VEHICLE_WIDTH) + UnScaleGUI(real_sprite->width) + UnScaleGUI(real_sprite->x_offs) - xoffs;
-		height = max<uint>(height, UnScaleGUI(real_sprite->height));
+		width = ScaleGUITrad(TRAININFO_DEFAULT_VEHICLE_WIDTH) + UnScaleGUI(rect.right) - xoffs;
+		height = max<uint>(height, UnScaleGUI(rect.bottom - rect.top + 1));
 		xoffs  = xoffs - ScaleGUITrad(TRAININFO_DEFAULT_VEHICLE_WIDTH) / 2;
-		yoffs  = min(yoffs, UnScaleGUI(real_sprite->y_offs));
+		yoffs  = min(yoffs, UnScaleGUI(rect.top));
 	}
 }
 
diff --git a/src/train_gui.cpp b/src/train_gui.cpp
index 42ba87c84..513f57fbb 100644
--- a/src/train_gui.cpp
+++ b/src/train_gui.cpp
@@ -126,7 +126,7 @@ void DrawTrainImage(const Train *v, int left, int right, int y, VehicleID select
 			PaletteID pal = (v->vehstatus & VS_CRASHED) ? PALETTE_CRASH : GetVehiclePalette(v);
 			VehicleSpriteSeq seq;
 			v->GetImage(dir, image_type, &seq);
-			DrawSprite(seq.sprite, pal, px + (rtl ? -offset.x : offset.x), height / 2 + offset.y);
+			seq.Draw(px + (rtl ? -offset.x : offset.x), height / 2 + offset.y, pal, v->vehstatus & VS_CRASHED);
 		}
 
 		if (!v->IsArticulatedPart()) sel_articulated = false;
@@ -387,7 +387,7 @@ void DrawTrainDetails(const Train *v, int left, int right, int y, int vscroll_po
 					PaletteID pal = (v->vehstatus & VS_CRASHED) ? PALETTE_CRASH : GetVehiclePalette(v);
 					VehicleSpriteSeq seq;
 					u->GetImage(dir, EIT_IN_DETAILS, &seq);
-					DrawSprite(seq.sprite, pal, px + (rtl ? -offset.x : offset.x), y - line_height * vscroll_pos + sprite_y_offset + pitch);
+					seq.Draw(px + (rtl ? -offset.x : offset.x), y - line_height * vscroll_pos + sprite_y_offset + pitch, pal, v->vehstatus & VS_CRASHED);
 				}
 				px += rtl ? -width : width;
 				dx += width;
diff --git a/src/vehicle.cpp b/src/vehicle.cpp
index c5261407b..54a2bfa28 100644
--- a/src/vehicle.cpp
+++ b/src/vehicle.cpp
@@ -68,6 +68,32 @@ uint16 _returned_mail_refit_capacity; ///< Stores the mail capacity after a refi
 VehiclePool _vehicle_pool("Vehicle");
 INSTANTIATE_POOL_METHODS(Vehicle)
 
+
+/**
+ * Determine shared bounds of all sprites.
+ * @param [out] bounds Shared bounds.
+ */
+void VehicleSpriteSeq::GetBounds(Rect *bounds) const
+{
+	const Sprite *spr = GetSprite(this->sprite, ST_NORMAL);
+	bounds->left = spr->x_offs;
+	bounds->top  = spr->y_offs;
+	bounds->right  = spr->width  + spr->x_offs - 1;
+	bounds->bottom = spr->height + spr->y_offs - 1;
+}
+
+/**
+ * Draw the sprite sequence.
+ * @param x X position
+ * @param y Y position
+ * @param default_pal Vehicle palette
+ * @param force_pal Whether to ignore individual palettes, and draw everything with \a default_pal.
+ */
+void VehicleSpriteSeq::Draw(int x, int y, PaletteID default_pal, bool force_pal) const
+{
+	DrawSprite(this->sprite, default_pal, x, y);
+}
+
 /**
  * Function to tell if a vehicle needs to be autorenewed
  * @param *c The vehicle owner
@@ -1486,19 +1512,19 @@ void Vehicle::UpdatePosition()
  */
 void Vehicle::UpdateViewport(bool dirty)
 {
-	const Sprite *spr = GetSprite(this->sprite_seq.sprite, ST_NORMAL);
+	Rect new_coord;
+	this->sprite_seq.GetBounds(&new_coord);
 
 	Point pt = RemapCoords(this->x_pos + this->x_offs, this->y_pos + this->y_offs, this->z_pos);
-	pt.x += spr->x_offs;
-	pt.y += spr->y_offs;
+	new_coord.left   += pt.x;
+	new_coord.top    += pt.y;
+	new_coord.right  += pt.x + 2 * ZOOM_LVL_BASE;
+	new_coord.bottom += pt.y + 2 * ZOOM_LVL_BASE;
 
-	UpdateVehicleViewportHash(this, pt.x, pt.y);
+	UpdateVehicleViewportHash(this, new_coord.left, new_coord.top);
 
 	Rect old_coord = this->coord;
-	this->coord.left   = pt.x;
-	this->coord.top    = pt.y;
-	this->coord.right  = pt.x + spr->width + 2 * ZOOM_LVL_BASE;
-	this->coord.bottom = pt.y + spr->height + 2 * ZOOM_LVL_BASE;
+	this->coord = new_coord;
 
 	if (dirty) {
 		if (old_coord.left == INVALID_COORD) {
diff --git a/src/vehicle_base.h b/src/vehicle_base.h
index 30366e5ea..0b5f2e1de 100644
--- a/src/vehicle_base.h
+++ b/src/vehicle_base.h
@@ -163,6 +163,9 @@ struct VehicleSpriteSeq {
 	{
 		this->sprite = sprite;
 	}
+
+	void GetBounds(Rect *bounds) const;
+	void Draw(int x, int y, PaletteID default_pal, bool force_pal) const;
 };
 
 /** A vehicle pool for a little over 1 million vehicles. */
diff --git a/src/vehicle_gui.cpp b/src/vehicle_gui.cpp
index 3d93e4d30..29b3b30fa 100644
--- a/src/vehicle_gui.cpp
+++ b/src/vehicle_gui.cpp
@@ -2844,8 +2844,9 @@ int GetSingleVehicleWidth(const Vehicle *v, EngineImageType image_type)
 			bool rtl = _current_text_dir == TD_RTL;
 			VehicleSpriteSeq seq;
 			v->GetImage(rtl ? DIR_E : DIR_W, image_type, &seq);
-			const Sprite *real_sprite = GetSprite(seq.sprite, ST_NORMAL);
-			return UnScaleGUI(real_sprite->width);
+			Rect rec;
+			seq.GetBounds(&rec);
+			return UnScaleGUI(rec.right - rec.left + 1);
 	}
 }