InputEvents Class Reference

Collaboration diagram for InputEvents:

Public Member Functions
bool	held (int buttons)
	whether or not a button is pressed during this cycle More...
bool	pressed (int buttons)
bool	released (int buttons)
bool	touchIn (int x, int width, int y, int height)
	whether or not a touch is detected within the specified rect in this cycle More...
bool	processSDLEvents ()
	update which buttons are pressed More...
bool	update ()
bool	isTouchDown ()
bool	isTouchUp ()
bool	isTouchDrag ()
bool	isTouch ()
bool	isScroll ()
bool	isKeyDown ()
bool	isKeyUp ()
bool	processDirectionalButtons ()
int	directionForKeycode ()
void	toggleHeldButtons ()
void	processJoystickHotplugging (SDL_Event *event)
	joystick device events processing More...

Static Public Member Functions
static GamepadInfo &	getLastGamepadInfo ()

Public Attributes
bool	allowTouch = true
bool	isScrolling = false
CST_Keycode	keyCode = -1
CST_Keymod	mod = -1
SDL_Event	event
bool	held_directions [4] = { false, false, false, false }
Uint32	held_type
int	rapidFireRate = 12
int	curFrame = 0
std::function< void()>	quitaction = NULL
float	wheelScroll = 0
int	yPos = 0
int	xPos = 0
bool	noop = false
Uint32	type

Static Public Attributes
static bool	bypassKeyEvents = false
static std::string	lastGamepadKey = defaultKeyName

Detailed Description

Definition at line 79 of file InputEvents.hpp.

Constructor & Destructor Documentation

InputEvents()

InputEvents::InputEvents

(

)

Definition at line 67 of file InputEvents.cpp.

{
#if defined(__WIIU__) && defined(USE_KEYBOARD)
    // hook up keyboard events for wiiu and SDL (TODO: have these fired by SDL2 port itself)
    KBWrapper* kbdwrapper = new KBWrapper(true, true);
#endif
}

Member Function Documentation

directionForKeycode()

int InputEvents::directionForKeycode

(

)

Definition at line 241 of file InputEvents.cpp.

{
    // this keycode overlaps with some other constants, so just return asap
    if (this->type == SDL_KEYDOWN && this->keyCode == SDLK_RETURN)
        return -1;
 
    // returns 0 1 2 or 3 for up down left or right
    switch (this->keyCode)
    {
    case SDL_UP_STICK:
    case SDL_UP:
    case SDLK_UP:
        return 0;
    case SDL_DOWN_STICK:
    case SDL_DOWN:
    case SDLK_DOWN:
        return 1;
    case SDL_LEFT_STICK:
    case SDL_LEFT:
    case SDLK_LEFT:
        return 2;
    case SDL_RIGHT_STICK:
    case SDL_RIGHT:
    case SDLK_RIGHT:
        return 3;
    default:
        return -1;
    }
    return -1;
}

getLastGamepadInfo()

GamepadInfo & InputEvents::getLastGamepadInfo ( )

static

Definition at line 366 of file InputEvents.cpp.

{
    return gamepadMap[lastGamepadKey];
}

held()

bool InputEvents::held

(

int

buttons

)

whether or not a button is pressed during this cycle

Definition at line 272 of file InputEvents.cpp.

{
    // if it's a key event
    if ((this->type == SDL_KEYDOWN || this->type == SDL_KEYUP) && !InputEvents::bypassKeyEvents)
    {
        for (int x = 0; x < TOTAL_BUTTONS; x++)
            if (key_buttons[x] == keyCode && (buttons & currentButtons[x]))
                return true;
    }
 
    // if it's a controller event
    else if (this->type == SDL_JOYBUTTONDOWN || this->type == SDL_JOYBUTTONUP)
    {
        for (int x = 0; x < TOTAL_BUTTONS; x++)
            if (pad_buttons[x] == keyCode && (buttons & currentButtons[x]))
                return true;
    }
 
    return false;
}

Referenced by Button::process(), and EKeyboard::process().

isKeyDown()

bool InputEvents::isKeyDown

(

)

Definition at line 333 of file InputEvents.cpp.

{
    return this->type == SDL_KEYDOWN || this->type == SDL_JOYBUTTONDOWN;
}

isKeyUp()

bool InputEvents::isKeyUp

(

)

Definition at line 338 of file InputEvents.cpp.

{
    return this->type == SDL_KEYUP || this->type == SDL_JOYBUTTONUP;
}

isScroll()

bool InputEvents::isScroll

(

)

Definition at line 328 of file InputEvents.cpp.

{
    return this->isScrolling;
}

isTouch()

bool InputEvents::isTouch

(

)

Definition at line 323 of file InputEvents.cpp.

{
    return isTouchDown() || isTouchDrag() || isTouchUp();
}

isTouchDown()

bool InputEvents::isTouchDown

(

)

Definition at line 308 of file InputEvents.cpp.

{
    return this->type == SDL_MOUSEBUTTONDOWN || (allowTouch && this->type == SDL_FINGERDOWN);
}

