"direction" | silmarils

Index

Type aliases

Cardinal Variables

Intercardinal Variables

Other Variables

Angle Functions

Rotation Functions

Vector Functions

Type aliases

CardinalDirection

CardinalDirection: North | East | South | West

The four points on a compass.

Direction

Direction: CardinalDirection | IntercardinalDirection

A cardinal or intercardinal direction.

East

East: "east"

IntercardinalDirection

IntercardinalDirection: NorthEast | NorthWest | SouthEast | SouthWest

The directions between the cardinal directions.

North

North: "north"

NorthEast

NorthEast: "north-east"

NorthWest

NorthWest: "north-west"

South

South: "south"

SouthEast

SouthEast: "south-east"

SouthWest

SouthWest: "south-west"

West

West: "west"

Cardinal Variables

Const EAST

EAST: East = "east"

Const NORTH

NORTH: North = "north"

Const SOUTH

SOUTH: South = "south"

Const WEST

WEST: West = "west"

Intercardinal Variables

Const NORTH_EAST

NORTH_EAST: NorthEast = "north-east"

Const NORTH_WEST

NORTH_WEST: NorthWest = "north-west"

Const SOUTH_EAST

SOUTH_EAST: SouthEast = "south-east"

Const SOUTH_WEST

SOUTH_WEST: SouthWest = "south-west"

Other Variables

Const CARDINAL_DIRECTIONS

CARDINAL_DIRECTIONS: CardinalDirection[] = [NORTH, EAST, SOUTH, WEST]

Const DIRECTIONS

DIRECTIONS: Direction[] = [NORTH, NORTH_EAST, EAST, SOUTH_EAST, SOUTH, SOUTH_WEST, WEST, NORTH_WEST]

Const INTERCARDINAL_DIRECTIONS

INTERCARDINAL_DIRECTIONS: IntercardinalDirection[] = [NORTH_EAST, SOUTH_EAST, SOUTH_WEST, NORTH_WEST]

Angle Functions

cardinalFromAngle

cardinalFromAngle(radians: number): CardinalDirection

- Defined in direction.ts:127
Calculates the approximate CardinalDirection from an angle in radians.

If you want to find the nearest direction of any type, use fromAngle.
```
Direction.fromAngle(0) // Direction.NORTH
Direction.fromAngle(Math.PI) // Direction.SOUTH
```
Parameters
- radians: number
  
  Angle in radians
Returns CardinalDirection

Approximate cardinal direction

fromAngle

fromAngle(radians: number): Direction

- Defined in direction.ts:95
Calculates the approximate direction from an angle in radians.
```
Direction.fromAngle(0) // Direction.NORTH
Direction.fromAngle(Math.PI) // Direction.SOUTH
```
Parameters
- radians: number
  
  Angle in radians
Returns Direction

Approximate direction

toAngle

toAngle(direction: Direction): number

- Defined in direction.ts:151
Calculates the angle of a given direction.
```
Direction.toAngle(Direction.NORTH) // 0
Direction.toAngle(Direction.SOUTH) // Math.PI
```
Parameters
- direction: Direction
Returns number

Angle in radians

Rotation Functions

rotate180

rotate180(direction: North): South
rotate180(direction: South): North
rotate180(direction: East): West
rotate180(direction: West): East
rotate180(direction: NorthEast): SouthWest
rotate180(direction: NorthWest): SouthEast
rotate180(direction: SouthEast): NorthWest
rotate180(direction: SouthWest): NorthEast
rotate180(direction: CardinalDirection): CardinalDirection
rotate180(direction: IntercardinalDirection): IntercardinalDirection
rotate180(direction: Direction): Direction

- Defined in direction.ts:353
Rotates a direction by 180 degrees.

Parameters
- direction: North
Returns South
- Defined in direction.ts:354
Parameters
- direction: South
Returns North
- Defined in direction.ts:355
Parameters
- direction: East
Returns West
- Defined in direction.ts:356
Parameters
- direction: West
Returns East
- Defined in direction.ts:357
Parameters
- direction: NorthEast
Returns SouthWest
- Defined in direction.ts:358
Parameters
- direction: NorthWest
Returns SouthEast
- Defined in direction.ts:359
Parameters
- direction: SouthEast
Returns NorthWest
- Defined in direction.ts:360
Parameters
- direction: SouthWest
Returns NorthEast
- Defined in direction.ts:361
Parameters
- direction: CardinalDirection
Returns CardinalDirection
- Defined in direction.ts:362
Parameters
- direction: IntercardinalDirection
Returns IntercardinalDirection
- Defined in direction.ts:363
Parameters
- direction: Direction
Returns Direction

