dir Class Reference

Named directions.
static const dir	none
static const dir	north
static const dir	east
static const dir	northeast
static const dir	south
static const dir	northsouth
static const dir	southeast
static const dir	northsoutheast
static const dir	west
static const dir	northwest
static const dir	eastwest
static const dir	northeastwest
static const dir	southwest
static const dir	northsouthwest
static const dir	southeastwest
static const dir	all
static bool	is_single (dir d)
static bool	is_twoway (dir d)
static bool	is_threeway (dir d)
static bool	is_curve (dir d)
static bool	is_straight (dir d)
static dir	double (dir d)
static dir	backward (dir d)
static slope	to_slope (dir d)
static coord	to_coord ()

Detailed Description

Class holding static methods to work with directions. Directions are just bit-encoded integers.

Definition at line 110 of file api_simple.cc.

Member Function Documentation

backward()

static dir dir::backward ( dir  d )

static

Parameters

d	direction to test

Returns

backward direction, e.g. w -> e, n+w -> s+e, n+w+s -> e.

double()

static dir dir::double ( dir  d )

static

Parameters

d

direction

Returns

complements direction to complete straight, i.e. w -> w+e, but n+w -> 0.

is_curve()

static bool dir::is_curve ( dir  d )

static

Parameters

d	direction to test

Returns

whether direction is curve, e.g. n+e, s+w.

is_single()

static bool dir::is_single ( dir  d )

static

Parameters

d	direction to test

Returns

whether direction is single direction, i.e. just one of n/s/e/w

is_straight()

static bool dir::is_straight ( dir  d )

static

Parameters

d	direction to test

Returns

whether direction is straight and has no curves in it, e.g. n+s, w.

is_threeway()

static bool dir::is_threeway ( dir  d )

static

Parameters

d	direction to test

Returns

whether direction is triple direction, e.g. n+s+e or n+s+e+w.

is_twoway()

static bool dir::is_twoway ( dir  d )

static

Parameters

d	direction to test

Returns

whether direction is double direction, e.g. n+e, n+s.

to_coord()

static coord dir::to_coord ( )

static

Helper function to convert direction vector to dir type.

to_slope()

static slope dir::to_slope ( dir  d )

static

Converts direction to slope: direction goes upward on slope.

Parameters

d

direction

Member Data Documentation

all

const dir dir::all

static

Definition at line 129 of file api_simple.cc.

east

const dir dir::east

static

Definition at line 116 of file api_simple.cc.

eastwest

const dir dir::eastwest

static

Definition at line 124 of file api_simple.cc.

none

const dir dir::none

static

Definition at line 114 of file api_simple.cc.

north

const dir dir::north

static

Definition at line 115 of file api_simple.cc.

northeast

const dir dir::northeast

static

Definition at line 117 of file api_simple.cc.

northeastwest

const dir dir::northeastwest

static

Definition at line 125 of file api_simple.cc.

northsouth

const dir dir::northsouth

static

Definition at line 119 of file api_simple.cc.

northsoutheast

const dir dir::northsoutheast

static

Definition at line 121 of file api_simple.cc.

northsouthwest

const dir dir::northsouthwest

static

Definition at line 127 of file api_simple.cc.

northwest

const dir dir::northwest

static

Definition at line 123 of file api_simple.cc.

south

const dir dir::south

static

Definition at line 118 of file api_simple.cc.

southeast

const dir dir::southeast

static

Definition at line 120 of file api_simple.cc.

southeastwest

const dir dir::southeastwest

static

Definition at line 128 of file api_simple.cc.

southwest

const dir dir::southwest

static

Definition at line 126 of file api_simple.cc.

west

const dir dir::west

static

Definition at line 122 of file api_simple.cc.

---

The documentation for this class was generated from the following file:

• api_simple.cc