physics_server_2d.h 27 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691
  1. /*************************************************************************/
  2. /* physics_server_2d.h */
  3. /*************************************************************************/
  4. /* This file is part of: */
  5. /* GODOT ENGINE */
  6. /* https://godotengine.org */
  7. /*************************************************************************/
  8. /* Copyright (c) 2007-2021 Juan Linietsky, Ariel Manzur. */
  9. /* Copyright (c) 2014-2021 Godot Engine contributors (cf. AUTHORS.md). */
  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. #ifndef PHYSICS_2D_SERVER_H
  31. #define PHYSICS_2D_SERVER_H
  32. #include "core/io/resource.h"
  33. #include "core/object/class_db.h"
  34. #include "core/object/reference.h"
  35. class PhysicsDirectSpaceState2D;
  36. class PhysicsDirectBodyState2D : public Object {
  37. GDCLASS(PhysicsDirectBodyState2D, Object);
  38. protected:
  39. static void _bind_methods();
  40. public:
  41. virtual Vector2 get_total_gravity() const = 0; // get gravity vector working on this body space/area
  42. virtual real_t get_total_linear_damp() const = 0; // get density of this body space/area
  43. virtual real_t get_total_angular_damp() const = 0; // get density of this body space/area
  44. virtual real_t get_inverse_mass() const = 0; // get the mass
  45. virtual real_t get_inverse_inertia() const = 0; // get density of this body space
  46. virtual void set_linear_velocity(const Vector2 &p_velocity) = 0;
  47. virtual Vector2 get_linear_velocity() const = 0;
  48. virtual void set_angular_velocity(real_t p_velocity) = 0;
  49. virtual real_t get_angular_velocity() const = 0;
  50. virtual void set_transform(const Transform2D &p_transform) = 0;
  51. virtual Transform2D get_transform() const = 0;
  52. virtual void add_central_force(const Vector2 &p_force) = 0;
  53. virtual void add_force(const Vector2 &p_force, const Vector2 &p_position = Vector2()) = 0;
  54. virtual void add_torque(real_t p_torque) = 0;
  55. virtual void apply_central_impulse(const Vector2 &p_impulse) = 0;
  56. virtual void apply_torque_impulse(real_t p_torque) = 0;
  57. virtual void apply_impulse(const Vector2 &p_impulse, const Vector2 &p_position = Vector2()) = 0;
  58. virtual void set_sleep_state(bool p_enable) = 0;
  59. virtual bool is_sleeping() const = 0;
  60. virtual int get_contact_count() const = 0;
  61. virtual Vector2 get_contact_local_position(int p_contact_idx) const = 0;
  62. virtual Vector2 get_contact_local_normal(int p_contact_idx) const = 0;
  63. virtual int get_contact_local_shape(int p_contact_idx) const = 0;
  64. virtual RID get_contact_collider(int p_contact_idx) const = 0;
  65. virtual Vector2 get_contact_collider_position(int p_contact_idx) const = 0;
  66. virtual ObjectID get_contact_collider_id(int p_contact_idx) const = 0;
  67. virtual Object *get_contact_collider_object(int p_contact_idx) const;
  68. virtual int get_contact_collider_shape(int p_contact_idx) const = 0;
  69. virtual Variant get_contact_collider_shape_metadata(int p_contact_idx) const = 0;
  70. virtual Vector2 get_contact_collider_velocity_at_position(int p_contact_idx) const = 0;
  71. virtual real_t get_step() const = 0;
  72. virtual void integrate_forces();
  73. virtual PhysicsDirectSpaceState2D *get_space_state() = 0;
  74. PhysicsDirectBodyState2D();
  75. };
  76. class PhysicsShapeQueryResult2D;
  77. //used for script
  78. class PhysicsShapeQueryParameters2D : public Reference {
  79. GDCLASS(PhysicsShapeQueryParameters2D, Reference);
  80. friend class PhysicsDirectSpaceState2D;
  81. RES shape_ref;
  82. RID shape;
  83. Transform2D transform;
  84. Vector2 motion;
  85. real_t margin;
  86. Set<RID> exclude;
  87. uint32_t collision_mask;
  88. bool collide_with_bodies;
  89. bool collide_with_areas;
  90. protected:
  91. static void _bind_methods();
  92. public:
  93. void set_shape(const RES &p_shape_ref);
  94. RES get_shape() const;
  95. void set_shape_rid(const RID &p_shape);
  96. RID get_shape_rid() const;
  97. void set_transform(const Transform2D &p_transform);
  98. Transform2D get_transform() const;
  99. void set_motion(const Vector2 &p_motion);
  100. Vector2 get_motion() const;
  101. void set_margin(real_t p_margin);
  102. real_t get_margin() const;
  103. void set_collision_mask(int p_collision_mask);
  104. int get_collision_mask() const;
  105. void set_collide_with_bodies(bool p_enable);
  106. bool is_collide_with_bodies_enabled() const;
  107. void set_collide_with_areas(bool p_enable);
  108. bool is_collide_with_areas_enabled() const;
  109. void set_exclude(const Vector<RID> &p_exclude);
  110. Vector<RID> get_exclude() const;
  111. PhysicsShapeQueryParameters2D();
  112. };
  113. class PhysicsDirectSpaceState2D : public Object {
  114. GDCLASS(PhysicsDirectSpaceState2D, Object);
  115. Dictionary _intersect_ray(const Vector2 &p_from, const Vector2 &p_to, const Vector<RID> &p_exclude = Vector<RID>(), uint32_t p_layers = 0, bool p_collide_with_bodies = true, bool p_collide_with_areas = false);
  116. Array _intersect_point(const Vector2 &p_point, int p_max_results = 32, const Vector<RID> &p_exclude = Vector<RID>(), uint32_t p_layers = 0, bool p_collide_with_bodies = true, bool p_collide_with_areas = false);
  117. Array _intersect_point_on_canvas(const Vector2 &p_point, ObjectID p_canvas_intance_id, int p_max_results = 32, const Vector<RID> &p_exclude = Vector<RID>(), uint32_t p_layers = 0, bool p_collide_with_bodies = true, bool p_collide_with_areas = false);
  118. Array _intersect_point_impl(const Vector2 &p_point, int p_max_results, const Vector<RID> &p_exclud, uint32_t p_layers, bool p_collide_with_bodies, bool p_collide_with_areas, bool p_filter_by_canvas = false, ObjectID p_canvas_instance_id = ObjectID());
  119. Array _intersect_shape(const Ref<PhysicsShapeQueryParameters2D> &p_shape_query, int p_max_results = 32);
  120. Array _cast_motion(const Ref<PhysicsShapeQueryParameters2D> &p_shape_query);
  121. Array _collide_shape(const Ref<PhysicsShapeQueryParameters2D> &p_shape_query, int p_max_results = 32);
  122. Dictionary _get_rest_info(const Ref<PhysicsShapeQueryParameters2D> &p_shape_query);
  123. protected:
  124. static void _bind_methods();
  125. public:
  126. struct RayResult {
  127. Vector2 position;
  128. Vector2 normal;
  129. RID rid;
  130. ObjectID collider_id;
  131. Object *collider;
  132. int shape;
  133. Variant metadata;
  134. };
  135. virtual bool intersect_ray(const Vector2 &p_from, const Vector2 &p_to, RayResult &r_result, const Set<RID> &p_exclude = Set<RID>(), uint32_t p_collision_layer = 0xFFFFFFFF, bool p_collide_with_bodies = true, bool p_collide_with_areas = false) = 0;
  136. struct ShapeResult {
  137. RID rid;
  138. ObjectID collider_id;
  139. Object *collider;
  140. int shape;
  141. Variant metadata;
  142. };
  143. virtual int intersect_point(const Vector2 &p_point, ShapeResult *r_results, int p_result_max, const Set<RID> &p_exclude = Set<RID>(), uint32_t p_collision_layer = 0xFFFFFFFF, bool p_collide_with_bodies = true, bool p_collide_with_areas = false, bool p_pick_point = false) = 0;
  144. virtual int intersect_point_on_canvas(const Vector2 &p_point, ObjectID p_canvas_instance_id, ShapeResult *r_results, int p_result_max, const Set<RID> &p_exclude = Set<RID>(), uint32_t p_collision_layer = 0xFFFFFFFF, bool p_collide_with_bodies = true, bool p_collide_with_areas = false, bool p_pick_point = false) = 0;
  145. virtual int intersect_shape(const RID &p_shape, const Transform2D &p_xform, const Vector2 &p_motion, real_t p_margin, ShapeResult *r_results, int p_result_max, const Set<RID> &p_exclude = Set<RID>(), uint32_t p_collision_layer = 0xFFFFFFFF, bool p_collide_with_bodies = true, bool p_collide_with_areas = false) = 0;
  146. virtual bool cast_motion(const RID &p_shape, const Transform2D &p_xform, const Vector2 &p_motion, real_t p_margin, real_t &p_closest_safe, real_t &p_closest_unsafe, const Set<RID> &p_exclude = Set<RID>(), uint32_t p_collision_layer = 0xFFFFFFFF, bool p_collide_with_bodies = true, bool p_collide_with_areas = false) = 0;
  147. virtual bool collide_shape(RID p_shape, const Transform2D &p_shape_xform, const Vector2 &p_motion, real_t p_margin, Vector2 *r_results, int p_result_max, int &r_result_count, const Set<RID> &p_exclude = Set<RID>(), uint32_t p_collision_layer = 0xFFFFFFFF, bool p_collide_with_bodies = true, bool p_collide_with_areas = false) = 0;
  148. struct ShapeRestInfo {
  149. Vector2 point;
  150. Vector2 normal;
  151. RID rid;
  152. ObjectID collider_id;
  153. int shape;
  154. Vector2 linear_velocity; //velocity at contact point
  155. Variant metadata;
  156. };
  157. virtual bool rest_info(RID p_shape, const Transform2D &p_shape_xform, const Vector2 &p_motion, real_t p_margin, ShapeRestInfo *r_info, const Set<RID> &p_exclude = Set<RID>(), uint32_t p_collision_layer = 0xFFFFFFFF, bool p_collide_with_bodies = true, bool p_collide_with_areas = false) = 0;
  158. PhysicsDirectSpaceState2D();
  159. };
  160. class PhysicsShapeQueryResult2D : public Reference {
  161. GDCLASS(PhysicsShapeQueryResult2D, Reference);
  162. Vector<PhysicsDirectSpaceState2D::ShapeResult> result;
  163. friend class PhysicsDirectSpaceState2D;
  164. protected:
  165. static void _bind_methods();
  166. public:
  167. int get_result_count() const;
  168. RID get_result_rid(int p_idx) const;
  169. ObjectID get_result_object_id(int p_idx) const;
  170. Object *get_result_object(int p_idx) const;
  171. int get_result_object_shape(int p_idx) const;
  172. PhysicsShapeQueryResult2D();
  173. };
  174. class PhysicsTestMotionResult2D;
  175. class PhysicsServer2D : public Object {
  176. GDCLASS(PhysicsServer2D, Object);
  177. static PhysicsServer2D *singleton;
  178. virtual bool _body_test_motion(RID p_body, const Transform2D &p_from, const Vector2 &p_motion, bool p_infinite_inertia, real_t p_margin = 0.08, const Ref<PhysicsTestMotionResult2D> &p_result = Ref<PhysicsTestMotionResult2D>());
  179. protected:
  180. static void _bind_methods();
  181. public:
  182. static PhysicsServer2D *get_singleton();
  183. enum ShapeType {
  184. SHAPE_LINE, ///< plane:"plane"
  185. SHAPE_RAY, ///< float:"length"
  186. SHAPE_SEGMENT, ///< float:"length"
  187. SHAPE_CIRCLE, ///< float:"radius"
  188. SHAPE_RECTANGLE, ///< vec3:"extents"
  189. SHAPE_CAPSULE,
  190. SHAPE_CONVEX_POLYGON, ///< array of planes:"planes"
  191. SHAPE_CONCAVE_POLYGON, ///< Vector2 array:"triangles" , or Dictionary with "indices" (int array) and "triangles" (Vector2 array)
  192. SHAPE_CUSTOM, ///< Server-Implementation based custom shape, calling shape_create() with this value will result in an error
  193. };
  194. virtual RID line_shape_create() = 0;
  195. virtual RID ray_shape_create() = 0;
  196. virtual RID segment_shape_create() = 0;
  197. virtual RID circle_shape_create() = 0;
  198. virtual RID rectangle_shape_create() = 0;
  199. virtual RID capsule_shape_create() = 0;
  200. virtual RID convex_polygon_shape_create() = 0;
  201. virtual RID concave_polygon_shape_create() = 0;
  202. virtual void shape_set_data(RID p_shape, const Variant &p_data) = 0;
  203. virtual void shape_set_custom_solver_bias(RID p_shape, real_t p_bias) = 0;
  204. virtual ShapeType shape_get_type(RID p_shape) const = 0;
  205. virtual Variant shape_get_data(RID p_shape) const = 0;
  206. virtual real_t shape_get_custom_solver_bias(RID p_shape) const = 0;
  207. //these work well, but should be used from the main thread only
  208. 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;
  209. /* SPACE API */
  210. virtual RID space_create() = 0;
  211. virtual void space_set_active(RID p_space, bool p_active) = 0;
  212. virtual bool space_is_active(RID p_space) const = 0;
  213. enum SpaceParameter {
  214. SPACE_PARAM_CONTACT_RECYCLE_RADIUS,
  215. SPACE_PARAM_CONTACT_MAX_SEPARATION,
  216. SPACE_PARAM_BODY_MAX_ALLOWED_PENETRATION,
  217. SPACE_PARAM_BODY_LINEAR_VELOCITY_SLEEP_THRESHOLD,
  218. SPACE_PARAM_BODY_ANGULAR_VELOCITY_SLEEP_THRESHOLD,
  219. SPACE_PARAM_BODY_TIME_TO_SLEEP,
  220. SPACE_PARAM_CONSTRAINT_DEFAULT_BIAS,
  221. SPACE_PARAM_TEST_MOTION_MIN_CONTACT_DEPTH,
  222. };
  223. virtual void space_set_param(RID p_space, SpaceParameter p_param, real_t p_value) = 0;
  224. virtual real_t space_get_param(RID p_space, SpaceParameter p_param) const = 0;
  225. // this function only works on physics process, errors and returns null otherwise
  226. virtual PhysicsDirectSpaceState2D *space_get_direct_state(RID p_space) = 0;
  227. virtual void space_set_debug_contacts(RID p_space, int p_max_contacts) = 0;
  228. virtual Vector<Vector2> space_get_contacts(RID p_space) const = 0;
  229. virtual int space_get_contact_count(RID p_space) const = 0;
  230. //missing space parameters
  231. /* AREA API */
  232. //missing attenuation? missing better override?
  233. enum AreaParameter {
  234. AREA_PARAM_GRAVITY,
  235. AREA_PARAM_GRAVITY_VECTOR,
  236. AREA_PARAM_GRAVITY_IS_POINT,
  237. AREA_PARAM_GRAVITY_DISTANCE_SCALE,
  238. AREA_PARAM_GRAVITY_POINT_ATTENUATION,
  239. AREA_PARAM_LINEAR_DAMP,
  240. AREA_PARAM_ANGULAR_DAMP,
  241. AREA_PARAM_PRIORITY
  242. };
  243. virtual RID area_create() = 0;
  244. virtual void area_set_space(RID p_area, RID p_space) = 0;
  245. virtual RID area_get_space(RID p_area) const = 0;
  246. enum AreaSpaceOverrideMode {
  247. AREA_SPACE_OVERRIDE_DISABLED,
  248. AREA_SPACE_OVERRIDE_COMBINE,
  249. AREA_SPACE_OVERRIDE_COMBINE_REPLACE, // Combines, then discards all subsequent calculations
  250. AREA_SPACE_OVERRIDE_REPLACE,
  251. AREA_SPACE_OVERRIDE_REPLACE_COMBINE // Discards all previous calculations, then keeps combining
  252. };
  253. virtual void area_set_space_override_mode(RID p_area, AreaSpaceOverrideMode p_mode) = 0;
  254. virtual AreaSpaceOverrideMode area_get_space_override_mode(RID p_area) const = 0;
  255. virtual void area_add_shape(RID p_area, RID p_shape, const Transform2D &p_transform = Transform2D(), bool p_disabled = false) = 0;
  256. virtual void area_set_shape(RID p_area, int p_shape_idx, RID p_shape) = 0;
  257. virtual void area_set_shape_transform(RID p_area, int p_shape_idx, const Transform2D &p_transform) = 0;
  258. virtual int area_get_shape_count(RID p_area) const = 0;
  259. virtual RID area_get_shape(RID p_area, int p_shape_idx) const = 0;
  260. virtual Transform2D area_get_shape_transform(RID p_area, int p_shape_idx) const = 0;
  261. virtual void area_remove_shape(RID p_area, int p_shape_idx) = 0;
  262. virtual void area_clear_shapes(RID p_area) = 0;
  263. virtual void area_set_shape_disabled(RID p_area, int p_shape, bool p_disabled) = 0;
  264. virtual void area_attach_object_instance_id(RID p_area, ObjectID p_id) = 0;
  265. virtual ObjectID area_get_object_instance_id(RID p_area) const = 0;
  266. virtual void area_attach_canvas_instance_id(RID p_area, ObjectID p_id) = 0;
  267. virtual ObjectID area_get_canvas_instance_id(RID p_area) const = 0;
  268. virtual void area_set_param(RID p_area, AreaParameter p_param, const Variant &p_value) = 0;
  269. virtual void area_set_transform(RID p_area, const Transform2D &p_transform) = 0;
  270. virtual Variant area_get_param(RID p_parea, AreaParameter p_param) const = 0;
  271. virtual Transform2D area_get_transform(RID p_area) const = 0;
  272. virtual void area_set_collision_mask(RID p_area, uint32_t p_mask) = 0;
  273. virtual void area_set_collision_layer(RID p_area, uint32_t p_layer) = 0;
  274. virtual void area_set_monitorable(RID p_area, bool p_monitorable) = 0;
  275. virtual void area_set_pickable(RID p_area, bool p_pickable) = 0;
  276. virtual void area_set_monitor_callback(RID p_area, Object *p_receiver, const StringName &p_method) = 0;
  277. virtual void area_set_area_monitor_callback(RID p_area, Object *p_receiver, const StringName &p_method) = 0;
  278. /* BODY API */
  279. //missing ccd?
  280. enum BodyMode {
  281. BODY_MODE_STATIC,
  282. BODY_MODE_KINEMATIC,
  283. BODY_MODE_RIGID,
  284. BODY_MODE_CHARACTER
  285. };
  286. virtual RID body_create() = 0;
  287. virtual void body_set_space(RID p_body, RID p_space) = 0;
  288. virtual RID body_get_space(RID p_body) const = 0;
  289. virtual void body_set_mode(RID p_body, BodyMode p_mode) = 0;
  290. virtual BodyMode body_get_mode(RID p_body) const = 0;
  291. virtual void body_add_shape(RID p_body, RID p_shape, const Transform2D &p_transform = Transform2D(), bool p_disabled = false) = 0;
  292. virtual void body_set_shape(RID p_body, int p_shape_idx, RID p_shape) = 0;
  293. virtual void body_set_shape_transform(RID p_body, int p_shape_idx, const Transform2D &p_transform) = 0;
  294. virtual void body_set_shape_metadata(RID p_body, int p_shape_idx, const Variant &p_metadata) = 0;
  295. virtual int body_get_shape_count(RID p_body) const = 0;
  296. virtual RID body_get_shape(RID p_body, int p_shape_idx) const = 0;
  297. virtual Transform2D body_get_shape_transform(RID p_body, int p_shape_idx) const = 0;
  298. virtual Variant body_get_shape_metadata(RID p_body, int p_shape_idx) const = 0;
  299. virtual void body_set_shape_disabled(RID p_body, int p_shape, bool p_disabled) = 0;
  300. virtual void body_set_shape_as_one_way_collision(RID p_body, int p_shape, bool p_enabled, real_t p_margin = 0) = 0;
  301. virtual void body_remove_shape(RID p_body, int p_shape_idx) = 0;
  302. virtual void body_clear_shapes(RID p_body) = 0;
  303. virtual void body_attach_object_instance_id(RID p_body, ObjectID p_id) = 0;
  304. virtual ObjectID body_get_object_instance_id(RID p_body) const = 0;
  305. virtual void body_attach_canvas_instance_id(RID p_body, ObjectID p_id) = 0;
  306. virtual ObjectID body_get_canvas_instance_id(RID p_body) const = 0;
  307. enum CCDMode {
  308. CCD_MODE_DISABLED,
  309. CCD_MODE_CAST_RAY,
  310. CCD_MODE_CAST_SHAPE,
  311. };
  312. virtual void body_set_continuous_collision_detection_mode(RID p_body, CCDMode p_mode) = 0;
  313. virtual CCDMode body_get_continuous_collision_detection_mode(RID p_body) const = 0;
  314. virtual void body_set_collision_layer(RID p_body, uint32_t p_layer) = 0;
  315. virtual uint32_t body_get_collision_layer(RID p_body) const = 0;
  316. virtual void body_set_collision_mask(RID p_body, uint32_t p_mask) = 0;
  317. virtual uint32_t body_get_collision_mask(RID p_body) const = 0;
  318. // common body variables
  319. enum BodyParameter {
  320. BODY_PARAM_BOUNCE,
  321. BODY_PARAM_FRICTION,
  322. BODY_PARAM_MASS, ///< unused for static, always infinite
  323. BODY_PARAM_INERTIA, // read-only: computed from mass & shapes
  324. BODY_PARAM_GRAVITY_SCALE,
  325. BODY_PARAM_LINEAR_DAMP,
  326. BODY_PARAM_ANGULAR_DAMP,
  327. BODY_PARAM_MAX,
  328. };
  329. virtual void body_set_param(RID p_body, BodyParameter p_param, real_t p_value) = 0;
  330. virtual real_t body_get_param(RID p_body, BodyParameter p_param) const = 0;
  331. //state
  332. enum BodyState {
  333. BODY_STATE_TRANSFORM,
  334. BODY_STATE_LINEAR_VELOCITY,
  335. BODY_STATE_ANGULAR_VELOCITY,
  336. BODY_STATE_SLEEPING,
  337. BODY_STATE_CAN_SLEEP,
  338. };
  339. virtual void body_set_state(RID p_body, BodyState p_state, const Variant &p_variant) = 0;
  340. virtual Variant body_get_state(RID p_body, BodyState p_state) const = 0;
  341. //do something about it
  342. virtual void body_set_applied_force(RID p_body, const Vector2 &p_force) = 0;
  343. virtual Vector2 body_get_applied_force(RID p_body) const = 0;
  344. virtual void body_set_applied_torque(RID p_body, real_t p_torque) = 0;
  345. virtual real_t body_get_applied_torque(RID p_body) const = 0;
  346. virtual void body_add_central_force(RID p_body, const Vector2 &p_force) = 0;
  347. virtual void body_add_force(RID p_body, const Vector2 &p_force, const Vector2 &p_position = Vector2()) = 0;
  348. virtual void body_add_torque(RID p_body, real_t p_torque) = 0;
  349. virtual void body_apply_central_impulse(RID p_body, const Vector2 &p_impulse) = 0;
  350. virtual void body_apply_torque_impulse(RID p_body, real_t p_torque) = 0;
  351. virtual void body_apply_impulse(RID p_body, const Vector2 &p_impulse, const Vector2 &p_position = Vector2()) = 0;
  352. virtual void body_set_axis_velocity(RID p_body, const Vector2 &p_axis_velocity) = 0;
  353. //fix
  354. virtual void body_add_collision_exception(RID p_body, RID p_body_b) = 0;
  355. virtual void body_remove_collision_exception(RID p_body, RID p_body_b) = 0;
  356. virtual void body_get_collision_exceptions(RID p_body, List<RID> *p_exceptions) = 0;
  357. virtual void body_set_max_contacts_reported(RID p_body, int p_contacts) = 0;
  358. virtual int body_get_max_contacts_reported(RID p_body) const = 0;
  359. //missing remove
  360. virtual void body_set_contacts_reported_depth_threshold(RID p_body, real_t p_threshold) = 0;
  361. virtual real_t body_get_contacts_reported_depth_threshold(RID p_body) const = 0;
  362. virtual void body_set_omit_force_integration(RID p_body, bool p_omit) = 0;
  363. virtual bool body_is_omitting_force_integration(RID p_body) const = 0;
  364. virtual void body_set_force_integration_callback(RID p_body, Object *p_receiver, const StringName &p_method, const Variant &p_udata = Variant()) = 0;
  365. 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;
  366. virtual void body_set_pickable(RID p_body, bool p_pickable) = 0;
  367. // this function only works on physics process, errors and returns null otherwise
  368. virtual PhysicsDirectBodyState2D *body_get_direct_state(RID p_body) = 0;
  369. struct MotionResult {
  370. Vector2 motion;
  371. Vector2 remainder;
  372. Vector2 collision_point;
  373. Vector2 collision_normal;
  374. Vector2 collider_velocity;
  375. int collision_local_shape;
  376. ObjectID collider_id;
  377. RID collider;
  378. int collider_shape;
  379. Variant collider_metadata;
  380. MotionResult() {
  381. collision_local_shape = 0;
  382. collider_shape = 0;
  383. collider_id = ObjectID();
  384. }
  385. };
  386. virtual bool body_test_motion(RID p_body, const Transform2D &p_from, const Vector2 &p_motion, bool p_infinite_inertia, real_t p_margin = 0.001, MotionResult *r_result = nullptr, bool p_exclude_raycast_shapes = true) = 0;
  387. struct SeparationResult {
  388. real_t collision_depth;
  389. Vector2 collision_point;
  390. Vector2 collision_normal;
  391. Vector2 collider_velocity;
  392. int collision_local_shape;
  393. ObjectID collider_id;
  394. RID collider;
  395. int collider_shape;
  396. Variant collider_metadata;
  397. };
  398. virtual int body_test_ray_separation(RID p_body, const Transform2D &p_transform, bool p_infinite_inertia, Vector2 &r_recover_motion, SeparationResult *r_results, int p_result_max, real_t p_margin = 0.001) = 0;
  399. /* JOINT API */
  400. virtual RID joint_create() = 0;
  401. virtual void joint_clear(RID p_joint) = 0;
  402. enum JointType {
  403. JOINT_TYPE_PIN,
  404. JOINT_TYPE_GROOVE,
  405. JOINT_TYPE_DAMPED_SPRING,
  406. JOINT_TYPE_MAX
  407. };
  408. enum JointParam {
  409. JOINT_PARAM_BIAS,
  410. JOINT_PARAM_MAX_BIAS,
  411. JOINT_PARAM_MAX_FORCE,
  412. };
  413. virtual void joint_set_param(RID p_joint, JointParam p_param, real_t p_value) = 0;
  414. virtual real_t joint_get_param(RID p_joint, JointParam p_param) const = 0;
  415. virtual void joint_disable_collisions_between_bodies(RID p_joint, const bool p_disable) = 0;
  416. virtual bool joint_is_disabled_collisions_between_bodies(RID p_joint) const = 0;
  417. virtual void joint_make_pin(RID p_joint, const Vector2 &p_anchor, RID p_body_a, RID p_body_b = RID()) = 0;
  418. 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;
  419. 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;
  420. enum PinJointParam {
  421. PIN_JOINT_SOFTNESS
  422. };
  423. virtual void pin_joint_set_param(RID p_joint, PinJointParam p_param, real_t p_value) = 0;
  424. virtual real_t pin_joint_get_param(RID p_joint, PinJointParam p_param) const = 0;
  425. enum DampedSpringParam {
  426. DAMPED_SPRING_REST_LENGTH,
  427. DAMPED_SPRING_STIFFNESS,
  428. DAMPED_SPRING_DAMPING
  429. };
  430. virtual void damped_spring_joint_set_param(RID p_joint, DampedSpringParam p_param, real_t p_value) = 0;
  431. virtual real_t damped_spring_joint_get_param(RID p_joint, DampedSpringParam p_param) const = 0;
  432. virtual JointType joint_get_type(RID p_joint) const = 0;
  433. /* QUERY API */
  434. enum AreaBodyStatus {
  435. AREA_BODY_ADDED,
  436. AREA_BODY_REMOVED
  437. };
  438. /* MISC */
  439. virtual void free(RID p_rid) = 0;
  440. virtual void set_active(bool p_active) = 0;
  441. virtual void init() = 0;
  442. virtual void step(real_t p_step) = 0;
  443. virtual void sync() = 0;
  444. virtual void flush_queries() = 0;
  445. virtual void end_sync() = 0;
  446. virtual void finish() = 0;
  447. virtual bool is_flushing_queries() const = 0;
  448. enum ProcessInfo {
  449. INFO_ACTIVE_OBJECTS,
  450. INFO_COLLISION_PAIRS,
  451. INFO_ISLAND_COUNT
  452. };
  453. virtual int get_process_info(ProcessInfo p_info) = 0;
  454. PhysicsServer2D();
  455. ~PhysicsServer2D();
  456. };
  457. class PhysicsTestMotionResult2D : public Reference {
  458. GDCLASS(PhysicsTestMotionResult2D, Reference);
  459. PhysicsServer2D::MotionResult result;
  460. bool colliding;
  461. friend class PhysicsServer2D;
  462. protected:
  463. static void _bind_methods();
  464. public:
  465. PhysicsServer2D::MotionResult *get_result_ptr() const { return const_cast<PhysicsServer2D::MotionResult *>(&result); }
  466. //bool is_colliding() const;
  467. Vector2 get_motion() const;
  468. Vector2 get_motion_remainder() const;
  469. Vector2 get_collision_point() const;
  470. Vector2 get_collision_normal() const;
  471. Vector2 get_collider_velocity() const;
  472. ObjectID get_collider_id() const;
  473. RID get_collider_rid() const;
  474. Object *get_collider() const;
  475. int get_collider_shape() const;
  476. PhysicsTestMotionResult2D();
  477. };
  478. typedef PhysicsServer2D *(*CreatePhysicsServer2DCallback)();
  479. class PhysicsServer2DManager {
  480. struct ClassInfo {
  481. String name;
  482. CreatePhysicsServer2DCallback create_callback = nullptr;
  483. ClassInfo() {}
  484. ClassInfo(String p_name, CreatePhysicsServer2DCallback p_create_callback) :
  485. name(p_name),
  486. create_callback(p_create_callback) {}
  487. ClassInfo(const ClassInfo &p_ci) :
  488. name(p_ci.name),
  489. create_callback(p_ci.create_callback) {}
  490. ClassInfo &operator=(const ClassInfo &p_ci) {
  491. name = p_ci.name;
  492. create_callback = p_ci.create_callback;
  493. return *this;
  494. }
  495. };
  496. static Vector<ClassInfo> physics_2d_servers;
  497. static int default_server_id;
  498. static int default_server_priority;
  499. public:
  500. static const String setting_property_name;
  501. private:
  502. static void on_servers_changed();
  503. public:
  504. static void register_server(const String &p_name, CreatePhysicsServer2DCallback p_creat_callback);
  505. static void set_default_server(const String &p_name, int p_priority = 0);
  506. static int find_server_id(const String &p_name);
  507. static int get_servers_count();
  508. static String get_server_name(int p_id);
  509. static PhysicsServer2D *new_default_server();
  510. static PhysicsServer2D *new_server(const String &p_name);
  511. };
  512. VARIANT_ENUM_CAST(PhysicsServer2D::ShapeType);
  513. VARIANT_ENUM_CAST(PhysicsServer2D::SpaceParameter);
  514. VARIANT_ENUM_CAST(PhysicsServer2D::AreaParameter);
  515. VARIANT_ENUM_CAST(PhysicsServer2D::AreaSpaceOverrideMode);
  516. VARIANT_ENUM_CAST(PhysicsServer2D::BodyMode);
  517. VARIANT_ENUM_CAST(PhysicsServer2D::BodyParameter);
  518. VARIANT_ENUM_CAST(PhysicsServer2D::BodyState);
  519. VARIANT_ENUM_CAST(PhysicsServer2D::CCDMode);
  520. VARIANT_ENUM_CAST(PhysicsServer2D::JointParam);
  521. VARIANT_ENUM_CAST(PhysicsServer2D::JointType);
  522. VARIANT_ENUM_CAST(PhysicsServer2D::DampedSpringParam);
  523. //VARIANT_ENUM_CAST( PhysicsServer2D::ObjectType );
  524. VARIANT_ENUM_CAST(PhysicsServer2D::AreaBodyStatus);
  525. VARIANT_ENUM_CAST(PhysicsServer2D::ProcessInfo);
  526. #endif