sprite.h

Go to the documentation of this file.

/*
 * This file is part of OpenTTD.
 * 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.
 * 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.
 * 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 <https://www.gnu.org/licenses/old-licenses/gpl-2.0>.
 */

 
#ifndef SPRITE_H
#define SPRITE_H
 
#include "core/geometry_type.hpp"
#include "transparency.h"
 
#include "table/sprites.h"
 
struct SpriteBounds {
  Coord3D<int8_t> origin; 
  Coord3D<uint8_t> extent; 
  Coord3D<int8_t> offset; 
 
  constexpr SpriteBounds() = default;
  constexpr SpriteBounds(const Coord3D<int8_t> &origin, const Coord3D<uint8_t> &extent, const Coord3D<int8_t> &offset) :
    origin(origin), extent(extent), offset(offset) {}
};
 
/* The following describes bunch of sprites to be drawn together in a single 3D
 * bounding box. Used especially for various multi-sprite buildings (like
 * depots or stations): */

struct DrawTileSeqStruct : SpriteBounds {
  PalSpriteID image;
 
  constexpr DrawTileSeqStruct() = default;
  constexpr DrawTileSeqStruct(int8_t origin_x, int8_t origin_y, int8_t origin_z, uint8_t extent_x, uint8_t extent_y, uint8_t extent_z, PalSpriteID image) :
    SpriteBounds({origin_x, origin_y, origin_z}, {extent_x, extent_y, extent_z}, {}), image(image) {}

  inline bool IsParentSprite() const
  {
    return static_cast<uint8_t>(this->origin.z) != 0x80;
  }
};

struct DrawTileSprites {
  PalSpriteID ground{}; 
 
  DrawTileSprites(PalSpriteID ground) : ground(ground) {}
  DrawTileSprites() = default;
 
  virtual ~DrawTileSprites() = default;

  virtual std::span<const DrawTileSeqStruct> GetSequence() const = 0;
};

struct DrawTileSpriteSpan : DrawTileSprites {
  std::span<const DrawTileSeqStruct> seq; 
 
  DrawTileSpriteSpan(PalSpriteID ground, std::span<const DrawTileSeqStruct> seq) : DrawTileSprites(ground), seq(seq) {}
  DrawTileSpriteSpan(PalSpriteID ground) : DrawTileSprites(ground) {};
  DrawTileSpriteSpan() = default;
 
  std::span<const DrawTileSeqStruct> GetSequence() const override { return this->seq; }
};

struct DrawBuildingsTileStruct : SpriteBounds {
  PalSpriteID ground;
  PalSpriteID building;
  uint8_t draw_proc;  // this allows to specify a special drawing procedure.
};
 
void DrawCommonTileSeq(const struct TileInfo *ti, const DrawTileSprites *dts, TransparencyOption to, int32_t orig_offset, uint32_t newgrf_offset, PaletteID default_palette, bool child_offset_is_unsigned);
void DrawCommonTileSeqInGUI(int x, int y, const DrawTileSprites *dts, int32_t orig_offset, uint32_t newgrf_offset, PaletteID default_palette, bool child_offset_is_unsigned);

inline void DrawRailTileSeq(const struct TileInfo *ti, const DrawTileSprites *dts, TransparencyOption to, int32_t total_offset, uint32_t newgrf_offset, PaletteID default_palette)
{
  DrawCommonTileSeq(ti, dts, to, total_offset, newgrf_offset, default_palette, false);
}

inline void DrawRailTileSeqInGUI(int x, int y, const DrawTileSprites *dts, int32_t total_offset, uint32_t newgrf_offset, PaletteID default_palette)
{
  DrawCommonTileSeqInGUI(x, y, dts, total_offset, newgrf_offset, default_palette, false);
}

inline void DrawOrigTileSeq(const struct TileInfo *ti, const DrawTileSprites *dts, TransparencyOption to, PaletteID default_palette)
{
  DrawCommonTileSeq(ti, dts, to, 0, 0, default_palette, false);
}

inline void DrawOrigTileSeqInGUI(int x, int y, const DrawTileSprites *dts, PaletteID default_palette)
{
  DrawCommonTileSeqInGUI(x, y, dts, 0, 0, default_palette, false);
}

inline void DrawNewGRFTileSeq(const struct TileInfo *ti, const DrawTileSprites *dts, TransparencyOption to, uint32_t stage, PaletteID default_palette)
{
  DrawCommonTileSeq(ti, dts, to, 0, stage, default_palette, true);
}

inline void DrawNewGRFTileSeqInGUI(int x, int y, const DrawTileSprites *dts, uint32_t stage, PaletteID default_palette)
{
  DrawCommonTileSeqInGUI(x, y, dts, 0, stage, default_palette, true);
}

inline PaletteID SpriteLayoutPaletteTransform(SpriteID image, PaletteID pal, PaletteID default_pal)
{
  if (HasBit(image, PALETTE_MODIFIER_TRANSPARENT) || HasBit(image, PALETTE_MODIFIER_COLOUR)) {
    return (pal != 0 ? pal : default_pal);
  } else {
    return PAL_NONE;
  }
}

inline PaletteID GroundSpritePaletteTransform(SpriteID image, PaletteID pal, PaletteID default_pal)
{
  if (HasBit(image, PALETTE_MODIFIER_COLOUR)) {
    return (pal != 0 ? pal : default_pal);
  } else {
    return PAL_NONE;
  }
}

static inline PaletteID GetColourPalette(Colours colour) { return PALETTE_RECOLOUR_START + colour; }
 
#endif /* SPRITE_H */