1

/* $Id$ */

     2

     3

/** @file newgrf_spritegroup.h */

     4

     5

#ifndef NEWGRF_SPRITEGROUP_H

     6

#define NEWGRF_SPRITEGROUP_H

     7

     8

#include "town.h"

     9

    10

struct SpriteGroup;

    11

    12

    13

/* 'Real' sprite groups contain a list of other result or callback sprite

    14

 * groups. */

    15

struct RealSpriteGroup {

    16

	/* Loaded = in motion, loading = not moving

    17

	 * Each group contains several spritesets, for various loading stages */

    18

    19

	/* XXX: For stations the meaning is different - loaded is for stations

    20

	 * with small amount of cargo whilst loading is for stations with a lot

    21

	 * of da stuff. */

    22

    23

	byte num_loaded;       ///< Number of loaded groups

    24

	byte num_loading;      ///< Number of loading groups

    25

	const SpriteGroup **loaded;  ///< List of loaded groups (can be SpriteIDs or Callback results)

    26

	const SpriteGroup **loading; ///< List of loading groups (can be SpriteIDs or Callback results)

    27

};

    28

    29

/* Shared by deterministic and random groups. */

    30

enum VarSpriteGroupScope {

    31

	VSG_SCOPE_SELF,

    32

	/* Engine of consists for vehicles, city for stations. */

    33

	VSG_SCOPE_PARENT,

    34

};

    35

    36

enum DeterministicSpriteGroupSize {

    37

	DSG_SIZE_BYTE,

    38

	DSG_SIZE_WORD,

    39

	DSG_SIZE_DWORD,

    40

};

    41

    42

enum DeterministicSpriteGroupAdjustType {

    43

	DSGA_TYPE_NONE,

    44

	DSGA_TYPE_DIV,

    45

	DSGA_TYPE_MOD,

    46

};

    47

    48

enum DeterministicSpriteGroupAdjustOperation {

    49

	DSGA_OP_ADD,  ///< a + b

    50

	DSGA_OP_SUB,  ///< a - b

    51

	DSGA_OP_SMIN, ///< (signed) min(a, b)

    52

	DSGA_OP_SMAX, ///< (signed) max(a, b)

    53

	DSGA_OP_UMIN, ///< (unsigned) min(a, b)

    54

	DSGA_OP_UMAX, ///< (unsigned) max(a, b)

    55

	DSGA_OP_SDIV, ///< (signed) a / b

    56

	DSGA_OP_SMOD, ///< (signed) a % b

    57

	DSGA_OP_UDIV, ///< (unsigned) a / b

    58

	DSGA_OP_UMOD, ///< (unsigned) a & b

    59

	DSGA_OP_MUL,  ///< a * b

    60

	DSGA_OP_AND,  ///< a & b

    61

	DSGA_OP_OR,   ///< a | b

    62

	DSGA_OP_XOR,  ///< a ^ b

    65

};

    66

    67

    68

struct DeterministicSpriteGroupAdjust {

    69

	DeterministicSpriteGroupAdjustOperation operation;

    70

	DeterministicSpriteGroupAdjustType type;

    71

	byte variable;

    72

	byte parameter; ///< Used for variables between 0x60 and 0x7F inclusive.

    73

	byte shift_num;

    74

	uint32 and_mask;

    75

	uint32 add_val;

    76

	uint32 divmod_val;

    77

	const SpriteGroup *subroutine;

    78

};

    79

    80

    81

struct DeterministicSpriteGroupRange {

    82

	const SpriteGroup *group;

    83

	uint32 low;

    84

	uint32 high;

    85

};

    86

    87

    88

struct DeterministicSpriteGroup {

    89

	VarSpriteGroupScope var_scope;

    90

	DeterministicSpriteGroupSize size;

    91

	byte num_adjusts;

    92

	byte num_ranges;

    93

	DeterministicSpriteGroupAdjust *adjusts;

    94

	DeterministicSpriteGroupRange *ranges; // Dynamically allocated

    95

    96

	/* Dynamically allocated, this is the sole owner */

    97

