1/**************************************************************************/
2/* physics_server_2d_extension.h */
3/**************************************************************************/
4/* This file is part of: */
5/* GODOT ENGINE */
6/* https://godotengine.org */
7/**************************************************************************/
8/* Copyright (c) 2014-present Godot Engine contributors (see AUTHORS.md). */
9/* Copyright (c) 2007-2014 Juan Linietsky, Ariel Manzur. */
10/* */
11/* Permission is hereby granted, free of charge, to any person obtaining */
12/* a copy of this software and associated documentation files (the */
13/* "Software"), to deal in the Software without restriction, including */
14/* without limitation the rights to use, copy, modify, merge, publish, */
15/* distribute, sublicense, and/or sell copies of the Software, and to */
16/* permit persons to whom the Software is furnished to do so, subject to */
17/* the following conditions: */
18/* */
19/* The above copyright notice and this permission notice shall be */
20/* included in all copies or substantial portions of the Software. */
21/* */
22/* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, */
23/* EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF */
24/* MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. */
25/* IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY */
26/* CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, */
27/* TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE */
28/* SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. */
29/**************************************************************************/
30
31#ifndef PHYSICS_SERVER_2D_EXTENSION_H
32#define PHYSICS_SERVER_2D_EXTENSION_H
33
34#include "core/extension/ext_wrappers.gen.inc"
35#include "core/object/gdvirtual.gen.inc"
36#include "core/variant/native_ptr.h"
37#include "core/variant/type_info.h"
38#include "core/variant/typed_array.h"
39#include "servers/physics_server_2d.h"
40
41class PhysicsDirectBodyState2DExtension : public PhysicsDirectBodyState2D {
42 GDCLASS(PhysicsDirectBodyState2DExtension, PhysicsDirectBodyState2D);
43
44protected:
45 static void _bind_methods();
46
47public:
48 // The warning is valid, but unavoidable. If the function is not overridden it will error anyway.
49
50 EXBIND0RC(Vector2, get_total_gravity)
51 EXBIND0RC(real_t, get_total_angular_damp)
52 EXBIND0RC(real_t, get_total_linear_damp)
53
54 EXBIND0RC(Vector2, get_center_of_mass)
55 EXBIND0RC(Vector2, get_center_of_mass_local)
56 EXBIND0RC(real_t, get_inverse_mass)
57 EXBIND0RC(real_t, get_inverse_inertia)
58
59 EXBIND1(set_linear_velocity, const Vector2 &)
60 EXBIND0RC(Vector2, get_linear_velocity)
61
62 EXBIND1(set_angular_velocity, real_t)
63 EXBIND0RC(real_t, get_angular_velocity)
64
65 EXBIND1(set_transform, const Transform2D &)
66 EXBIND0RC(Transform2D, get_transform)
67
68 EXBIND1RC(Vector2, get_velocity_at_local_position, const Vector2 &)
69
70 EXBIND1(apply_central_impulse, const Vector2 &)
71 EXBIND1(apply_torque_impulse, real_t)
72 EXBIND2(apply_impulse, const Vector2 &, const Vector2 &)
73
74 EXBIND1(apply_central_force, const Vector2 &)
75 EXBIND2(apply_force, const Vector2 &, const Vector2 &)
76 EXBIND1(apply_torque, real_t)
77
78 EXBIND1(add_constant_central_force, const Vector2 &)
79 EXBIND2(add_constant_force, const Vector2 &, const Vector2 &)
80 EXBIND1(add_constant_torque, real_t)
81
82 EXBIND1(set_constant_force, const Vector2 &)
83 EXBIND0RC(Vector2, get_constant_force)
84
85 EXBIND1(set_constant_torque, real_t)
86 EXBIND0RC(real_t, get_constant_torque)
87
88 EXBIND1(set_sleep_state, bool)
89 EXBIND0RC(bool, is_sleeping)
90
91 EXBIND0RC(int, get_contact_count)
92
93 EXBIND1RC(Vector2, get_contact_local_position, int)
94 EXBIND1RC(Vector2, get_contact_local_normal, int)
95 EXBIND1RC(Vector2, get_contact_local_velocity_at_position, int)
96 EXBIND1RC(int, get_contact_local_shape, int)
97 EXBIND1RC(RID, get_contact_collider, int)
98 EXBIND1RC(Vector2, get_contact_collider_position, int)
99 EXBIND1RC(ObjectID, get_contact_collider_id, int)
100 EXBIND1RC(Object *, get_contact_collider_object, int)
101 EXBIND1RC(int, get_contact_collider_shape, int)
102 EXBIND1RC(Vector2, get_contact_collider_velocity_at_position, int)
103 EXBIND1RC(Vector2, get_contact_impulse, int)
104
105 EXBIND0RC(real_t, get_step)
106 EXBIND0(integrate_forces)
107
108 EXBIND0R(PhysicsDirectSpaceState2D *, get_space_state)
109
110 PhysicsDirectBodyState2DExtension();
111};
112
113typedef PhysicsDirectSpaceState2D::RayResult PhysicsServer2DExtensionRayResult;
114typedef PhysicsDirectSpaceState2D::ShapeResult PhysicsServer2DExtensionShapeResult;
115typedef PhysicsDirectSpaceState2D::ShapeRestInfo PhysicsServer2DExtensionShapeRestInfo;
116
117GDVIRTUAL_NATIVE_PTR(PhysicsServer2DExtensionRayResult)
118GDVIRTUAL_NATIVE_PTR(PhysicsServer2DExtensionShapeResult)
119GDVIRTUAL_NATIVE_PTR(PhysicsServer2DExtensionShapeRestInfo)
120
121class PhysicsDirectSpaceState2DExtension : public PhysicsDirectSpaceState2D {
122 GDCLASS(PhysicsDirectSpaceState2DExtension, PhysicsDirectSpaceState2D);
123
124 thread_local static const HashSet<RID> *exclude;
125
126protected:
127 static void _bind_methods();
128 bool is_body_excluded_from_query(const RID &p_body) const;
129
130 GDVIRTUAL7R(bool, _intersect_ray, const Vector2 &, const Vector2 &, uint32_t, bool, bool, bool, GDExtensionPtr<PhysicsServer2DExtensionRayResult>)
131 GDVIRTUAL7R(int, _intersect_point, const Vector2 &, ObjectID, uint32_t, bool, bool, GDExtensionPtr<PhysicsServer2DExtensionShapeResult>, int)
132 GDVIRTUAL9R(int, _intersect_shape, RID, const Transform2D &, const Vector2 &, real_t, uint32_t, bool, bool, GDExtensionPtr<PhysicsServer2DExtensionShapeResult>, int)
133 GDVIRTUAL9R(bool, _cast_motion, RID, const Transform2D &, const Vector2 &, real_t, uint32_t, bool, bool, GDExtensionPtr<real_t>, GDExtensionPtr<real_t>)
134 GDVIRTUAL10R(bool, _collide_shape, RID, const Transform2D &, const Vector2 &, real_t, uint32_t, bool, bool, GDExtensionPtr<Vector2>, int, GDExtensionPtr<int>)
135 GDVIRTUAL8R(bool, _rest_info, RID, const Transform2D &, const Vector2 &, real_t, uint32_t, bool, bool, GDExtensionPtr<PhysicsServer2DExtensionShapeRestInfo>)
136
137public:
138 virtual bool intersect_ray(const RayParameters &p_parameters, RayResult &r_result) override {
139 exclude = &p_parameters.exclude;
140 bool ret = false;
141 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);
142 exclude = nullptr;
143 return ret;
144 }
145 virtual int intersect_point(const PointParameters &p_parameters, ShapeResult *r_results, int p_result_max) override {
146 exclude = &p_parameters.exclude;
147 int ret = false;
148 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);
149 exclude = nullptr;
150 return ret;
151 }
152 virtual int intersect_shape(const ShapeParameters &p_parameters, ShapeResult *r_results, int p_result_max) override {
153 exclude = &p_parameters.exclude;
154 int ret = 0;
155 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);
156 exclude = nullptr;
157 return ret;
158 }
159 virtual bool cast_motion(const ShapeParameters &p_parameters, real_t &p_closest_safe, real_t &p_closest_unsafe) override {
160 exclude = &p_parameters.exclude;
161 bool ret = false;
162 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);
163 exclude = nullptr;
164 return ret;
165 }
166 virtual bool collide_shape(const ShapeParameters &p_parameters, Vector2 *r_results, int p_result_max, int &r_result_count) override {
167 exclude = &p_parameters.exclude;
168 bool ret = false;
169 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);
170 exclude = nullptr;
171 return ret;
172 }
173 virtual bool rest_info(const ShapeParameters &p_parameters, ShapeRestInfo *r_info) override {
174 exclude = &p_parameters.exclude;
175 bool ret = false;
176 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);
177 exclude = nullptr;
178 return ret;
179 }
180
181 PhysicsDirectSpaceState2DExtension();
182};
183
184typedef PhysicsServer2D::MotionResult PhysicsServer2DExtensionMotionResult;
185
186GDVIRTUAL_NATIVE_PTR(PhysicsServer2DExtensionMotionResult)
187
188class PhysicsServer2DExtension : public PhysicsServer2D {
189 GDCLASS(PhysicsServer2DExtension, PhysicsServer2D);
190
191protected:
192 static void _bind_methods();
193
194 GDVIRTUAL9R(bool, _shape_collide, RID, const Transform2D &, const Vector2 &, RID, const Transform2D &, const Vector2 &, GDExtensionPtr<Vector2>, int, GDExtensionPtr<int>)
195
196 GDVIRTUAL8R(bool, _body_collide_shape, RID, int, RID, const Transform2D &, const Vector2 &, GDExtensionPtr<Vector2>, int, GDExtensionPtr<int>)
197
198public:
199 // The warning is valid, but unavoidable. If the function is not overridden it will error anyway.
200
201 /* SHAPE API */
202
203 EXBIND0R(RID, world_boundary_shape_create)
204 EXBIND0R(RID, separation_ray_shape_create)
205 EXBIND0R(RID, segment_shape_create)
206 EXBIND0R(RID, circle_shape_create)
207 EXBIND0R(RID, rectangle_shape_create)
208 EXBIND0R(RID, capsule_shape_create)
209 EXBIND0R(RID, convex_polygon_shape_create)
210 EXBIND0R(RID, concave_polygon_shape_create)
211
212 EXBIND2(shape_set_data, RID, const Variant &)
213 EXBIND2(shape_set_custom_solver_bias, RID, real_t)
214
215 EXBIND1RC(ShapeType, shape_get_type, RID)
216 EXBIND1RC(Variant, shape_get_data, RID)
217 EXBIND1RC(real_t, shape_get_custom_solver_bias, RID)
218
219 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 {
220 bool ret = false;
221 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);
222 return ret;
223 }
224
225 /* SPACE API */
226
227 EXBIND0R(RID, space_create)
228 EXBIND2(space_set_active, RID, bool)
229 EXBIND1RC(bool, space_is_active, RID)
230
231 EXBIND3(space_set_param, RID, SpaceParameter, real_t)
232 EXBIND2RC(real_t, space_get_param, RID, SpaceParameter)
233
234 EXBIND1R(PhysicsDirectSpaceState2D *, space_get_direct_state, RID)
235
236 EXBIND2(space_set_debug_contacts, RID, int)
237 EXBIND1RC(Vector<Vector2>, space_get_contacts, RID)
238 EXBIND1RC(int, space_get_contact_count, RID)
239
240 /* AREA API */
241
242 //EXBIND0RID(area);
243 EXBIND0R(RID, area_create)
244
245 EXBIND2(area_set_space, RID, RID)
246 EXBIND1RC(RID, area_get_space, RID)
247
248 EXBIND4(area_add_shape, RID, RID, const Transform2D &, bool)
249 EXBIND3(area_set_shape, RID, int, RID)
250 EXBIND3(area_set_shape_transform, RID, int, const Transform2D &)
251 EXBIND3(area_set_shape_disabled, RID, int, bool)
252
253 EXBIND1RC(int, area_get_shape_count, RID)
254 EXBIND2RC(RID, area_get_shape, RID, int)
255 EXBIND2RC(Transform2D, area_get_shape_transform, RID, int)
256
257 EXBIND2(area_remove_shape, RID, int)
258 EXBIND1(area_clear_shapes, RID)
259
260 EXBIND2(area_attach_object_instance_id, RID, ObjectID)
261 EXBIND1RC(ObjectID, area_get_object_instance_id, RID)
262
263 EXBIND2(area_attach_canvas_instance_id, RID, ObjectID)
264 EXBIND1RC(ObjectID, area_get_canvas_instance_id, RID)
265
266 EXBIND3(area_set_param, RID, AreaParameter, const Variant &)
267 EXBIND2(area_set_transform, RID, const Transform2D &)
268
269 EXBIND2RC(Variant, area_get_param, RID, AreaParameter)
270 EXBIND1RC(Transform2D, area_get_transform, RID)
271
272 EXBIND2(area_set_collision_layer, RID, uint32_t)
273 EXBIND1RC(uint32_t, area_get_collision_layer, RID)
274
275 EXBIND2(area_set_collision_mask, RID, uint32_t)
276 EXBIND1RC(uint32_t, area_get_collision_mask, RID)
277
278 EXBIND2(area_set_monitorable, RID, bool)
279 EXBIND2(area_set_pickable, RID, bool)
280
281 EXBIND2(area_set_monitor_callback, RID, const Callable &)
282 EXBIND2(area_set_area_monitor_callback, RID, const Callable &)
283
284 /* BODY API */
285
286 //EXBIND2RID(body,BodyMode,bool);
287 EXBIND0R(RID, body_create)
288
289 EXBIND2(body_set_space, RID, RID)
290 EXBIND1RC(RID, body_get_space, RID)
291
292 EXBIND2(body_set_mode, RID, BodyMode)
293 EXBIND1RC(BodyMode, body_get_mode, RID)
294
295 EXBIND4(body_add_shape, RID, RID, const Transform2D &, bool)
296 EXBIND3(body_set_shape, RID, int, RID)
297 EXBIND3(body_set_shape_transform, RID, int, const Transform2D &)
298
299 EXBIND1RC(int, body_get_shape_count, RID)
300 EXBIND2RC(RID, body_get_shape, RID, int)
301 EXBIND2RC(Transform2D, body_get_shape_transform, RID, int)
302
303 EXBIND3(body_set_shape_disabled, RID, int, bool)
304 EXBIND4(body_set_shape_as_one_way_collision, RID, int, bool, real_t)
305
306 EXBIND2(body_remove_shape, RID, int)
307 EXBIND1(body_clear_shapes, RID)
308
309 EXBIND2(body_attach_object_instance_id, RID, ObjectID)
310 EXBIND1RC(ObjectID, body_get_object_instance_id, RID)
311
312 EXBIND2(body_attach_canvas_instance_id, RID, ObjectID)
313 EXBIND1RC(ObjectID, body_get_canvas_instance_id, RID)
314
315 EXBIND2(body_set_continuous_collision_detection_mode, RID, CCDMode)
316 EXBIND1RC(CCDMode, body_get_continuous_collision_detection_mode, RID)
317
318 EXBIND2(body_set_collision_layer, RID, uint32_t)
319 EXBIND1RC(uint32_t, body_get_collision_layer, RID)
320
321 EXBIND2(body_set_collision_mask, RID, uint32_t)
322 EXBIND1RC(uint32_t, body_get_collision_mask, RID)
323
324 EXBIND2(body_set_collision_priority, RID, real_t)
325 EXBIND1RC(real_t, body_get_collision_priority, RID)
326
327 EXBIND3(body_set_param, RID, BodyParameter, const Variant &)
328 EXBIND2RC(Variant, body_get_param, RID, BodyParameter)
329
330 EXBIND1(body_reset_mass_properties, RID)
331
332 EXBIND3(body_set_state, RID, BodyState, const Variant &)
333 EXBIND2RC(Variant, body_get_state, RID, BodyState)
334
335 EXBIND2(body_apply_central_impulse, RID, const Vector2 &)
336 EXBIND2(body_apply_torque_impulse, RID, real_t)
337 EXBIND3(body_apply_impulse, RID, const Vector2 &, const Vector2 &)
338
339 EXBIND2(body_apply_central_force, RID, const Vector2 &)
340 EXBIND3(body_apply_force, RID, const Vector2 &, const Vector2 &)
341 EXBIND2(body_apply_torque, RID, real_t)
342
343 EXBIND2(body_add_constant_central_force, RID, const Vector2 &)
344 EXBIND3(body_add_constant_force, RID, const Vector2 &, const Vector2 &)
345 EXBIND2(body_add_constant_torque, RID, real_t)
346
347 EXBIND2(body_set_constant_force, RID, const Vector2 &)
348 EXBIND1RC(Vector2, body_get_constant_force, RID)
349
350 EXBIND2(body_set_constant_torque, RID, real_t)
351 EXBIND1RC(real_t, body_get_constant_torque, RID)
352
353 EXBIND2(body_set_axis_velocity, RID, const Vector2 &)
354
355 EXBIND2(body_add_collision_exception, RID, RID)
356 EXBIND2(body_remove_collision_exception, RID, RID)
357 GDVIRTUAL1RC(TypedArray<RID>, _body_get_collision_exceptions, RID)
358
359 void body_get_collision_exceptions(RID p_body, List<RID> *p_exceptions) override {
360 TypedArray<RID> ret;
361 GDVIRTUAL_REQUIRED_CALL(_body_get_collision_exceptions, p_body, ret);
362 for (int i = 0; i < ret.size(); i++) {
363 p_exceptions->push_back(ret[i]);
364 }
365 }
366
367 EXBIND2(body_set_max_contacts_reported, RID, int)
368 EXBIND1RC(int, body_get_max_contacts_reported, RID)
369
370 EXBIND2(body_set_contacts_reported_depth_threshold, RID, real_t)
371 EXBIND1RC(real_t, body_get_contacts_reported_depth_threshold, RID)
372
373 EXBIND2(body_set_omit_force_integration, RID, bool)
374 EXBIND1RC(bool, body_is_omitting_force_integration, RID)
375
376 EXBIND2(body_set_state_sync_callback, RID, const Callable &)
377 EXBIND3(body_set_force_integration_callback, RID, const Callable &, const Variant &)
378
379 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 {
380 bool ret = false;
381 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);
382 return ret;
383 }
384
385 EXBIND2(body_set_pickable, RID, bool)
386
387 EXBIND1R(PhysicsDirectBodyState2D *, body_get_direct_state, RID)
388
389 GDVIRTUAL7RC(bool, _body_test_motion, RID, const Transform2D &, const Vector2 &, real_t, bool, bool, GDExtensionPtr<PhysicsServer2DExtensionMotionResult>)
390
391 thread_local static const HashSet<RID> *exclude_bodies;
392 thread_local static const HashSet<ObjectID> *exclude_objects;
393
394 bool body_test_motion_is_excluding_body(RID p_body) const;
395 bool body_test_motion_is_excluding_object(ObjectID p_object) const;
396
397 bool body_test_motion(RID p_body, const MotionParameters &p_parameters, MotionResult *r_result = nullptr) override {
398 bool ret = false;
399 exclude_bodies = &p_parameters.exclude_bodies;
400 exclude_objects = &p_parameters.exclude_objects;
401 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);
402 exclude_bodies = nullptr;
403 exclude_objects = nullptr;
404 return ret;
405 }
406
407 /* JOINT API */
408
409 EXBIND0R(RID, joint_create)
410 EXBIND1(joint_clear, RID)
411
412 EXBIND3(joint_set_param, RID, JointParam, real_t)
413 EXBIND2RC(real_t, joint_get_param, RID, JointParam)
414
415 EXBIND2(joint_disable_collisions_between_bodies, RID, bool)
416 EXBIND1RC(bool, joint_is_disabled_collisions_between_bodies, RID)
417
418 EXBIND4(joint_make_pin, RID, const Vector2 &, RID, RID)
419 EXBIND6(joint_make_groove, RID, const Vector2 &, const Vector2 &, const Vector2 &, RID, RID)
420 EXBIND5(joint_make_damped_spring, RID, const Vector2 &, const Vector2 &, RID, RID)
421
422 EXBIND3(pin_joint_set_param, RID, PinJointParam, real_t)
423 EXBIND2RC(real_t, pin_joint_get_param, RID, PinJointParam)
424
425 EXBIND3(damped_spring_joint_set_param, RID, DampedSpringParam, real_t)
426 EXBIND2RC(real_t, damped_spring_joint_get_param, RID, DampedSpringParam)
427
428 EXBIND1RC(JointType, joint_get_type, RID)
429
430 /* MISC */
431
432 GDVIRTUAL1(_free_rid, RID)
433 virtual void free(RID p_rid) override {
434 GDVIRTUAL_REQUIRED_CALL(_free_rid, p_rid);
435 }
436
437 EXBIND1(set_active, bool)
438
439 EXBIND0(init)
440 EXBIND1(step, real_t)
441 EXBIND0(sync)
442 EXBIND0(flush_queries)
443 EXBIND0(end_sync)
444 EXBIND0(finish)
445
446 EXBIND0RC(bool, is_flushing_queries)
447 EXBIND1R(int, get_process_info, ProcessInfo)
448
449 PhysicsServer2DExtension();
450 ~PhysicsServer2DExtension();
451};
452
453#endif // PHYSICS_SERVER_2D_EXTENSION_H
454