src/sprite.h

   1 /* $Id$ */
   2
   3 /*
   4  * This file is part of OpenTTD.
   5  * OpenTTD is free software; you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation, version 2.
   6  * OpenTTD is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
   7  * See the GNU General Public License for more details. You should have received a copy of the GNU General Public License along with OpenTTD. If not, see <http://www.gnu.org/licenses/>.
   8  */
   9
  10 /** @file sprite.h Base for drawing complex sprites. */
  11
  12 #ifndef SPRITE_H
  13 #define SPRITE_H
  14
  15 #include "transparency.h"
  16
  17 #include "table/sprites.h"
  18
  19 #define GENERAL_SPRITE_COLOUR(colour) ((colour) + PALETTE_RECOLOUR_START)
  20 #define COMPANY_SPRITE_COLOUR(owner) (GENERAL_SPRITE_COLOUR(_company_colours[owner]))
  21
  22 /* The following describes bunch of sprites to be drawn together in a single 3D
  23  * bounding box. Used especially for various multi-sprite buildings (like
  24  * depots or stations): */
  25
  26 /** A tile child sprite and palette to draw for stations etc, with 3D bounding box */
  27 struct DrawTileSeqStruct {
  28         int8 delta_x; ///< \c 0x80 is sequence terminator
  29         int8 delta_y;
  30         int8 delta_z; ///< \c 0x80 identifies child sprites
  31         byte size_x;
  32         byte size_y;
  33         byte size_z;
  34         PalSpriteID image;
  35
  36         /** Make this struct a sequence terminator. */
  37         void MakeTerminator()
  38         {
  39                 this->delta_x = (int8)0x80;
  40         }
  41
  42         /** Check whether this is a sequence terminator. */
  43         bool IsTerminator() const
  44         {
  45                 return (byte)this->delta_x == 0x80;
  46         }
  47
  48         /** Check whether this is a parent sprite with a boundingbox. */
  49         bool IsParentSprite() const
  50         {
  51                 return (byte)this->delta_z != 0x80;
  52         }
  53 };
  54
  55 /**
  56  * Ground palette sprite of a tile, together with its sprite layout.
  57  * This struct is used for static sprite layouts in the code.
  58  * For allocated ones from NewGRF see #NewGRFSpriteLayout.
  59  */
  60 struct DrawTileSprites {
  61         PalSpriteID ground;           ///< Palette and sprite for the ground
  62         const DrawTileSeqStruct *seq; ///< Array of child sprites. Terminated with a terminator entry
  63 };
  64
  65 /** Iterate through all DrawTileSeqStructs in DrawTileSprites. */
  66 #define foreach_draw_tile_seq(idx, list) for (idx = list; !idx->IsTerminator(); idx++)
  67
  68 void DrawCommonTileSeq (const struct TileInfo *ti, const DrawTileSeqStruct *seq,
  69         TransparencyOption to, int32 orig_offset, uint32 newgrf_offset,
  70         PaletteID default_palette, bool child_offset_is_unsigned);
  71
  72 void DrawCommonTileSeqInGUI (BlitArea *dpi, int x, int y,
  73         const DrawTileSeqStruct *seq, int32 orig_offset, uint32 newgrf_offset,
  74         PaletteID default_palette, bool child_offset_is_unsigned);
  75
  76 /**
  77  * Draw tile sprite sequence on tile with railroad specifics.
  78  * @param total_offset Spriteoffset from normal rail to current railtype.
  79  * @param newgrf_offset Startsprite of the Action1 to use.
  80  */
  81 static inline void DrawRailTileSeq (const struct TileInfo *ti,
  82         const DrawTileSeqStruct *seq, TransparencyOption to,
  83         int32 total_offset, uint32 newgrf_offset, PaletteID default_palette)
  84 {
  85         DrawCommonTileSeq (ti, seq, to, total_offset, newgrf_offset,
  86                                 default_palette, false);
  87 }
  88
  89 /**
  90  * Draw tile sprite sequence in GUI with railroad specifics.
  91  * @param total_offset Spriteoffset from normal rail to current railtype.
  92  * @param newgrf_offset Startsprite of the Action1 to use.
  93  */
  94 static inline void DrawRailTileSeqInGUI (BlitArea *dpi, int x, int y,
  95         const DrawTileSeqStruct *seq, int32 total_offset,
  96         uint32 newgrf_offset, PaletteID default_palette)
  97 {
  98         DrawCommonTileSeqInGUI (dpi, x, y, seq, total_offset, newgrf_offset,
  99                                 default_palette, false);
 100 }
 101
 102 /**
 103  * Draw TTD sprite sequence on tile.
 104  */
 105 static inline void DrawOrigTileSeq (const struct TileInfo *ti,
 106         const DrawTileSeqStruct *seq, TransparencyOption to,
 107         PaletteID default_palette)
 108 {
 109         DrawCommonTileSeq (ti, seq, to, 0, 0, default_palette, false);
 110 }
 111
 112 /**
 113  * Draw TTD sprite sequence in GUI.
 114  */
 115 static inline void DrawOrigTileSeqInGUI (BlitArea *dpi, int x, int y,
 116         const DrawTileSeqStruct *seq, PaletteID default_palette)
 117 {
 118         DrawCommonTileSeqInGUI (dpi, x, y, seq, 0, 0, default_palette, false);
 119 }
 120
 121 /**
 122  * Draw NewGRF industrytile or house sprite layout
 123  * @param stage Sprite inside the Action1 spritesets to use, i.e. construction stage.
 124  */
 125 static inline void DrawNewGRFTileSeq (const struct TileInfo *ti,
 126         const DrawTileSeqStruct *seq, TransparencyOption to,
 127         uint32 stage, PaletteID default_palette)
 128 {
 129         DrawCommonTileSeq (ti, seq, to, 0, stage, default_palette, true);
 130 }
 131
 132 /**
 133  * Draw NewGRF object in GUI
 134  * @param stage Sprite inside the Action1 spritesets to use, i.e. construction stage.
 135  */
 136 static inline void DrawNewGRFTileSeqInGUI (BlitArea *dpi, int x, int y,
 137         const DrawTileSeqStruct *seq, uint32 stage, PaletteID default_palette)
 138 {
 139         DrawCommonTileSeqInGUI (dpi, x, y, seq, 0, stage, default_palette, true);
 140 }
 141
 142 /**
 143  * Applies PALETTE_MODIFIER_COLOUR to a palette entry of a ground sprite
 144  * @note Not useable for OTTD internal spritelayouts from table/xxx_land.h as PALETTE_MODIFIER_TRANSPARENT is only set
 145  *       when to use the default palette.
 146  *
 147  * @param image The sprite to draw
 148  * @param pal The palette from the sprite layout
 149  * @param default_pal The default recolour sprite to use (typically company colour resp. random industry/house colour)
 150  * @return The palette to use
 151  */
 152 static inline PaletteID GroundSpritePaletteTransform(SpriteID image, PaletteID pal, PaletteID default_pal)
 153 {
 154         if (HasBit(image, PALETTE_MODIFIER_COLOUR)) {
 155                 return (pal != 0 ? pal : default_pal);
 156         } else {
 157                 return PAL_NONE;
 158         }
 159 }
 160
 161 #endif /* SPRITE_H */