	const SpriteGroup *default_group;

    98

};

    99

   100

enum RandomizedSpriteGroupCompareMode {

   101

	RSG_CMP_ANY,

   102

	RSG_CMP_ALL,

   103

};

   104

   105

struct RandomizedSpriteGroup {

   106

	VarSpriteGroupScope var_scope;  ///< Take this object:

   107

   108

	RandomizedSpriteGroupCompareMode cmp_mode; ///< Check for these triggers:

   109

	byte triggers;

   110

   111

	byte lowest_randbit; ///< Look for this in the per-object randomized bitmask:

   112

	byte num_groups; ///< must be power of 2

   113

   114

	const SpriteGroup **groups; ///< Take the group with appropriate index:

   115

};

   116

   117

   118

/* This contains a callback result. A failed callback has a value of

   119

 * CALLBACK_FAILED */

   120

struct CallbackResultSpriteGroup {

   121

	uint16 result;

   122

};

   123

   124

   125

/* A result sprite group returns the first SpriteID and the number of

   126

 * sprites in the set */

   127

struct ResultSpriteGroup {

   128

	SpriteID sprite;

   129

	byte num_sprites;

   130

};

   131

   132

struct TileLayoutSpriteGroup {

   133

	byte num_sprites; ///< Number of sprites in the spriteset, used for loading stages

   134

	struct DrawTileSprites *dts;

   135

};

   136

   137

/* List of different sprite group types */

   138

enum SpriteGroupType {

   139

	SGT_INVALID,

   140

	SGT_REAL,

   141

	SGT_DETERMINISTIC,

   142

	SGT_RANDOMIZED,

   143

	SGT_CALLBACK,

   144

	SGT_RESULT,

   145

	SGT_TILELAYOUT,

   146

};

   147

   148

/* Common wrapper for all the different sprite group types */

   149

struct SpriteGroup {

   150

	SpriteGroupType type;

   151

   152

	union {

   153

		RealSpriteGroup real;

   154

		DeterministicSpriteGroup determ;

   155

		RandomizedSpriteGroup random;

   156

		CallbackResultSpriteGroup callback;

   157

		ResultSpriteGroup result;

   158

		TileLayoutSpriteGroup layout;

   159

	} g;

   160

};

   161

   162

   163

SpriteGroup *AllocateSpriteGroup();

   164

void InitializeSpriteGroupPool();

   165

   166

   167

struct ResolverObject {

   168

	uint16 callback;

   169

	uint32 callback_param1;

   170

	uint32 callback_param2;

   171

   172

	byte trigger;

   173

	uint32 last_value;

   174

	uint32 reseed;

   175

	VarSpriteGroupScope scope;

   176

   177

	bool info_view; ///< Indicates if the item is being drawn in an info window

   178

   179

	union {

   180

		struct {

   181

			const struct Vehicle *self;

   182

			const struct Vehicle *parent;

   183

			EngineID self_type;

   184

		} vehicle;

   185

		struct {

   186

			TileIndex tile;

   187

			const struct Station *st;

   188

			const struct StationSpec *statspec;

   189

			CargoID cargo_type;

   190

		} station;

   191

		struct {

   192

			TileIndex tile;

   193

			Town *town;

   194

			HouseID house_id;

   195

		} house;

   196

		struct {

   197

			const struct CargoSpec *cs;

   198

		} cargo;

   199

	} u;

   200

   201

	uint32 (*GetRandomBits)(const struct ResolverObject*);

   202

	uint32 (*GetTriggers)(const struct ResolverObject*);

   203

	void (*SetTriggers)(const struct ResolverObject*, int);

   204

	uint32 (*GetVariable)(const struct ResolverObject*, byte, byte, bool*);

   205

	const SpriteGroup *(*ResolveReal)(const struct ResolverObject*, const SpriteGroup*);

   206

};

   207

   208

   209

/* Base sprite group resolver */

   210

const SpriteGroup *Resolve(const SpriteGroup *group, ResolverObject *object);

   211

   212

   213

#endif /* NEWGRF_SPRITEGROUP_H */