rotateLeft45

rotateLeft45(direction: North): NorthWest
rotateLeft45(direction: NorthWest): West
rotateLeft45(direction: West): SouthWest
rotateLeft45(direction: SouthWest): South
rotateLeft45(direction: South): SouthEast
rotateLeft45(direction: SouthEast): East
rotateLeft45(direction: East): NorthEast
rotateLeft45(direction: CardinalDirection): IntercardinalDirection
rotateLeft45(direction: IntercardinalDirection): CardinalDirection
rotateLeft45(direction: Direction): Direction

- Defined in direction.ts:267
Rotates a direction by 45 degrees in a counterclockwise direction.

Parameters
- direction: North
Returns NorthWest
- Defined in direction.ts:268
Parameters
- direction: NorthWest
Returns West
- Defined in direction.ts:269
Parameters
- direction: West
Returns SouthWest
- Defined in direction.ts:270
Parameters
- direction: SouthWest
Returns South
- Defined in direction.ts:271
Parameters
- direction: South
Returns SouthEast
- Defined in direction.ts:272
Parameters
- direction: SouthEast
Returns East
- Defined in direction.ts:273
Parameters
- direction: East
Returns NorthEast
- Defined in direction.ts:274
Parameters
- direction: CardinalDirection
Returns IntercardinalDirection
- Defined in direction.ts:275
Parameters
- direction: IntercardinalDirection
Returns CardinalDirection
- Defined in direction.ts:276
Parameters
- direction: Direction
Returns Direction

rotateLeft90

rotateLeft90(direction: North): West
rotateLeft90(direction: West): South
rotateLeft90(direction: South): East
rotateLeft90(direction: East): North
rotateLeft90(direction: NorthEast): NorthWest
rotateLeft90(direction: NorthWest): SouthWest
rotateLeft90(direction: SouthWest): SouthEast
rotateLeft90(direction: SouthEast): NorthEast
rotateLeft90(direction: CardinalDirection): CardinalDirection
rotateLeft90(direction: IntercardinalDirection): IntercardinalDirection
rotateLeft90(direction: Direction): Direction

- Defined in direction.ts:324
Rotates a direction by 90 degrees in a counterclockwise direction.

Parameters
- direction: North
Returns West
- Defined in direction.ts:325
Parameters
- direction: West
Returns South
- Defined in direction.ts:326
Parameters
- direction: South
Returns East
- Defined in direction.ts:327
Parameters
- direction: East
Returns North
- Defined in direction.ts:328
Parameters
- direction: NorthEast
Returns NorthWest
- Defined in direction.ts:329
Parameters
- direction: NorthWest
Returns SouthWest
- Defined in direction.ts:330
Parameters
- direction: SouthWest
Returns SouthEast
- Defined in direction.ts:331
Parameters
- direction: SouthEast
Returns NorthEast
- Defined in direction.ts:332
Parameters
- direction: CardinalDirection
Returns CardinalDirection
- Defined in direction.ts:333
Parameters
- direction: IntercardinalDirection
Returns IntercardinalDirection
- Defined in direction.ts:334
Parameters
- direction: Direction
Returns Direction

rotateRight45

rotateRight45(direction: North): NorthEast
rotateRight45(direction: NorthEast): East
rotateRight45(direction: East): SouthEast
rotateRight45(direction: SouthEast): South
rotateRight45(direction: South): SouthWest
rotateRight45(direction: SouthWest): West
rotateRight45(direction: West): NorthWest
rotateRight45(direction: NorthWest): North
rotateRight45(direction: CardinalDirection): IntercardinalDirection
rotateRight45(direction: IntercardinalDirection): CardinalDirection
rotateRight45(direction: Direction): Direction

- Defined in direction.ts:238
Rotates a direction by 45 degrees in a clockwise direction.