isTouchDrag()

bool InputEvents::isTouchDrag

(

)

Definition at line 313 of file InputEvents.cpp.

{
    return this->type == SDL_MOUSEMOTION || (allowTouch && this->type == SDL_FINGERMOTION);
}

isTouchUp()

bool InputEvents::isTouchUp

(

)

Definition at line 318 of file InputEvents.cpp.

{
    return this->type == SDL_MOUSEBUTTONUP || (allowTouch && this->type == SDL_FINGERUP);
}

pressed()

bool InputEvents::pressed

(

int

buttons

)

Definition at line 293 of file InputEvents.cpp.

{
    return isKeyDown() && held(buttons);
}

processDirectionalButtons()

bool InputEvents::processDirectionalButtons

(

)

Definition at line 214 of file InputEvents.cpp.

{
    // up the counter
    curFrame++;
 
    // if one of the four direction keys is true, fire off repeat events for it
    // (when rapidFire lines up only)
    if (curFrame > 0 && curFrame % rapidFireRate == 0)
    {
        for (int x = 0; x < 4; x++)
        {
            if (!held_directions[x])
                continue;
 
            // send a corresponding directional event
            this->type = held_type;
            bool isGamepad = (this->type == SDL_JOYBUTTONDOWN || this->type == SDL_JOYBUTTONUP);
            this->keyCode = isGamepad ? pad_buttons[4 + x] : key_buttons[4 + x]; // send up through right directions
            this->noop = false;
 
            return true;
        }
    }
 
    return false;
}

processJoystickHotplugging()

void InputEvents::processJoystickHotplugging

(

SDL_Event *

event

)

joystick device events processing

Definition at line 343 of file InputEvents.cpp.

{
    SDL_Joystick *j;
    switch(event->type)
    {
    case SDL_JOYDEVICEADDED:
        j = SDL_JoystickOpen(event->jdevice.which);
        if (j)
            printf("Added joystick device: %s, with ID %d\n", SDL_JoystickName(j), SDL_JoystickInstanceID(j));
        break;
    case SDL_JOYDEVICEREMOVED:
        j = SDL_JoystickFromInstanceID(event->jdevice.which);
        if (j && SDL_JoystickGetAttached(j))
        {
            printf("Removed joystick device: %s\n", SDL_JoystickName(j));
            SDL_JoystickClose(j);
        }
        break;
    default:
        break;
    }
}

Referenced by processSDLEvents().

processSDLEvents()

bool InputEvents::processSDLEvents

(

)

update which buttons are pressed

Definition at line 75 of file InputEvents.cpp.

{
    // get an event from SDL
    if (!SDL_PollEvent(&event))
        return false;
 
    // update our variables
    this->type = event.type;
    this->noop = false;
 
    // process joystick hotplugging events
    processJoystickHotplugging(&event);
 
    std::string curControllerName= lastGamepadKey;
 
    // get the controller name
    if (this->type == SDL_KEYDOWN || this->type == SDL_KEYUP) {
        // keyboard event
        lastGamepadKey = "Keyboard";
    } else if (this->type == SDL_JOYBUTTONDOWN || this->type == SDL_JOYBUTTONUP) {
        SDL_Joystick* joystickId = SDL_JoystickFromInstanceID(event.jbutton.which);
        if (joystickId != NULL) {
            std::string controllerName = SDL_JoystickName(joystickId);
            lastGamepadKey = defaultKeyName; // default in case no match is found
            if (!controllerName.empty() && gamepadMap.find(controllerName) != gamepadMap.end()){
                lastGamepadKey = controllerName;
            }
        }
    }
    if (curControllerName != lastGamepadKey) {
        printf("Switched to controller profile: %s\n", lastGamepadKey.c_str());
        GamepadInfo& gamepadInfo = gamepadMap[lastGamepadKey];
        if (gamepadInfo.buttons != nullptr) {
            currentButtons = gamepadInfo.buttons;
        }
        // keyButtonNames = gamepadInfo.names;
        // TODO: callback to update all buttons on the UI
    }
 
    this->isScrolling = false;
 
#ifdef PC
    this->allowTouch = false;
    if (event.type == SDL_MOUSEWHEEL) {
        this->wheelScroll = event.wheel.y;
        this->isScrolling = true;
    }
#endif
 
    if (this->type == SDL_QUIT)
    {
        if (this->quitaction != NULL) this->quitaction();
        return false; //Quitting overrides all other events.
    }
    else if (event.key.repeat == 0 && (this->type == SDL_KEYDOWN || this->type == SDL_KEYUP))
    {
        this->keyCode = event.key.keysym.sym;
        this->mod = event.key.keysym.mod;
    }
    else if (this->type == SDL_JOYBUTTONDOWN || this->type == SDL_JOYBUTTONUP)
    {
        this->keyCode = event.jbutton.button;
    }
    else if (this->type == SDL_MOUSEMOTION || this->type == SDL_MOUSEBUTTONUP || this->type == SDL_MOUSEBUTTONDOWN)
    {
        bool isMotion = this->type == SDL_MOUSEMOTION;
 
        this->yPos = isMotion ? event.motion.y : event.button.y;
        this->xPos = isMotion ? event.motion.x : event.button.x;
    }
    else if (allowTouch && (this->type == SDL_FINGERMOTION || this->type == SDL_FINGERUP || this->type == SDL_FINGERDOWN))
    {
        this->yPos = event.tfinger.y * SCREEN_HEIGHT;
        this->xPos = event.tfinger.x * SCREEN_WIDTH;
    }
 
    if (this->type == SDL_WINDOWEVENT && event.window.event == SDL_WINDOWEVENT_RESIZED) {
        printf("Window resized to %dx%d\n", event.window.data1, event.window.data2);
        RootDisplay::mainDisplay->setScreenResolution(
            event.window.data1 * RootDisplay::dpiScale,
            event.window.data2 * RootDisplay::dpiScale
        );
 
        // callback to alert the app that the window changed resolution
        if (RootDisplay::mainDisplay->windowResizeCallback)
            RootDisplay::mainDisplay->windowResizeCallback();
 
        RootDisplay::mainDisplay->needsRedraw = true;
    }
 
    // offset the x, y positions by the dpi scale
    this->xPos = (int)(this->xPos * RootDisplay::dpiScale);
    this->yPos = (int)(this->yPos * RootDisplay::dpiScale);
 
    toggleHeldButtons();
 
    return true;
}

