HoverRace::Control::Nav Class Reference

A navigation direction. More...

#include <Nav.h>

Public Types
enum	dir_t {   NEUTRAL, UP, DOWN, LEFT,   RIGHT, NEXT, PREV }

Public Member Functions
constexpr	Nav (dir_t dir=NEUTRAL) noexcept
constexpr	Nav (const Nav &) noexcept=default
constexpr	Nav (Nav &&) noexcept=default
constexpr dir_t	AsDigital () const noexcept
	Converts this direction into one of the cardinal directions. More...
Nav &	operator= (const Nav &) noexcept=default
Nav &	operator= (Nav &&) noexcept=default

Private Attributes
dir_t	dir

Detailed Description

A navigation direction.

This is a placeholder for future support for analog directional controls. For now, only digital (cardinal directions) are supported.

Author

Michael Imamura

Member Enumeration Documentation

enum HoverRace::Control::Nav::dir_t

Enumerator
NEUTRAL
UP
DOWN
LEFT
RIGHT
NEXT
PREV

Constructor & Destructor Documentation

constexpr HoverRace::Control::Nav::Nav ( dir_t  dir = NEUTRAL )

inlinenoexcept

constexpr HoverRace::Control::Nav::Nav ( const Nav &  )

defaultnoexcept

constexpr HoverRace::Control::Nav::Nav ( Nav &&  )

defaultnoexcept

Member Function Documentation

constexpr dir_t HoverRace::Control::Nav::AsDigital ( ) const

inlinenoexcept

Converts this direction into one of the cardinal directions.

Returns

The direction.

Nav& HoverRace::Control::Nav::operator= ( const Nav &  )

defaultnoexcept

Nav& HoverRace::Control::Nav::operator= ( Nav &&  )

defaultnoexcept

Member Data Documentation

dir_t HoverRace::Control::Nav::dir

private

---

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

• Nav.h