O1Library Docs
Fall 2023
DocsAPI
Generated with
This document is part of the ebook for O1 (aka CS-A1110 Programming 1), a course at Aalto University.
This document is part of the ebook for O1 (aka CS-A1110 Programming 1), a course at Aalto University.
O1Library Docs/o1/o1.grid/CompassDir

CompassDir

o1.grid.CompassDir$
See theCompassDir companion enum
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.*.

Attributes

Companion
enum
Supertypes
trait Sum
trait Mirror
class Object
trait Matchable
class Any

Members list

Inherited Not inherited
  • Not inherited
  • Mirror

Type members

Value members

Concrete methods

def fromArrowKey(key: Value): 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.

Parameters

key

any key on the keyboard

Attributes

Returns

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

See also
def fromKey(key: Value): 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.

Parameters

key

any key on the keyboard

Attributes

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: Value): 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.

Parameters

key

any key on the keyboard

Attributes

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

Generated with
This document is part of the ebook for O1 (aka CS-A1110 Programming 1), a course at Aalto University.
This document is part of the ebook for O1 (aka CS-A1110 Programming 1), a course at Aalto University.