Book a Demo!
CoCalc Logo Icon
StoreFeaturesDocsShareSupportNewsAboutPoliciesSign UpSign In
godotengine
GitHub Repository: godotengine/godot
Path: blob/master/servers/physics_2d/physics_server_2d.h
11322 views
1
/**************************************************************************/
2
/* physics_server_2d.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
#pragma once
32
33
#include "core/io/resource.h"
34
#include "core/object/class_db.h"
35
#include "core/object/ref_counted.h"
36
37
constexpr int MAX_CONTACTS_REPORTED_2D_MAX = 4096;
38
39
class PhysicsDirectSpaceState2D;
40
template <typename T>
41
class TypedArray;
42
43
class PhysicsDirectBodyState2D : public Object {
44
GDCLASS(PhysicsDirectBodyState2D, Object);
45
46
protected:
47
static void _bind_methods();
48
49
public:
50
virtual Vector2 get_total_gravity() const = 0; // get gravity vector working on this body space/area
51
virtual real_t get_total_linear_damp() const = 0; // get density of this body space/area
52
virtual real_t get_total_angular_damp() const = 0; // get density of this body space/area
53
54
virtual Vector2 get_center_of_mass() const = 0;
55
virtual Vector2 get_center_of_mass_local() const = 0;
56
virtual real_t get_inverse_mass() const = 0; // get the mass
57
virtual real_t get_inverse_inertia() const = 0; // get density of this body space
58
59
virtual void set_linear_velocity(const Vector2 &p_velocity) = 0;
60
virtual Vector2 get_linear_velocity() const = 0;
61
62
virtual void set_angular_velocity(real_t p_velocity) = 0;
63
virtual real_t get_angular_velocity() const = 0;
64
65
virtual void set_transform(const Transform2D &p_transform) = 0;
66
virtual Transform2D get_transform() const = 0;
67
68
virtual Vector2 get_velocity_at_local_position(const Vector2 &p_position) const = 0;
69
70
virtual void apply_central_impulse(const Vector2 &p_impulse) = 0;
71
virtual void apply_torque_impulse(real_t p_torque) = 0;
72
virtual void apply_impulse(const Vector2 &p_impulse, const Vector2 &p_position = Vector2()) = 0;
73
74
virtual void apply_central_force(const Vector2 &p_force) = 0;
75
virtual void apply_force(const Vector2 &p_force, const Vector2 &p_position = Vector2()) = 0;
76
virtual void apply_torque(real_t p_torque) = 0;
77
78
virtual void add_constant_central_force(const Vector2 &p_force) = 0;
79
virtual void add_constant_force(const Vector2 &p_force, const Vector2 &p_position = Vector2()) = 0;
80
virtual void add_constant_torque(real_t p_torque) = 0;
81
82
virtual void set_constant_force(const Vector2 &p_force) = 0;
83
virtual Vector2 get_constant_force() const = 0;
84
85
virtual void set_constant_torque(real_t p_torque) = 0;
86
virtual real_t get_constant_torque() const = 0;
87
88
virtual void set_sleep_state(bool p_enable) = 0;
89
virtual bool is_sleeping() const = 0;
90
91
virtual void set_collision_layer(uint32_t p_layer) = 0;
92
virtual uint32_t get_collision_layer() const = 0;
93
94
virtual void set_collision_mask(uint32_t p_mask) = 0;
95
virtual uint32_t get_collision_mask() const = 0;
96
97
virtual int get_contact_count() const = 0;
98
99
virtual Vector2 get_contact_local_position(int p_contact_idx) const = 0;
100
virtual Vector2 get_contact_local_normal(int p_contact_idx) const = 0;
101
virtual int get_contact_local_shape(int p_contact_idx) const = 0;
102
virtual Vector2 get_contact_local_velocity_at_position(int p_contact_idx) const = 0;
103
104
virtual RID get_contact_collider(int p_contact_idx) const = 0;
105
virtual Vector2 get_contact_collider_position(int p_contact_idx) const = 0;
106
virtual ObjectID get_contact_collider_id(int p_contact_idx) const = 0;
107
virtual Object *get_contact_collider_object(int p_contact_idx) const;
108
virtual int get_contact_collider_shape(int p_contact_idx) const = 0;
109
virtual Vector2 get_contact_collider_velocity_at_position(int p_contact_idx) const = 0;
110
virtual Vector2 get_contact_impulse(int p_contact_idx) const = 0;
111
112
virtual real_t get_step() const = 0;
113
virtual void integrate_forces();
114
115
virtual PhysicsDirectSpaceState2D *get_space_state() = 0;
116
117
PhysicsDirectBodyState2D();
118
};
119
120
class PhysicsRayQueryParameters2D;
121
class PhysicsPointQueryParameters2D;
122
class PhysicsShapeQueryParameters2D;
123
124
class PhysicsDirectSpaceState2D : public Object {
125
GDCLASS(PhysicsDirectSpaceState2D, Object);
126
127
Dictionary _intersect_ray(const Ref<PhysicsRayQueryParameters2D> &p_ray_query);
128
TypedArray<Dictionary> _intersect_point(const Ref<PhysicsPointQueryParameters2D> &p_point_query, int p_max_results = 32);
129
TypedArray<Dictionary> _intersect_shape(const Ref<PhysicsShapeQueryParameters2D> &p_shape_query, int p_max_results = 32);
130
Vector<real_t> _cast_motion(const Ref<PhysicsShapeQueryParameters2D> &p_shape_query);
131
TypedArray<Vector2> _collide_shape(const Ref<PhysicsShapeQueryParameters2D> &p_shape_query, int p_max_results = 32);
132
Dictionary _get_rest_info(const Ref<PhysicsShapeQueryParameters2D> &p_shape_query);
133
134
protected:
135
static void _bind_methods();
136
137
public:
138
struct RayParameters {
139
Vector2 from;
140
Vector2 to;
141
HashSet<RID> exclude;
142
uint32_t collision_mask = UINT32_MAX;
143
144
bool collide_with_bodies = true;
145
bool collide_with_areas = false;
146
147
bool hit_from_inside = false;
148
};
149
150
struct RayResult {
151
Vector2 position;
152
Vector2 normal;
153
RID rid;
154
ObjectID collider_id;
155
Object *collider = nullptr;
156
int shape = 0;
157
};
158
159
virtual bool intersect_ray(const RayParameters &p_parameters, RayResult &r_result) = 0;
160
161
struct ShapeResult {
162
RID rid;
163
ObjectID collider_id;
164
Object *collider = nullptr;
165
int shape = 0;
166
};
167
168
struct PointParameters {
169
Vector2 position;
170
ObjectID canvas_instance_id;
171
HashSet<RID> exclude;
172
uint32_t collision_mask = UINT32_MAX;
173
174
bool collide_with_bodies = true;
175
bool collide_with_areas = false;
176
177
bool pick_point = false;
178
};
179
180
virtual int intersect_point(const PointParameters &p_parameters, ShapeResult *r_results, int p_result_max) = 0;
181
182
struct ShapeParameters {
183
RID shape_rid;
184
Transform2D transform;
185
Vector2 motion;
186
real_t margin = 0.0;
187
HashSet<RID> exclude;
188
uint32_t collision_mask = UINT32_MAX;
189
190
bool collide_with_bodies = true;
191
bool collide_with_areas = false;
192
};
193
194
struct ShapeRestInfo {
195
Vector2 point;
196
Vector2 normal;
197
RID rid;
198
ObjectID collider_id;
199
int shape = 0;
200
Vector2 linear_velocity; // Velocity at contact point.
201
};
202
203
virtual int intersect_shape(const ShapeParameters &p_parameters, ShapeResult *r_results, int p_result_max) = 0;
204
virtual bool cast_motion(const ShapeParameters &p_parameters, real_t &p_closest_safe, real_t &p_closest_unsafe) = 0;
205
virtual bool collide_shape(const ShapeParameters &p_parameters, Vector2 *r_results, int p_result_max, int &r_result_count) = 0;
206
virtual bool rest_info(const ShapeParameters &p_parameters, ShapeRestInfo *r_info) = 0;
207
208
PhysicsDirectSpaceState2D();
209
};
210
211
class PhysicsTestMotionParameters2D;
212
class PhysicsTestMotionResult2D;
213
214
class PhysicsServer2D : public Object {
215
GDCLASS(PhysicsServer2D, Object);
216
217
static PhysicsServer2D *singleton;
218
219
virtual bool _body_test_motion(RID p_body, const Ref<PhysicsTestMotionParameters2D> &p_parameters, const Ref<PhysicsTestMotionResult2D> &p_result = Ref<PhysicsTestMotionResult2D>());
220
221
protected:
222
static void _bind_methods();
223
224
public:
225
static PhysicsServer2D *get_singleton();
226
227
enum ShapeType {
228
SHAPE_WORLD_BOUNDARY, ///< plane:"plane"
229
SHAPE_SEPARATION_RAY, ///< float:"length"
230
SHAPE_SEGMENT, ///< float:"length"
231
SHAPE_CIRCLE, ///< float:"radius"
232
SHAPE_RECTANGLE, ///< vec3:"extents"
233
SHAPE_CAPSULE,
234
SHAPE_CONVEX_POLYGON, ///< array of planes:"planes"
235
SHAPE_CONCAVE_POLYGON, ///< Vector2 array:"triangles" , or Dictionary with "indices" (int array) and "triangles" (Vector2 array)
236
SHAPE_CUSTOM, ///< Server-Implementation based custom shape, calling shape_create() with this value will result in an error
237
};
238
239
virtual RID world_boundary_shape_create() = 0;
240
virtual RID separation_ray_shape_create() = 0;
241
virtual RID segment_shape_create() = 0;
242
virtual RID circle_shape_create() = 0;
243
virtual RID rectangle_shape_create() = 0;
244
virtual RID capsule_shape_create() = 0;
245
virtual RID convex_polygon_shape_create() = 0;
246
virtual RID concave_polygon_shape_create() = 0;
247
248
virtual void shape_set_data(RID p_shape, const Variant &p_data) = 0;
249
virtual void shape_set_custom_solver_bias(RID p_shape, real_t p_bias) = 0;
250
251
virtual ShapeType shape_get_type(RID p_shape) const = 0;
252
virtual Variant shape_get_data(RID p_shape) const = 0;
253
virtual real_t shape_get_custom_solver_bias(RID p_shape) const = 0;
254
255
//these work well, but should be used from the main thread only
256
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) = 0;
257
258
/* SPACE API */
259
260
virtual RID space_create() = 0;
261
virtual void space_set_active(RID p_space, bool p_active) = 0;
262
virtual bool space_is_active(RID p_space) const = 0;
263
264
enum SpaceParameter {
265
SPACE_PARAM_CONTACT_RECYCLE_RADIUS,
266
SPACE_PARAM_CONTACT_MAX_SEPARATION,
267
SPACE_PARAM_CONTACT_MAX_ALLOWED_PENETRATION,
268
SPACE_PARAM_CONTACT_DEFAULT_BIAS,
269
SPACE_PARAM_BODY_LINEAR_VELOCITY_SLEEP_THRESHOLD,
270
SPACE_PARAM_BODY_ANGULAR_VELOCITY_SLEEP_THRESHOLD,
271
SPACE_PARAM_BODY_TIME_TO_SLEEP,
272
SPACE_PARAM_CONSTRAINT_DEFAULT_BIAS,
273
SPACE_PARAM_SOLVER_ITERATIONS,
274
};
275
276
virtual void space_set_param(RID p_space, SpaceParameter p_param, real_t p_value) = 0;
277
virtual real_t space_get_param(RID p_space, SpaceParameter p_param) const = 0;
278
279
// this function only works on physics process, errors and returns null otherwise
280
virtual PhysicsDirectSpaceState2D *space_get_direct_state(RID p_space) = 0;
281
282
virtual void space_set_debug_contacts(RID p_space, int p_max_contacts) = 0;
283
virtual Vector<Vector2> space_get_contacts(RID p_space) const = 0;
284
virtual int space_get_contact_count(RID p_space) const = 0;
285
286
//missing space parameters
287
288
/* AREA API */
289
290
//missing attenuation? missing better override?
291
292
enum AreaParameter {
293
AREA_PARAM_GRAVITY_OVERRIDE_MODE,
294
AREA_PARAM_GRAVITY,
295
AREA_PARAM_GRAVITY_VECTOR,
296
AREA_PARAM_GRAVITY_IS_POINT,
297
AREA_PARAM_GRAVITY_POINT_UNIT_DISTANCE,
298
AREA_PARAM_LINEAR_DAMP_OVERRIDE_MODE,
299
AREA_PARAM_LINEAR_DAMP,
300
AREA_PARAM_ANGULAR_DAMP_OVERRIDE_MODE,
301
AREA_PARAM_ANGULAR_DAMP,
302
AREA_PARAM_PRIORITY
303
};
304
305
virtual RID area_create() = 0;
306
307
virtual void area_set_space(RID p_area, RID p_space) = 0;
308
virtual RID area_get_space(RID p_area) const = 0;
309
310
enum AreaSpaceOverrideMode {
311
AREA_SPACE_OVERRIDE_DISABLED,
312
AREA_SPACE_OVERRIDE_COMBINE,
313
AREA_SPACE_OVERRIDE_COMBINE_REPLACE, // Combines, then discards all subsequent calculations
314
AREA_SPACE_OVERRIDE_REPLACE,
315
AREA_SPACE_OVERRIDE_REPLACE_COMBINE // Discards all previous calculations, then keeps combining
316
};
317
318
virtual void area_add_shape(RID p_area, RID p_shape, const Transform2D &p_transform = Transform2D(), bool p_disabled = false) = 0;
319
virtual void area_set_shape(RID p_area, int p_shape_idx, RID p_shape) = 0;
320
virtual void area_set_shape_transform(RID p_area, int p_shape_idx, const Transform2D &p_transform) = 0;
321
322
virtual int area_get_shape_count(RID p_area) const = 0;
323
virtual RID area_get_shape(RID p_area, int p_shape_idx) const = 0;
324
virtual Transform2D area_get_shape_transform(RID p_area, int p_shape_idx) const = 0;
325
326
virtual void area_remove_shape(RID p_area, int p_shape_idx) = 0;
327
virtual void area_clear_shapes(RID p_area) = 0;
328
329
virtual void area_set_shape_disabled(RID p_area, int p_shape, bool p_disabled) = 0;
330
331
virtual void area_attach_object_instance_id(RID p_area, ObjectID p_id) = 0;
332
virtual ObjectID area_get_object_instance_id(RID p_area) const = 0;
333
334
virtual void area_attach_canvas_instance_id(RID p_area, ObjectID p_id) = 0;
335
virtual ObjectID area_get_canvas_instance_id(RID p_area) const = 0;
336
337
virtual void area_set_param(RID p_area, AreaParameter p_param, const Variant &p_value) = 0;
338
virtual void area_set_transform(RID p_area, const Transform2D &p_transform) = 0;
339
340
virtual Variant area_get_param(RID p_parea, AreaParameter p_param) const = 0;
341
virtual Transform2D area_get_transform(RID p_area) const = 0;
342
343
virtual void area_set_collision_layer(RID p_area, uint32_t p_layer) = 0;
344
virtual uint32_t area_get_collision_layer(RID p_area) const = 0;
345
346
virtual void area_set_collision_mask(RID p_area, uint32_t p_mask) = 0;
347
virtual uint32_t area_get_collision_mask(RID p_area) const = 0;
348
349
virtual void area_set_monitorable(RID p_area, bool p_monitorable) = 0;
350
virtual void area_set_pickable(RID p_area, bool p_pickable) = 0;
351
352
virtual void area_set_monitor_callback(RID p_area, const Callable &p_callback) = 0;
353
virtual void area_set_area_monitor_callback(RID p_area, const Callable &p_callback) = 0;
354
355
/* BODY API */
356
357
//missing ccd?
358
359
enum BodyMode {
360
BODY_MODE_STATIC,
361
BODY_MODE_KINEMATIC,
362
BODY_MODE_RIGID,
363
BODY_MODE_RIGID_LINEAR,
364
};
365
366
virtual RID body_create() = 0;
367
368
virtual void body_set_space(RID p_body, RID p_space) = 0;
369
virtual RID body_get_space(RID p_body) const = 0;
370
371
virtual void body_set_mode(RID p_body, BodyMode p_mode) = 0;
372
virtual BodyMode body_get_mode(RID p_body) const = 0;
373
374
virtual void body_add_shape(RID p_body, RID p_shape, const Transform2D &p_transform = Transform2D(), bool p_disabled = false) = 0;
375
virtual void body_set_shape(RID p_body, int p_shape_idx, RID p_shape) = 0;
376
virtual void body_set_shape_transform(RID p_body, int p_shape_idx, const Transform2D &p_transform) = 0;
377
378
virtual int body_get_shape_count(RID p_body) const = 0;
379
virtual RID body_get_shape(RID p_body, int p_shape_idx) const = 0;
380
virtual Transform2D body_get_shape_transform(RID p_body, int p_shape_idx) const = 0;
381
382
virtual void body_set_shape_disabled(RID p_body, int p_shape, bool p_disabled) = 0;
383
virtual void body_set_shape_as_one_way_collision(RID p_body, int p_shape, bool p_enabled, real_t p_margin = 0) = 0;
384
385
virtual void body_remove_shape(RID p_body, int p_shape_idx) = 0;
386
virtual void body_clear_shapes(RID p_body) = 0;
387
388
virtual void body_attach_object_instance_id(RID p_body, ObjectID p_id) = 0;
389
virtual ObjectID body_get_object_instance_id(RID p_body) const = 0;
390
391
virtual void body_attach_canvas_instance_id(RID p_body, ObjectID p_id) = 0;
392
virtual ObjectID body_get_canvas_instance_id(RID p_body) const = 0;
393
394
enum CCDMode {
395
CCD_MODE_DISABLED,
396
CCD_MODE_CAST_RAY,
397
CCD_MODE_CAST_SHAPE,
398
};
399
400
virtual void body_set_continuous_collision_detection_mode(RID p_body, CCDMode p_mode) = 0;
401
virtual CCDMode body_get_continuous_collision_detection_mode(RID p_body) const = 0;
402
403
virtual void body_set_collision_layer(RID p_body, uint32_t p_layer) = 0;
404
virtual uint32_t body_get_collision_layer(RID p_body) const = 0;
405
406
virtual void body_set_collision_mask(RID p_body, uint32_t p_mask) = 0;
407
virtual uint32_t body_get_collision_mask(RID p_body) const = 0;
408
409
virtual void body_set_collision_priority(RID p_body, real_t p_priority) = 0;
410
virtual real_t body_get_collision_priority(RID p_body) const = 0;
411
412
// common body variables
413
enum BodyParameter {
414
BODY_PARAM_BOUNCE,
415
BODY_PARAM_FRICTION,
416
BODY_PARAM_MASS, ///< unused for static, always infinite
417
BODY_PARAM_INERTIA,
418
BODY_PARAM_CENTER_OF_MASS,
419
BODY_PARAM_GRAVITY_SCALE,
420
BODY_PARAM_LINEAR_DAMP_MODE,
421
BODY_PARAM_ANGULAR_DAMP_MODE,
422
BODY_PARAM_LINEAR_DAMP,
423
BODY_PARAM_ANGULAR_DAMP,
424
BODY_PARAM_MAX,
425
};
426
427
enum BodyDampMode {
428
BODY_DAMP_MODE_COMBINE,
429
BODY_DAMP_MODE_REPLACE,
430
};
431
432
virtual void body_set_param(RID p_body, BodyParameter p_param, const Variant &p_value) = 0;
433
virtual Variant body_get_param(RID p_body, BodyParameter p_param) const = 0;
434
435
virtual void body_reset_mass_properties(RID p_body) = 0;
436
437
//state
438
enum BodyState {
439
BODY_STATE_TRANSFORM,
440
BODY_STATE_LINEAR_VELOCITY,
441
BODY_STATE_ANGULAR_VELOCITY,
442
BODY_STATE_SLEEPING,
443
BODY_STATE_CAN_SLEEP,
444
};
445
446
virtual void body_set_state(RID p_body, BodyState p_state, const Variant &p_variant) = 0;
447
virtual Variant body_get_state(RID p_body, BodyState p_state) const = 0;
448
449
virtual void body_apply_central_impulse(RID p_body, const Vector2 &p_impulse) = 0;
450
virtual void body_apply_torque_impulse(RID p_body, real_t p_torque) = 0;
451
virtual void body_apply_impulse(RID p_body, const Vector2 &p_impulse, const Vector2 &p_position = Vector2()) = 0;
452
453
virtual void body_apply_central_force(RID p_body, const Vector2 &p_force) = 0;
454
virtual void body_apply_force(RID p_body, const Vector2 &p_force, const Vector2 &p_position = Vector2()) = 0;
455
virtual void body_apply_torque(RID p_body, real_t p_torque) = 0;
456
457
virtual void body_add_constant_central_force(RID p_body, const Vector2 &p_force) = 0;
458
virtual void body_add_constant_force(RID p_body, const Vector2 &p_force, const Vector2 &p_position = Vector2()) = 0;
459
virtual void body_add_constant_torque(RID p_body, real_t p_torque) = 0;
460
461
virtual void body_set_constant_force(RID p_body, const Vector2 &p_force) = 0;
462
virtual Vector2 body_get_constant_force(RID p_body) const = 0;
463
464
virtual void body_set_constant_torque(RID p_body, real_t p_torque) = 0;
465
virtual real_t body_get_constant_torque(RID p_body) const = 0;
466
467
virtual void body_set_axis_velocity(RID p_body, const Vector2 &p_axis_velocity) = 0;
468
469
//fix
470
virtual void body_add_collision_exception(RID p_body, RID p_body_b) = 0;
471
virtual void body_remove_collision_exception(RID p_body, RID p_body_b) = 0;
472
virtual void body_get_collision_exceptions(RID p_body, List<RID> *p_exceptions) = 0;
473
474
virtual void body_set_max_contacts_reported(RID p_body, int p_contacts) = 0;
475
virtual int body_get_max_contacts_reported(RID p_body) const = 0;
476
477
//missing remove
478
virtual void body_set_contacts_reported_depth_threshold(RID p_body, real_t p_threshold) = 0;
479
virtual real_t body_get_contacts_reported_depth_threshold(RID p_body) const = 0;
480
481
virtual void body_set_omit_force_integration(RID p_body, bool p_omit) = 0;
482
virtual bool body_is_omitting_force_integration(RID p_body) const = 0;
483
484
virtual void body_set_state_sync_callback(RID p_body, const Callable &p_callable) = 0;
485
virtual void body_set_force_integration_callback(RID p_body, const Callable &p_callable, const Variant &p_udata = Variant()) = 0;
486
487
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) = 0;
488
489
virtual void body_set_pickable(RID p_body, bool p_pickable) = 0;
490
491
// this function only works on physics process, errors and returns null otherwise
492
virtual PhysicsDirectBodyState2D *body_get_direct_state(RID p_body) = 0;
493
494
struct MotionParameters {
495
Transform2D from;
496
Vector2 motion;
497
real_t margin = 0.08;
498
bool collide_separation_ray = false;
499
HashSet<RID> exclude_bodies;
500
HashSet<ObjectID> exclude_objects;
501
bool recovery_as_collision = false;
502
503
MotionParameters() {}
504
505
MotionParameters(const Transform2D &p_from, const Vector2 &p_motion, real_t p_margin = 0.08) :
506
from(p_from),
507
motion(p_motion),
508
margin(p_margin) {}
509
};
510
511
struct MotionResult {
512
Vector2 travel;
513
Vector2 remainder;
514
515
Vector2 collision_point;
516
Vector2 collision_normal;
517
Vector2 collider_velocity;
518
real_t collision_depth = 0.0;
519
real_t collision_safe_fraction = 0.0;
520
real_t collision_unsafe_fraction = 0.0;
521
int collision_local_shape = 0;
522
ObjectID collider_id;
523
RID collider;
524
int collider_shape = 0;
525
526
real_t get_angle(Vector2 p_up_direction) const {
527
return Math::acos(collision_normal.dot(p_up_direction));
528
}
529
};
530
531
virtual bool body_test_motion(RID p_body, const MotionParameters &p_parameters, MotionResult *r_result = nullptr) = 0;
532
533
/* JOINT API */
534
535
virtual RID joint_create() = 0;
536
537
virtual void joint_clear(RID p_joint) = 0;
538
539
enum JointType {
540
JOINT_TYPE_PIN,
541
JOINT_TYPE_GROOVE,
542
JOINT_TYPE_DAMPED_SPRING,
543
JOINT_TYPE_MAX
544
};
545
546
enum JointParam {
547
JOINT_PARAM_BIAS,
548
JOINT_PARAM_MAX_BIAS,
549
JOINT_PARAM_MAX_FORCE,
550
};
551
552
virtual void joint_set_param(RID p_joint, JointParam p_param, real_t p_value) = 0;
553
virtual real_t joint_get_param(RID p_joint, JointParam p_param) const = 0;
554
555
virtual void joint_disable_collisions_between_bodies(RID p_joint, const bool p_disable) = 0;
556
virtual bool joint_is_disabled_collisions_between_bodies(RID p_joint) const = 0;
557
558
virtual void joint_make_pin(RID p_joint, const Vector2 &p_anchor, RID p_body_a, RID p_body_b = RID()) = 0;
559
virtual void joint_make_groove(RID p_joint, const Vector2 &p_a_groove1, const Vector2 &p_a_groove2, const Vector2 &p_b_anchor, RID p_body_a, RID p_body_b) = 0;
560
virtual void joint_make_damped_spring(RID p_joint, const Vector2 &p_anchor_a, const Vector2 &p_anchor_b, RID p_body_a, RID p_body_b = RID()) = 0;
561
562
enum PinJointParam {
563
PIN_JOINT_SOFTNESS,
564
PIN_JOINT_LIMIT_UPPER,
565
PIN_JOINT_LIMIT_LOWER,
566
PIN_JOINT_MOTOR_TARGET_VELOCITY
567
};
568
569
virtual void pin_joint_set_param(RID p_joint, PinJointParam p_param, real_t p_value) = 0;
570
virtual real_t pin_joint_get_param(RID p_joint, PinJointParam p_param) const = 0;
571
572
enum PinJointFlag {
573
PIN_JOINT_FLAG_ANGULAR_LIMIT_ENABLED,
574
PIN_JOINT_FLAG_MOTOR_ENABLED
575
};
576
577
virtual void pin_joint_set_flag(RID p_joint, PinJointFlag p_flag, bool p_enabled) = 0;
578
virtual bool pin_joint_get_flag(RID p_joint, PinJointFlag p_flag) const = 0;
579
580
enum DampedSpringParam {
581
DAMPED_SPRING_REST_LENGTH,
582
DAMPED_SPRING_STIFFNESS,
583
DAMPED_SPRING_DAMPING
584
};
585
virtual void damped_spring_joint_set_param(RID p_joint, DampedSpringParam p_param, real_t p_value) = 0;
586
virtual real_t damped_spring_joint_get_param(RID p_joint, DampedSpringParam p_param) const = 0;
587
588
virtual JointType joint_get_type(RID p_joint) const = 0;
589
590
/* QUERY API */
591
592
enum AreaBodyStatus {
593
AREA_BODY_ADDED,
594
AREA_BODY_REMOVED
595
};
596
597
/* MISC */
598
599
virtual void free_rid(RID p_rid) = 0;
600
#ifndef DISABLE_DEPRECATED
601
[[deprecated("Use `free_rid()` instead.")]] void free(RID p_rid) {
602
free_rid(p_rid);
603
}
604
#endif // DISABLE_DEPRECATED
605
606
virtual void set_active(bool p_active) = 0;
607
virtual void init() = 0;
608
virtual void step(real_t p_step) = 0;
609
virtual void sync() = 0;
610
virtual void flush_queries() = 0;
611
virtual void end_sync() = 0;
612
virtual void finish() = 0;
613
614
virtual bool is_flushing_queries() const = 0;
615
616
enum ProcessInfo {
617
INFO_ACTIVE_OBJECTS,
618
INFO_COLLISION_PAIRS,
619
INFO_ISLAND_COUNT
620
};
621
622
virtual int get_process_info(ProcessInfo p_info) = 0;
623
624
PhysicsServer2D();
625
~PhysicsServer2D();
626
};
627
628
class PhysicsRayQueryParameters2D : public RefCounted {
629
GDCLASS(PhysicsRayQueryParameters2D, RefCounted);
630
631
PhysicsDirectSpaceState2D::RayParameters parameters;
632
633
protected:
634
static void _bind_methods();
635
636
public:
637
static Ref<PhysicsRayQueryParameters2D> create(Vector2 p_from, Vector2 p_to, uint32_t p_mask, const TypedArray<RID> &p_exclude);
638
const PhysicsDirectSpaceState2D::RayParameters &get_parameters() const { return parameters; }
639
640
void set_from(const Vector2 &p_from) { parameters.from = p_from; }
641
const Vector2 &get_from() const { return parameters.from; }
642
643
void set_to(const Vector2 &p_to) { parameters.to = p_to; }
644
const Vector2 &get_to() const { return parameters.to; }
645
646
void set_collision_mask(uint32_t p_mask) { parameters.collision_mask = p_mask; }
647
uint32_t get_collision_mask() const { return parameters.collision_mask; }
648
649
void set_collide_with_bodies(bool p_enable) { parameters.collide_with_bodies = p_enable; }
650
bool is_collide_with_bodies_enabled() const { return parameters.collide_with_bodies; }
651
652
void set_collide_with_areas(bool p_enable) { parameters.collide_with_areas = p_enable; }
653
bool is_collide_with_areas_enabled() const { return parameters.collide_with_areas; }
654
655
void set_hit_from_inside(bool p_enable) { parameters.hit_from_inside = p_enable; }
656
bool is_hit_from_inside_enabled() const { return parameters.hit_from_inside; }
657
658
void set_exclude(const TypedArray<RID> &p_exclude);
659
TypedArray<RID> get_exclude() const;
660
};
661
662
class PhysicsPointQueryParameters2D : public RefCounted {
663
GDCLASS(PhysicsPointQueryParameters2D, RefCounted);
664
665
PhysicsDirectSpaceState2D::PointParameters parameters;
666
667
protected:
668
static void _bind_methods();
669
670
public:
671
const PhysicsDirectSpaceState2D::PointParameters &get_parameters() const { return parameters; }
672
673
void set_position(const Vector2 &p_position) { parameters.position = p_position; }
674
const Vector2 &get_position() const { return parameters.position; }
675
676
void set_canvas_instance_id(ObjectID p_canvas_instance_id) { parameters.canvas_instance_id = p_canvas_instance_id; }
677
ObjectID get_canvas_instance_id() const { return parameters.canvas_instance_id; }
678
679
void set_collision_mask(uint32_t p_mask) { parameters.collision_mask = p_mask; }
680
uint32_t get_collision_mask() const { return parameters.collision_mask; }
681
682
void set_collide_with_bodies(bool p_enable) { parameters.collide_with_bodies = p_enable; }
683
bool is_collide_with_bodies_enabled() const { return parameters.collide_with_bodies; }
684
685
void set_collide_with_areas(bool p_enable) { parameters.collide_with_areas = p_enable; }
686
bool is_collide_with_areas_enabled() const { return parameters.collide_with_areas; }
687
688
void set_exclude(const TypedArray<RID> &p_exclude);
689
TypedArray<RID> get_exclude() const;
690
};
691
692
class PhysicsShapeQueryParameters2D : public RefCounted {
693
GDCLASS(PhysicsShapeQueryParameters2D, RefCounted);
694
695
PhysicsDirectSpaceState2D::ShapeParameters parameters;
696
697
Ref<Resource> shape_ref;
698
699
protected:
700
static void _bind_methods();
701
702
public:
703
const PhysicsDirectSpaceState2D::ShapeParameters &get_parameters() const { return parameters; }
704
705
void set_shape(const Ref<Resource> &p_shape_ref);
706
Ref<Resource> get_shape() const { return shape_ref; }
707
708
void set_shape_rid(const RID &p_shape);
709
RID get_shape_rid() const { return parameters.shape_rid; }
710
711
void set_transform(const Transform2D &p_transform) { parameters.transform = p_transform; }
712
const Transform2D &get_transform() const { return parameters.transform; }
713
714
void set_motion(const Vector2 &p_motion) { parameters.motion = p_motion; }
715
const Vector2 &get_motion() const { return parameters.motion; }
716
717
void set_margin(real_t p_margin) { parameters.margin = p_margin; }
718
real_t get_margin() const { return parameters.margin; }
719
720
void set_collision_mask(uint32_t p_mask) { parameters.collision_mask = p_mask; }
721
uint32_t get_collision_mask() const { return parameters.collision_mask; }
722
723
void set_collide_with_bodies(bool p_enable) { parameters.collide_with_bodies = p_enable; }
724
bool is_collide_with_bodies_enabled() const { return parameters.collide_with_bodies; }
725
726
void set_collide_with_areas(bool p_enable) { parameters.collide_with_areas = p_enable; }
727
bool is_collide_with_areas_enabled() const { return parameters.collide_with_areas; }
728
729
void set_exclude(const TypedArray<RID> &p_exclude);
730
TypedArray<RID> get_exclude() const;
731
};
732
733
class PhysicsTestMotionParameters2D : public RefCounted {
734
GDCLASS(PhysicsTestMotionParameters2D, RefCounted);
735
736
PhysicsServer2D::MotionParameters parameters;
737
738
protected:
739
static void _bind_methods();
740
741
public:
742
const PhysicsServer2D::MotionParameters &get_parameters() const { return parameters; }
743
744
const Transform2D &get_from() const { return parameters.from; }
745
void set_from(const Transform2D &p_from) { parameters.from = p_from; }
746
747
const Vector2 &get_motion() const { return parameters.motion; }
748
void set_motion(const Vector2 &p_motion) { parameters.motion = p_motion; }
749
750
real_t get_margin() const { return parameters.margin; }
751
void set_margin(real_t p_margin) { parameters.margin = p_margin; }
752
753
bool is_collide_separation_ray_enabled() const { return parameters.collide_separation_ray; }
754
void set_collide_separation_ray_enabled(bool p_enabled) { parameters.collide_separation_ray = p_enabled; }
755
756
TypedArray<RID> get_exclude_bodies() const;
757
void set_exclude_bodies(const TypedArray<RID> &p_exclude);
758
759
TypedArray<uint64_t> get_exclude_objects() const;
760
void set_exclude_objects(const TypedArray<uint64_t> &p_exclude);
761
762
bool is_recovery_as_collision_enabled() const { return parameters.recovery_as_collision; }
763
void set_recovery_as_collision_enabled(bool p_enabled) { parameters.recovery_as_collision = p_enabled; }
764
};
765
766
class PhysicsTestMotionResult2D : public RefCounted {
767
GDCLASS(PhysicsTestMotionResult2D, RefCounted);
768
769
PhysicsServer2D::MotionResult result;
770
771
protected:
772
static void _bind_methods();
773
774
public:
775
PhysicsServer2D::MotionResult *get_result_ptr() { return &result; }
776
777
Vector2 get_travel() const;
778
Vector2 get_remainder() const;
779
780
Vector2 get_collision_point() const;
781
Vector2 get_collision_normal() const;
782
Vector2 get_collider_velocity() const;
783
ObjectID get_collider_id() const;
784
RID get_collider_rid() const;
785
Object *get_collider() const;
786
int get_collider_shape() const;
787
int get_collision_local_shape() const;
788
real_t get_collision_depth() const;
789
real_t get_collision_safe_fraction() const;
790
real_t get_collision_unsafe_fraction() const;
791
};
792
793
class PhysicsServer2DManager : public Object {
794
GDCLASS(PhysicsServer2DManager, Object);
795
796
static PhysicsServer2DManager *singleton;
797
798
struct ClassInfo {
799
String name;
800
Callable create_callback;
801
802
ClassInfo() {}
803
804
ClassInfo(String p_name, Callable p_create_callback) :
805
name(p_name),
806
create_callback(p_create_callback) {}
807
808
ClassInfo(const ClassInfo &p_ci) :
809
name(p_ci.name),
810
create_callback(p_ci.create_callback) {}
811
812
void operator=(const ClassInfo &p_ci) {
813
name = p_ci.name;
814
create_callback = p_ci.create_callback;
815
}
816
};
817
818
Vector<ClassInfo> physics_2d_servers;
819
int default_server_id = -1;
820
int default_server_priority = -1;
821
822
void on_servers_changed();
823
824
protected:
825
static void _bind_methods();
826
827
public:
828
static const String setting_property_name;
829
830
static PhysicsServer2DManager *get_singleton();
831
832
void register_server(const String &p_name, const Callable &p_create_callback);
833
void set_default_server(const String &p_name, int p_priority = 0);
834
int find_server_id(const String &p_name);
835
int get_servers_count();
836
String get_server_name(int p_id);
837
PhysicsServer2D *new_default_server();
838
PhysicsServer2D *new_server(const String &p_name);
839
840
PhysicsServer2DManager();
841
~PhysicsServer2DManager();
842
};
843
844
VARIANT_ENUM_CAST(PhysicsServer2D::ShapeType);
845
VARIANT_ENUM_CAST(PhysicsServer2D::SpaceParameter);
846
VARIANT_ENUM_CAST(PhysicsServer2D::AreaParameter);
847
VARIANT_ENUM_CAST(PhysicsServer2D::AreaSpaceOverrideMode);
848
VARIANT_ENUM_CAST(PhysicsServer2D::BodyMode);
849
VARIANT_ENUM_CAST(PhysicsServer2D::BodyParameter);
850
VARIANT_ENUM_CAST(PhysicsServer2D::BodyDampMode);
851
VARIANT_ENUM_CAST(PhysicsServer2D::BodyState);
852
VARIANT_ENUM_CAST(PhysicsServer2D::CCDMode);
853
VARIANT_ENUM_CAST(PhysicsServer2D::JointParam);
854
VARIANT_ENUM_CAST(PhysicsServer2D::JointType);
855
VARIANT_ENUM_CAST(PhysicsServer2D::PinJointParam);
856
VARIANT_ENUM_CAST(PhysicsServer2D::PinJointFlag);
857
VARIANT_ENUM_CAST(PhysicsServer2D::DampedSpringParam);
858
VARIANT_ENUM_CAST(PhysicsServer2D::AreaBodyStatus);
859
VARIANT_ENUM_CAST(PhysicsServer2D::ProcessInfo);
860
861