LuciadCPillar 2024.0.08
|
Represents a mouse button in the controller API. More...
#include <luciad/input/mouse/MouseButton.h>
Public Member Functions | |
constexpr | MouseButton (size_t index) |
Creates a new MouseButton with the given index. More... | |
constexpr bool | isLeft () const |
Returns whether the button is the left mouse button. More... | |
constexpr bool | isMiddle () const |
Returns whether the button is the middle mouse button. More... | |
constexpr bool | isRight () const |
Returns whether the button is the right mouse button. More... | |
constexpr bool | isUnknown () const |
Returns whether the button is unknown. More... | |
constexpr bool | operator!= (const MouseButton &rhs) const |
constexpr bool | operator== (const MouseButton &rhs) const |
Static Public Member Functions | |
static const MouseButton & | left () |
Returns the left mouse button. More... | |
static const MouseButton & | middle () |
Returns the middle mouse button. More... | |
static const MouseButton & | right () |
Returns the right mouse button. More... | |
static const MouseButton & | unknown () |
Returns an unknown mouse button. More... | |
Public Attributes | |
size_t | index |
The mouse button index. More... | |
Represents a mouse button in the controller API.
|
inlineexplicitconstexpr |
Creates a new MouseButton with the given index.
The mouse button index maps to mouse buttons as follows:
Unmapped values can be used to express a custom mouse button.
index | the mouse button index. |
|
inlineconstexpr |
Returns whether the button is the left mouse button.
|
inlineconstexpr |
Returns whether the button is the middle mouse button.
|
inlineconstexpr |
Returns whether the button is the right mouse button.
|
inlineconstexpr |
Returns whether the button is unknown.
|
static |
Returns the left mouse button.
|
static |
Returns the middle mouse button.
|
inlineconstexpr |
rhs | the MouseButton that this MouseButton is being compared to. |
|
inlineconstexpr |
rhs | the MouseButton that this MouseButton is being compared to. |
|
static |
Returns the right mouse button.
|
static |
Returns an unknown mouse button.
size_t luciad::MouseButton::index |
The mouse button index.