Direction.GetCardinalDirectionIndex Method

DirectionGetCardinalDirectionIndex Method

Returns the index for the specified cardinal direction to use it, e.g. in a collection.

Namespace: Slash.Math.Utils
Assembly: Slash.Math (in Slash.Math.dll) Version: 1.0.6018.40177

Syntax

public static int GetCardinalDirectionIndex(
	DirectionType direction
)

Public Shared Function GetCardinalDirectionIndex ( 
	direction As DirectionType
) As Integer

public:
static int GetCardinalDirectionIndex(
	DirectionType direction
)

static member GetCardinalDirectionIndex : 
        direction : DirectionType -> int

direction: Type: Slash.Math.UtilsDirectionType
Cardinal direction to get index for.

Type: Int32
Index between 0 and 4 (exclusive).

Exceptions

Exception	Condition
ArgumentException	Thrown if specified direction is no cardinal direction.