Blender V4.5
Public Member Functions | Static Public Member Functions | Public Attributes | List of all members
GHOST_ModifierKeys Struct Reference

#include <GHOST_ModifierKeys.hh>

Public Member Functions

 GHOST_ModifierKeys ()
 ~GHOST_ModifierKeys ()
bool get (GHOST_TModifierKey mask) const
void set (GHOST_TModifierKey mask, bool down)
void clear ()
bool equals (const GHOST_ModifierKeys &keys) const

Static Public Member Functions

static GHOST_TKey getModifierKeyCode (GHOST_TModifierKey mask)

Public Attributes

uint8_t m_LeftShift: 1
uint8_t m_RightShift: 1
uint8_t m_LeftAlt: 1
uint8_t m_RightAlt: 1
uint8_t m_LeftControl: 1
uint8_t m_RightControl: 1
uint8_t m_LeftOS: 1
uint8_t m_RightOS: 1
uint8_t m_LeftHyper: 1
uint8_t m_RightHyper: 1

Detailed Description

Stores the state of modifier keys. Discriminates between left and right modifier keys.

Definition at line 18 of file GHOST_ModifierKeys.hh.

Constructor & Destructor Documentation

◆ GHOST_ModifierKeys()

GHOST_ModifierKeys::GHOST_ModifierKeys ( )

Constructor.

Copyright (C) 2001 NaN Technologies B.V.

Definition at line 16 of file GHOST_ModifierKeys.cc.

References clear().

Referenced by equals(), and ~GHOST_ModifierKeys().

◆ ~GHOST_ModifierKeys()

GHOST_ModifierKeys::~GHOST_ModifierKeys ( )
default

References GHOST_ModifierKeys(), and mask().

Member Function Documentation

◆ clear()

void GHOST_ModifierKeys::clear ( )

Sets the state of all modifier keys to up.

Definition at line 134 of file GHOST_ModifierKeys.cc.

References m_LeftAlt, m_LeftControl, m_LeftHyper, m_LeftOS, m_LeftShift, m_RightAlt, m_RightControl, m_RightHyper, m_RightOS, and m_RightShift.

Referenced by GHOST_ModifierKeys().

◆ equals()

bool GHOST_ModifierKeys::equals ( const GHOST_ModifierKeys & keys) const

Determines whether to modifier key states are equal.

Parameters
keysThe modifier key state to compare to.
Returns
Indication of equality.

Definition at line 148 of file GHOST_ModifierKeys.cc.

References GHOST_ModifierKeys(), m_LeftAlt, m_LeftControl, m_LeftHyper, m_LeftOS, m_LeftShift, m_RightAlt, m_RightControl, m_RightHyper, m_RightOS, and m_RightShift.

◆ get()

bool GHOST_ModifierKeys::get ( GHOST_TModifierKey mask) const

Returns the state of a single modifier key.

Parameters
maskKey state to return.
Returns
The state of the key (pressed == true).

Definition at line 66 of file GHOST_ModifierKeys.cc.

References GHOST_ASSERT, GHOST_kModifierKeyLeftAlt, GHOST_kModifierKeyLeftControl, GHOST_kModifierKeyLeftHyper, GHOST_kModifierKeyLeftOS, GHOST_kModifierKeyLeftShift, GHOST_kModifierKeyRightAlt, GHOST_kModifierKeyRightControl, GHOST_kModifierKeyRightHyper, GHOST_kModifierKeyRightOS, GHOST_kModifierKeyRightShift, m_LeftAlt, m_LeftControl, m_LeftHyper, m_LeftOS, m_LeftShift, m_RightAlt, m_RightControl, m_RightHyper, m_RightOS, m_RightShift, and mask().

Referenced by GHOST_System::getModifierKeyState().

◆ getModifierKeyCode()

GHOST_TKey GHOST_ModifierKeys::getModifierKeyCode ( GHOST_TModifierKey mask)
static

Returns the modifier key's key code from a modifier key mask.

Parameters
maskThe mask of the modifier key.
Returns
The modifier key's key code.

Definition at line 23 of file GHOST_ModifierKeys.cc.

