godotengine
/
godot
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Augment the `InputEvent` class with a `CANCELED` state 

The `InputEvent` class currently supports the `pressed` and `released` states, which given the binary nature, is represented by a `bool` field.
This commit introduced the `CANCELED` state, which signals that an ongoing input event has been canceled.
To represent all the states, the `InputEventState` enum is added and the `InputEvent` logic is refactored accordingly.
This commit is contained in:
Fredia Huya-Kouadio 2023-05-03 17:57:13 -07:00
parent cf8ad12b56
commit 250749fa79
8 changed files with 83 additions and 76 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
core/input/input.cpp
View File

@ -542,6 +542,7 @@ void Input::_parse_input_event_impl(const Ref<InputEvent> &p_event, bool p_is_em
Ref<InputEventScreenTouch> touch_event; Ref<InputEventScreenTouch> touch_event;
touch_event.instantiate(); touch_event.instantiate();
touch_event->set_pressed(mb->is_pressed()); touch_event->set_pressed(mb->is_pressed());
touch_event->set_canceled(mb->is_canceled());
touch_event->set_position(mb->get_position()); touch_event->set_position(mb->get_position());
touch_event->set_double_tap(mb->is_double_click()); touch_event->set_double_tap(mb->is_double_click());
touch_event->set_device(InputEvent::DEVICE_ID_EMULATION); touch_event->set_device(InputEvent::DEVICE_ID_EMULATION);
@ -613,6 +614,7 @@ void Input::_parse_input_event_impl(const Ref<InputEvent> &p_event, bool p_is_em
button_event->set_position(st->get_position()); button_event->set_position(st->get_position());
button_event->set_global_position(st->get_position()); button_event->set_global_position(st->get_position());
button_event->set_pressed(st->is_pressed()); button_event->set_pressed(st->is_pressed());
button_event->set_canceled(st->is_canceled());
button_event->set_button_index(MouseButton::LEFT); button_event->set_button_index(MouseButton::LEFT);
button_event->set_double_click(st->is_double_tap()); button_event->set_double_click(st->is_double_tap());

89
core/input/input_event.cpp
View File

@ -52,15 +52,15 @@ bool InputEvent::is_action(const StringName &p_action, bool p_exact_match) const
} }
bool InputEvent::is_action_pressed(const StringName &p_action, bool p_allow_echo, bool p_exact_match) const { bool InputEvent::is_action_pressed(const StringName &p_action, bool p_allow_echo, bool p_exact_match) const {
bool pressed; bool pressed_state;
bool valid = InputMap::get_singleton()->event_get_action_status(Ref<InputEvent>(const_cast<InputEvent *>(this)), p_action, p_exact_match, &pressed, nullptr, nullptr); bool valid = InputMap::get_singleton()->event_get_action_status(Ref<InputEvent>(const_cast<InputEvent *>(this)), p_action, p_exact_match, &pressed_state, nullptr, nullptr);
return valid && pressed && (p_allow_echo || !is_echo()); return valid && pressed_state && (p_allow_echo || !is_echo());
} }
bool InputEvent::is_action_released(const StringName &p_action, bool p_exact_match) const { bool InputEvent::is_action_released(const StringName &p_action, bool p_exact_match) const {
bool pressed; bool pressed_state;
bool valid = InputMap::get_singleton()->event_get_action_status(Ref<InputEvent>(const_cast<InputEvent *>(this)), p_action, p_exact_match, &pressed, nullptr, nullptr); bool valid = InputMap::get_singleton()->event_get_action_status(Ref<InputEvent>(const_cast<InputEvent *>(this)), p_action, p_exact_match, &pressed_state, nullptr, nullptr);
return valid && !pressed; return valid && !pressed_state;
} }
float InputEvent::get_action_strength(const StringName &p_action, bool p_exact_match) const { float InputEvent::get_action_strength(const StringName &p_action, bool p_exact_match) const {
@ -75,8 +75,16 @@ float InputEvent::get_action_raw_strength(const StringName &p_action, bool p_exa
return valid ? raw_strength : 0.0f; return valid ? raw_strength : 0.0f;
} }
bool InputEvent::is_canceled() const {
return canceled;
}
bool InputEvent::is_pressed() const { bool InputEvent::is_pressed() const {
return false; return pressed && !canceled;
}
bool InputEvent::is_released() const {
return !pressed && !canceled;
} }
bool InputEvent::is_echo() const { bool InputEvent::is_echo() const {
@ -108,7 +116,9 @@ void InputEvent::_bind_methods() {
ClassDB::bind_method(D_METHOD("is_action_released", "action", "exact_match"), &InputEvent::is_action_released, DEFVAL(false)); ClassDB::bind_method(D_METHOD("is_action_released", "action", "exact_match"), &InputEvent::is_action_released, DEFVAL(false));
ClassDB::bind_method(D_METHOD("get_action_strength", "action", "exact_match"), &InputEvent::get_action_strength, DEFVAL(false)); ClassDB::bind_method(D_METHOD("get_action_strength", "action", "exact_match"), &InputEvent::get_action_strength, DEFVAL(false));
ClassDB::bind_method(D_METHOD("is_canceled"), &InputEvent::is_canceled);
ClassDB::bind_method(D_METHOD("is_pressed"), &InputEvent::is_pressed); ClassDB::bind_method(D_METHOD("is_pressed"), &InputEvent::is_pressed);
ClassDB::bind_method(D_METHOD("is_released"), &InputEvent::is_released);
ClassDB::bind_method(D_METHOD("is_echo"), &InputEvent::is_echo); ClassDB::bind_method(D_METHOD("is_echo"), &InputEvent::is_echo);
ClassDB::bind_method(D_METHOD("as_text"), &InputEvent::as_text); ClassDB::bind_method(D_METHOD("as_text"), &InputEvent::as_text);
@ -318,10 +328,6 @@ void InputEventKey::set_pressed(bool p_pressed) {
emit_changed(); emit_changed();
} }
bool InputEventKey::is_pressed() const {
return pressed;
}
void InputEventKey::set_keycode(Key p_keycode) { void InputEventKey::set_keycode(Key p_keycode) {
keycode = p_keycode; keycode = p_keycode;
emit_changed(); emit_changed();
@ -668,8 +674,8 @@ void InputEventMouseButton::set_pressed(bool p_pressed) {
pressed = p_pressed; pressed = p_pressed;
} }
bool InputEventMouseButton::is_pressed() const { void InputEventMouseButton::set_canceled(bool p_canceled) {
return pressed; canceled = p_canceled;
} }
void InputEventMouseButton::set_double_click(bool p_double_click) { void InputEventMouseButton::set_double_click(bool p_double_click) {
@ -696,6 +702,7 @@ Ref<InputEvent> InputEventMouseButton::xformed_by(const Transform2D &p_xform, co
mb->set_button_mask(get_button_mask()); mb->set_button_mask(get_button_mask());
mb->set_pressed(pressed); mb->set_pressed(pressed);
mb->set_canceled(canceled);
mb->set_double_click(double_click); mb->set_double_click(double_click);
mb->set_factor(factor); mb->set_factor(factor);
mb->set_button_index(button_index); mb->set_button_index(button_index);
@ -791,6 +798,7 @@ String InputEventMouseButton::as_text() const {
String InputEventMouseButton::to_string() { String InputEventMouseButton::to_string() {
String p = is_pressed() ? "true" : "false"; String p = is_pressed() ? "true" : "false";
String canceled_state = is_canceled() ? "true" : "false";
String d = double_click ? "true" : "false"; String d = double_click ? "true" : "false";
MouseButton idx = get_button_index(); MouseButton idx = get_button_index();
@ -817,7 +825,7 @@ String InputEventMouseButton::to_string() {
// Work around the fact vformat can only take 5 substitutions but 6 need to be passed. // Work around the fact vformat can only take 5 substitutions but 6 need to be passed.
String index_and_mods = vformat("button_index=%s, mods=%s", button_index, mods); String index_and_mods = vformat("button_index=%s, mods=%s", button_index, mods);
return vformat("InputEventMouseButton: %s, pressed=%s, position=(%s), button_mask=%d, double_click=%s", index_and_mods, p, String(get_position()), get_button_mask(), d); return vformat("InputEventMouseButton: %s, pressed=%s, canceled=%s, position=(%s), button_mask=%d, double_click=%s", index_and_mods, p, canceled_state, String(get_position()), get_button_mask(), d);
} }
void InputEventMouseButton::_bind_methods() { void InputEventMouseButton::_bind_methods() {
@ -828,13 +836,14 @@ void InputEventMouseButton::_bind_methods() {
ClassDB::bind_method(D_METHOD("get_button_index"), &InputEventMouseButton::get_button_index); ClassDB::bind_method(D_METHOD("get_button_index"), &InputEventMouseButton::get_button_index);
ClassDB::bind_method(D_METHOD("set_pressed", "pressed"), &InputEventMouseButton::set_pressed); ClassDB::bind_method(D_METHOD("set_pressed", "pressed"), &InputEventMouseButton::set_pressed);
// ClassDB::bind_method(D_METHOD("is_pressed"), &InputEventMouseButton::is_pressed); ClassDB::bind_method(D_METHOD("set_canceled", "canceled"), &InputEventMouseButton::set_canceled);
ClassDB::bind_method(D_METHOD("set_double_click", "double_click"), &InputEventMouseButton::set_double_click); ClassDB::bind_method(D_METHOD("set_double_click", "double_click"), &InputEventMouseButton::set_double_click);
ClassDB::bind_method(D_METHOD("is_double_click"), &InputEventMouseButton::is_double_click); ClassDB::bind_method(D_METHOD("is_double_click"), &InputEventMouseButton::is_double_click);
ADD_PROPERTY(PropertyInfo(Variant::FLOAT, "factor"), "set_factor", "get_factor"); ADD_PROPERTY(PropertyInfo(Variant::FLOAT, "factor"), "set_factor", "get_factor");
ADD_PROPERTY(PropertyInfo(Variant::INT, "button_index"), "set_button_index", "get_button_index"); ADD_PROPERTY(PropertyInfo(Variant::INT, "button_index"), "set_button_index", "get_button_index");
ADD_PROPERTY(PropertyInfo(Variant::BOOL, "canceled"), "set_canceled", "is_canceled");
ADD_PROPERTY(PropertyInfo(Variant::BOOL, "pressed"), "set_pressed", "is_pressed"); ADD_PROPERTY(PropertyInfo(Variant::BOOL, "pressed"), "set_pressed", "is_pressed");
ADD_PROPERTY(PropertyInfo(Variant::BOOL, "double_click"), "set_double_click", "is_double_click"); ADD_PROPERTY(PropertyInfo(Variant::BOOL, "double_click"), "set_double_click", "is_double_click");
} }
@ -942,6 +951,10 @@ bool InputEventMouseMotion::accumulate(const Ref<InputEvent> &p_event) {
return false; return false;
} }
if (is_canceled() != motion->is_canceled()) {
return false;
}
if (is_pressed() != motion->is_pressed()) { if (is_pressed() != motion->is_pressed()) {
return false; return false;
} }
@ -1012,6 +1025,7 @@ JoyAxis InputEventJoypadMotion::get_axis() const {
void InputEventJoypadMotion::set_axis_value(float p_value) { void InputEventJoypadMotion::set_axis_value(float p_value) {
axis_value = p_value; axis_value = p_value;
pressed = Math::abs(axis_value) >= 0.5f;
emit_changed(); emit_changed();
} }
@ -1019,10 +1033,6 @@ float InputEventJoypadMotion::get_axis_value() const {
return axis_value; return axis_value;
} }
bool InputEventJoypadMotion::is_pressed() const {
return Math::abs(axis_value) >= 0.5f;
}
bool InputEventJoypadMotion::action_match(const Ref<InputEvent> &p_event, bool p_exact_match, float p_deadzone, bool *r_pressed, float *r_strength, float *r_raw_strength) const { bool InputEventJoypadMotion::action_match(const Ref<InputEvent> &p_event, bool p_exact_match, float p_deadzone, bool *r_pressed, float *r_strength, float *r_raw_strength) const {
Ref<InputEventJoypadMotion> jm = p_event; Ref<InputEventJoypadMotion> jm = p_event;
if (jm.is_null()) { if (jm.is_null()) {
@ -1037,12 +1047,12 @@ bool InputEventJoypadMotion::action_match(const Ref<InputEvent> &p_event, bool p
if (match) { if (match) {
float jm_abs_axis_value = Math::abs(jm->get_axis_value()); float jm_abs_axis_value = Math::abs(jm->get_axis_value());
bool same_direction = (((axis_value < 0) == (jm->axis_value < 0)) || jm->axis_value == 0); bool same_direction = (((axis_value < 0) == (jm->axis_value < 0)) || jm->axis_value == 0);
bool pressed = same_direction && jm_abs_axis_value >= p_deadzone; bool pressed_state = same_direction && jm_abs_axis_value >= p_deadzone;
if (r_pressed != nullptr) { if (r_pressed != nullptr) {
*r_pressed = pressed; *r_pressed = pressed_state;
} }
if (r_strength != nullptr) { if (r_strength != nullptr) {
if (pressed) { if (pressed_state) {
if (p_deadzone == 1.0f) { if (p_deadzone == 1.0f) {
*r_strength = 1.0f; *r_strength = 1.0f;
} else { } else {
@ -1122,10 +1132,6 @@ void InputEventJoypadButton::set_pressed(bool p_pressed) {
pressed = p_pressed; pressed = p_pressed;
} }
bool InputEventJoypadButton::is_pressed() const {
return pressed;
}
void InputEventJoypadButton::set_pressure(float p_pressure) { void InputEventJoypadButton::set_pressure(float p_pressure) {
pressure = p_pressure; pressure = p_pressure;
} }
@ -1206,7 +1212,7 @@ String InputEventJoypadButton::as_text() const {
} }
String InputEventJoypadButton::to_string() { String InputEventJoypadButton::to_string() {
String p = pressed ? "true" : "false"; String p = is_pressed() ? "true" : "false";
return vformat("InputEventJoypadButton: button_index=%d, pressed=%s, pressure=%.2f", button_index, p, pressure); return vformat("InputEventJoypadButton: button_index=%d, pressed=%s, pressure=%.2f", button_index, p, pressure);
} }
@ -1226,7 +1232,6 @@ void InputEventJoypadButton::_bind_methods() {
ClassDB::bind_method(D_METHOD("get_pressure"), &InputEventJoypadButton::get_pressure); ClassDB::bind_method(D_METHOD("get_pressure"), &InputEventJoypadButton::get_pressure);
ClassDB::bind_method(D_METHOD("set_pressed", "pressed"), &InputEventJoypadButton::set_pressed); ClassDB::bind_method(D_METHOD("set_pressed", "pressed"), &InputEventJoypadButton::set_pressed);
// ClassDB::bind_method(D_METHOD("is_pressed"), &InputEventJoypadButton::is_pressed);
ADD_PROPERTY(PropertyInfo(Variant::INT, "button_index"), "set_button_index", "get_button_index"); ADD_PROPERTY(PropertyInfo(Variant::INT, "button_index"), "set_button_index", "get_button_index");
ADD_PROPERTY(PropertyInfo(Variant::FLOAT, "pressure"), "set_pressure", "get_pressure"); ADD_PROPERTY(PropertyInfo(Variant::FLOAT, "pressure"), "set_pressure", "get_pressure");
@ -1255,8 +1260,8 @@ void InputEventScreenTouch::set_pressed(bool p_pressed) {
pressed = p_pressed; pressed = p_pressed;
} }
bool InputEventScreenTouch::is_pressed() const { void InputEventScreenTouch::set_canceled(bool p_canceled) {
return pressed; canceled = p_canceled;
} }
void InputEventScreenTouch::set_double_tap(bool p_double_tap) { void InputEventScreenTouch::set_double_tap(bool p_double_tap) {
@ -1274,21 +1279,23 @@ Ref<InputEvent> InputEventScreenTouch::xformed_by(const Transform2D &p_xform, co
st->set_index(index); st->set_index(index);
st->set_position(p_xform.xform(pos + p_local_ofs)); st->set_position(p_xform.xform(pos + p_local_ofs));
st->set_pressed(pressed); st->set_pressed(pressed);
st->set_canceled(canceled);
st->set_double_tap(double_tap); st->set_double_tap(double_tap);
return st; return st;
} }
String InputEventScreenTouch::as_text() const { String InputEventScreenTouch::as_text() const {
String status = pressed ? RTR("touched") : RTR("released"); String status = canceled ? RTR("canceled") : (pressed ? RTR("touched") : RTR("released"));
return vformat(RTR("Screen %s at (%s) with %s touch points"), status, String(get_position()), itos(index)); return vformat(RTR("Screen %s at (%s) with %s touch points"), status, String(get_position()), itos(index));
} }
String InputEventScreenTouch::to_string() { String InputEventScreenTouch::to_string() {
String p = pressed ? "true" : "false"; String p = pressed ? "true" : "false";
String canceled_state = canceled ? "true" : "false";
String double_tap_string = double_tap ? "true" : "false"; String double_tap_string = double_tap ? "true" : "false";
return vformat("InputEventScreenTouch: index=%d, pressed=%s, position=(%s), double_tap=%s", index, p, String(get_position()), double_tap_string); return vformat("InputEventScreenTouch: index=%d, pressed=%s, canceled=%s, position=(%s), double_tap=%s", index, p, canceled_state, String(get_position()), double_tap_string);
} }
void InputEventScreenTouch::_bind_methods() { void InputEventScreenTouch::_bind_methods() {
@ -1299,13 +1306,14 @@ void InputEventScreenTouch::_bind_methods() {
ClassDB::bind_method(D_METHOD("get_position"), &InputEventScreenTouch::get_position); ClassDB::bind_method(D_METHOD("get_position"), &InputEventScreenTouch::get_position);
ClassDB::bind_method(D_METHOD("set_pressed", "pressed"), &InputEventScreenTouch::set_pressed); ClassDB::bind_method(D_METHOD("set_pressed", "pressed"), &InputEventScreenTouch::set_pressed);
//ClassDB::bind_method(D_METHOD("is_pressed"),&InputEventScreenTouch::is_pressed); ClassDB::bind_method(D_METHOD("set_canceled", "canceled"), &InputEventScreenTouch::set_canceled);
ClassDB::bind_method(D_METHOD("set_double_tap", "double_tap"), &InputEventScreenTouch::set_double_tap); ClassDB::bind_method(D_METHOD("set_double_tap", "double_tap"), &InputEventScreenTouch::set_double_tap);
ClassDB::bind_method(D_METHOD("is_double_tap"), &InputEventScreenTouch::is_double_tap); ClassDB::bind_method(D_METHOD("is_double_tap"), &InputEventScreenTouch::is_double_tap);
ADD_PROPERTY(PropertyInfo(Variant::INT, "index"), "set_index", "get_index"); ADD_PROPERTY(PropertyInfo(Variant::INT, "index"), "set_index", "get_index");
ADD_PROPERTY(PropertyInfo(Variant::VECTOR2, "position", PROPERTY_HINT_NONE, "suffix:px"), "set_position", "get_position"); ADD_PROPERTY(PropertyInfo(Variant::VECTOR2, "position", PROPERTY_HINT_NONE, "suffix:px"), "set_position", "get_position");
ADD_PROPERTY(PropertyInfo(Variant::BOOL, "canceled"), "set_canceled", "is_canceled");
ADD_PROPERTY(PropertyInfo(Variant::BOOL, "pressed"), "set_pressed", "is_pressed"); ADD_PROPERTY(PropertyInfo(Variant::BOOL, "pressed"), "set_pressed", "is_pressed");
ADD_PROPERTY(PropertyInfo(Variant::BOOL, "double_tap"), "set_double_tap", "is_double_tap"); ADD_PROPERTY(PropertyInfo(Variant::BOOL, "double_tap"), "set_double_tap", "is_double_tap");
} }
@ -1457,10 +1465,6 @@ void InputEventAction::set_pressed(bool p_pressed) {
pressed = p_pressed; pressed = p_pressed;
} }
bool InputEventAction::is_pressed() const {
return pressed;
}
void InputEventAction::set_strength(float p_strength) { void InputEventAction::set_strength(float p_strength) {
strength = CLAMP(p_strength, 0.0f, 1.0f); strength = CLAMP(p_strength, 0.0f, 1.0f);
} }
@ -1489,7 +1493,7 @@ bool InputEventAction::action_match(const Ref<InputEvent> &p_event, bool p_exact
bool match = action == act->action; bool match = action == act->action;
if (match) { if (match) {
bool act_pressed = act->pressed; bool act_pressed = act->is_pressed();
if (r_pressed != nullptr) { if (r_pressed != nullptr) {
*r_pressed = act_pressed; *r_pressed = act_pressed;
} }
@ -1520,7 +1524,7 @@ String InputEventAction::as_text() const {
} }
String InputEventAction::to_string() { String InputEventAction::to_string() {
String p = pressed ? "true" : "false"; String p = is_pressed() ? "true" : "false";
return vformat("InputEventAction: action=\"%s\", pressed=%s", action, p); return vformat("InputEventAction: action=\"%s\", pressed=%s", action, p);
} }
@ -1529,13 +1533,10 @@ void InputEventAction::_bind_methods() {
ClassDB::bind_method(D_METHOD("get_action"), &InputEventAction::get_action); ClassDB::bind_method(D_METHOD("get_action"), &InputEventAction::get_action);
ClassDB::bind_method(D_METHOD("set_pressed", "pressed"), &InputEventAction::set_pressed); ClassDB::bind_method(D_METHOD("set_pressed", "pressed"), &InputEventAction::set_pressed);
//ClassDB::bind_method(D_METHOD("is_pressed"), &InputEventAction::is_pressed);
ClassDB::bind_method(D_METHOD("set_strength", "strength"), &InputEventAction::set_strength); ClassDB::bind_method(D_METHOD("set_strength", "strength"), &InputEventAction::set_strength);
ClassDB::bind_method(D_METHOD("get_strength"), &InputEventAction::get_strength); ClassDB::bind_method(D_METHOD("get_strength"), &InputEventAction::get_strength);
// ClassDB::bind_method(D_METHOD("is_action", "name"), &InputEventAction::is_action);
ADD_PROPERTY(PropertyInfo(Variant::STRING_NAME, "action"), "set_action", "get_action"); ADD_PROPERTY(PropertyInfo(Variant::STRING_NAME, "action"), "set_action", "get_action");
ADD_PROPERTY(PropertyInfo(Variant::BOOL, "pressed"), "set_pressed", "is_pressed"); ADD_PROPERTY(PropertyInfo(Variant::BOOL, "pressed"), "set_pressed", "is_pressed");
ADD_PROPERTY(PropertyInfo(Variant::FLOAT, "strength", PROPERTY_HINT_RANGE, "0,1,0.01"), "set_strength", "get_strength"); ADD_PROPERTY(PropertyInfo(Variant::FLOAT, "strength", PROPERTY_HINT_RANGE, "0,1,0.01"), "set_strength", "get_strength");
@ -1758,10 +1759,6 @@ void InputEventShortcut::_bind_methods() {
ADD_PROPERTY(PropertyInfo(Variant::OBJECT, "shortcut", PROPERTY_HINT_RESOURCE_TYPE, "Shortcut"), "set_shortcut", "get_shortcut"); ADD_PROPERTY(PropertyInfo(Variant::OBJECT, "shortcut", PROPERTY_HINT_RESOURCE_TYPE, "Shortcut"), "set_shortcut", "get_shortcut");
} }
bool InputEventShortcut::is_pressed() const {
return true;
}
String InputEventShortcut::as_text() const { String InputEventShortcut::as_text() const {
ERR_FAIL_COND_V(shortcut.is_null(), "None"); ERR_FAIL_COND_V(shortcut.is_null(), "None");

24
core/input/input_event.h
View File

@ -56,6 +56,9 @@ class InputEvent : public Resource {
int device = 0; int device = 0;
protected: protected:
bool canceled = false;
bool pressed = false;
static void _bind_methods(); static void _bind_methods();
public: public:
@ -71,8 +74,9 @@ public:
float get_action_strength(const StringName &p_action, bool p_exact_match = false) const; float get_action_strength(const StringName &p_action, bool p_exact_match = false) const;
float get_action_raw_strength(const StringName &p_action, bool p_exact_match = false) const; float get_action_raw_strength(const StringName &p_action, bool p_exact_match = false) const;
// To be removed someday, since they do not make sense for all events bool is_canceled() const;
virtual bool is_pressed() const; bool is_pressed() const;
bool is_released() const;
virtual bool is_echo() const; virtual bool is_echo() const;
virtual String as_text() const = 0; virtual String as_text() const = 0;
@ -149,8 +153,6 @@ public:
class InputEventKey : public InputEventWithModifiers { class InputEventKey : public InputEventWithModifiers {
GDCLASS(InputEventKey, InputEventWithModifiers); GDCLASS(InputEventKey, InputEventWithModifiers);
bool pressed = false; /// otherwise release
Key keycode = Key::NONE; // Key enum, without modifier masks. Key keycode = Key::NONE; // Key enum, without modifier masks.
Key physical_keycode = Key::NONE; Key physical_keycode = Key::NONE;
Key key_label = Key::NONE; Key key_label = Key::NONE;
@ -163,7 +165,6 @@ protected:
public: public:
void set_pressed(bool p_pressed); void set_pressed(bool p_pressed);
virtual bool is_pressed() const override;
void set_keycode(Key p_keycode); void set_keycode(Key p_keycode);
Key get_keycode() const; Key get_keycode() const;
@ -229,7 +230,6 @@ class InputEventMouseButton : public InputEventMouse {
float factor = 1; float factor = 1;
MouseButton button_index = MouseButton::NONE; MouseButton button_index = MouseButton::NONE;
bool pressed = false; //otherwise released
bool double_click = false; //last even less than double click time bool double_click = false; //last even less than double click time
protected: protected:
@ -243,7 +243,7 @@ public:
MouseButton get_button_index() const; MouseButton get_button_index() const;
void set_pressed(bool p_pressed); void set_pressed(bool p_pressed);
virtual bool is_pressed() const override; void set_canceled(bool p_canceled);
void set_double_click(bool p_double_click); void set_double_click(bool p_double_click);
bool is_double_click() const; bool is_double_click() const;
@ -312,8 +312,6 @@ public:
void set_axis_value(float p_value); void set_axis_value(float p_value);
float get_axis_value() const; float get_axis_value() const;
virtual bool is_pressed() const override;
virtual bool action_match(const Ref<InputEvent> &p_event, bool p_exact_match, float p_deadzone, bool *r_pressed, float *r_strength, float *r_raw_strength) const override; virtual bool action_match(const Ref<InputEvent> &p_event, bool p_exact_match, float p_deadzone, bool *r_pressed, float *r_strength, float *r_raw_strength) const override;
virtual bool is_match(const Ref<InputEvent> &p_event, bool p_exact_match = true) const override; virtual bool is_match(const Ref<InputEvent> &p_event, bool p_exact_match = true) const override;
@ -328,7 +326,6 @@ class InputEventJoypadButton : public InputEvent {
GDCLASS(InputEventJoypadButton, InputEvent); GDCLASS(InputEventJoypadButton, InputEvent);
JoyButton button_index = (JoyButton)0; JoyButton button_index = (JoyButton)0;
bool pressed = false;
float pressure = 0; //0 to 1 float pressure = 0; //0 to 1
protected: protected:
static void _bind_methods(); static void _bind_methods();
@ -338,7 +335,6 @@ public:
JoyButton get_button_index() const; JoyButton get_button_index() const;
void set_pressed(bool p_pressed); void set_pressed(bool p_pressed);
virtual bool is_pressed() const override;
void set_pressure(float p_pressure); void set_pressure(float p_pressure);
float get_pressure() const; float get_pressure() const;
@ -360,7 +356,6 @@ class InputEventScreenTouch : public InputEventFromWindow {
GDCLASS(InputEventScreenTouch, InputEventFromWindow); GDCLASS(InputEventScreenTouch, InputEventFromWindow);
int index = 0; int index = 0;
Vector2 pos; Vector2 pos;
bool pressed = false;
bool double_tap = false; bool double_tap = false;
protected: protected:
@ -374,7 +369,7 @@ public:
Vector2 get_position() const; Vector2 get_position() const;
void set_pressed(bool p_pressed); void set_pressed(bool p_pressed);
virtual bool is_pressed() const override; void set_canceled(bool p_canceled);
void set_double_tap(bool p_double_tap); void set_double_tap(bool p_double_tap);
bool is_double_tap() const; bool is_double_tap() const;
@ -434,7 +429,6 @@ class InputEventAction : public InputEvent {
GDCLASS(InputEventAction, InputEvent); GDCLASS(InputEventAction, InputEvent);
StringName action; StringName action;
bool pressed = false;
float strength = 1.0f; float strength = 1.0f;
protected: protected:
@ -445,7 +439,6 @@ public:
StringName get_action() const; StringName get_action() const;
void set_pressed(bool p_pressed); void set_pressed(bool p_pressed);
virtual bool is_pressed() const override;
void set_strength(float p_strength); void set_strength(float p_strength);
float get_strength() const; float get_strength() const;
@ -569,7 +562,6 @@ protected:
public: public:
void set_shortcut(Ref<Shortcut> p_shortcut); void set_shortcut(Ref<Shortcut> p_shortcut);
Ref<Shortcut> get_shortcut(); Ref<Shortcut> get_shortcut();
virtual bool is_pressed() const override;
virtual String as_text() const override; virtual String as_text() const override;
virtual String to_string() override; virtual String to_string() override;

12
doc/classes/InputEvent.xml
View File

@ -71,6 +71,12 @@
Returns [code]true[/code] if this input event's type is one that can be assigned to an input action. Returns [code]true[/code] if this input event's type is one that can be assigned to an input action.
</description> </description>
</method> </method>
<method name="is_canceled" qualifiers="const">
<return type="bool" />
<description>
Returns [code]true[/code] if this input event has been canceled.
</description>
</method>
<method name="is_echo" qualifiers="const"> <method name="is_echo" qualifiers="const">
<return type="bool" /> <return type="bool" />
<description> <description>
@ -93,6 +99,12 @@
[b]Note:[/b] Due to keyboard ghosting, [method is_pressed] may return [code]false[/code] even if one of the action's keys is pressed. See [url=$DOCS_URL/tutorials/inputs/input_examples.html#keyboard-events]Input examples[/url] in the documentation for more information. [b]Note:[/b] Due to keyboard ghosting, [method is_pressed] may return [code]false[/code] even if one of the action's keys is pressed. See [url=$DOCS_URL/tutorials/inputs/input_examples.html#keyboard-events]Input examples[/url] in the documentation for more information.
</description> </description>
</method> </method>
<method name="is_released" qualifiers="const">
<return type="bool" />
<description>
Returns [code]true[/code] if this input event is released. Not relevant for events of type [InputEventMouseMotion] or [InputEventScreenDrag].
</description>
</method>
<method name="xformed_by" qualifiers="const"> <method name="xformed_by" qualifiers="const">
<return type="InputEvent" /> <return type="InputEvent" />
<param index="0" name="xform" type="Transform2D" /> <param index="0" name="xform" type="Transform2D" />

3
doc/classes/InputEventMouseButton.xml
View File

@ -13,6 +13,9 @@
<member name="button_index" type="int" setter="set_button_index" getter="get_button_index" enum="MouseButton" default="0"> <member name="button_index" type="int" setter="set_button_index" getter="get_button_index" enum="MouseButton" default="0">
The mouse button identifier, one of the [enum MouseButton] button or button wheel constants. The mouse button identifier, one of the [enum MouseButton] button or button wheel constants.
</member> </member>
<member name="canceled" type="bool" setter="set_canceled" getter="is_canceled" default="false">
If [code]true[/code], the mouse button event has been canceled.
</member>
<member name="double_click" type="bool" setter="set_double_click" getter="is_double_click" default="false"> <member name="double_click" type="bool" setter="set_double_click" getter="is_double_click" default="false">
If [code]true[/code], the mouse button's state is a double-click. If [code]true[/code], the mouse button's state is a double-click.
</member> </member>

3
doc/classes/InputEventScreenTouch.xml
View File

@ -11,6 +11,9 @@
<link title="InputEvent">$DOCS_URL/tutorials/inputs/inputevent.html</link> <link title="InputEvent">$DOCS_URL/tutorials/inputs/inputevent.html</link>
</tutorials> </tutorials>
<members> <members>
<member name="canceled" type="bool" setter="set_canceled" getter="is_canceled" default="false">
If [code]true[/code], the touch event has been canceled.
</member>
<member name="double_tap" type="bool" setter="set_double_tap" getter="is_double_tap" default="false"> <member name="double_tap" type="bool" setter="set_double_tap" getter="is_double_tap" default="false">
If [code]true[/code], the touch's state is a double tap. If [code]true[/code], the touch's state is a double tap.
</member> </member>

22
platform/android/android_input_handler.cpp
View File

@ -138,22 +138,19 @@ void AndroidInputHandler::process_key_event(int p_physical_keycode, int p_unicod
} }
void AndroidInputHandler::_cancel_all_touch() { void AndroidInputHandler::_cancel_all_touch() {
_parse_all_touch(false, false, true); _parse_all_touch(false, true);
touch.clear(); touch.clear();
} }
void AndroidInputHandler::_parse_all_touch(bool p_pressed, bool p_double_tap, bool reset_index) { void AndroidInputHandler::_parse_all_touch(bool p_pressed, bool p_canceled, bool p_double_tap) {
if (touch.size()) { if (touch.size()) {
//end all if exist //end all if exist
for (int i = 0; i < touch.size(); i++) { for (int i = 0; i < touch.size(); i++) {
Ref<InputEventScreenTouch> ev; Ref<InputEventScreenTouch> ev;
ev.instantiate(); ev.instantiate();
if (reset_index) { ev->set_index(touch[i].id);
ev->set_index(-1);
} else {
ev->set_index(touch[i].id);
}
ev->set_pressed(p_pressed); ev->set_pressed(p_pressed);
ev->set_canceled(p_canceled);
ev->set_position(touch[i].pos); ev->set_position(touch[i].pos);
ev->set_double_tap(p_double_tap); ev->set_double_tap(p_double_tap);
Input::get_singleton()->parse_input_event(ev); Input::get_singleton()->parse_input_event(ev);
@ -180,7 +177,7 @@ void AndroidInputHandler::process_touch_event(int p_event, int p_pointer, const
} }
//send touch //send touch
_parse_all_touch(true, p_double_tap); _parse_all_touch(true, false, p_double_tap);
} break; } break;
case AMOTION_EVENT_ACTION_MOVE: { //motion case AMOTION_EVENT_ACTION_MOVE: { //motion
@ -257,11 +254,11 @@ void AndroidInputHandler::process_touch_event(int p_event, int p_pointer, const
void AndroidInputHandler::_cancel_mouse_event_info(bool p_source_mouse_relative) { void AndroidInputHandler::_cancel_mouse_event_info(bool p_source_mouse_relative) {
buttons_state = BitField<MouseButtonMask>(); buttons_state = BitField<MouseButtonMask>();
_parse_mouse_event_info(BitField<MouseButtonMask>(), false, false, p_source_mouse_relative); _parse_mouse_event_info(BitField<MouseButtonMask>(), false, true, false, p_source_mouse_relative);
mouse_event_info.valid = false; mouse_event_info.valid = false;
} }
void AndroidInputHandler::_parse_mouse_event_info(BitField<MouseButtonMask> event_buttons_mask, bool p_pressed, bool p_double_click, bool p_source_mouse_relative) { void AndroidInputHandler::_parse_mouse_event_info(BitField<MouseButtonMask> event_buttons_mask, bool p_pressed, bool p_canceled, bool p_double_click, bool p_source_mouse_relative) {
if (!mouse_event_info.valid) { if (!mouse_event_info.valid) {
return; return;
} }
@ -278,6 +275,7 @@ void AndroidInputHandler::_parse_mouse_event_info(BitField<MouseButtonMask> even
hover_prev_pos = mouse_event_info.pos; hover_prev_pos = mouse_event_info.pos;
} }
ev->set_pressed(p_pressed); ev->set_pressed(p_pressed);
ev->set_canceled(p_canceled);
BitField<MouseButtonMask> changed_button_mask = BitField<MouseButtonMask>(buttons_state.operator int64_t() ^ event_buttons_mask.operator int64_t()); BitField<MouseButtonMask> changed_button_mask = BitField<MouseButtonMask>(buttons_state.operator int64_t() ^ event_buttons_mask.operator int64_t());
buttons_state = event_buttons_mask; buttons_state = event_buttons_mask;
@ -289,7 +287,7 @@ void AndroidInputHandler::_parse_mouse_event_info(BitField<MouseButtonMask> even
} }
void AndroidInputHandler::_release_mouse_event_info(bool p_source_mouse_relative) { void AndroidInputHandler::_release_mouse_event_info(bool p_source_mouse_relative) {
_parse_mouse_event_info(BitField<MouseButtonMask>(), false, false, p_source_mouse_relative); _parse_mouse_event_info(BitField<MouseButtonMask>(), false, false, false, p_source_mouse_relative);
mouse_event_info.valid = false; mouse_event_info.valid = false;
} }
@ -318,7 +316,7 @@ void AndroidInputHandler::process_mouse_event(int p_event_action, int p_event_an
mouse_event_info.valid = true; mouse_event_info.valid = true;
mouse_event_info.pos = p_event_pos; mouse_event_info.pos = p_event_pos;
_parse_mouse_event_info(event_buttons_mask, true, p_double_click, p_source_mouse_relative); _parse_mouse_event_info(event_buttons_mask, true, false, p_double_click, p_source_mouse_relative);
} break; } break;
case AMOTION_EVENT_ACTION_CANCEL: { case AMOTION_EVENT_ACTION_CANCEL: {

4
platform/android/android_input_handler.h
View File

@ -83,13 +83,13 @@ private:
void _wheel_button_click(BitField<MouseButtonMask> event_buttons_mask, const Ref<InputEventMouseButton> &ev, MouseButton wheel_button, float factor); void _wheel_button_click(BitField<MouseButtonMask> event_buttons_mask, const Ref<InputEventMouseButton> &ev, MouseButton wheel_button, float factor);
void _parse_mouse_event_info(BitField<MouseButtonMask> event_buttons_mask, bool p_pressed, bool p_double_click, bool p_source_mouse_relative); void _parse_mouse_event_info(BitField<MouseButtonMask> event_buttons_mask, bool p_pressed, bool p_canceled, bool p_double_click, bool p_source_mouse_relative);
void _release_mouse_event_info(bool p_source_mouse_relative = false); void _release_mouse_event_info(bool p_source_mouse_relative = false);
void _cancel_mouse_event_info(bool p_source_mouse_relative = false); void _cancel_mouse_event_info(bool p_source_mouse_relative = false);
void _parse_all_touch(bool p_pressed, bool p_double_tap, bool reset_index = false); void _parse_all_touch(bool p_pressed, bool p_canceled = false, bool p_double_tap = false);
void _release_all_touch(); void _release_all_touch();