O1Library Docs/API/o1.grid/CompassDir

CompassDir

object CompassDir

This companion object of type CompassDir provides a selection of related constants and utility methods.

This object has an alias in the top-level package o1, so it’s accessible to students simply via import o1.*.

Companion:
class
trait Sum
trait Mirror
class Object
trait Matchable
class Any

Type members

Inherited types

type MirroredElemLabels <: Tuple

The names of the product elements

The names of the product elements

Inherited from:
Mirror
type MirroredLabel <: String

The name of the type

The name of the type

Inherited from:
Mirror

Value members

Concrete methods

def fromArrowKey(key: Key): Option[CompassDir]

Returns the CompassDir that corresponds to the given arrow key. For example, the right arrow corresponds to East.

Returns the CompassDir that corresponds to the given arrow key. For example, the right arrow corresponds to East.

Value parameters:
key

any key on the keyboard

Returns:

one of the four CompassDirs; None if the given key is not one of the four arrow keys

See also:
def fromKey(key: Key): Option[CompassDir]

Returns the CompassDir that corresponds to the given arrow key. For example, the right arrow or the D key corresponds to East.

Returns the CompassDir that corresponds to the given arrow key. For example, the right arrow or the D key corresponds to East.

Value parameters:
key

any key on the keyboard

Returns:

one of the four CompassDirs; None if the given key is not one of the four arrow keys or one of the four WASD keys

See also:
def fromWASD(key: Key): Option[CompassDir]

Returns the CompassDir that corresponds to the given WASD key. For example, the D key corresponds to East.

Returns the CompassDir that corresponds to the given WASD key. For example, the D key corresponds to East.

Value parameters:
key

any key on the keyboard

Returns:

one of the four CompassDirs; None if the given key is not one of the four WASD keys

See also:

Concrete fields

val Clockwise: Vector[CompassDir]

a collection of all the four directions, in clockwise order starting with North

a collection of all the four directions, in clockwise order starting with North

val Count: Int

The number of the compass directions represented by class CompassDir. Four, that is.

The number of the compass directions represented by class CompassDir. Four, that is.

Givens

Givens