References Element::needsRedraw, and processJoystickHotplugging().

released()

bool InputEvents::released

(

int

buttons

)

Definition at line 298 of file InputEvents.cpp.

{
    return isKeyUp() && held(buttons);
}

toggleHeldButtons()

void InputEvents::toggleHeldButtons

(

)

Definition at line 184 of file InputEvents.cpp.

{
    int directionCode = directionForKeycode();
 
    if (directionCode >= 0)
    {
        if (isKeyDown())
        {
            // make sure it's not already down
            if (!held_directions[directionCode])
            {
                // on key down, set the corresponding held boolean to true
                held_directions[directionCode] = true;
                held_type = this->type;
 
                // reset the frame counter so we don't fire on this frame
                // (initial reset is lower to add a slight delay when they first start holding)
                curFrame = -25;
            }
        }
 
        if (isKeyUp())
        {
            // release the corresponding key too
            held_directions[directionCode] = false;
        }
    }
}

touchIn()

bool InputEvents::touchIn	(	int	x,
		int	width,
		int	y,
		int	height
	)

whether or not a touch is detected within the specified rect in this cycle

Definition at line 303 of file InputEvents.cpp.

{
    return (this->xPos >= x && this->xPos <= x + width && this->yPos >= y && this->yPos <= y + height);
}

Referenced by EKeyboard::process(), and Element::process().

update()

bool InputEvents::update

(

)

Definition at line 174 of file InputEvents.cpp.

{
    this->type = 0;
    this->keyCode = -1;
    this->noop = true;
 
    // process SDL or directional events
    return processSDLEvents() || processDirectionalButtons();
}

Member Data Documentation

allowTouch

bool InputEvents::allowTouch = true

Definition at line 96 of file InputEvents.hpp.

bypassKeyEvents

bool InputEvents::bypassKeyEvents = false

static

Definition at line 127 of file InputEvents.hpp.

curFrame

int InputEvents::curFrame = 0

Definition at line 125 of file InputEvents.hpp.

event

SDL_Event InputEvents::event

Definition at line 119 of file InputEvents.hpp.

held_directions

bool InputEvents::held_directions[4] = { false, false, false, false }

Definition at line 121 of file InputEvents.hpp.

held_type

Uint32 InputEvents::held_type

Definition at line 122 of file InputEvents.hpp.

isScrolling

bool InputEvents::isScrolling = false

Definition at line 97 of file InputEvents.hpp.

keyCode

CST_Keycode InputEvents::keyCode = -1

Definition at line 117 of file InputEvents.hpp.

lastGamepadKey

std::string InputEvents::lastGamepadKey = defaultKeyName

static

Definition at line 129 of file InputEvents.hpp.

mod

CST_Keymod InputEvents::mod = -1

Definition at line 118 of file InputEvents.hpp.

noop

bool InputEvents::noop = false

Definition at line 137 of file InputEvents.hpp.

quitaction

std::function<void()> InputEvents::quitaction = NULL

Definition at line 131 of file InputEvents.hpp.

rapidFireRate

int InputEvents::rapidFireRate = 12

Definition at line 124 of file InputEvents.hpp.

type

Uint32 InputEvents::type

Definition at line 139 of file InputEvents.hpp.

wheelScroll

float InputEvents::wheelScroll = 0

Definition at line 133 of file InputEvents.hpp.

xPos

int InputEvents::xPos = 0

Definition at line 136 of file InputEvents.hpp.

yPos

int InputEvents::yPos = 0

Definition at line 135 of file InputEvents.hpp.

---

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

• src/InputEvents.hpp
• src/InputEvents.cpp