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

    25

// Iterate through all DrawTileSeqStructs in DrawTileSprites.

    26

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

    27

    28

    29

/* This is for custom sprites: */

    30

    31

    32

typedef struct SpriteGroup SpriteGroup;

    33

    34

typedef struct RealSpriteGroup {

    35

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

    36

    37

	// Loaded = in motion, loading = not moving

    38

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

    39

    40

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

    41

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

    42

	// of da stuff.

    43

    44

	byte loaded_count;     ///< Number of loaded groups

    45

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

    46

	byte loading_count;    ///< Number of loading groups

    47

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

    48

} RealSpriteGroup;

    49

    50

/* Shared by deterministic and random groups. */

    51

typedef enum VarSpriteGroupScope {

    52

	VSG_SCOPE_SELF,

    53

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

    54

	VSG_SCOPE_PARENT,

    55

} VarSpriteGroupScope;

    56

    57

typedef struct DeterministicSpriteGroupRanges DeterministicSpriteGroupRanges;

    58

    59

typedef enum DeterministicSpriteGroupOperation {

    60

	DSG_OP_NONE,

    61

	DSG_OP_DIV,

    62

	DSG_OP_MOD,

    63

} DeterministicSpriteGroupOperation;

    64

    65

typedef struct DeterministicSpriteGroupRange DeterministicSpriteGroupRange;

    66

    67

typedef struct DeterministicSpriteGroup {

    68

	// Take this variable:

    69

	VarSpriteGroupScope var_scope;

    70

	byte variable;

    71

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

    72

    73

	// Do this with it:

    74

	byte shift_num;

    75

	byte and_mask;

    76

    77

	// Then do this with it:

    78

	DeterministicSpriteGroupOperation operation;

    79

	byte add_val;

    80

	byte divmod_val;

    81

    82

	// And apply it to this:

    83

	byte num_ranges;

    84

	DeterministicSpriteGroupRange *ranges; // Dynamically allocated

    85

    86

	// Dynamically allocated, this is the sole owner

    87

	SpriteGroup *default_group;

    88

} DeterministicSpriteGroup;

    89

    90

typedef enum RandomizedSpriteGroupCompareMode {

    91

	RSG_CMP_ANY,

    92

	RSG_CMP_ALL,

    93

} RandomizedSpriteGroupCompareMode;

    94

    95

typedef struct RandomizedSpriteGroup {

    96

	// Take this object:

    97

	VarSpriteGroupScope var_scope;

    98

    99

	// Check for these triggers:

   100

	RandomizedSpriteGroupCompareMode cmp_mode;

   101

	byte triggers;

   102

   103

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

   104

	byte lowest_randbit;

   105

	byte num_groups; // must be power of 2

   106

   107

	// Take the group with appropriate index:

   108

	SpriteGroup **groups;

   109

} RandomizedSpriteGroup;

   110

   111

typedef struct CallbackResultSpriteGroup {

   112

	uint16 result;

   113

} CallbackResultSpriteGroup;

   114

   115

typedef struct ResultSpriteGroup {

   116

	uint16 result;

   117

	byte sprites;

   118

} ResultSpriteGroup;

   119

   120

typedef enum SpriteGroupType {

   121

	SGT_INVALID,

   122

	SGT_REAL,

   123

	SGT_DETERMINISTIC,

   124

	SGT_RANDOMIZED,

   125

	SGT_CALLBACK,

   126

	SGT_RESULT,

   127

} SpriteGroupType;

   128

   129

struct SpriteGroup {

   130

	SpriteGroupType type;

   131

   132

	union {

   133

		RealSpriteGroup real;

   134

		DeterministicSpriteGroup determ;

   135

		RandomizedSpriteGroup random;

   136

		CallbackResultSpriteGroup callback;

   137

		ResultSpriteGroup result;

   138

	} g;

   139

};

   140

   141

struct DeterministicSpriteGroupRange {

   142

	SpriteGroup *group;

   143

	byte low;

   144

	byte high;

   145

};

   146

   147

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

   148

 * chooses corresponding SpriteGroup accordingly to the given

   149

 * DeterministicSpriteGroup. */

   150

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

   151

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

   152

int GetDeterministicSpriteValue(byte var);

   153

   154

/* This takes randomized bitmask (probably associated with

   155

 * vehicle/station/whatever) and chooses corresponding SpriteGroup

   156

 * accordingly to the given RandomizedSpriteGroup. */

   157

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

   158

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

   159

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

   160

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

   161

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

   162

   163

#endif /* SPRITE_H */