2023-01-05 13:25:55 +01:00
|
|
|
/**************************************************************************/
|
|
|
|
/* touch_screen_button.h */
|
|
|
|
/**************************************************************************/
|
|
|
|
/* This file is part of: */
|
|
|
|
/* GODOT ENGINE */
|
|
|
|
/* https://godotengine.org */
|
|
|
|
/**************************************************************************/
|
|
|
|
/* Copyright (c) 2014-present Godot Engine contributors (see AUTHORS.md). */
|
|
|
|
/* Copyright (c) 2007-2014 Juan Linietsky, Ariel Manzur. */
|
|
|
|
/* */
|
|
|
|
/* Permission is hereby granted, free of charge, to any person obtaining */
|
|
|
|
/* a copy of this software and associated documentation files (the */
|
|
|
|
/* "Software"), to deal in the Software without restriction, including */
|
|
|
|
/* without limitation the rights to use, copy, modify, merge, publish, */
|
|
|
|
/* distribute, sublicense, and/or sell copies of the Software, and to */
|
|
|
|
/* permit persons to whom the Software is furnished to do so, subject to */
|
|
|
|
/* the following conditions: */
|
|
|
|
/* */
|
|
|
|
/* The above copyright notice and this permission notice shall be */
|
|
|
|
/* included in all copies or substantial portions of the Software. */
|
|
|
|
/* */
|
|
|
|
/* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, */
|
|
|
|
/* EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF */
|
|
|
|
/* MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. */
|
|
|
|
/* IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY */
|
|
|
|
/* CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, */
|
|
|
|
/* TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE */
|
|
|
|
/* SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. */
|
|
|
|
/**************************************************************************/
|
2018-01-05 00:50:27 +01:00
|
|
|
|
2019-02-12 17:18:13 +01:00
|
|
|
#ifndef TOUCH_SCREEN_BUTTON_H
|
|
|
|
#define TOUCH_SCREEN_BUTTON_H
|
2014-02-10 02:10:30 +01:00
|
|
|
|
|
|
|
#include "scene/2d/node_2d.h"
|
2019-02-12 17:18:13 +01:00
|
|
|
#include "scene/resources/bit_map.h"
|
2017-01-25 17:06:06 +01:00
|
|
|
#include "scene/resources/rectangle_shape_2d.h"
|
2014-02-10 02:10:30 +01:00
|
|
|
#include "scene/resources/texture.h"
|
|
|
|
|
|
|
|
class TouchScreenButton : public Node2D {
|
2017-01-03 03:03:46 +01:00
|
|
|
GDCLASS(TouchScreenButton, Node2D);
|
2014-02-10 02:10:30 +01:00
|
|
|
|
2017-03-05 16:44:50 +01:00
|
|
|
public:
|
2014-02-10 02:10:30 +01:00
|
|
|
enum VisibilityMode {
|
|
|
|
VISIBILITY_ALWAYS,
|
|
|
|
VISIBILITY_TOUCHSCREEN_ONLY
|
|
|
|
};
|
|
|
|
|
|
|
|
private:
|
2021-12-06 15:46:05 +01:00
|
|
|
Ref<Texture2D> texture_normal;
|
2019-06-11 20:43:37 +02:00
|
|
|
Ref<Texture2D> texture_pressed;
|
2014-02-10 02:10:30 +01:00
|
|
|
Ref<BitMap> bitmask;
|
2017-01-25 17:06:06 +01:00
|
|
|
Ref<Shape2D> shape;
|
2021-02-07 22:29:31 +01:00
|
|
|
bool shape_centered = true;
|
|
|
|
bool shape_visible = true;
|
2017-01-25 17:06:06 +01:00
|
|
|
|
|
|
|
Ref<RectangleShape2D> unit_rect;
|
2014-02-10 02:10:30 +01:00
|
|
|
|
|
|
|
StringName action;
|
2021-02-07 22:29:31 +01:00
|
|
|
bool passby_press = false;
|
|
|
|
int finger_pressed = -1;
|
2014-02-10 02:10:30 +01:00
|
|
|
|
2021-02-07 22:29:31 +01:00
|
|
|
VisibilityMode visibility = VISIBILITY_ALWAYS;
|
2014-02-10 02:10:30 +01:00
|
|
|
|
2021-08-22 17:37:22 +02:00
|
|
|
virtual void input(const Ref<InputEvent> &p_event) override;
|
2014-02-10 02:10:30 +01:00
|
|
|
|
2017-06-14 17:08:35 +02:00
|
|
|
bool _is_point_inside(const Point2 &p_point);
|
|
|
|
|
2017-02-04 16:57:11 +01:00
|
|
|
void _press(int p_finger_pressed);
|
|
|
|
void _release(bool p_exiting_tree = false);
|
|
|
|
|
2014-02-10 02:10:30 +01:00
|
|
|
protected:
|
|
|
|
void _notification(int p_what);
|
|
|
|
static void _bind_methods();
|
2023-07-02 10:45:16 +02:00
|
|
|
#ifndef DISABLE_DEPRECATED
|
|
|
|
bool _set(const StringName &p_name, const Variant &p_value);
|
|
|
|
#endif // DISABLE_DEPRECATED
|
2014-02-10 02:10:30 +01:00
|
|
|
|
|
|
|
public:
|
2019-10-21 23:37:07 +02:00
|
|
|
#ifdef TOOLS_ENABLED
|
2020-07-10 12:34:39 +02:00
|
|
|
virtual Rect2 _edit_get_rect() const override;
|
|
|
|
virtual bool _edit_use_rect() const override;
|
2019-10-21 23:37:07 +02:00
|
|
|
#endif
|
|
|
|
|
2021-12-06 15:46:05 +01:00
|
|
|
void set_texture_normal(const Ref<Texture2D> &p_texture);
|
|
|
|
Ref<Texture2D> get_texture_normal() const;
|
2014-02-10 02:10:30 +01:00
|
|
|
|
2019-06-11 20:43:37 +02:00
|
|
|
void set_texture_pressed(const Ref<Texture2D> &p_texture_pressed);
|
|
|
|
Ref<Texture2D> get_texture_pressed() const;
|
2014-02-10 02:10:30 +01:00
|
|
|
|
|
|
|
void set_bitmask(const Ref<BitMap> &p_bitmask);
|
|
|
|
Ref<BitMap> get_bitmask() const;
|
|
|
|
|
2017-01-25 17:06:06 +01:00
|
|
|
void set_shape(const Ref<Shape2D> &p_shape);
|
|
|
|
Ref<Shape2D> get_shape() const;
|
|
|
|
|
|
|
|
void set_shape_centered(bool p_shape_centered);
|
|
|
|
bool is_shape_centered() const;
|
|
|
|
|
2017-04-03 14:23:52 +02:00
|
|
|
void set_shape_visible(bool p_shape_visible);
|
|
|
|
bool is_shape_visible() const;
|
|
|
|
|
2014-02-10 02:10:30 +01:00
|
|
|
void set_action(const String &p_action);
|
|
|
|
String get_action() const;
|
|
|
|
|
|
|
|
void set_passby_press(bool p_enable);
|
|
|
|
bool is_passby_press_enabled() const;
|
|
|
|
|
|
|
|
void set_visibility_mode(VisibilityMode p_mode);
|
|
|
|
VisibilityMode get_visibility_mode() const;
|
|
|
|
|
|
|
|
bool is_pressed() const;
|
|
|
|
|
2020-07-10 12:34:39 +02:00
|
|
|
virtual Rect2 get_anchorable_rect() const override;
|
2014-02-10 02:10:30 +01:00
|
|
|
|
|
|
|
TouchScreenButton();
|
|
|
|
};
|
|
|
|
|
|
|
|
VARIANT_ENUM_CAST(TouchScreenButton::VisibilityMode);
|
|
|
|
|
2019-02-12 17:18:13 +01:00
|
|
|
#endif // TOUCH_SCREEN_BUTTON_H
|