godot/servers/extensions/physics_server_2d_extension.h
Rémi Verschelde d95794ec8a
One Copyright Update to rule them all
As many open source projects have started doing it, we're removing the
current year from the copyright notice, so that we don't need to bump
it every year.

It seems like only the first year of publication is technically
relevant for copyright notices, and even that seems to be something
that many companies stopped listing altogether (in a version controlled
codebase, the commits are a much better source of date of publication
than a hardcoded copyright statement).

We also now list Godot Engine contributors first as we're collectively
the current maintainers of the project, and we clarify that the
"exclusive" copyright of the co-founders covers the timespan before
opensourcing (their further contributions are included as part of Godot
Engine contributors).

Also fixed "cf." Frenchism - it's meant as "refer to / see".
2023-01-05 13:25:55 +01:00

453 lines
19 KiB
C++

/**************************************************************************/
/* physics_server_2d_extension.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. */
/**************************************************************************/
#ifndef PHYSICS_SERVER_2D_EXTENSION_H
#define PHYSICS_SERVER_2D_EXTENSION_H
#include "core/extension/ext_wrappers.gen.inc"
#include "core/object/gdvirtual.gen.inc"
#include "core/object/script_language.h"
#include "core/variant/native_ptr.h"
#include "core/variant/type_info.h"
#include "core/variant/typed_array.h"
#include "servers/physics_server_2d.h"
class PhysicsDirectBodyState2DExtension : public PhysicsDirectBodyState2D {
GDCLASS(PhysicsDirectBodyState2DExtension, PhysicsDirectBodyState2D);
protected:
static void _bind_methods();
public:
// The warning is valid, but unavoidable. If the function is not overridden it will error anyway.
EXBIND0RC(Vector2, get_total_gravity)
EXBIND0RC(real_t, get_total_angular_damp)
EXBIND0RC(real_t, get_total_linear_damp)
EXBIND0RC(Vector2, get_center_of_mass)
EXBIND0RC(Vector2, get_center_of_mass_local)
EXBIND0RC(real_t, get_inverse_mass)
EXBIND0RC(real_t, get_inverse_inertia)
EXBIND1(set_linear_velocity, const Vector2 &)
EXBIND0RC(Vector2, get_linear_velocity)
EXBIND1(set_angular_velocity, real_t)
EXBIND0RC(real_t, get_angular_velocity)
EXBIND1(set_transform, const Transform2D &)
EXBIND0RC(Transform2D, get_transform)
EXBIND1RC(Vector2, get_velocity_at_local_position, const Vector2 &)
EXBIND1(apply_central_impulse, const Vector2 &)
EXBIND1(apply_torque_impulse, real_t)
EXBIND2(apply_impulse, const Vector2 &, const Vector2 &)
EXBIND1(apply_central_force, const Vector2 &)
EXBIND2(apply_force, const Vector2 &, const Vector2 &)
EXBIND1(apply_torque, real_t)
EXBIND1(add_constant_central_force, const Vector2 &)
EXBIND2(add_constant_force, const Vector2 &, const Vector2 &)
EXBIND1(add_constant_torque, real_t)
EXBIND1(set_constant_force, const Vector2 &)
EXBIND0RC(Vector2, get_constant_force)
EXBIND1(set_constant_torque, real_t)
EXBIND0RC(real_t, get_constant_torque)
EXBIND1(set_sleep_state, bool)
EXBIND0RC(bool, is_sleeping)
EXBIND0RC(int, get_contact_count)
EXBIND1RC(Vector2, get_contact_local_position, int)
EXBIND1RC(Vector2, get_contact_local_normal, int)
EXBIND1RC(int, get_contact_local_shape, int)
EXBIND1RC(RID, get_contact_collider, int)
EXBIND1RC(Vector2, get_contact_collider_position, int)
EXBIND1RC(ObjectID, get_contact_collider_id, int)
EXBIND1RC(Object *, get_contact_collider_object, int)
EXBIND1RC(int, get_contact_collider_shape, int)
EXBIND1RC(Vector2, get_contact_collider_velocity_at_position, int)
EXBIND0RC(real_t, get_step)
EXBIND0(integrate_forces)
EXBIND0R(PhysicsDirectSpaceState2D *, get_space_state)
PhysicsDirectBodyState2DExtension();
};
typedef PhysicsDirectSpaceState2D::RayResult PhysicsServer2DExtensionRayResult;
typedef PhysicsDirectSpaceState2D::ShapeResult PhysicsServer2DExtensionShapeResult;
typedef PhysicsDirectSpaceState2D::ShapeRestInfo PhysicsServer2DExtensionShapeRestInfo;
GDVIRTUAL_NATIVE_PTR(PhysicsServer2DExtensionRayResult)
GDVIRTUAL_NATIVE_PTR(PhysicsServer2DExtensionShapeResult)
GDVIRTUAL_NATIVE_PTR(PhysicsServer2DExtensionShapeRestInfo)
class PhysicsDirectSpaceState2DExtension : public PhysicsDirectSpaceState2D {
GDCLASS(PhysicsDirectSpaceState2DExtension, PhysicsDirectSpaceState2D);
thread_local static const HashSet<RID> *exclude;
protected:
static void _bind_methods();
bool is_body_excluded_from_query(const RID &p_body) const;
GDVIRTUAL7R(bool, _intersect_ray, const Vector2 &, const Vector2 &, uint32_t, bool, bool, bool, GDExtensionPtr<PhysicsServer2DExtensionRayResult>)
GDVIRTUAL7R(int, _intersect_point, const Vector2 &, ObjectID, uint32_t, bool, bool, GDExtensionPtr<PhysicsServer2DExtensionShapeResult>, int)
GDVIRTUAL9R(int, _intersect_shape, RID, const Transform2D &, const Vector2 &, real_t, uint32_t, bool, bool, GDExtensionPtr<PhysicsServer2DExtensionShapeResult>, int)
GDVIRTUAL9R(bool, _cast_motion, RID, const Transform2D &, const Vector2 &, real_t, uint32_t, bool, bool, GDExtensionPtr<real_t>, GDExtensionPtr<real_t>)
GDVIRTUAL10R(bool, _collide_shape, RID, const Transform2D &, const Vector2 &, real_t, uint32_t, bool, bool, GDExtensionPtr<Vector2>, int, GDExtensionPtr<int>)
GDVIRTUAL8R(bool, _rest_info, RID, const Transform2D &, const Vector2 &, real_t, uint32_t, bool, bool, GDExtensionPtr<PhysicsServer2DExtensionShapeRestInfo>)
public:
virtual bool intersect_ray(const RayParameters &p_parameters, RayResult &r_result) override {
exclude = &p_parameters.exclude;
bool ret = false;
GDVIRTUAL_REQUIRED_CALL(_intersect_ray, p_parameters.from, p_parameters.to, p_parameters.collision_mask, p_parameters.collide_with_bodies, p_parameters.collide_with_areas, p_parameters.hit_from_inside, &r_result, ret);
exclude = nullptr;
return ret;
}
virtual int intersect_point(const PointParameters &p_parameters, ShapeResult *r_results, int p_result_max) override {
exclude = &p_parameters.exclude;
int ret = false;
GDVIRTUAL_REQUIRED_CALL(_intersect_point, p_parameters.position, p_parameters.canvas_instance_id, p_parameters.collision_mask, p_parameters.collide_with_bodies, p_parameters.collide_with_areas, r_results, p_result_max, ret);
exclude = nullptr;
return ret;
}
virtual int intersect_shape(const ShapeParameters &p_parameters, ShapeResult *r_results, int p_result_max) override {
exclude = &p_parameters.exclude;
int ret = 0;
GDVIRTUAL_REQUIRED_CALL(_intersect_shape, p_parameters.shape_rid, p_parameters.transform, p_parameters.motion, p_parameters.margin, p_parameters.collision_mask, p_parameters.collide_with_bodies, p_parameters.collide_with_areas, r_results, p_result_max, ret);
exclude = nullptr;
return ret;
}
virtual bool cast_motion(const ShapeParameters &p_parameters, real_t &p_closest_safe, real_t &p_closest_unsafe) override {
exclude = &p_parameters.exclude;
bool ret = false;
GDVIRTUAL_REQUIRED_CALL(_cast_motion, p_parameters.shape_rid, p_parameters.transform, p_parameters.motion, p_parameters.margin, p_parameters.collision_mask, p_parameters.collide_with_bodies, p_parameters.collide_with_areas, &p_closest_safe, &p_closest_unsafe, ret);
exclude = nullptr;
return ret;
}
virtual bool collide_shape(const ShapeParameters &p_parameters, Vector2 *r_results, int p_result_max, int &r_result_count) override {
exclude = &p_parameters.exclude;
bool ret = false;
GDVIRTUAL_REQUIRED_CALL(_collide_shape, p_parameters.shape_rid, p_parameters.transform, p_parameters.motion, p_parameters.margin, p_parameters.collision_mask, p_parameters.collide_with_bodies, p_parameters.collide_with_areas, r_results, p_result_max, &r_result_count, ret);
exclude = nullptr;
return ret;
}
virtual bool rest_info(const ShapeParameters &p_parameters, ShapeRestInfo *r_info) override {
exclude = &p_parameters.exclude;
bool ret = false;
GDVIRTUAL_REQUIRED_CALL(_rest_info, p_parameters.shape_rid, p_parameters.transform, p_parameters.motion, p_parameters.margin, p_parameters.collision_mask, p_parameters.collide_with_bodies, p_parameters.collide_with_areas, r_info, ret);
exclude = nullptr;
return ret;
}
PhysicsDirectSpaceState2DExtension();
};
typedef PhysicsServer2D::MotionResult PhysicsServer2DExtensionMotionResult;
GDVIRTUAL_NATIVE_PTR(PhysicsServer2DExtensionMotionResult)
class PhysicsServer2DExtension : public PhysicsServer2D {
GDCLASS(PhysicsServer2DExtension, PhysicsServer2D);
protected:
static void _bind_methods();
GDVIRTUAL9R(bool, _shape_collide, RID, const Transform2D &, const Vector2 &, RID, const Transform2D &, const Vector2 &, GDExtensionPtr<Vector2>, int, GDExtensionPtr<int>)
GDVIRTUAL8R(bool, _body_collide_shape, RID, int, RID, const Transform2D &, const Vector2 &, GDExtensionPtr<Vector2>, int, GDExtensionPtr<int>)
public:
// The warning is valid, but unavoidable. If the function is not overridden it will error anyway.
/* SHAPE API */
EXBIND0R(RID, world_boundary_shape_create)
EXBIND0R(RID, separation_ray_shape_create)
EXBIND0R(RID, segment_shape_create)
EXBIND0R(RID, circle_shape_create)
EXBIND0R(RID, rectangle_shape_create)
EXBIND0R(RID, capsule_shape_create)
EXBIND0R(RID, convex_polygon_shape_create)
EXBIND0R(RID, concave_polygon_shape_create)
EXBIND2(shape_set_data, RID, const Variant &)
EXBIND2(shape_set_custom_solver_bias, RID, real_t)
EXBIND1RC(ShapeType, shape_get_type, RID)
EXBIND1RC(Variant, shape_get_data, RID)
EXBIND1RC(real_t, shape_get_custom_solver_bias, RID)
virtual bool shape_collide(RID p_shape_A, const Transform2D &p_xform_A, const Vector2 &p_motion_A, RID p_shape_B, const Transform2D &p_xform_B, const Vector2 &p_motion_B, Vector2 *r_results, int p_result_max, int &r_result_count) override {
bool ret = false;
GDVIRTUAL_REQUIRED_CALL(_shape_collide, p_shape_A, p_xform_A, p_motion_A, p_shape_B, p_xform_B, p_motion_B, r_results, p_result_max, &r_result_count, ret);
return ret;
}
/* SPACE API */
EXBIND0R(RID, space_create)
EXBIND2(space_set_active, RID, bool)
EXBIND1RC(bool, space_is_active, RID)
EXBIND3(space_set_param, RID, SpaceParameter, real_t)
EXBIND2RC(real_t, space_get_param, RID, SpaceParameter)
EXBIND1R(PhysicsDirectSpaceState2D *, space_get_direct_state, RID)
EXBIND2(space_set_debug_contacts, RID, int)
EXBIND1RC(Vector<Vector2>, space_get_contacts, RID)
EXBIND1RC(int, space_get_contact_count, RID)
/* AREA API */
//EXBIND0RID(area);
EXBIND0R(RID, area_create)
EXBIND2(area_set_space, RID, RID)
EXBIND1RC(RID, area_get_space, RID)
EXBIND4(area_add_shape, RID, RID, const Transform2D &, bool)
EXBIND3(area_set_shape, RID, int, RID)
EXBIND3(area_set_shape_transform, RID, int, const Transform2D &)
EXBIND3(area_set_shape_disabled, RID, int, bool)
EXBIND1RC(int, area_get_shape_count, RID)
EXBIND2RC(RID, area_get_shape, RID, int)
EXBIND2RC(Transform2D, area_get_shape_transform, RID, int)
EXBIND2(area_remove_shape, RID, int)
EXBIND1(area_clear_shapes, RID)
EXBIND2(area_attach_object_instance_id, RID, ObjectID)
EXBIND1RC(ObjectID, area_get_object_instance_id, RID)
EXBIND2(area_attach_canvas_instance_id, RID, ObjectID)
EXBIND1RC(ObjectID, area_get_canvas_instance_id, RID)
EXBIND3(area_set_param, RID, AreaParameter, const Variant &)
EXBIND2(area_set_transform, RID, const Transform2D &)
EXBIND2RC(Variant, area_get_param, RID, AreaParameter)
EXBIND1RC(Transform2D, area_get_transform, RID)
EXBIND2(area_set_collision_layer, RID, uint32_t)
EXBIND1RC(uint32_t, area_get_collision_layer, RID)
EXBIND2(area_set_collision_mask, RID, uint32_t)
EXBIND1RC(uint32_t, area_get_collision_mask, RID)
EXBIND2(area_set_monitorable, RID, bool)
EXBIND2(area_set_pickable, RID, bool)
EXBIND2(area_set_monitor_callback, RID, const Callable &)
EXBIND2(area_set_area_monitor_callback, RID, const Callable &)
/* BODY API */
//EXBIND2RID(body,BodyMode,bool);
EXBIND0R(RID, body_create)
EXBIND2(body_set_space, RID, RID)
EXBIND1RC(RID, body_get_space, RID)
EXBIND2(body_set_mode, RID, BodyMode)
EXBIND1RC(BodyMode, body_get_mode, RID)
EXBIND4(body_add_shape, RID, RID, const Transform2D &, bool)
EXBIND3(body_set_shape, RID, int, RID)
EXBIND3(body_set_shape_transform, RID, int, const Transform2D &)
EXBIND1RC(int, body_get_shape_count, RID)
EXBIND2RC(RID, body_get_shape, RID, int)
EXBIND2RC(Transform2D, body_get_shape_transform, RID, int)
EXBIND3(body_set_shape_disabled, RID, int, bool)
EXBIND4(body_set_shape_as_one_way_collision, RID, int, bool, real_t)
EXBIND2(body_remove_shape, RID, int)
EXBIND1(body_clear_shapes, RID)
EXBIND2(body_attach_object_instance_id, RID, ObjectID)
EXBIND1RC(ObjectID, body_get_object_instance_id, RID)
EXBIND2(body_attach_canvas_instance_id, RID, ObjectID)
EXBIND1RC(ObjectID, body_get_canvas_instance_id, RID)
EXBIND2(body_set_continuous_collision_detection_mode, RID, CCDMode)
EXBIND1RC(CCDMode, body_get_continuous_collision_detection_mode, RID)
EXBIND2(body_set_collision_layer, RID, uint32_t)
EXBIND1RC(uint32_t, body_get_collision_layer, RID)
EXBIND2(body_set_collision_mask, RID, uint32_t)
EXBIND1RC(uint32_t, body_get_collision_mask, RID)
EXBIND2(body_set_collision_priority, RID, real_t)
EXBIND1RC(real_t, body_get_collision_priority, RID)
EXBIND3(body_set_param, RID, BodyParameter, const Variant &)
EXBIND2RC(Variant, body_get_param, RID, BodyParameter)
EXBIND1(body_reset_mass_properties, RID)
EXBIND3(body_set_state, RID, BodyState, const Variant &)
EXBIND2RC(Variant, body_get_state, RID, BodyState)
EXBIND2(body_apply_central_impulse, RID, const Vector2 &)
EXBIND2(body_apply_torque_impulse, RID, real_t)
EXBIND3(body_apply_impulse, RID, const Vector2 &, const Vector2 &)
EXBIND2(body_apply_central_force, RID, const Vector2 &)
EXBIND3(body_apply_force, RID, const Vector2 &, const Vector2 &)
EXBIND2(body_apply_torque, RID, real_t)
EXBIND2(body_add_constant_central_force, RID, const Vector2 &)
EXBIND3(body_add_constant_force, RID, const Vector2 &, const Vector2 &)
EXBIND2(body_add_constant_torque, RID, real_t)
EXBIND2(body_set_constant_force, RID, const Vector2 &)
EXBIND1RC(Vector2, body_get_constant_force, RID)
EXBIND2(body_set_constant_torque, RID, real_t)
EXBIND1RC(real_t, body_get_constant_torque, RID)
EXBIND2(body_set_axis_velocity, RID, const Vector2 &)
EXBIND2(body_add_collision_exception, RID, RID)
EXBIND2(body_remove_collision_exception, RID, RID)
GDVIRTUAL1RC(TypedArray<RID>, _body_get_collision_exceptions, RID)
void body_get_collision_exceptions(RID p_body, List<RID> *p_exceptions) override {
TypedArray<RID> ret;
GDVIRTUAL_REQUIRED_CALL(_body_get_collision_exceptions, p_body, ret);
for (int i = 0; i < ret.size(); i++) {
p_exceptions->push_back(ret[i]);
}
}
EXBIND2(body_set_max_contacts_reported, RID, int)
EXBIND1RC(int, body_get_max_contacts_reported, RID)
EXBIND2(body_set_contacts_reported_depth_threshold, RID, real_t)
EXBIND1RC(real_t, body_get_contacts_reported_depth_threshold, RID)
EXBIND2(body_set_omit_force_integration, RID, bool)
EXBIND1RC(bool, body_is_omitting_force_integration, RID)
EXBIND2(body_set_state_sync_callback, RID, const Callable &)
EXBIND3(body_set_force_integration_callback, RID, const Callable &, const Variant &)
virtual bool body_collide_shape(RID p_body, int p_body_shape, RID p_shape, const Transform2D &p_shape_xform, const Vector2 &p_motion, Vector2 *r_results, int p_result_max, int &r_result_count) override {
bool ret = false;
GDVIRTUAL_REQUIRED_CALL(_body_collide_shape, p_body, p_body_shape, p_shape, p_shape_xform, p_motion, r_results, p_result_max, &r_result_count, ret);
return ret;
}
EXBIND2(body_set_pickable, RID, bool)
EXBIND1R(PhysicsDirectBodyState2D *, body_get_direct_state, RID)
GDVIRTUAL7RC(bool, _body_test_motion, RID, const Transform2D &, const Vector2 &, real_t, bool, bool, GDExtensionPtr<PhysicsServer2DExtensionMotionResult>)
thread_local static const HashSet<RID> *exclude_bodies;
thread_local static const HashSet<ObjectID> *exclude_objects;
bool body_test_motion_is_excluding_body(RID p_body) const;
bool body_test_motion_is_excluding_object(ObjectID p_object) const;
bool body_test_motion(RID p_body, const MotionParameters &p_parameters, MotionResult *r_result = nullptr) override {
bool ret = false;
exclude_bodies = &p_parameters.exclude_bodies;
exclude_objects = &p_parameters.exclude_objects;
GDVIRTUAL_REQUIRED_CALL(_body_test_motion, p_body, p_parameters.from, p_parameters.motion, p_parameters.margin, p_parameters.collide_separation_ray, p_parameters.recovery_as_collision, r_result, ret);
exclude_bodies = nullptr;
exclude_objects = nullptr;
return ret;
}
/* JOINT API */
EXBIND0R(RID, joint_create)
EXBIND1(joint_clear, RID)
EXBIND3(joint_set_param, RID, JointParam, real_t)
EXBIND2RC(real_t, joint_get_param, RID, JointParam)
EXBIND2(joint_disable_collisions_between_bodies, RID, bool)
EXBIND1RC(bool, joint_is_disabled_collisions_between_bodies, RID)
EXBIND4(joint_make_pin, RID, const Vector2 &, RID, RID)
EXBIND6(joint_make_groove, RID, const Vector2 &, const Vector2 &, const Vector2 &, RID, RID)
EXBIND5(joint_make_damped_spring, RID, const Vector2 &, const Vector2 &, RID, RID)
EXBIND3(pin_joint_set_param, RID, PinJointParam, real_t)
EXBIND2RC(real_t, pin_joint_get_param, RID, PinJointParam)
EXBIND3(damped_spring_joint_set_param, RID, DampedSpringParam, real_t)
EXBIND2RC(real_t, damped_spring_joint_get_param, RID, DampedSpringParam)
EXBIND1RC(JointType, joint_get_type, RID)
/* MISC */
GDVIRTUAL1(_free_rid, RID)
virtual void free(RID p_rid) override {
GDVIRTUAL_REQUIRED_CALL(_free_rid, p_rid);
}
EXBIND1(set_active, bool)
EXBIND0(init)
EXBIND1(step, real_t)
EXBIND0(sync)
EXBIND0(flush_queries)
EXBIND0(end_sync)
EXBIND0(finish)
EXBIND0RC(bool, is_flushing_queries)
EXBIND1R(int, get_process_info, ProcessInfo)
PhysicsServer2DExtension();
~PhysicsServer2DExtension();
};
#endif // PHYSICS_SERVER_2D_EXTENSION_H