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

Maps a mouse button to a control input value. More...

#include <mapping.hpp>

Inheritance diagram for input::mouse_button_mapping:
input::mapping

Public Member Functions

constexpr mapping_type get_mapping_type () const noexcept override
 Returns mapping_type::mouse_button. More...
 
 mouse_button_mapping (input::mouse *mouse, mouse_button button)
 Constructs a mouse button mapping. More...
 
 mouse_button_mapping ()=default
 Constructs a mouse button 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_button button {0}
 Mapped mouse button. More...
 

Detailed Description

Maps a mouse button to a control input value.

Definition at line 162 of file mapping.hpp.

Constructor & Destructor Documentation

◆ mouse_button_mapping() [1/2]

input::mouse_button_mapping::mouse_button_mapping ( input::mouse mouse,
mouse_button  button 
)

Constructs a mouse button mapping.

Parameters
mousePointer to the mouse to map, or nullptr if input from any mouse will be mapped.
buttonMouse button to map.

Definition at line 46 of file mapping.cpp.

◆ mouse_button_mapping() [2/2]

input::mouse_button_mapping::mouse_button_mapping ( )
default

Constructs a mouse button mapping.

Parameters
mousePointer to the mouse to map, or nullptr if input from any mouse will be mapped.
buttonMouse button to map.

Member Function Documentation

◆ get_mapping_type()

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

Returns mapping_type::mouse_button.

Implements input::mapping.

Definition at line 177 of file mapping.hpp.

Member Data Documentation

◆ button

mouse_button input::mouse_button_mapping::button {0}

Mapped mouse button.

Definition at line 186 of file mapping.hpp.

◆ mouse

input::mouse* input::mouse_button_mapping::mouse {nullptr}

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

Definition at line 183 of file mapping.hpp.


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