References GHOST_ASSERT, GHOST_kKeyLeftAlt, GHOST_kKeyLeftControl, GHOST_kKeyLeftHyper, GHOST_kKeyLeftOS, GHOST_kKeyLeftShift, GHOST_kKeyRightAlt, GHOST_kKeyRightControl, GHOST_kKeyRightHyper, GHOST_kKeyRightOS, GHOST_kKeyRightShift, GHOST_kKeyUnknown, GHOST_kModifierKeyLeftAlt, GHOST_kModifierKeyLeftControl, GHOST_kModifierKeyLeftHyper, GHOST_kModifierKeyLeftOS, GHOST_kModifierKeyLeftShift, GHOST_kModifierKeyRightAlt, GHOST_kModifierKeyRightControl, GHOST_kModifierKeyRightHyper, GHOST_kModifierKeyRightOS, GHOST_kModifierKeyRightShift, and mask().

◆ set()

void GHOST_ModifierKeys::set ( GHOST_TModifierKey mask,
bool down )

Updates the state of a single modifier key.

Parameters
maskKey state to update.
downThe new state of the key.

Definition at line 95 of file GHOST_ModifierKeys.cc.

References GHOST_ASSERT, GHOST_kModifierKeyLeftAlt, GHOST_kModifierKeyLeftControl, GHOST_kModifierKeyLeftHyper, GHOST_kModifierKeyLeftOS, GHOST_kModifierKeyLeftShift, GHOST_kModifierKeyRightAlt, GHOST_kModifierKeyRightControl, GHOST_kModifierKeyRightHyper, GHOST_kModifierKeyRightOS, GHOST_kModifierKeyRightShift, m_LeftAlt, m_LeftControl, m_LeftHyper, m_LeftOS, m_LeftShift, m_RightAlt, m_RightControl, m_RightHyper, m_RightOS, m_RightShift, and mask().

Referenced by GHOST_SystemCocoa::getModifierKeys(), GHOST_SystemSDL::getModifierKeys(), GHOST_SystemWayland::getModifierKeys(), GHOST_SystemWin32::getModifierKeys(), and GHOST_SystemX11::getModifierKeys().

Member Data Documentation

◆ m_LeftAlt

uint8_t GHOST_ModifierKeys::m_LeftAlt

Bit-field that stores the appropriate key state.

Definition at line 64 of file GHOST_ModifierKeys.hh.

Referenced by clear(), equals(), get(), and set().

◆ m_LeftControl

uint8_t GHOST_ModifierKeys::m_LeftControl

Bit-field that stores the appropriate key state.

Definition at line 68 of file GHOST_ModifierKeys.hh.

Referenced by clear(), equals(), get(), and set().

◆ m_LeftHyper

uint8_t GHOST_ModifierKeys::m_LeftHyper

Definition at line 74 of file GHOST_ModifierKeys.hh.

Referenced by clear(), equals(), get(), and set().

◆ m_LeftOS

uint8_t GHOST_ModifierKeys::m_LeftOS

Bit-field that stores the appropriate key state.

Definition at line 72 of file GHOST_ModifierKeys.hh.

Referenced by clear(), equals(), get(), and set().

◆ m_LeftShift

uint8_t GHOST_ModifierKeys::m_LeftShift

Bit-field that stores the appropriate key state.

Definition at line 60 of file GHOST_ModifierKeys.hh.

Referenced by clear(), equals(), get(), and set().

◆ m_RightAlt

uint8_t GHOST_ModifierKeys::m_RightAlt

Bit-field that stores the appropriate key state.

Definition at line 66 of file GHOST_ModifierKeys.hh.

Referenced by clear(), equals(), get(), and set().

◆ m_RightControl

uint8_t GHOST_ModifierKeys::m_RightControl

Bit-field that stores the appropriate key state.

Definition at line 70 of file GHOST_ModifierKeys.hh.

Referenced by clear(), equals(), get(), and set().

◆ m_RightHyper

uint8_t GHOST_ModifierKeys::m_RightHyper

Definition at line 75 of file GHOST_ModifierKeys.hh.

Referenced by clear(), equals(), get(), and set().

◆ m_RightOS

uint8_t GHOST_ModifierKeys::m_RightOS

Definition at line 73 of file GHOST_ModifierKeys.hh.

Referenced by clear(), equals(), get(), and set().

◆ m_RightShift

uint8_t GHOST_ModifierKeys::m_RightShift

Bit-field that stores the appropriate key state.

Definition at line 62 of file GHOST_ModifierKeys.hh.

Referenced by clear(), equals(), get(), and set().

The documentation for this struct was generated from the following files:
Generated on for Blender by  doxygen 1.15.0