1

/* $Id$ */

     2

     3

#ifndef SPRITE_H

     4

#define SPRITE_H

     5

     6

     7

/* The following describes bunch of sprites to be drawn together in a single 3D

     8

 * bounding box. Used especially for various multi-sprite buildings (like

     9

 * depots or stations): */

    10

    11

typedef struct DrawTileSeqStruct {

    12

	int8 delta_x; // 0x80 is sequence terminator

    13

	int8 delta_y;

    14

	int8 delta_z;

    15

	byte width,height;

    16

	byte unk; // 'depth', just z-size; TODO: rename

    17

	uint32 image;

    18

} DrawTileSeqStruct;

    19

    20

typedef struct DrawTileSprites {

    21

	SpriteID ground_sprite;

    22

	const DrawTileSeqStruct* seq;

    23

} DrawTileSprites;

    24

    40

// Iterate through all DrawTileSeqStructs in DrawTileSprites.

    41

#define foreach_draw_tile_seq(idx, list) for (idx = list; ((byte) idx->delta_x) != 0x80; idx++)

    42

    43

    44

/* This is for custom sprites: */

    45

    46

    47

typedef struct SpriteGroup SpriteGroup;

    48

    49

typedef struct RealSpriteGroup {

    50

	byte sprites_per_set; // means number of directions - 4 or 8

    51

    52

	// Loaded = in motion, loading = not moving

    53

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

    54

    55

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

    56

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

    57

	// of da stuff.

    58

    59

	byte loaded_count;     ///< Number of loaded groups

    60

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

    61

	byte loading_count;    ///< Number of loading groups

    62

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

    63

} RealSpriteGroup;

    64

    65

/* Shared by deterministic and random groups. */

    66

typedef enum VarSpriteGroupScope {

    67

	VSG_SCOPE_SELF,

    68

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

    69

	VSG_SCOPE_PARENT,

    70

} VarSpriteGroupScope;

    71

    72

typedef struct DeterministicSpriteGroupRanges DeterministicSpriteGroupRanges;

    73

    74

typedef enum DeterministicSpriteGroupOperation {

    75

	DSG_OP_NONE,

    76

	DSG_OP_DIV,

    77

	DSG_OP_MOD,

    78

} DeterministicSpriteGroupOperation;

    79

    80

typedef struct DeterministicSpriteGroupRange DeterministicSpriteGroupRange;

    81

    82

typedef struct DeterministicSpriteGroup {

    83

	// Take this variable:

    84

	VarSpriteGroupScope var_scope;

    85

	byte variable;

    86

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

    87

    88

	// Do this with it:

    89

	byte shift_num;

    90

	byte and_mask;

    91

    92

	// Then do this with it:

    93

	DeterministicSpriteGroupOperation operation;

    94

	byte add_val;

    95

	byte divmod_val;

    96

    97

	// And apply it to this:

    98

	byte num_ranges;

    99

	DeterministicSpriteGroupRange *ranges; // Dynamically allocated

   100

   101

	// Dynamically allocated, this is the sole owner

   102

	SpriteGroup *default_group;

   103

} DeterministicSpriteGroup;

   104

   105

typedef enum RandomizedSpriteGroupCompareMode {

   106

	RSG_CMP_ANY,

   107

	RSG_CMP_ALL,

   108

} RandomizedSpriteGroupCompareMode;

   109

   110

typedef struct RandomizedSpriteGroup {

   111

	// Take this object:

   112

	VarSpriteGroupScope var_scope;

   113

   114

	// Check for these triggers:

   115

	RandomizedSpriteGroupCompareMode cmp_mode;

   116

	byte triggers;

   117

   118

	// Look for this in the per-object randomized bitmask:

   119

	byte lowest_randbit;

   120

	byte num_groups; // must be power of 2

   121

   122

	// Take the group with appropriate index:

   123

	SpriteGroup **groups;

   124

} RandomizedSpriteGroup;

   125

   126

typedef struct CallbackResultSpriteGroup {

   127

	uint16 result;

   128

} CallbackResultSpriteGroup;

   129

   130

typedef struct ResultSpriteGroup {

   131

	uint16 result;

   132

	byte sprites;

   133

} ResultSpriteGroup;

   134

   135

typedef enum SpriteGroupType {

   136

	SGT_INVALID,

   137

	SGT_REAL,

   138

	SGT_DETERMINISTIC,

   139

	SGT_RANDOMIZED,

   140

	SGT_CALLBACK,

   141

	SGT_RESULT,

   142

} SpriteGroupType;

   143

   144

struct SpriteGroup {

   145

	SpriteGroupType type;

   146

   147

	union {

   148

		RealSpriteGroup real;

   149

		DeterministicSpriteGroup determ;

   150

		RandomizedSpriteGroup random;

   151

		CallbackResultSpriteGroup callback;

   152

		ResultSpriteGroup result;

   153

	} g;

   154

};

   155

   156

struct DeterministicSpriteGroupRange {

   157

	SpriteGroup *group;

   158

	byte low;

   159

	byte high;

   160

};

   161

   162

/* This takes value (probably of the variable specified in the group) and

   163

 * chooses corresponding SpriteGroup accordingly to the given

   164

 * DeterministicSpriteGroup. */

   165

SpriteGroup *EvalDeterministicSpriteGroup(const DeterministicSpriteGroup *dsg, int value);

   166

/* Get value of a common deterministic SpriteGroup variable. */

   167

int GetDeterministicSpriteValue(byte var);

   168

   169

/* This takes randomized bitmask (probably associated with

   170

 * vehicle/station/whatever) and chooses corresponding SpriteGroup

   171

 * accordingly to the given RandomizedSpriteGroup. */

   172

SpriteGroup *EvalRandomizedSpriteGroup(const RandomizedSpriteGroup *rsg, byte random_bits);

   173

/* Triggers given RandomizedSpriteGroup with given bitmask and returns and-mask

   174

 * of random bits to be reseeded, or zero if there were no triggers matched

   175

 * (then they are |ed to @waiting_triggers instead). */

   176

byte RandomizedSpriteGroupTriggeredBits(const RandomizedSpriteGroup *rsg, byte triggers, byte *waiting_triggers);

   177

   178

#endif /* SPRITE_H */