MoveDirection< EnumType > Class Template Reference

Base template providing common logic for movement directions. More...

#include <move_types.h>

Public Member Functions
constexpr	MoveDirection (EnumType v)
	Construct a new Move Direction object.
bool	is_none () const
	Checks if the movement state is None (0).
EnumType	get_value () const
	Gets the underlying enum value.
bool	operator! () const
	Logical NOT operator.
	operator uint8_t () const
	Implicit conversion to uint8_t for hardware drivers.
bool	operator== (EnumType v) const
	Equality comparison with underlying enum.
bool	operator!= (EnumType v) const
	Inequality comparison with underlying enum.

Protected Attributes
EnumType	_value

Detailed Description

template<typename EnumType>
class MoveDirection< EnumType >

Base template providing common logic for movement directions.

Template Parameters

EnumType

The axis-specific enum (MoveXValue or MoveYValue).

Constructor & Destructor Documentation

MoveDirection()

template<typename EnumType >

MoveDirection< EnumType >::MoveDirection ( EnumType v )

inlineconstexpr

Construct a new Move Direction object.

Parameters

v	The initial enum value.

Member Function Documentation

get_value()

template<typename EnumType >

EnumType MoveDirection< EnumType >::get_value ( ) const

inline

Gets the underlying enum value.

Returns

EnumType.

is_none()

template<typename EnumType >

bool MoveDirection< EnumType >::is_none ( ) const

inline

Checks if the movement state is None (0).

Returns

true if no movement.

operator uint8_t()

template<typename EnumType >

MoveDirection< EnumType >::operator uint8_t ( ) const

inline

Implicit conversion to uint8_t for hardware drivers.

Returns

uint8_t value.

operator!()

template<typename EnumType >

bool MoveDirection< EnumType >::operator! ( ) const

inline

Logical NOT operator.

Returns

true if direction is None.

operator!=()

template<typename EnumType >

bool MoveDirection< EnumType >::operator!= ( EnumType v ) const

inline

Inequality comparison with underlying enum.

Parameters

v	Value to compare.

operator==()

template<typename EnumType >

bool MoveDirection< EnumType >::operator== ( EnumType v ) const

inline

Equality comparison with underlying enum.

Parameters

v	Value to compare.

Member Data Documentation

_value

template<typename EnumType >

EnumType MoveDirection< EnumType >::_value

protected

Internal storage of the movement state.

---

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

• include/move_types.h