Path: blob/master/servers/physics_2d/physics_server_2d.h
11322 views
/**************************************************************************/1/* physics_server_2d.h */2/**************************************************************************/3/* This file is part of: */4/* GODOT ENGINE */5/* https://godotengine.org */6/**************************************************************************/7/* Copyright (c) 2014-present Godot Engine contributors (see AUTHORS.md). */8/* Copyright (c) 2007-2014 Juan Linietsky, Ariel Manzur. */9/* */10/* Permission is hereby granted, free of charge, to any person obtaining */11/* a copy of this software and associated documentation files (the */12/* "Software"), to deal in the Software without restriction, including */13/* without limitation the rights to use, copy, modify, merge, publish, */14/* distribute, sublicense, and/or sell copies of the Software, and to */15/* permit persons to whom the Software is furnished to do so, subject to */16/* the following conditions: */17/* */18/* The above copyright notice and this permission notice shall be */19/* included in all copies or substantial portions of the Software. */20/* */21/* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, */22/* EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF */23/* MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. */24/* IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY */25/* CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, */26/* TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE */27/* SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. */28/**************************************************************************/2930#pragma once3132#include "core/io/resource.h"33#include "core/object/class_db.h"34#include "core/object/ref_counted.h"3536constexpr int MAX_CONTACTS_REPORTED_2D_MAX = 4096;3738class PhysicsDirectSpaceState2D;39template <typename T>40class TypedArray;4142class PhysicsDirectBodyState2D : public Object {43GDCLASS(PhysicsDirectBodyState2D, Object);4445protected:46static void _bind_methods();4748public:49virtual Vector2 get_total_gravity() const = 0; // get gravity vector working on this body space/area50virtual real_t get_total_linear_damp() const = 0; // get density of this body space/area51virtual real_t get_total_angular_damp() const = 0; // get density of this body space/area5253virtual Vector2 get_center_of_mass() const = 0;54virtual Vector2 get_center_of_mass_local() const = 0;55virtual real_t get_inverse_mass() const = 0; // get the mass56virtual real_t get_inverse_inertia() const = 0; // get density of this body space5758virtual void set_linear_velocity(const Vector2 &p_velocity) = 0;59virtual Vector2 get_linear_velocity() const = 0;6061virtual void set_angular_velocity(real_t p_velocity) = 0;62virtual real_t get_angular_velocity() const = 0;6364virtual void set_transform(const Transform2D &p_transform) = 0;65virtual Transform2D get_transform() const = 0;6667virtual Vector2 get_velocity_at_local_position(const Vector2 &p_position) const = 0;6869virtual void apply_central_impulse(const Vector2 &p_impulse) = 0;70virtual void apply_torque_impulse(real_t p_torque) = 0;71virtual void apply_impulse(const Vector2 &p_impulse, const Vector2 &p_position = Vector2()) = 0;7273virtual void apply_central_force(const Vector2 &p_force) = 0;74virtual void apply_force(const Vector2 &p_force, const Vector2 &p_position = Vector2()) = 0;75virtual void apply_torque(real_t p_torque) = 0;7677virtual void add_constant_central_force(const Vector2 &p_force) = 0;78virtual void add_constant_force(const Vector2 &p_force, const Vector2 &p_position = Vector2()) = 0;79virtual void add_constant_torque(real_t p_torque) = 0;8081virtual void set_constant_force(const Vector2 &p_force) = 0;82virtual Vector2 get_constant_force() const = 0;8384virtual void set_constant_torque(real_t p_torque) = 0;85virtual real_t get_constant_torque() const = 0;8687virtual void set_sleep_state(bool p_enable) = 0;88virtual bool is_sleeping() const = 0;8990virtual void set_collision_layer(uint32_t p_layer) = 0;91virtual uint32_t get_collision_layer() const = 0;9293virtual void set_collision_mask(uint32_t p_mask) = 0;94virtual uint32_t get_collision_mask() const = 0;9596virtual int get_contact_count() const = 0;9798virtual Vector2 get_contact_local_position(int p_contact_idx) const = 0;99virtual Vector2 get_contact_local_normal(int p_contact_idx) const = 0;100virtual int get_contact_local_shape(int p_contact_idx) const = 0;101virtual Vector2 get_contact_local_velocity_at_position(int p_contact_idx) const = 0;102103virtual RID get_contact_collider(int p_contact_idx) const = 0;104virtual Vector2 get_contact_collider_position(int p_contact_idx) const = 0;105virtual ObjectID get_contact_collider_id(int p_contact_idx) const = 0;106virtual Object *get_contact_collider_object(int p_contact_idx) const;107virtual int get_contact_collider_shape(int p_contact_idx) const = 0;108virtual Vector2 get_contact_collider_velocity_at_position(int p_contact_idx) const = 0;109virtual Vector2 get_contact_impulse(int p_contact_idx) const = 0;110111virtual real_t get_step() const = 0;112virtual void integrate_forces();113114virtual PhysicsDirectSpaceState2D *get_space_state() = 0;115116PhysicsDirectBodyState2D();117};118119class PhysicsRayQueryParameters2D;120class PhysicsPointQueryParameters2D;121class PhysicsShapeQueryParameters2D;122123class PhysicsDirectSpaceState2D : public Object {124GDCLASS(PhysicsDirectSpaceState2D, Object);125126Dictionary _intersect_ray(const Ref<PhysicsRayQueryParameters2D> &p_ray_query);127TypedArray<Dictionary> _intersect_point(const Ref<PhysicsPointQueryParameters2D> &p_point_query, int p_max_results = 32);128TypedArray<Dictionary> _intersect_shape(const Ref<PhysicsShapeQueryParameters2D> &p_shape_query, int p_max_results = 32);129Vector<real_t> _cast_motion(const Ref<PhysicsShapeQueryParameters2D> &p_shape_query);130TypedArray<Vector2> _collide_shape(const Ref<PhysicsShapeQueryParameters2D> &p_shape_query, int p_max_results = 32);131Dictionary _get_rest_info(const Ref<PhysicsShapeQueryParameters2D> &p_shape_query);132133protected:134static void _bind_methods();135136public:137struct RayParameters {138Vector2 from;139Vector2 to;140HashSet<RID> exclude;141uint32_t collision_mask = UINT32_MAX;142143bool collide_with_bodies = true;144bool collide_with_areas = false;145146bool hit_from_inside = false;147};148149struct RayResult {150Vector2 position;151Vector2 normal;152RID rid;153ObjectID collider_id;154Object *collider = nullptr;155int shape = 0;156};157158virtual bool intersect_ray(const RayParameters &p_parameters, RayResult &r_result) = 0;159160struct ShapeResult {161RID rid;162ObjectID collider_id;163Object *collider = nullptr;164int shape = 0;165};166167struct PointParameters {168Vector2 position;169ObjectID canvas_instance_id;170HashSet<RID> exclude;171uint32_t collision_mask = UINT32_MAX;172173bool collide_with_bodies = true;174bool collide_with_areas = false;175176bool pick_point = false;177};178179virtual int intersect_point(const PointParameters &p_parameters, ShapeResult *r_results, int p_result_max) = 0;180181struct ShapeParameters {182RID shape_rid;183Transform2D transform;184Vector2 motion;185real_t margin = 0.0;186HashSet<RID> exclude;187uint32_t collision_mask = UINT32_MAX;188189bool collide_with_bodies = true;190bool collide_with_areas = false;191};192193struct ShapeRestInfo {194Vector2 point;195Vector2 normal;196RID rid;197ObjectID collider_id;198int shape = 0;199Vector2 linear_velocity; // Velocity at contact point.200};201202virtual int intersect_shape(const ShapeParameters &p_parameters, ShapeResult *r_results, int p_result_max) = 0;203virtual bool cast_motion(const ShapeParameters &p_parameters, real_t &p_closest_safe, real_t &p_closest_unsafe) = 0;204virtual bool collide_shape(const ShapeParameters &p_parameters, Vector2 *r_results, int p_result_max, int &r_result_count) = 0;205virtual bool rest_info(const ShapeParameters &p_parameters, ShapeRestInfo *r_info) = 0;206207PhysicsDirectSpaceState2D();208};209210class PhysicsTestMotionParameters2D;211class PhysicsTestMotionResult2D;212213class PhysicsServer2D : public Object {214GDCLASS(PhysicsServer2D, Object);215216static PhysicsServer2D *singleton;217218virtual bool _body_test_motion(RID p_body, const Ref<PhysicsTestMotionParameters2D> &p_parameters, const Ref<PhysicsTestMotionResult2D> &p_result = Ref<PhysicsTestMotionResult2D>());219220protected:221static void _bind_methods();222223public:224static PhysicsServer2D *get_singleton();225226enum ShapeType {227SHAPE_WORLD_BOUNDARY, ///< plane:"plane"228SHAPE_SEPARATION_RAY, ///< float:"length"229SHAPE_SEGMENT, ///< float:"length"230SHAPE_CIRCLE, ///< float:"radius"231SHAPE_RECTANGLE, ///< vec3:"extents"232SHAPE_CAPSULE,233SHAPE_CONVEX_POLYGON, ///< array of planes:"planes"234SHAPE_CONCAVE_POLYGON, ///< Vector2 array:"triangles" , or Dictionary with "indices" (int array) and "triangles" (Vector2 array)235SHAPE_CUSTOM, ///< Server-Implementation based custom shape, calling shape_create() with this value will result in an error236};237238virtual RID world_boundary_shape_create() = 0;239virtual RID separation_ray_shape_create() = 0;240virtual RID segment_shape_create() = 0;241virtual RID circle_shape_create() = 0;242virtual RID rectangle_shape_create() = 0;243virtual RID capsule_shape_create() = 0;244virtual RID convex_polygon_shape_create() = 0;245virtual RID concave_polygon_shape_create() = 0;246247virtual void shape_set_data(RID p_shape, const Variant &p_data) = 0;248virtual void shape_set_custom_solver_bias(RID p_shape, real_t p_bias) = 0;249250virtual ShapeType shape_get_type(RID p_shape) const = 0;251virtual Variant shape_get_data(RID p_shape) const = 0;252virtual real_t shape_get_custom_solver_bias(RID p_shape) const = 0;253254//these work well, but should be used from the main thread only255virtual 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;256257/* SPACE API */258259virtual RID space_create() = 0;260virtual void space_set_active(RID p_space, bool p_active) = 0;261virtual bool space_is_active(RID p_space) const = 0;262263enum SpaceParameter {264SPACE_PARAM_CONTACT_RECYCLE_RADIUS,265SPACE_PARAM_CONTACT_MAX_SEPARATION,266SPACE_PARAM_CONTACT_MAX_ALLOWED_PENETRATION,267SPACE_PARAM_CONTACT_DEFAULT_BIAS,268SPACE_PARAM_BODY_LINEAR_VELOCITY_SLEEP_THRESHOLD,269SPACE_PARAM_BODY_ANGULAR_VELOCITY_SLEEP_THRESHOLD,270SPACE_PARAM_BODY_TIME_TO_SLEEP,271SPACE_PARAM_CONSTRAINT_DEFAULT_BIAS,272SPACE_PARAM_SOLVER_ITERATIONS,273};274275virtual void space_set_param(RID p_space, SpaceParameter p_param, real_t p_value) = 0;276virtual real_t space_get_param(RID p_space, SpaceParameter p_param) const = 0;277278// this function only works on physics process, errors and returns null otherwise279virtual PhysicsDirectSpaceState2D *space_get_direct_state(RID p_space) = 0;280281virtual void space_set_debug_contacts(RID p_space, int p_max_contacts) = 0;282virtual Vector<Vector2> space_get_contacts(RID p_space) const = 0;283virtual int space_get_contact_count(RID p_space) const = 0;284285//missing space parameters286287/* AREA API */288289//missing attenuation? missing better override?290291enum AreaParameter {292AREA_PARAM_GRAVITY_OVERRIDE_MODE,293AREA_PARAM_GRAVITY,294AREA_PARAM_GRAVITY_VECTOR,295AREA_PARAM_GRAVITY_IS_POINT,296AREA_PARAM_GRAVITY_POINT_UNIT_DISTANCE,297AREA_PARAM_LINEAR_DAMP_OVERRIDE_MODE,298AREA_PARAM_LINEAR_DAMP,299AREA_PARAM_ANGULAR_DAMP_OVERRIDE_MODE,300AREA_PARAM_ANGULAR_DAMP,301AREA_PARAM_PRIORITY302};303304virtual RID area_create() = 0;305306virtual void area_set_space(RID p_area, RID p_space) = 0;307virtual RID area_get_space(RID p_area) const = 0;308309enum AreaSpaceOverrideMode {310AREA_SPACE_OVERRIDE_DISABLED,311AREA_SPACE_OVERRIDE_COMBINE,312AREA_SPACE_OVERRIDE_COMBINE_REPLACE, // Combines, then discards all subsequent calculations313AREA_SPACE_OVERRIDE_REPLACE,314AREA_SPACE_OVERRIDE_REPLACE_COMBINE // Discards all previous calculations, then keeps combining315};316317virtual void area_add_shape(RID p_area, RID p_shape, const Transform2D &p_transform = Transform2D(), bool p_disabled = false) = 0;318virtual void area_set_shape(RID p_area, int p_shape_idx, RID p_shape) = 0;319virtual void area_set_shape_transform(RID p_area, int p_shape_idx, const Transform2D &p_transform) = 0;320321virtual int area_get_shape_count(RID p_area) const = 0;322virtual RID area_get_shape(RID p_area, int p_shape_idx) const = 0;323virtual Transform2D area_get_shape_transform(RID p_area, int p_shape_idx) const = 0;324325virtual void area_remove_shape(RID p_area, int p_shape_idx) = 0;326virtual void area_clear_shapes(RID p_area) = 0;327328virtual void area_set_shape_disabled(RID p_area, int p_shape, bool p_disabled) = 0;329330virtual void area_attach_object_instance_id(RID p_area, ObjectID p_id) = 0;331virtual ObjectID area_get_object_instance_id(RID p_area) const = 0;332333virtual void area_attach_canvas_instance_id(RID p_area, ObjectID p_id) = 0;334virtual ObjectID area_get_canvas_instance_id(RID p_area) const = 0;335336virtual void area_set_param(RID p_area, AreaParameter p_param, const Variant &p_value) = 0;337virtual void area_set_transform(RID p_area, const Transform2D &p_transform) = 0;338339virtual Variant area_get_param(RID p_parea, AreaParameter p_param) const = 0;340virtual Transform2D area_get_transform(RID p_area) const = 0;341342virtual void area_set_collision_layer(RID p_area, uint32_t p_layer) = 0;343virtual uint32_t area_get_collision_layer(RID p_area) const = 0;344345virtual void area_set_collision_mask(RID p_area, uint32_t p_mask) = 0;346virtual uint32_t area_get_collision_mask(RID p_area) const = 0;347348virtual void area_set_monitorable(RID p_area, bool p_monitorable) = 0;349virtual void area_set_pickable(RID p_area, bool p_pickable) = 0;350351virtual void area_set_monitor_callback(RID p_area, const Callable &p_callback) = 0;352virtual void area_set_area_monitor_callback(RID p_area, const Callable &p_callback) = 0;353354/* BODY API */355356//missing ccd?357358enum BodyMode {359BODY_MODE_STATIC,360BODY_MODE_KINEMATIC,361BODY_MODE_RIGID,362BODY_MODE_RIGID_LINEAR,363};364365virtual RID body_create() = 0;366367virtual void body_set_space(RID p_body, RID p_space) = 0;368virtual RID body_get_space(RID p_body) const = 0;369370virtual void body_set_mode(RID p_body, BodyMode p_mode) = 0;371virtual BodyMode body_get_mode(RID p_body) const = 0;372373virtual void body_add_shape(RID p_body, RID p_shape, const Transform2D &p_transform = Transform2D(), bool p_disabled = false) = 0;374virtual void body_set_shape(RID p_body, int p_shape_idx, RID p_shape) = 0;375virtual void body_set_shape_transform(RID p_body, int p_shape_idx, const Transform2D &p_transform) = 0;376377virtual int body_get_shape_count(RID p_body) const = 0;378virtual RID body_get_shape(RID p_body, int p_shape_idx) const = 0;379virtual Transform2D body_get_shape_transform(RID p_body, int p_shape_idx) const = 0;380381virtual void body_set_shape_disabled(RID p_body, int p_shape, bool p_disabled) = 0;382virtual void body_set_shape_as_one_way_collision(RID p_body, int p_shape, bool p_enabled, real_t p_margin = 0) = 0;383384virtual void body_remove_shape(RID p_body, int p_shape_idx) = 0;385virtual void body_clear_shapes(RID p_body) = 0;386387virtual void body_attach_object_instance_id(RID p_body, ObjectID p_id) = 0;388virtual ObjectID body_get_object_instance_id(RID p_body) const = 0;389390virtual void body_attach_canvas_instance_id(RID p_body, ObjectID p_id) = 0;391virtual ObjectID body_get_canvas_instance_id(RID p_body) const = 0;392393enum CCDMode {394CCD_MODE_DISABLED,395CCD_MODE_CAST_RAY,396CCD_MODE_CAST_SHAPE,397};398399virtual void body_set_continuous_collision_detection_mode(RID p_body, CCDMode p_mode) = 0;400virtual CCDMode body_get_continuous_collision_detection_mode(RID p_body) const = 0;401402virtual void body_set_collision_layer(RID p_body, uint32_t p_layer) = 0;403virtual uint32_t body_get_collision_layer(RID p_body) const = 0;404405virtual void body_set_collision_mask(RID p_body, uint32_t p_mask) = 0;406virtual uint32_t body_get_collision_mask(RID p_body) const = 0;407408virtual void body_set_collision_priority(RID p_body, real_t p_priority) = 0;409virtual real_t body_get_collision_priority(RID p_body) const = 0;410411// common body variables412enum BodyParameter {413BODY_PARAM_BOUNCE,414BODY_PARAM_FRICTION,415BODY_PARAM_MASS, ///< unused for static, always infinite416BODY_PARAM_INERTIA,417BODY_PARAM_CENTER_OF_MASS,418BODY_PARAM_GRAVITY_SCALE,419BODY_PARAM_LINEAR_DAMP_MODE,420BODY_PARAM_ANGULAR_DAMP_MODE,421BODY_PARAM_LINEAR_DAMP,422BODY_PARAM_ANGULAR_DAMP,423BODY_PARAM_MAX,424};425426enum BodyDampMode {427BODY_DAMP_MODE_COMBINE,428BODY_DAMP_MODE_REPLACE,429};430431virtual void body_set_param(RID p_body, BodyParameter p_param, const Variant &p_value) = 0;432virtual Variant body_get_param(RID p_body, BodyParameter p_param) const = 0;433434virtual void body_reset_mass_properties(RID p_body) = 0;435436//state437enum BodyState {438BODY_STATE_TRANSFORM,439BODY_STATE_LINEAR_VELOCITY,440BODY_STATE_ANGULAR_VELOCITY,441BODY_STATE_SLEEPING,442BODY_STATE_CAN_SLEEP,443};444445virtual void body_set_state(RID p_body, BodyState p_state, const Variant &p_variant) = 0;446virtual Variant body_get_state(RID p_body, BodyState p_state) const = 0;447448virtual void body_apply_central_impulse(RID p_body, const Vector2 &p_impulse) = 0;449virtual void body_apply_torque_impulse(RID p_body, real_t p_torque) = 0;450virtual void body_apply_impulse(RID p_body, const Vector2 &p_impulse, const Vector2 &p_position = Vector2()) = 0;451452virtual void body_apply_central_force(RID p_body, const Vector2 &p_force) = 0;453virtual void body_apply_force(RID p_body, const Vector2 &p_force, const Vector2 &p_position = Vector2()) = 0;454virtual void body_apply_torque(RID p_body, real_t p_torque) = 0;455456virtual void body_add_constant_central_force(RID p_body, const Vector2 &p_force) = 0;457virtual void body_add_constant_force(RID p_body, const Vector2 &p_force, const Vector2 &p_position = Vector2()) = 0;458virtual void body_add_constant_torque(RID p_body, real_t p_torque) = 0;459460virtual void body_set_constant_force(RID p_body, const Vector2 &p_force) = 0;461virtual Vector2 body_get_constant_force(RID p_body) const = 0;462463virtual void body_set_constant_torque(RID p_body, real_t p_torque) = 0;464virtual real_t body_get_constant_torque(RID p_body) const = 0;465466virtual void body_set_axis_velocity(RID p_body, const Vector2 &p_axis_velocity) = 0;467468//fix469virtual void body_add_collision_exception(RID p_body, RID p_body_b) = 0;470virtual void body_remove_collision_exception(RID p_body, RID p_body_b) = 0;471virtual void body_get_collision_exceptions(RID p_body, List<RID> *p_exceptions) = 0;472473virtual void body_set_max_contacts_reported(RID p_body, int p_contacts) = 0;474virtual int body_get_max_contacts_reported(RID p_body) const = 0;475476//missing remove477virtual void body_set_contacts_reported_depth_threshold(RID p_body, real_t p_threshold) = 0;478virtual real_t body_get_contacts_reported_depth_threshold(RID p_body) const = 0;479480virtual void body_set_omit_force_integration(RID p_body, bool p_omit) = 0;481virtual bool body_is_omitting_force_integration(RID p_body) const = 0;482483virtual void body_set_state_sync_callback(RID p_body, const Callable &p_callable) = 0;484virtual void body_set_force_integration_callback(RID p_body, const Callable &p_callable, const Variant &p_udata = Variant()) = 0;485486virtual 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;487488virtual void body_set_pickable(RID p_body, bool p_pickable) = 0;489490// this function only works on physics process, errors and returns null otherwise491virtual PhysicsDirectBodyState2D *body_get_direct_state(RID p_body) = 0;492493struct MotionParameters {494Transform2D from;495Vector2 motion;496real_t margin = 0.08;497bool collide_separation_ray = false;498HashSet<RID> exclude_bodies;499HashSet<ObjectID> exclude_objects;500bool recovery_as_collision = false;501502MotionParameters() {}503504MotionParameters(const Transform2D &p_from, const Vector2 &p_motion, real_t p_margin = 0.08) :505from(p_from),506motion(p_motion),507margin(p_margin) {}508};509510struct MotionResult {511Vector2 travel;512Vector2 remainder;513514Vector2 collision_point;515Vector2 collision_normal;516Vector2 collider_velocity;517real_t collision_depth = 0.0;518real_t collision_safe_fraction = 0.0;519real_t collision_unsafe_fraction = 0.0;520int collision_local_shape = 0;521ObjectID collider_id;522RID collider;523int collider_shape = 0;524525real_t get_angle(Vector2 p_up_direction) const {526return Math::acos(collision_normal.dot(p_up_direction));527}528};529530virtual bool body_test_motion(RID p_body, const MotionParameters &p_parameters, MotionResult *r_result = nullptr) = 0;531532/* JOINT API */533534virtual RID joint_create() = 0;535536virtual void joint_clear(RID p_joint) = 0;537538enum JointType {539JOINT_TYPE_PIN,540JOINT_TYPE_GROOVE,541JOINT_TYPE_DAMPED_SPRING,542JOINT_TYPE_MAX543};544545enum JointParam {546JOINT_PARAM_BIAS,547JOINT_PARAM_MAX_BIAS,548JOINT_PARAM_MAX_FORCE,549};550551virtual void joint_set_param(RID p_joint, JointParam p_param, real_t p_value) = 0;552virtual real_t joint_get_param(RID p_joint, JointParam p_param) const = 0;553554virtual void joint_disable_collisions_between_bodies(RID p_joint, const bool p_disable) = 0;555virtual bool joint_is_disabled_collisions_between_bodies(RID p_joint) const = 0;556557virtual void joint_make_pin(RID p_joint, const Vector2 &p_anchor, RID p_body_a, RID p_body_b = RID()) = 0;558virtual 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;559virtual 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;560561enum PinJointParam {562PIN_JOINT_SOFTNESS,563PIN_JOINT_LIMIT_UPPER,564PIN_JOINT_LIMIT_LOWER,565PIN_JOINT_MOTOR_TARGET_VELOCITY566};567568virtual void pin_joint_set_param(RID p_joint, PinJointParam p_param, real_t p_value) = 0;569virtual real_t pin_joint_get_param(RID p_joint, PinJointParam p_param) const = 0;570571enum PinJointFlag {572PIN_JOINT_FLAG_ANGULAR_LIMIT_ENABLED,573PIN_JOINT_FLAG_MOTOR_ENABLED574};575576virtual void pin_joint_set_flag(RID p_joint, PinJointFlag p_flag, bool p_enabled) = 0;577virtual bool pin_joint_get_flag(RID p_joint, PinJointFlag p_flag) const = 0;578579enum DampedSpringParam {580DAMPED_SPRING_REST_LENGTH,581DAMPED_SPRING_STIFFNESS,582DAMPED_SPRING_DAMPING583};584virtual void damped_spring_joint_set_param(RID p_joint, DampedSpringParam p_param, real_t p_value) = 0;585virtual real_t damped_spring_joint_get_param(RID p_joint, DampedSpringParam p_param) const = 0;586587virtual JointType joint_get_type(RID p_joint) const = 0;588589/* QUERY API */590591enum AreaBodyStatus {592AREA_BODY_ADDED,593AREA_BODY_REMOVED594};595596/* MISC */597598virtual void free_rid(RID p_rid) = 0;599#ifndef DISABLE_DEPRECATED600[[deprecated("Use `free_rid()` instead.")]] void free(RID p_rid) {601free_rid(p_rid);602}603#endif // DISABLE_DEPRECATED604605virtual void set_active(bool p_active) = 0;606virtual void init() = 0;607virtual void step(real_t p_step) = 0;608virtual void sync() = 0;609virtual void flush_queries() = 0;610virtual void end_sync() = 0;611virtual void finish() = 0;612613virtual bool is_flushing_queries() const = 0;614615enum ProcessInfo {616INFO_ACTIVE_OBJECTS,617INFO_COLLISION_PAIRS,618INFO_ISLAND_COUNT619};620621virtual int get_process_info(ProcessInfo p_info) = 0;622623PhysicsServer2D();624~PhysicsServer2D();625};626627class PhysicsRayQueryParameters2D : public RefCounted {628GDCLASS(PhysicsRayQueryParameters2D, RefCounted);629630PhysicsDirectSpaceState2D::RayParameters parameters;631632protected:633static void _bind_methods();634635public:636static Ref<PhysicsRayQueryParameters2D> create(Vector2 p_from, Vector2 p_to, uint32_t p_mask, const TypedArray<RID> &p_exclude);637const PhysicsDirectSpaceState2D::RayParameters &get_parameters() const { return parameters; }638639void set_from(const Vector2 &p_from) { parameters.from = p_from; }640const Vector2 &get_from() const { return parameters.from; }641642void set_to(const Vector2 &p_to) { parameters.to = p_to; }643const Vector2 &get_to() const { return parameters.to; }644645void set_collision_mask(uint32_t p_mask) { parameters.collision_mask = p_mask; }646uint32_t get_collision_mask() const { return parameters.collision_mask; }647648void set_collide_with_bodies(bool p_enable) { parameters.collide_with_bodies = p_enable; }649bool is_collide_with_bodies_enabled() const { return parameters.collide_with_bodies; }650651void set_collide_with_areas(bool p_enable) { parameters.collide_with_areas = p_enable; }652bool is_collide_with_areas_enabled() const { return parameters.collide_with_areas; }653654void set_hit_from_inside(bool p_enable) { parameters.hit_from_inside = p_enable; }655bool is_hit_from_inside_enabled() const { return parameters.hit_from_inside; }656657void set_exclude(const TypedArray<RID> &p_exclude);658TypedArray<RID> get_exclude() const;659};660661class PhysicsPointQueryParameters2D : public RefCounted {662GDCLASS(PhysicsPointQueryParameters2D, RefCounted);663664PhysicsDirectSpaceState2D::PointParameters parameters;665666protected:667static void _bind_methods();668669public:670const PhysicsDirectSpaceState2D::PointParameters &get_parameters() const { return parameters; }671672void set_position(const Vector2 &p_position) { parameters.position = p_position; }673const Vector2 &get_position() const { return parameters.position; }674675void set_canvas_instance_id(ObjectID p_canvas_instance_id) { parameters.canvas_instance_id = p_canvas_instance_id; }676ObjectID get_canvas_instance_id() const { return parameters.canvas_instance_id; }677678void set_collision_mask(uint32_t p_mask) { parameters.collision_mask = p_mask; }679uint32_t get_collision_mask() const { return parameters.collision_mask; }680681void set_collide_with_bodies(bool p_enable) { parameters.collide_with_bodies = p_enable; }682bool is_collide_with_bodies_enabled() const { return parameters.collide_with_bodies; }683684void set_collide_with_areas(bool p_enable) { parameters.collide_with_areas = p_enable; }685bool is_collide_with_areas_enabled() const { return parameters.collide_with_areas; }686687void set_exclude(const TypedArray<RID> &p_exclude);688TypedArray<RID> get_exclude() const;689};690691class PhysicsShapeQueryParameters2D : public RefCounted {692GDCLASS(PhysicsShapeQueryParameters2D, RefCounted);693694PhysicsDirectSpaceState2D::ShapeParameters parameters;695696Ref<Resource> shape_ref;697698protected:699static void _bind_methods();700701public:702const PhysicsDirectSpaceState2D::ShapeParameters &get_parameters() const { return parameters; }703704void set_shape(const Ref<Resource> &p_shape_ref);705Ref<Resource> get_shape() const { return shape_ref; }706707void set_shape_rid(const RID &p_shape);708RID get_shape_rid() const { return parameters.shape_rid; }709710void set_transform(const Transform2D &p_transform) { parameters.transform = p_transform; }711const Transform2D &get_transform() const { return parameters.transform; }712713void set_motion(const Vector2 &p_motion) { parameters.motion = p_motion; }714const Vector2 &get_motion() const { return parameters.motion; }715716void set_margin(real_t p_margin) { parameters.margin = p_margin; }717real_t get_margin() const { return parameters.margin; }718719void set_collision_mask(uint32_t p_mask) { parameters.collision_mask = p_mask; }720uint32_t get_collision_mask() const { return parameters.collision_mask; }721722void set_collide_with_bodies(bool p_enable) { parameters.collide_with_bodies = p_enable; }723bool is_collide_with_bodies_enabled() const { return parameters.collide_with_bodies; }724725void set_collide_with_areas(bool p_enable) { parameters.collide_with_areas = p_enable; }726bool is_collide_with_areas_enabled() const { return parameters.collide_with_areas; }727728void set_exclude(const TypedArray<RID> &p_exclude);729TypedArray<RID> get_exclude() const;730};731732class PhysicsTestMotionParameters2D : public RefCounted {733GDCLASS(PhysicsTestMotionParameters2D, RefCounted);734735PhysicsServer2D::MotionParameters parameters;736737protected:738static void _bind_methods();739740public:741const PhysicsServer2D::MotionParameters &get_parameters() const { return parameters; }742743const Transform2D &get_from() const { return parameters.from; }744void set_from(const Transform2D &p_from) { parameters.from = p_from; }745746const Vector2 &get_motion() const { return parameters.motion; }747void set_motion(const Vector2 &p_motion) { parameters.motion = p_motion; }748749real_t get_margin() const { return parameters.margin; }750void set_margin(real_t p_margin) { parameters.margin = p_margin; }751752bool is_collide_separation_ray_enabled() const { return parameters.collide_separation_ray; }753void set_collide_separation_ray_enabled(bool p_enabled) { parameters.collide_separation_ray = p_enabled; }754755TypedArray<RID> get_exclude_bodies() const;756void set_exclude_bodies(const TypedArray<RID> &p_exclude);757758TypedArray<uint64_t> get_exclude_objects() const;759void set_exclude_objects(const TypedArray<uint64_t> &p_exclude);760761bool is_recovery_as_collision_enabled() const { return parameters.recovery_as_collision; }762void set_recovery_as_collision_enabled(bool p_enabled) { parameters.recovery_as_collision = p_enabled; }763};764765class PhysicsTestMotionResult2D : public RefCounted {766GDCLASS(PhysicsTestMotionResult2D, RefCounted);767768PhysicsServer2D::MotionResult result;769770protected:771static void _bind_methods();772773public:774PhysicsServer2D::MotionResult *get_result_ptr() { return &result; }775776Vector2 get_travel() const;777Vector2 get_remainder() const;778779Vector2 get_collision_point() const;780Vector2 get_collision_normal() const;781Vector2 get_collider_velocity() const;782ObjectID get_collider_id() const;783RID get_collider_rid() const;784Object *get_collider() const;785int get_collider_shape() const;786int get_collision_local_shape() const;787real_t get_collision_depth() const;788real_t get_collision_safe_fraction() const;789real_t get_collision_unsafe_fraction() const;790};791792class PhysicsServer2DManager : public Object {793GDCLASS(PhysicsServer2DManager, Object);794795static PhysicsServer2DManager *singleton;796797struct ClassInfo {798String name;799Callable create_callback;800801ClassInfo() {}802803ClassInfo(String p_name, Callable p_create_callback) :804name(p_name),805create_callback(p_create_callback) {}806807ClassInfo(const ClassInfo &p_ci) :808name(p_ci.name),809create_callback(p_ci.create_callback) {}810811void operator=(const ClassInfo &p_ci) {812name = p_ci.name;813create_callback = p_ci.create_callback;814}815};816817Vector<ClassInfo> physics_2d_servers;818int default_server_id = -1;819int default_server_priority = -1;820821void on_servers_changed();822823protected:824static void _bind_methods();825826public:827static const String setting_property_name;828829static PhysicsServer2DManager *get_singleton();830831void register_server(const String &p_name, const Callable &p_create_callback);832void set_default_server(const String &p_name, int p_priority = 0);833int find_server_id(const String &p_name);834int get_servers_count();835String get_server_name(int p_id);836PhysicsServer2D *new_default_server();837PhysicsServer2D *new_server(const String &p_name);838839PhysicsServer2DManager();840~PhysicsServer2DManager();841};842843VARIANT_ENUM_CAST(PhysicsServer2D::ShapeType);844VARIANT_ENUM_CAST(PhysicsServer2D::SpaceParameter);845VARIANT_ENUM_CAST(PhysicsServer2D::AreaParameter);846VARIANT_ENUM_CAST(PhysicsServer2D::AreaSpaceOverrideMode);847VARIANT_ENUM_CAST(PhysicsServer2D::BodyMode);848VARIANT_ENUM_CAST(PhysicsServer2D::BodyParameter);849VARIANT_ENUM_CAST(PhysicsServer2D::BodyDampMode);850VARIANT_ENUM_CAST(PhysicsServer2D::BodyState);851VARIANT_ENUM_CAST(PhysicsServer2D::CCDMode);852VARIANT_ENUM_CAST(PhysicsServer2D::JointParam);853VARIANT_ENUM_CAST(PhysicsServer2D::JointType);854VARIANT_ENUM_CAST(PhysicsServer2D::PinJointParam);855VARIANT_ENUM_CAST(PhysicsServer2D::PinJointFlag);856VARIANT_ENUM_CAST(PhysicsServer2D::DampedSpringParam);857VARIANT_ENUM_CAST(PhysicsServer2D::AreaBodyStatus);858VARIANT_ENUM_CAST(PhysicsServer2D::ProcessInfo);859860861