Parameters
- direction: North
Returns NorthEast
- Defined in direction.ts:239
Parameters
- direction: NorthEast
Returns East
- Defined in direction.ts:240
Parameters
- direction: East
Returns SouthEast
- Defined in direction.ts:241
Parameters
- direction: SouthEast
Returns South
- Defined in direction.ts:242
Parameters
- direction: South
Returns SouthWest
- Defined in direction.ts:243
Parameters
- direction: SouthWest
Returns West
- Defined in direction.ts:244
Parameters
- direction: West
Returns NorthWest
- Defined in direction.ts:245
Parameters
- direction: NorthWest
Returns North
- Defined in direction.ts:246
Parameters
- direction: CardinalDirection
Returns IntercardinalDirection
- Defined in direction.ts:247
Parameters
- direction: IntercardinalDirection
Returns CardinalDirection
- Defined in direction.ts:248
Parameters
- direction: Direction
Returns Direction

rotateRight90

rotateRight90(direction: North): East
rotateRight90(direction: East): South
rotateRight90(direction: South): West
rotateRight90(direction: West): North
rotateRight90(direction: NorthEast): SouthEast
rotateRight90(direction: SouthEast): SouthWest
rotateRight90(direction: SouthWest): NorthWest
rotateRight90(direction: NorthWest): NorthEast
rotateRight90(direction: CardinalDirection): CardinalDirection
rotateRight90(direction: IntercardinalDirection): IntercardinalDirection
rotateRight90(direction: Direction): Direction

- Defined in direction.ts:295
Rotates a direction by 90 degrees in a clockwise direction.

Parameters
- direction: North
Returns East
- Defined in direction.ts:296
Parameters
- direction: East
Returns South
- Defined in direction.ts:297
Parameters
- direction: South
Returns West
- Defined in direction.ts:298
Parameters
- direction: West
Returns North
- Defined in direction.ts:299
Parameters
- direction: NorthEast
Returns SouthEast
- Defined in direction.ts:300
Parameters
- direction: SouthEast
Returns SouthWest
- Defined in direction.ts:301
Parameters
- direction: SouthWest
Returns NorthWest
- Defined in direction.ts:302
Parameters
- direction: NorthWest
Returns NorthEast
- Defined in direction.ts:303
Parameters
- direction: CardinalDirection
Returns CardinalDirection
- Defined in direction.ts:304
Parameters
- direction: IntercardinalDirection
Returns IntercardinalDirection
- Defined in direction.ts:305
Parameters
- direction: Direction
Returns Direction

Vector Functions

cardinalFromVector

cardinalFromVector(vector: Vector): CardinalDirection

- Defined in direction.ts:214
Returns the approximate cardinal direction of a vector.

Parameters
- vector: Vector
Returns CardinalDirection

fromVector

fromVector(vector: Vector): Direction

- Defined in direction.ts:192
Returns the approximate direction from a vector.

Parameters
- vector: Vector
Returns Direction

toVector

toVector(direction: Direction): Vector

- Defined in direction.ts:170
Creates a unit vector from a direction.

Parameters
- direction: Direction
Returns Vector

Index

Type aliases

Cardinal Variables

Intercardinal Variables

Other Variables

Angle Functions

Rotation Functions

Vector Functions

Type aliases

CardinalDirection

Direction

East

IntercardinalDirection

North

NorthEast

NorthWest

South

SouthEast

SouthWest

West

Cardinal Variables

Const EAST

Const NORTH

Const SOUTH

Const WEST

Intercardinal Variables

Const NORTH_EAST

Const NORTH_WEST

Const SOUTH_EAST

Const SOUTH_WEST

Other Variables

Const CARDINAL_DIRECTIONS

Const DIRECTIONS

Const INTERCARDINAL_DIRECTIONS

Angle Functions

cardinalFromAngle

Parameters

radians: number

Returns CardinalDirection

fromAngle

Parameters

radians: number

Returns Direction

toAngle

Parameters

direction: Direction

Returns number

Rotation Functions

rotate180

Parameters

direction: North

Returns South

Parameters

direction: South

Returns North

Parameters

direction: East

Returns West

Parameters

direction: West

Returns East

Parameters

direction: NorthEast

Returns SouthWest

Parameters

direction: NorthWest

Returns SouthEast

Parameters

direction: SouthEast

Returns NorthWest

Parameters

direction: SouthWest

Returns NorthEast

Parameters

direction: CardinalDirection

Returns CardinalDirection

Parameters

direction: IntercardinalDirection

Returns IntercardinalDirection

Parameters