2014-02-10 02:10:30 +01:00
|
|
|
/*************************************************************************/
|
2020-03-26 22:49:16 +01:00
|
|
|
/* area_3d.h */
|
2014-02-10 02:10:30 +01:00
|
|
|
/*************************************************************************/
|
|
|
|
/* This file is part of: */
|
|
|
|
/* GODOT ENGINE */
|
2017-08-27 14:16:55 +02:00
|
|
|
/* https://godotengine.org */
|
2014-02-10 02:10:30 +01:00
|
|
|
/*************************************************************************/
|
2021-01-01 20:13:46 +01:00
|
|
|
/* Copyright (c) 2007-2021 Juan Linietsky, Ariel Manzur. */
|
|
|
|
/* Copyright (c) 2014-2021 Godot Engine contributors (cf. AUTHORS.md). */
|
2014-02-10 02:10:30 +01:00
|
|
|
/* */
|
|
|
|
/* 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
|
|
|
|
2020-03-26 22:49:16 +01:00
|
|
|
#ifndef AREA_3D_H
|
|
|
|
#define AREA_3D_H
|
2014-02-10 02:10:30 +01:00
|
|
|
|
2020-11-07 23:33:38 +01:00
|
|
|
#include "core/templates/vset.h"
|
2020-03-26 22:49:16 +01:00
|
|
|
#include "scene/3d/collision_object_3d.h"
|
2014-02-10 02:10:30 +01:00
|
|
|
|
2020-03-26 22:49:16 +01:00
|
|
|
class Area3D : public CollisionObject3D {
|
|
|
|
GDCLASS(Area3D, CollisionObject3D);
|
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-02-07 22:29:31 +01:00
|
|
|
SpaceOverride space_override = SPACE_OVERRIDE_DISABLED;
|
2014-02-10 02:10:30 +01:00
|
|
|
Vector3 gravity_vec;
|
|
|
|
real_t gravity;
|
2021-02-07 22:29:31 +01:00
|
|
|
bool gravity_is_point = false;
|
|
|
|
real_t gravity_distance_scale = 0.0;
|
|
|
|
real_t angular_damp = 0.1;
|
|
|
|
real_t linear_damp = 0.1;
|
|
|
|
uint32_t collision_mask = 1;
|
|
|
|
uint32_t collision_layer = 1;
|
|
|
|
int priority = 0;
|
|
|
|
bool monitoring = false;
|
|
|
|
bool monitorable = false;
|
|
|
|
bool locked = false;
|
2014-10-03 05:10:51 +02: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;
|
|
|
|
};
|
|
|
|
|
2017-03-05 16:44:50 +01:00
|
|
|
Map<ObjectID, BodyState> body_map;
|
2015-06-12 20:52:21 +02: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-06-12 20:52:21 +02: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-06-12 20:52:21 +02:00
|
|
|
return self_shape < p_sp.self_shape;
|
2020-05-14 16:41:43 +02:00
|
|
|
} else {
|
2015-06-12 20:52:21 +02:00
|
|
|
return area_shape < p_sp.area_shape;
|
2020-05-14 16:41:43 +02:00
|
|
|
}
|
2015-06-12 20:52:21 +02: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-06-12 20:52:21 +02: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-06-12 20:52:21 +02:00
|
|
|
VSet<AreaShapePair> shapes;
|
|
|
|
};
|
|
|
|
|
2017-03-05 16:44:50 +01:00
|
|
|
Map<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;
|
|
|
|
StringName audio_bus = "Master";
|
2017-07-15 06:23:10 +02:00
|
|
|
|
2021-02-07 22:29:31 +01:00
|
|
|
bool use_reverb_bus = false;
|
|
|
|
StringName reverb_bus = "Master";
|
|
|
|
float reverb_amount = 0.0;
|
|
|
|
float reverb_uniformity = 0.0;
|
2017-07-15 06:23:10 +02:00
|
|
|
|
2020-07-10 12:34:39 +02:00
|
|
|
void _validate_property(PropertyInfo &property) const override;
|
2017-07-15 06:23:10 +02:00
|
|
|
|
2014-02-10 02:10:30 +01:00
|
|
|
protected:
|
|
|
|
void _notification(int p_what);
|
|
|
|
static void _bind_methods();
|
|
|
|
|
2017-03-05 16:44:50 +01:00
|
|
|
public:
|
2014-02-10 02:10:30 +01:00
|
|
|
void set_space_override_mode(SpaceOverride p_mode);
|
|
|
|
SpaceOverride get_space_override_mode() const;
|
|
|
|
|
|
|
|
void set_gravity_is_point(bool p_enabled);
|
|
|
|
bool is_gravity_a_point() const;
|
|
|
|
|
2015-03-19 15:10:07 +01:00
|
|
|
void set_gravity_distance_scale(real_t p_scale);
|
|
|
|
real_t get_gravity_distance_scale() const;
|
|
|
|
|
2017-03-05 16:44:50 +01:00
|
|
|
void set_gravity_vector(const Vector3 &p_vec);
|
2014-02-10 02:10:30 +01:00
|
|
|
Vector3 get_gravity_vector() const;
|
|
|
|
|
|
|
|
void set_gravity(real_t p_gravity);
|
|
|
|
real_t get_gravity() const;
|
|
|
|
|
2015-08-30 23:57:17 +02:00
|
|
|
void set_angular_damp(real_t p_angular_damp);
|
|
|
|
real_t get_angular_damp() const;
|
|
|
|
|
|
|
|
void set_linear_damp(real_t p_linear_damp);
|
|
|
|
real_t get_linear_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-06-12 20:52:21 +02:00
|
|
|
void set_monitorable(bool p_enable);
|
|
|
|
bool is_monitorable() const;
|
|
|
|
|
2016-04-09 20:54:09 +02:00
|
|
|
void set_collision_mask(uint32_t p_mask);
|
|
|
|
uint32_t get_collision_mask() const;
|
|
|
|
|
2017-06-13 17:45:01 +02:00
|
|
|
void set_collision_layer(uint32_t p_layer);
|
|
|
|
uint32_t get_collision_layer() const;
|
2016-04-09 20:54:09 +02:00
|
|
|
|
|
|
|
void set_collision_mask_bit(int p_bit, bool p_value);
|
|
|
|
bool get_collision_mask_bit(int p_bit) const;
|
|
|
|
|
2017-06-13 17:45:01 +02:00
|
|
|
void set_collision_layer_bit(int p_bit, bool p_value);
|
|
|
|
bool get_collision_layer_bit(int p_bit) const;
|
2016-04-09 20:54:09 +02:00
|
|
|
|
2020-04-21 17:16:45 +02:00
|
|
|
TypedArray<Node3D> get_overlapping_bodies() const;
|
|
|
|
TypedArray<Area3D> get_overlapping_areas() const; //function for script
|
2015-06-12 20:52:21 +02:00
|
|
|
|
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-07-15 06:23:10 +02:00
|
|
|
void set_audio_bus_override(bool p_override);
|
|
|
|
bool is_overriding_audio_bus() const;
|
|
|
|
|
2020-12-10 09:31:14 +01:00
|
|
|
void set_audio_bus_name(const StringName &p_audio_bus);
|
|
|
|
StringName get_audio_bus_name() const;
|
2017-07-15 06:23:10 +02:00
|
|
|
|
|
|
|
void set_use_reverb_bus(bool p_enable);
|
|
|
|
bool is_using_reverb_bus() const;
|
|
|
|
|
|
|
|
void set_reverb_bus(const StringName &p_audio_bus);
|
|
|
|
StringName get_reverb_bus() const;
|
|
|
|
|
|
|
|
void set_reverb_amount(float p_amount);
|
|
|
|
float get_reverb_amount() const;
|
|
|
|
|
|
|
|
void set_reverb_uniformity(float p_uniformity);
|
|
|
|
float get_reverb_uniformity() const;
|
|
|
|
|
2020-03-26 22:49:16 +01:00
|
|
|
Area3D();
|
|
|
|
~Area3D();
|
2014-02-10 02:10:30 +01:00
|
|
|
};
|
|
|
|
|
2020-03-26 22:49:16 +01:00
|
|
|
VARIANT_ENUM_CAST(Area3D::SpaceOverride);
|
2014-02-10 02:10:30 +01:00
|
|
|
|
|
|
|
#endif // AREA__H
|