2023-01-05 13:25:55 +01:00
|
|
|
/**************************************************************************/
|
|
|
|
/* area_2d.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
|
|
|
|
2014-02-10 02:10:30 +01:00
|
|
|
#ifndef AREA_2D_H
|
|
|
|
#define AREA_2D_H
|
|
|
|
|
2020-11-07 23:33:38 +01:00
|
|
|
#include "core/templates/vset.h"
|
2014-02-10 02:10:30 +01:00
|
|
|
#include "scene/2d/collision_object_2d.h"
|
|
|
|
|
|
|
|
class Area2D : public CollisionObject2D {
|
2017-03-05 16:44:50 +01:00
|
|
|
GDCLASS(Area2D, CollisionObject2D);
|
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 SpaceOverride {
|
|
|
|
SPACE_OVERRIDE_DISABLED,
|
|
|
|
SPACE_OVERRIDE_COMBINE,
|
2015-12-14 02:56:11 +01:00
|
|
|
SPACE_OVERRIDE_COMBINE_REPLACE,
|
|
|
|
SPACE_OVERRIDE_REPLACE,
|
|
|
|
SPACE_OVERRIDE_REPLACE_COMBINE
|
2014-02-10 02:10:30 +01:00
|
|
|
};
|
|
|
|
|
2017-03-05 16:44:50 +01:00
|
|
|
private:
|
2021-11-05 02:12:00 +01:00
|
|
|
SpaceOverride gravity_space_override = SPACE_OVERRIDE_DISABLED;
|
2014-02-10 02:10:30 +01:00
|
|
|
Vector2 gravity_vec;
|
2022-05-02 16:28:25 +02:00
|
|
|
real_t gravity = 0.0;
|
2021-02-07 22:29:31 +01:00
|
|
|
bool gravity_is_point = false;
|
2023-01-30 01:11:41 +01:00
|
|
|
real_t gravity_point_unit_distance = 0.0;
|
2021-11-05 02:12:00 +01:00
|
|
|
|
|
|
|
SpaceOverride linear_damp_space_override = SPACE_OVERRIDE_DISABLED;
|
|
|
|
SpaceOverride angular_damp_space_override = SPACE_OVERRIDE_DISABLED;
|
2021-02-07 22:29:31 +01:00
|
|
|
real_t linear_damp = 0.1;
|
|
|
|
real_t angular_damp = 1.0;
|
2021-11-05 02:12:00 +01:00
|
|
|
|
2021-02-07 22:29:31 +01:00
|
|
|
int priority = 0;
|
2021-11-05 02:12:00 +01:00
|
|
|
|
2021-02-07 22:29:31 +01:00
|
|
|
bool monitoring = false;
|
|
|
|
bool monitorable = false;
|
|
|
|
bool locked = false;
|
2014-02-10 02:10:30 +01:00
|
|
|
|
2020-02-12 18:24:06 +01:00
|
|
|
void _body_inout(int p_status, const RID &p_body, ObjectID p_instance, int p_body_shape, int p_area_shape);
|
2014-02-10 02:10:30 +01:00
|
|
|
|
2014-11-06 01:20:42 +01:00
|
|
|
void _body_enter_tree(ObjectID p_id);
|
|
|
|
void _body_exit_tree(ObjectID p_id);
|
2014-02-10 02:10:30 +01:00
|
|
|
|
|
|
|
struct ShapePair {
|
2021-02-07 22:29:31 +01:00
|
|
|
int body_shape = 0;
|
|
|
|
int area_shape = 0;
|
2017-03-05 16:44:50 +01:00
|
|
|
bool operator<(const ShapePair &p_sp) const {
|
2020-05-14 16:41:43 +02:00
|
|
|
if (body_shape == p_sp.body_shape) {
|
2014-02-10 02:10:30 +01:00
|
|
|
return area_shape < p_sp.area_shape;
|
2020-05-14 16:41:43 +02:00
|
|
|
} else {
|
2014-02-10 02:10:30 +01:00
|
|
|
return body_shape < p_sp.body_shape;
|
2020-05-14 16:41:43 +02:00
|
|
|
}
|
2014-02-10 02:10:30 +01:00
|
|
|
}
|
|
|
|
|
|
|
|
ShapePair() {}
|
2017-03-05 16:44:50 +01:00
|
|
|
ShapePair(int p_bs, int p_as) {
|
|
|
|
body_shape = p_bs;
|
|
|
|
area_shape = p_as;
|
|
|
|
}
|
2014-02-10 02:10:30 +01:00
|
|
|
};
|
|
|
|
|
|
|
|
struct BodyState {
|
2020-10-12 17:25:32 +02:00
|
|
|
RID rid;
|
2021-02-07 22:29:31 +01:00
|
|
|
int rc = 0;
|
|
|
|
bool in_tree = false;
|
2014-02-10 02:10:30 +01:00
|
|
|
VSet<ShapePair> shapes;
|
|
|
|
};
|
|
|
|
|
2022-05-13 15:04:37 +02:00
|
|
|
HashMap<ObjectID, BodyState> body_map;
|
2015-03-17 04:45:25 +01:00
|
|
|
|
2020-02-12 18:24:06 +01:00
|
|
|
void _area_inout(int p_status, const RID &p_area, ObjectID p_instance, int p_area_shape, int p_self_shape);
|
2015-03-17 04:45:25 +01:00
|
|
|
|
|
|
|
void _area_enter_tree(ObjectID p_id);
|
|
|
|
void _area_exit_tree(ObjectID p_id);
|
|
|
|
|
|
|
|
struct AreaShapePair {
|
2021-02-07 22:29:31 +01:00
|
|
|
int area_shape = 0;
|
|
|
|
int self_shape = 0;
|
2017-03-05 16:44:50 +01:00
|
|
|
bool operator<(const AreaShapePair &p_sp) const {
|
2020-05-14 16:41:43 +02:00
|
|
|
if (area_shape == p_sp.area_shape) {
|
2015-03-17 04:45:25 +01:00
|
|
|
return self_shape < p_sp.self_shape;
|
2020-05-14 16:41:43 +02:00
|
|
|
} else {
|
2015-03-17 04:45:25 +01:00
|
|
|
return area_shape < p_sp.area_shape;
|
2020-05-14 16:41:43 +02:00
|
|
|
}
|
2015-03-17 04:45:25 +01:00
|
|
|
}
|
|
|
|
|
|
|
|
AreaShapePair() {}
|
2017-03-05 16:44:50 +01:00
|
|
|
AreaShapePair(int p_bs, int p_as) {
|
|
|
|
area_shape = p_bs;
|
|
|
|
self_shape = p_as;
|
|
|
|
}
|
2015-03-17 04:45:25 +01:00
|
|
|
};
|
|
|
|
|
|
|
|
struct AreaState {
|
2020-10-12 17:25:32 +02:00
|
|
|
RID rid;
|
2021-02-07 22:29:31 +01:00
|
|
|
int rc = 0;
|
|
|
|
bool in_tree = false;
|
2015-03-17 04:45:25 +01:00
|
|
|
VSet<AreaShapePair> shapes;
|
|
|
|
};
|
|
|
|
|
2022-05-13 15:04:37 +02:00
|
|
|
HashMap<ObjectID, AreaState> area_map;
|
2014-02-10 02:10:30 +01:00
|
|
|
void _clear_monitoring();
|
|
|
|
|
2021-02-07 22:29:31 +01:00
|
|
|
bool audio_bus_override = false;
|
2017-06-19 02:07:32 +02:00
|
|
|
StringName audio_bus;
|
|
|
|
|
2014-02-10 02:10:30 +01:00
|
|
|
protected:
|
|
|
|
void _notification(int p_what);
|
|
|
|
static void _bind_methods();
|
2022-08-12 22:57:11 +02:00
|
|
|
void _validate_property(PropertyInfo &p_property) const;
|
2014-02-10 02:10:30 +01:00
|
|
|
|
2017-03-05 16:44:50 +01:00
|
|
|
public:
|
2021-11-05 02:12:00 +01:00
|
|
|
void set_gravity_space_override_mode(SpaceOverride p_mode);
|
|
|
|
SpaceOverride get_gravity_space_override_mode() const;
|
2014-02-10 02:10:30 +01:00
|
|
|
|
|
|
|
void set_gravity_is_point(bool p_enabled);
|
|
|
|
bool is_gravity_a_point() const;
|
|
|
|
|
2023-01-30 01:11:41 +01:00
|
|
|
void set_gravity_point_unit_distance(real_t p_scale);
|
|
|
|
real_t get_gravity_point_unit_distance() const;
|
2015-04-29 18:06:25 +02:00
|
|
|
|
2021-11-05 02:12:00 +01:00
|
|
|
void set_gravity_point_center(const Vector2 &p_center);
|
|
|
|
const Vector2 &get_gravity_point_center() const;
|
|
|
|
|
|
|
|
void set_gravity_direction(const Vector2 &p_direction);
|
|
|
|
const Vector2 &get_gravity_direction() const;
|
2014-02-10 02:10:30 +01:00
|
|
|
|
|
|
|
void set_gravity(real_t p_gravity);
|
|
|
|
real_t get_gravity() const;
|
|
|
|
|
2021-11-05 02:12:00 +01:00
|
|
|
void set_linear_damp_space_override_mode(SpaceOverride p_mode);
|
|
|
|
SpaceOverride get_linear_damp_space_override_mode() const;
|
|
|
|
|
|
|
|
void set_angular_damp_space_override_mode(SpaceOverride p_mode);
|
|
|
|
SpaceOverride get_angular_damp_space_override_mode() const;
|
|
|
|
|
2015-01-05 22:37:12 +01:00
|
|
|
void set_linear_damp(real_t p_linear_damp);
|
|
|
|
real_t get_linear_damp() const;
|
|
|
|
|
|
|
|
void set_angular_damp(real_t p_angular_damp);
|
|
|
|
real_t get_angular_damp() const;
|
2014-02-10 02:10:30 +01:00
|
|
|
|
|
|
|
void set_priority(real_t p_priority);
|
|
|
|
real_t get_priority() const;
|
|
|
|
|
2017-01-14 00:03:51 +01:00
|
|
|
void set_monitoring(bool p_enable);
|
|
|
|
bool is_monitoring() const;
|
2014-02-10 02:10:30 +01:00
|
|
|
|
2015-03-17 04:45:25 +01:00
|
|
|
void set_monitorable(bool p_enable);
|
|
|
|
bool is_monitorable() const;
|
|
|
|
|
2020-04-21 17:16:45 +02:00
|
|
|
TypedArray<Node2D> get_overlapping_bodies() const; //function for script
|
|
|
|
TypedArray<Area2D> get_overlapping_areas() const; //function for script
|
2014-11-13 04:53:12 +01:00
|
|
|
|
2022-09-09 23:26:14 +02:00
|
|
|
bool has_overlapping_bodies() const;
|
|
|
|
bool has_overlapping_areas() const;
|
|
|
|
|
2017-03-05 16:44:50 +01:00
|
|
|
bool overlaps_area(Node *p_area) const;
|
|
|
|
bool overlaps_body(Node *p_body) const;
|
2014-02-10 02:10:30 +01:00
|
|
|
|
2017-06-19 02:07:32 +02:00
|
|
|
void set_audio_bus_override(bool p_override);
|
|
|
|
bool is_overriding_audio_bus() const;
|
|
|
|
|
2017-09-22 18:29:33 +02:00
|
|
|
void set_audio_bus_name(const StringName &p_audio_bus);
|
|
|
|
StringName get_audio_bus_name() const;
|
2017-06-19 02:07:32 +02:00
|
|
|
|
2014-02-10 02:10:30 +01:00
|
|
|
Area2D();
|
|
|
|
~Area2D();
|
|
|
|
};
|
|
|
|
|
|
|
|
VARIANT_ENUM_CAST(Area2D::SpaceOverride);
|
|
|
|
|
|
|
|
#endif // AREA_2D_H
|