1

/* $Id$ */

     2

     3

#ifndef DIRECTION_H

     4

#define DIRECTION_H

     5

     6

/* Direction as commonly used in v->direction, 8 way. */

     7

typedef enum Direction {

     8

	DIR_N   = 0,

     9

	DIR_NE  = 1,      /* Northeast, upper right on your monitor */

    10

	DIR_E   = 2,

    11

	DIR_SE  = 3,

    12

	DIR_S   = 4,

    13

	DIR_SW  = 5,

    14

	DIR_W   = 6,

    15

	DIR_NW  = 7,

    16

	DIR_END,

    17

	INVALID_DIR = 0xFF,

    18

} Direction;

    19

    20

static inline Direction ReverseDir(Direction d)

    21

{

    22

	return (Direction)(4 ^ d);

    23

}

    24

    25

    26

typedef enum DirDiff {

    27

	DIRDIFF_SAME    = 0,

    28

	DIRDIFF_45RIGHT = 1,

    29

	DIRDIFF_90RIGHT = 2,

    30

	DIRDIFF_REVERSE = 4,

    31

	DIRDIFF_90LEFT  = 6,

    32

	DIRDIFF_45LEFT  = 7

    33

} DirDiff;

    34

    35

static inline DirDiff DirDifference(Direction d0, Direction d1)

    36

{

    37

	return (DirDiff)((d0 + 8 - d1) % 8);

    38

}

    39

    40

static inline DirDiff ChangeDirDiff(DirDiff d, DirDiff delta)

    41

{

    42

	return (DirDiff)((d + delta) % 8);

    43

}

    44

    45

    46

static inline Direction ChangeDir(Direction d, DirDiff delta)

    47

{

    48

	return (Direction)((d + delta) % 8);

    49

}

    50

    51

    52

/* Direction commonly used as the direction of entering and leaving tiles, 4-way */

    53

typedef enum DiagDirection {

    54

	DIAGDIR_NE  = 0,      /* Northeast, upper right on your monitor */

    55

	DIAGDIR_SE  = 1,

    56

	DIAGDIR_SW  = 2,

    57

	DIAGDIR_NW  = 3,

    58

	DIAGDIR_END,

    59

	INVALID_DIAGDIR = 0xFF,

    60

} DiagDirection;

    61

    62

static inline DiagDirection ReverseDiagDir(DiagDirection d)

    63

{

    64

	return (DiagDirection)(2 ^ d);

    65

}

    66

    67

    68

typedef enum DiagDirDiff {

    69

	DIAGDIRDIFF_SAME    = 0,

    70

	DIAGDIRDIFF_90RIGHT = 1,

    71

	DIAGDIRDIFF_REVERSE = 2,

    72

	DIAGDIRDIFF_90LEFT  = 3

    73

} DiagDirDiff;

    74

    75

static inline DiagDirection ChangeDiagDir(DiagDirection d, DiagDirDiff delta)

    76

{

    77

	return (DiagDirection)((d + delta) % 4);

    78

}

    79

    80

    81

static inline DiagDirection DirToDiagDir(Direction dir)

    82

{

    83

	return (DiagDirection)(dir >> 1);

    84

}

    85

    86

    87

static inline Direction DiagDirToDir(DiagDirection dir)

    88

{

    89

	return (Direction)(dir * 2 + 1);

    90

}

    91

    92

    93

/* the 2 axis */

    94

typedef enum Axis {

    95

	AXIS_X = 0,

    96

	AXIS_Y = 1,

    97

	AXIS_END

    98

} Axis;

    99

   100

   101

static inline Axis OtherAxis(Axis a)

   102

{

   103

	return (Axis)(a ^ 1);

   104

}

   105

   106

   107

static inline Axis DiagDirToAxis(DiagDirection d)

   108

{

   109

	return (Axis)(d & 1);

   110

}

   111

   112

   113

/*

   114

 * Converts an Axis to a DiagDirection

   115

 * Points always in the positive direction, i.e. S[EW]

   116

 */

   117

static inline DiagDirection AxisToDiagDir(Axis a)

   118

{

   119

	return (DiagDirection)(2 - a);

   120

}

   121

   122

/**

   123

 * Convert an axis and a flag for north/south into a DiagDirection

   124

 * @param ns north -> 0, south -> 1

   125

 */

   126

static inline DiagDirection XYNSToDiagDir(Axis xy, uint ns)

   127

{

   128

	return (DiagDirection)(xy * 3 ^ ns * 2);

   129

}

   130

   131

   132

static inline bool IsValidDiagDirection(DiagDirection d)

   133

{

   134

	return d < DIAGDIR_END;

   135

}

   136

   137

static inline bool IsValidDirection(Direction d)

   138

{

   139

	return d < DIR_END;

   140

}

   141

   142

static inline bool IsValidAxis(Axis d)

   143

{

   144

	return d < AXIS_END;

   145

}

   146

   147

#endif /* DIRECTION_H */