Antkeeper  0.0.1
Public Member Functions | Public Attributes | List of all members
input::mouse_motion_mapping Class Reference

Maps a direction along a mouse motion axis to a control input value. More...

#include <mapping.hpp>

Inheritance diagram for input::mouse_motion_mapping:
input::mapping

Public Member Functions

constexpr mapping_type get_mapping_type () const noexcept override
 Returns mapping_type::mouse_motion. More...
 
 mouse_motion_mapping (input::mouse *mouse, mouse_motion_axis axis, bool direction)
 Constructs a mouse motion mapping. More...
 
 mouse_motion_mapping ()=default
 Constructs a mouse motion mapping. More...
 
- Public Member Functions inherited from input::mapping
 mapping ()=default
 Constructs an input mapping. More...
 
virtual ~mapping ()=default
 Destructs an input mapping. More...
 

Public Attributes

input::mousemouse {nullptr}
 Pointer to the mapped mouse, or nullptr if input from any mouse is accepted. More...
 
mouse_motion_axis axis {0}
 Mapped mouse motion axis. More...
 
bool direction {false}
 Sign bit of the mapped direction. More...
 

Detailed Description

Maps a direction along a mouse motion axis to a control input value.

Definition at line 192 of file mapping.hpp.

Constructor & Destructor Documentation

◆ mouse_motion_mapping() [1/2]

input::mouse_motion_mapping::mouse_motion_mapping ( input::mouse mouse,
mouse_motion_axis  axis,
bool  direction 
)

Constructs a mouse motion mapping.

Parameters
mousePointer to the mouse to map, or nullptr if input from any mouse will be mapped.
axisMouse motion axis to map.
directionSign bit of the direction to map.

Definition at line 51 of file mapping.cpp.

◆ mouse_motion_mapping() [2/2]

input::mouse_motion_mapping::mouse_motion_mapping ( )
default

Constructs a mouse motion mapping.

Parameters
mousePointer to the mouse to map, or nullptr if input from any mouse will be mapped.
axisMouse motion axis to map.
directionSign bit of the direction to map.

Member Function Documentation

◆ get_mapping_type()

constexpr mapping_type input::mouse_motion_mapping::get_mapping_type ( ) const
inlineconstexproverridevirtualnoexcept

Returns mapping_type::mouse_motion.

Implements input::mapping.

Definition at line 208 of file mapping.hpp.

Member Data Documentation

◆ axis

mouse_motion_axis input::mouse_motion_mapping::axis {0}

Mapped mouse motion axis.

Definition at line 217 of file mapping.hpp.

◆ direction

bool input::mouse_motion_mapping::direction {false}

Sign bit of the mapped direction.

Definition at line 220 of file mapping.hpp.

◆ mouse

input::mouse* input::mouse_motion_mapping::mouse {nullptr}

Pointer to the mapped mouse, or nullptr if input from any mouse is accepted.

Definition at line 214 of file mapping.hpp.


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