Path: blob/master/servers/physics_3d/physics_server_3d.h
11322 views
/**************************************************************************/1/* physics_server_3d.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/gdvirtual.gen.inc"3435constexpr int MAX_CONTACTS_REPORTED_3D_MAX = 4096;3637class PhysicsDirectSpaceState3D;38template <typename T>39class TypedArray;4041class PhysicsDirectBodyState3D : public Object {42GDCLASS(PhysicsDirectBodyState3D, Object);4344protected:45static void _bind_methods();4647public:48virtual Vector3 get_total_gravity() const = 0;49virtual real_t get_total_angular_damp() const = 0;50virtual real_t get_total_linear_damp() const = 0;5152virtual Vector3 get_center_of_mass() const = 0;53virtual Vector3 get_center_of_mass_local() const = 0;54virtual Basis get_principal_inertia_axes() const = 0;55virtual real_t get_inverse_mass() const = 0; // get the mass56virtual Vector3 get_inverse_inertia() const = 0; // get density of this body space57virtual Basis get_inverse_inertia_tensor() const = 0; // get density of this body space5859virtual void set_linear_velocity(const Vector3 &p_velocity) = 0;60virtual Vector3 get_linear_velocity() const = 0;6162virtual void set_angular_velocity(const Vector3 &p_velocity) = 0;63virtual Vector3 get_angular_velocity() const = 0;6465virtual void set_transform(const Transform3D &p_transform) = 0;66virtual Transform3D get_transform() const = 0;6768virtual Vector3 get_velocity_at_local_position(const Vector3 &p_position) const = 0;6970virtual void apply_central_impulse(const Vector3 &p_impulse) = 0;71virtual void apply_impulse(const Vector3 &p_impulse, const Vector3 &p_position = Vector3()) = 0;72virtual void apply_torque_impulse(const Vector3 &p_impulse) = 0;7374virtual void apply_central_force(const Vector3 &p_force) = 0;75virtual void apply_force(const Vector3 &p_force, const Vector3 &p_position = Vector3()) = 0;76virtual void apply_torque(const Vector3 &p_torque) = 0;7778virtual void add_constant_central_force(const Vector3 &p_force) = 0;79virtual void add_constant_force(const Vector3 &p_force, const Vector3 &p_position = Vector3()) = 0;80virtual void add_constant_torque(const Vector3 &p_torque) = 0;8182virtual void set_constant_force(const Vector3 &p_force) = 0;83virtual Vector3 get_constant_force() const = 0;8485virtual void set_constant_torque(const Vector3 &p_torque) = 0;86virtual Vector3 get_constant_torque() const = 0;8788virtual void set_sleep_state(bool p_sleep) = 0;89virtual bool is_sleeping() const = 0;9091virtual void set_collision_layer(uint32_t p_layer) = 0;92virtual uint32_t get_collision_layer() const = 0;9394virtual void set_collision_mask(uint32_t p_mask) = 0;95virtual uint32_t get_collision_mask() const = 0;9697virtual int get_contact_count() const = 0;9899virtual Vector3 get_contact_local_position(int p_contact_idx) const = 0;100virtual Vector3 get_contact_local_normal(int p_contact_idx) const = 0;101virtual Vector3 get_contact_impulse(int p_contact_idx) const = 0;102virtual int get_contact_local_shape(int p_contact_idx) const = 0;103virtual Vector3 get_contact_local_velocity_at_position(int p_contact_idx) const = 0;104105virtual RID get_contact_collider(int p_contact_idx) const = 0;106virtual Vector3 get_contact_collider_position(int p_contact_idx) const = 0;107virtual ObjectID get_contact_collider_id(int p_contact_idx) const = 0;108virtual Object *get_contact_collider_object(int p_contact_idx) const;109virtual int get_contact_collider_shape(int p_contact_idx) const = 0;110virtual Vector3 get_contact_collider_velocity_at_position(int p_contact_idx) const = 0;111112virtual real_t get_step() const = 0;113virtual void integrate_forces();114115virtual PhysicsDirectSpaceState3D *get_space_state() = 0;116117PhysicsDirectBodyState3D();118};119120class PhysicsRayQueryParameters3D;121class PhysicsPointQueryParameters3D;122class PhysicsShapeQueryParameters3D;123124class PhysicsDirectSpaceState3D : public Object {125GDCLASS(PhysicsDirectSpaceState3D, Object);126127private:128Dictionary _intersect_ray(const Ref<PhysicsRayQueryParameters3D> &p_ray_query);129TypedArray<Dictionary> _intersect_point(const Ref<PhysicsPointQueryParameters3D> &p_point_query, int p_max_results = 32);130TypedArray<Dictionary> _intersect_shape(const Ref<PhysicsShapeQueryParameters3D> &p_shape_query, int p_max_results = 32);131Vector<real_t> _cast_motion(const Ref<PhysicsShapeQueryParameters3D> &p_shape_query);132TypedArray<Vector3> _collide_shape(const Ref<PhysicsShapeQueryParameters3D> &p_shape_query, int p_max_results = 32);133Dictionary _get_rest_info(const Ref<PhysicsShapeQueryParameters3D> &p_shape_query);134135protected:136static void _bind_methods();137138public:139struct RayParameters {140Vector3 from;141Vector3 to;142HashSet<RID> exclude;143uint32_t collision_mask = UINT32_MAX;144145bool collide_with_bodies = true;146bool collide_with_areas = false;147148bool hit_from_inside = false;149bool hit_back_faces = true;150151bool pick_ray = false;152};153154struct RayResult {155Vector3 position;156Vector3 normal;157RID rid;158ObjectID collider_id;159Object *collider = nullptr;160int shape = 0;161int face_index = -1;162};163164virtual bool intersect_ray(const RayParameters &p_parameters, RayResult &r_result) = 0;165166struct ShapeResult {167RID rid;168ObjectID collider_id;169Object *collider = nullptr;170int shape = 0;171};172173struct PointParameters {174Vector3 position;175HashSet<RID> exclude;176uint32_t collision_mask = UINT32_MAX;177178bool collide_with_bodies = true;179bool collide_with_areas = false;180};181182virtual int intersect_point(const PointParameters &p_parameters, ShapeResult *r_results, int p_result_max) = 0;183184struct ShapeParameters {185RID shape_rid;186Transform3D transform;187Vector3 motion;188real_t margin = 0.0;189HashSet<RID> exclude;190uint32_t collision_mask = UINT32_MAX;191192bool collide_with_bodies = true;193bool collide_with_areas = false;194};195196struct ShapeRestInfo {197Vector3 point;198Vector3 normal;199RID rid;200ObjectID collider_id;201int shape = 0;202Vector3 linear_velocity; // Velocity at contact point.203};204205virtual int intersect_shape(const ShapeParameters &p_parameters, ShapeResult *r_results, int p_result_max) = 0;206virtual bool cast_motion(const ShapeParameters &p_parameters, real_t &p_closest_safe, real_t &p_closest_unsafe, ShapeRestInfo *r_info = nullptr) = 0;207virtual bool collide_shape(const ShapeParameters &p_parameters, Vector3 *r_results, int p_result_max, int &r_result_count) = 0;208virtual bool rest_info(const ShapeParameters &p_parameters, ShapeRestInfo *r_info) = 0;209210virtual Vector3 get_closest_point_to_object_volume(RID p_object, const Vector3 p_point) const = 0;211212PhysicsDirectSpaceState3D();213};214215class PhysicsServer3DRenderingServerHandler : public Object {216GDCLASS(PhysicsServer3DRenderingServerHandler, Object)217protected:218GDVIRTUAL2_REQUIRED(_set_vertex, int, const Vector3 &)219GDVIRTUAL2_REQUIRED(_set_normal, int, const Vector3 &)220GDVIRTUAL1_REQUIRED(_set_aabb, const AABB &)221222static void _bind_methods();223224public:225virtual void set_vertex(int p_vertex_id, const Vector3 &p_vertex);226virtual void set_normal(int p_vertex_id, const Vector3 &p_normal);227virtual void set_aabb(const AABB &p_aabb);228229virtual ~PhysicsServer3DRenderingServerHandler() {}230};231232class PhysicsTestMotionParameters3D;233class PhysicsTestMotionResult3D;234235class PhysicsServer3D : public Object {236GDCLASS(PhysicsServer3D, Object);237238static PhysicsServer3D *singleton;239240virtual bool _body_test_motion(RID p_body, const Ref<PhysicsTestMotionParameters3D> &p_parameters, const Ref<PhysicsTestMotionResult3D> &p_result = Ref<PhysicsTestMotionResult3D>());241242protected:243static void _bind_methods();244245public:246static PhysicsServer3D *get_singleton();247248enum ShapeType {249SHAPE_WORLD_BOUNDARY, ///< plane:"plane"250SHAPE_SEPARATION_RAY, ///< float:"length"251SHAPE_SPHERE, ///< float:"radius"252SHAPE_BOX, ///< vec3:"extents"253SHAPE_CAPSULE, ///< dict( float:"radius", float:"height"):capsule254SHAPE_CYLINDER, ///< dict( float:"radius", float:"height"):cylinder255SHAPE_CONVEX_POLYGON, ///< array of planes:"planes"256SHAPE_CONCAVE_POLYGON, ///< vector3 array:"triangles" , or Dictionary with "indices" (int array) and "triangles" (Vector3 array)257SHAPE_HEIGHTMAP, ///< dict( int:"width", int:"depth",float:"cell_size", float_array:"heights"258SHAPE_SOFT_BODY, ///< Used internally, can't be created from the physics server.259SHAPE_CUSTOM, ///< Server-Implementation based custom shape, calling shape_create() with this value will result in an error260};261262RID shape_create(ShapeType p_shape);263264virtual RID world_boundary_shape_create() = 0;265virtual RID separation_ray_shape_create() = 0;266virtual RID sphere_shape_create() = 0;267virtual RID box_shape_create() = 0;268virtual RID capsule_shape_create() = 0;269virtual RID cylinder_shape_create() = 0;270virtual RID convex_polygon_shape_create() = 0;271virtual RID concave_polygon_shape_create() = 0;272virtual RID heightmap_shape_create() = 0;273virtual RID custom_shape_create() = 0;274275virtual void shape_set_data(RID p_shape, const Variant &p_data) = 0;276virtual void shape_set_custom_solver_bias(RID p_shape, real_t p_bias) = 0;277278virtual ShapeType shape_get_type(RID p_shape) const = 0;279virtual Variant shape_get_data(RID p_shape) const = 0;280281virtual void shape_set_margin(RID p_shape, real_t p_margin) = 0;282virtual real_t shape_get_margin(RID p_shape) const = 0;283284virtual real_t shape_get_custom_solver_bias(RID p_shape) const = 0;285286/* SPACE API */287288virtual RID space_create() = 0;289virtual void space_set_active(RID p_space, bool p_active) = 0;290virtual bool space_is_active(RID p_space) const = 0;291292enum SpaceParameter {293SPACE_PARAM_CONTACT_RECYCLE_RADIUS,294SPACE_PARAM_CONTACT_MAX_SEPARATION,295SPACE_PARAM_CONTACT_MAX_ALLOWED_PENETRATION,296SPACE_PARAM_CONTACT_DEFAULT_BIAS,297SPACE_PARAM_BODY_LINEAR_VELOCITY_SLEEP_THRESHOLD,298SPACE_PARAM_BODY_ANGULAR_VELOCITY_SLEEP_THRESHOLD,299SPACE_PARAM_BODY_TIME_TO_SLEEP,300SPACE_PARAM_SOLVER_ITERATIONS,301};302303virtual void space_set_param(RID p_space, SpaceParameter p_param, real_t p_value) = 0;304virtual real_t space_get_param(RID p_space, SpaceParameter p_param) const = 0;305306// this function only works on physics process, errors and returns null otherwise307virtual PhysicsDirectSpaceState3D *space_get_direct_state(RID p_space) = 0;308309virtual void space_set_debug_contacts(RID p_space, int p_max_contacts) = 0;310virtual Vector<Vector3> space_get_contacts(RID p_space) const = 0;311virtual int space_get_contact_count(RID p_space) const = 0;312313//missing space parameters314315/* AREA API */316317//missing attenuation? missing better override?318319enum AreaParameter {320AREA_PARAM_GRAVITY_OVERRIDE_MODE,321AREA_PARAM_GRAVITY,322AREA_PARAM_GRAVITY_VECTOR,323AREA_PARAM_GRAVITY_IS_POINT,324AREA_PARAM_GRAVITY_POINT_UNIT_DISTANCE,325AREA_PARAM_LINEAR_DAMP_OVERRIDE_MODE,326AREA_PARAM_LINEAR_DAMP,327AREA_PARAM_ANGULAR_DAMP_OVERRIDE_MODE,328AREA_PARAM_ANGULAR_DAMP,329AREA_PARAM_PRIORITY,330AREA_PARAM_WIND_FORCE_MAGNITUDE,331AREA_PARAM_WIND_SOURCE,332AREA_PARAM_WIND_DIRECTION,333AREA_PARAM_WIND_ATTENUATION_FACTOR,334};335336virtual RID area_create() = 0;337338virtual void area_set_space(RID p_area, RID p_space) = 0;339virtual RID area_get_space(RID p_area) const = 0;340341enum AreaSpaceOverrideMode {342AREA_SPACE_OVERRIDE_DISABLED,343AREA_SPACE_OVERRIDE_COMBINE,344AREA_SPACE_OVERRIDE_COMBINE_REPLACE,345AREA_SPACE_OVERRIDE_REPLACE,346AREA_SPACE_OVERRIDE_REPLACE_COMBINE347};348349virtual void area_add_shape(RID p_area, RID p_shape, const Transform3D &p_transform = Transform3D(), bool p_disabled = false) = 0;350virtual void area_set_shape(RID p_area, int p_shape_idx, RID p_shape) = 0;351virtual void area_set_shape_transform(RID p_area, int p_shape_idx, const Transform3D &p_transform) = 0;352353virtual int area_get_shape_count(RID p_area) const = 0;354virtual RID area_get_shape(RID p_area, int p_shape_idx) const = 0;355virtual Transform3D area_get_shape_transform(RID p_area, int p_shape_idx) const = 0;356357virtual void area_remove_shape(RID p_area, int p_shape_idx) = 0;358virtual void area_clear_shapes(RID p_area) = 0;359360virtual void area_set_shape_disabled(RID p_area, int p_shape_idx, bool p_disabled) = 0;361362virtual void area_attach_object_instance_id(RID p_area, ObjectID p_id) = 0;363virtual ObjectID area_get_object_instance_id(RID p_area) const = 0;364365virtual void area_set_param(RID p_area, AreaParameter p_param, const Variant &p_value) = 0;366virtual void area_set_transform(RID p_area, const Transform3D &p_transform) = 0;367368virtual Variant area_get_param(RID p_parea, AreaParameter p_param) const = 0;369virtual Transform3D area_get_transform(RID p_area) const = 0;370371virtual void area_set_collision_layer(RID p_area, uint32_t p_layer) = 0;372virtual uint32_t area_get_collision_layer(RID p_area) const = 0;373374virtual void area_set_collision_mask(RID p_area, uint32_t p_mask) = 0;375virtual uint32_t area_get_collision_mask(RID p_area) const = 0;376377virtual void area_set_monitorable(RID p_area, bool p_monitorable) = 0;378379virtual void area_set_monitor_callback(RID p_area, const Callable &p_callback) = 0;380virtual void area_set_area_monitor_callback(RID p_area, const Callable &p_callback) = 0;381382virtual void area_set_ray_pickable(RID p_area, bool p_enable) = 0;383384/* BODY API */385386//missing ccd?387388enum BodyMode {389BODY_MODE_STATIC,390BODY_MODE_KINEMATIC,391BODY_MODE_RIGID,392BODY_MODE_RIGID_LINEAR,393};394395enum BodyDampMode {396BODY_DAMP_MODE_COMBINE,397BODY_DAMP_MODE_REPLACE,398};399400virtual RID body_create() = 0;401402virtual void body_set_space(RID p_body, RID p_space) = 0;403virtual RID body_get_space(RID p_body) const = 0;404405virtual void body_set_mode(RID p_body, BodyMode p_mode) = 0;406virtual BodyMode body_get_mode(RID p_body) const = 0;407408virtual void body_add_shape(RID p_body, RID p_shape, const Transform3D &p_transform = Transform3D(), bool p_disabled = false) = 0;409virtual void body_set_shape(RID p_body, int p_shape_idx, RID p_shape) = 0;410virtual void body_set_shape_transform(RID p_body, int p_shape_idx, const Transform3D &p_transform) = 0;411412virtual int body_get_shape_count(RID p_body) const = 0;413virtual RID body_get_shape(RID p_body, int p_shape_idx) const = 0;414virtual Transform3D body_get_shape_transform(RID p_body, int p_shape_idx) const = 0;415416virtual void body_remove_shape(RID p_body, int p_shape_idx) = 0;417virtual void body_clear_shapes(RID p_body) = 0;418419virtual void body_set_shape_disabled(RID p_body, int p_shape_idx, bool p_disabled) = 0;420421virtual void body_attach_object_instance_id(RID p_body, ObjectID p_id) = 0;422virtual ObjectID body_get_object_instance_id(RID p_body) const = 0;423424virtual void body_set_enable_continuous_collision_detection(RID p_body, bool p_enable) = 0;425virtual bool body_is_continuous_collision_detection_enabled(RID p_body) const = 0;426427virtual void body_set_collision_layer(RID p_body, uint32_t p_layer) = 0;428virtual uint32_t body_get_collision_layer(RID p_body) const = 0;429430virtual void body_set_collision_mask(RID p_body, uint32_t p_mask) = 0;431virtual uint32_t body_get_collision_mask(RID p_body) const = 0;432433virtual void body_set_collision_priority(RID p_body, real_t p_priority) = 0;434virtual real_t body_get_collision_priority(RID p_body) const = 0;435436virtual void body_set_user_flags(RID p_body, uint32_t p_flags) = 0;437virtual uint32_t body_get_user_flags(RID p_body) const = 0;438439// common body variables440enum BodyParameter {441BODY_PARAM_BOUNCE,442BODY_PARAM_FRICTION,443BODY_PARAM_MASS, ///< unused for static, always infinite444BODY_PARAM_INERTIA,445BODY_PARAM_CENTER_OF_MASS,446BODY_PARAM_GRAVITY_SCALE,447BODY_PARAM_LINEAR_DAMP_MODE,448BODY_PARAM_ANGULAR_DAMP_MODE,449BODY_PARAM_LINEAR_DAMP,450BODY_PARAM_ANGULAR_DAMP,451BODY_PARAM_MAX,452};453454virtual void body_set_param(RID p_body, BodyParameter p_param, const Variant &p_value) = 0;455virtual Variant body_get_param(RID p_body, BodyParameter p_param) const = 0;456457virtual void body_reset_mass_properties(RID p_body) = 0;458459//state460enum BodyState {461BODY_STATE_TRANSFORM,462BODY_STATE_LINEAR_VELOCITY,463BODY_STATE_ANGULAR_VELOCITY,464BODY_STATE_SLEEPING,465BODY_STATE_CAN_SLEEP466};467468virtual void body_set_state(RID p_body, BodyState p_state, const Variant &p_variant) = 0;469virtual Variant body_get_state(RID p_body, BodyState p_state) const = 0;470471virtual void body_apply_central_impulse(RID p_body, const Vector3 &p_impulse) = 0;472virtual void body_apply_impulse(RID p_body, const Vector3 &p_impulse, const Vector3 &p_position = Vector3()) = 0;473virtual void body_apply_torque_impulse(RID p_body, const Vector3 &p_impulse) = 0;474475virtual void body_apply_central_force(RID p_body, const Vector3 &p_force) = 0;476virtual void body_apply_force(RID p_body, const Vector3 &p_force, const Vector3 &p_position = Vector3()) = 0;477virtual void body_apply_torque(RID p_body, const Vector3 &p_torque) = 0;478479virtual void body_add_constant_central_force(RID p_body, const Vector3 &p_force) = 0;480virtual void body_add_constant_force(RID p_body, const Vector3 &p_force, const Vector3 &p_position = Vector3()) = 0;481virtual void body_add_constant_torque(RID p_body, const Vector3 &p_torque) = 0;482483virtual void body_set_constant_force(RID p_body, const Vector3 &p_force) = 0;484virtual Vector3 body_get_constant_force(RID p_body) const = 0;485486virtual void body_set_constant_torque(RID p_body, const Vector3 &p_torque) = 0;487virtual Vector3 body_get_constant_torque(RID p_body) const = 0;488489virtual void body_set_axis_velocity(RID p_body, const Vector3 &p_axis_velocity) = 0;490491enum BodyAxis {492BODY_AXIS_LINEAR_X = 1 << 0,493BODY_AXIS_LINEAR_Y = 1 << 1,494BODY_AXIS_LINEAR_Z = 1 << 2,495BODY_AXIS_ANGULAR_X = 1 << 3,496BODY_AXIS_ANGULAR_Y = 1 << 4,497BODY_AXIS_ANGULAR_Z = 1 << 5498};499500virtual void body_set_axis_lock(RID p_body, BodyAxis p_axis, bool p_lock) = 0;501virtual bool body_is_axis_locked(RID p_body, BodyAxis p_axis) const = 0;502503//fix504virtual void body_add_collision_exception(RID p_body, RID p_body_b) = 0;505virtual void body_remove_collision_exception(RID p_body, RID p_body_b) = 0;506virtual void body_get_collision_exceptions(RID p_body, List<RID> *p_exceptions) = 0;507508virtual void body_set_max_contacts_reported(RID p_body, int p_contacts) = 0;509virtual int body_get_max_contacts_reported(RID p_body) const = 0;510511//missing remove512virtual void body_set_contacts_reported_depth_threshold(RID p_body, real_t p_threshold) = 0;513virtual real_t body_get_contacts_reported_depth_threshold(RID p_body) const = 0;514515virtual void body_set_omit_force_integration(RID p_body, bool p_omit) = 0;516virtual bool body_is_omitting_force_integration(RID p_body) const = 0;517518virtual void body_set_state_sync_callback(RID p_body, const Callable &p_callable) = 0;519virtual void body_set_force_integration_callback(RID p_body, const Callable &p_callable, const Variant &p_udata = Variant()) = 0;520521virtual void body_set_ray_pickable(RID p_body, bool p_enable) = 0;522523// this function only works on physics process, errors and returns null otherwise524virtual PhysicsDirectBodyState3D *body_get_direct_state(RID p_body) = 0;525526struct MotionParameters {527Transform3D from;528Vector3 motion;529real_t margin = 0.001;530int max_collisions = 1;531bool collide_separation_ray = false;532HashSet<RID> exclude_bodies;533HashSet<ObjectID> exclude_objects;534bool recovery_as_collision = false;535536MotionParameters() {}537538MotionParameters(const Transform3D &p_from, const Vector3 &p_motion, real_t p_margin = 0.001) :539from(p_from),540motion(p_motion),541margin(p_margin) {}542};543544struct MotionCollision {545Vector3 position;546Vector3 normal;547Vector3 collider_velocity;548Vector3 collider_angular_velocity;549real_t depth = 0.0;550int local_shape = 0;551ObjectID collider_id;552RID collider;553int collider_shape = 0;554555real_t get_angle(Vector3 p_up_direction) const {556return Math::acos(normal.dot(p_up_direction));557}558};559560struct MotionResult {561Vector3 travel;562Vector3 remainder;563real_t collision_depth = 0.0;564real_t collision_safe_fraction = 0.0;565real_t collision_unsafe_fraction = 0.0;566567static const int MAX_COLLISIONS = 32;568MotionCollision collisions[MAX_COLLISIONS];569int collision_count = 0;570};571572virtual bool body_test_motion(RID p_body, const MotionParameters &p_parameters, MotionResult *r_result = nullptr) = 0;573574/* SOFT BODY */575576virtual RID soft_body_create() = 0;577578virtual void soft_body_update_rendering_server(RID p_body, PhysicsServer3DRenderingServerHandler *p_rendering_server_handler) = 0;579580virtual void soft_body_set_space(RID p_body, RID p_space) = 0;581virtual RID soft_body_get_space(RID p_body) const = 0;582583virtual void soft_body_set_mesh(RID p_body, RID p_mesh) = 0;584585virtual AABB soft_body_get_bounds(RID p_body) const = 0;586587virtual void soft_body_set_collision_layer(RID p_body, uint32_t p_layer) = 0;588virtual uint32_t soft_body_get_collision_layer(RID p_body) const = 0;589590virtual void soft_body_set_collision_mask(RID p_body, uint32_t p_mask) = 0;591virtual uint32_t soft_body_get_collision_mask(RID p_body) const = 0;592593virtual void soft_body_add_collision_exception(RID p_body, RID p_body_b) = 0;594virtual void soft_body_remove_collision_exception(RID p_body, RID p_body_b) = 0;595virtual void soft_body_get_collision_exceptions(RID p_body, List<RID> *p_exceptions) = 0;596597virtual void soft_body_set_state(RID p_body, BodyState p_state, const Variant &p_variant) = 0;598virtual Variant soft_body_get_state(RID p_body, BodyState p_state) const = 0;599600virtual void soft_body_set_transform(RID p_body, const Transform3D &p_transform) = 0;601602virtual void soft_body_set_ray_pickable(RID p_body, bool p_enable) = 0;603604virtual void soft_body_set_simulation_precision(RID p_body, int p_simulation_precision) = 0;605virtual int soft_body_get_simulation_precision(RID p_body) const = 0;606607virtual void soft_body_set_total_mass(RID p_body, real_t p_total_mass) = 0;608virtual real_t soft_body_get_total_mass(RID p_body) const = 0;609610virtual void soft_body_set_linear_stiffness(RID p_body, real_t p_stiffness) = 0;611virtual real_t soft_body_get_linear_stiffness(RID p_body) const = 0;612613virtual void soft_body_set_shrinking_factor(RID p_body, real_t p_shrinking_factor) = 0;614virtual real_t soft_body_get_shrinking_factor(RID p_body) const = 0;615616virtual void soft_body_set_pressure_coefficient(RID p_body, real_t p_pressure_coefficient) = 0;617virtual real_t soft_body_get_pressure_coefficient(RID p_body) const = 0;618619virtual void soft_body_set_damping_coefficient(RID p_body, real_t p_damping_coefficient) = 0;620virtual real_t soft_body_get_damping_coefficient(RID p_body) const = 0;621622virtual void soft_body_set_drag_coefficient(RID p_body, real_t p_drag_coefficient) = 0;623virtual real_t soft_body_get_drag_coefficient(RID p_body) const = 0;624625virtual void soft_body_move_point(RID p_body, int p_point_index, const Vector3 &p_global_position) = 0;626virtual Vector3 soft_body_get_point_global_position(RID p_body, int p_point_index) const = 0;627628virtual void soft_body_apply_point_impulse(RID p_body, int p_point_index, const Vector3 &p_impulse) = 0;629virtual void soft_body_apply_point_force(RID p_body, int p_point_index, const Vector3 &p_force) = 0;630virtual void soft_body_apply_central_impulse(RID p_body, const Vector3 &p_impulse) = 0;631virtual void soft_body_apply_central_force(RID p_body, const Vector3 &p_force) = 0;632633virtual void soft_body_remove_all_pinned_points(RID p_body) = 0;634virtual void soft_body_pin_point(RID p_body, int p_point_index, bool p_pin) = 0;635virtual bool soft_body_is_point_pinned(RID p_body, int p_point_index) const = 0;636637/* JOINT API */638639enum JointType {640JOINT_TYPE_PIN,641JOINT_TYPE_HINGE,642JOINT_TYPE_SLIDER,643JOINT_TYPE_CONE_TWIST,644JOINT_TYPE_6DOF,645JOINT_TYPE_MAX,646647};648649virtual RID joint_create() = 0;650651virtual void joint_clear(RID p_joint) = 0;652653virtual JointType joint_get_type(RID p_joint) const = 0;654655virtual void joint_set_solver_priority(RID p_joint, int p_priority) = 0;656virtual int joint_get_solver_priority(RID p_joint) const = 0;657658virtual void joint_disable_collisions_between_bodies(RID p_joint, bool p_disable) = 0;659virtual bool joint_is_disabled_collisions_between_bodies(RID p_joint) const = 0;660661virtual void joint_make_pin(RID p_joint, RID p_body_A, const Vector3 &p_local_A, RID p_body_B, const Vector3 &p_local_B) = 0;662663enum PinJointParam {664PIN_JOINT_BIAS,665PIN_JOINT_DAMPING,666PIN_JOINT_IMPULSE_CLAMP667};668669virtual void pin_joint_set_param(RID p_joint, PinJointParam p_param, real_t p_value) = 0;670virtual real_t pin_joint_get_param(RID p_joint, PinJointParam p_param) const = 0;671672virtual void pin_joint_set_local_a(RID p_joint, const Vector3 &p_A) = 0;673virtual Vector3 pin_joint_get_local_a(RID p_joint) const = 0;674675virtual void pin_joint_set_local_b(RID p_joint, const Vector3 &p_B) = 0;676virtual Vector3 pin_joint_get_local_b(RID p_joint) const = 0;677678enum HingeJointParam {679HINGE_JOINT_BIAS,680HINGE_JOINT_LIMIT_UPPER,681HINGE_JOINT_LIMIT_LOWER,682HINGE_JOINT_LIMIT_BIAS,683HINGE_JOINT_LIMIT_SOFTNESS,684HINGE_JOINT_LIMIT_RELAXATION,685HINGE_JOINT_MOTOR_TARGET_VELOCITY,686HINGE_JOINT_MOTOR_MAX_IMPULSE,687HINGE_JOINT_MAX688};689690enum HingeJointFlag {691HINGE_JOINT_FLAG_USE_LIMIT,692HINGE_JOINT_FLAG_ENABLE_MOTOR,693HINGE_JOINT_FLAG_MAX694};695696virtual void joint_make_hinge(RID p_joint, RID p_body_A, const Transform3D &p_hinge_A, RID p_body_B, const Transform3D &p_hinge_B) = 0;697virtual void joint_make_hinge_simple(RID p_joint, RID p_body_A, const Vector3 &p_pivot_A, const Vector3 &p_axis_A, RID p_body_B, const Vector3 &p_pivot_B, const Vector3 &p_axis_B) = 0;698699virtual void hinge_joint_set_param(RID p_joint, HingeJointParam p_param, real_t p_value) = 0;700virtual real_t hinge_joint_get_param(RID p_joint, HingeJointParam p_param) const = 0;701702virtual void hinge_joint_set_flag(RID p_joint, HingeJointFlag p_flag, bool p_enabled) = 0;703virtual bool hinge_joint_get_flag(RID p_joint, HingeJointFlag p_flag) const = 0;704705enum SliderJointParam {706SLIDER_JOINT_LINEAR_LIMIT_UPPER,707SLIDER_JOINT_LINEAR_LIMIT_LOWER,708SLIDER_JOINT_LINEAR_LIMIT_SOFTNESS,709SLIDER_JOINT_LINEAR_LIMIT_RESTITUTION,710SLIDER_JOINT_LINEAR_LIMIT_DAMPING,711SLIDER_JOINT_LINEAR_MOTION_SOFTNESS,712SLIDER_JOINT_LINEAR_MOTION_RESTITUTION,713SLIDER_JOINT_LINEAR_MOTION_DAMPING,714SLIDER_JOINT_LINEAR_ORTHOGONAL_SOFTNESS,715SLIDER_JOINT_LINEAR_ORTHOGONAL_RESTITUTION,716SLIDER_JOINT_LINEAR_ORTHOGONAL_DAMPING,717718SLIDER_JOINT_ANGULAR_LIMIT_UPPER,719SLIDER_JOINT_ANGULAR_LIMIT_LOWER,720SLIDER_JOINT_ANGULAR_LIMIT_SOFTNESS,721SLIDER_JOINT_ANGULAR_LIMIT_RESTITUTION,722SLIDER_JOINT_ANGULAR_LIMIT_DAMPING,723SLIDER_JOINT_ANGULAR_MOTION_SOFTNESS,724SLIDER_JOINT_ANGULAR_MOTION_RESTITUTION,725SLIDER_JOINT_ANGULAR_MOTION_DAMPING,726SLIDER_JOINT_ANGULAR_ORTHOGONAL_SOFTNESS,727SLIDER_JOINT_ANGULAR_ORTHOGONAL_RESTITUTION,728SLIDER_JOINT_ANGULAR_ORTHOGONAL_DAMPING,729SLIDER_JOINT_MAX730731};732733virtual void joint_make_slider(RID p_joint, RID p_body_A, const Transform3D &p_local_frame_A, RID p_body_B, const Transform3D &p_local_frame_B) = 0; //reference frame is A734735virtual void slider_joint_set_param(RID p_joint, SliderJointParam p_param, real_t p_value) = 0;736virtual real_t slider_joint_get_param(RID p_joint, SliderJointParam p_param) const = 0;737738enum ConeTwistJointParam {739CONE_TWIST_JOINT_SWING_SPAN,740CONE_TWIST_JOINT_TWIST_SPAN,741CONE_TWIST_JOINT_BIAS,742CONE_TWIST_JOINT_SOFTNESS,743CONE_TWIST_JOINT_RELAXATION,744CONE_TWIST_MAX745};746747virtual void joint_make_cone_twist(RID p_joint, RID p_body_A, const Transform3D &p_local_frame_A, RID p_body_B, const Transform3D &p_local_frame_B) = 0; //reference frame is A748749virtual void cone_twist_joint_set_param(RID p_joint, ConeTwistJointParam p_param, real_t p_value) = 0;750virtual real_t cone_twist_joint_get_param(RID p_joint, ConeTwistJointParam p_param) const = 0;751752enum G6DOFJointAxisParam {753G6DOF_JOINT_LINEAR_LOWER_LIMIT,754G6DOF_JOINT_LINEAR_UPPER_LIMIT,755G6DOF_JOINT_LINEAR_LIMIT_SOFTNESS,756G6DOF_JOINT_LINEAR_RESTITUTION,757G6DOF_JOINT_LINEAR_DAMPING,758G6DOF_JOINT_LINEAR_MOTOR_TARGET_VELOCITY,759G6DOF_JOINT_LINEAR_MOTOR_FORCE_LIMIT,760G6DOF_JOINT_LINEAR_SPRING_STIFFNESS,761G6DOF_JOINT_LINEAR_SPRING_DAMPING,762G6DOF_JOINT_LINEAR_SPRING_EQUILIBRIUM_POINT,763G6DOF_JOINT_ANGULAR_LOWER_LIMIT,764G6DOF_JOINT_ANGULAR_UPPER_LIMIT,765G6DOF_JOINT_ANGULAR_LIMIT_SOFTNESS,766G6DOF_JOINT_ANGULAR_DAMPING,767G6DOF_JOINT_ANGULAR_RESTITUTION,768G6DOF_JOINT_ANGULAR_FORCE_LIMIT,769G6DOF_JOINT_ANGULAR_ERP,770G6DOF_JOINT_ANGULAR_MOTOR_TARGET_VELOCITY,771G6DOF_JOINT_ANGULAR_MOTOR_FORCE_LIMIT,772G6DOF_JOINT_ANGULAR_SPRING_STIFFNESS,773G6DOF_JOINT_ANGULAR_SPRING_DAMPING,774G6DOF_JOINT_ANGULAR_SPRING_EQUILIBRIUM_POINT,775G6DOF_JOINT_MAX776};777778enum G6DOFJointAxisFlag {779G6DOF_JOINT_FLAG_ENABLE_LINEAR_LIMIT,780G6DOF_JOINT_FLAG_ENABLE_ANGULAR_LIMIT,781G6DOF_JOINT_FLAG_ENABLE_ANGULAR_SPRING,782G6DOF_JOINT_FLAG_ENABLE_LINEAR_SPRING,783G6DOF_JOINT_FLAG_ENABLE_MOTOR,784G6DOF_JOINT_FLAG_ENABLE_LINEAR_MOTOR,785G6DOF_JOINT_FLAG_MAX786};787788virtual void joint_make_generic_6dof(RID p_joint, RID p_body_A, const Transform3D &p_local_frame_A, RID p_body_B, const Transform3D &p_local_frame_B) = 0; //reference frame is A789790virtual void generic_6dof_joint_set_param(RID p_joint, Vector3::Axis, G6DOFJointAxisParam p_param, real_t p_value) = 0;791virtual real_t generic_6dof_joint_get_param(RID p_joint, Vector3::Axis, G6DOFJointAxisParam p_param) const = 0;792793virtual void generic_6dof_joint_set_flag(RID p_joint, Vector3::Axis, G6DOFJointAxisFlag p_flag, bool p_enable) = 0;794virtual bool generic_6dof_joint_get_flag(RID p_joint, Vector3::Axis, G6DOFJointAxisFlag p_flag) const = 0;795796/* QUERY API */797798enum AreaBodyStatus {799AREA_BODY_ADDED,800AREA_BODY_REMOVED801};802803/* MISC */804805virtual void free_rid(RID p_rid) = 0;806#ifndef DISABLE_DEPRECATED807[[deprecated("Use `free_rid()` instead.")]] void free(RID p_rid) {808free_rid(p_rid);809}810#endif // DISABLE_DEPRECATED811812virtual void set_active(bool p_active) = 0;813virtual void init() = 0;814virtual void step(real_t p_step) = 0;815virtual void sync() = 0;816virtual void flush_queries() = 0;817virtual void end_sync() = 0;818virtual void finish() = 0;819820virtual bool is_flushing_queries() const = 0;821822enum ProcessInfo {823INFO_ACTIVE_OBJECTS,824INFO_COLLISION_PAIRS,825INFO_ISLAND_COUNT826};827828virtual int get_process_info(ProcessInfo p_info) = 0;829830PhysicsServer3D();831~PhysicsServer3D();832};833834class PhysicsRayQueryParameters3D : public RefCounted {835GDCLASS(PhysicsRayQueryParameters3D, RefCounted);836837PhysicsDirectSpaceState3D::RayParameters parameters;838839protected:840static void _bind_methods();841842public:843static Ref<PhysicsRayQueryParameters3D> create(Vector3 p_from, Vector3 p_to, uint32_t p_mask, const TypedArray<RID> &p_exclude);844const PhysicsDirectSpaceState3D::RayParameters &get_parameters() const { return parameters; }845846void set_from(const Vector3 &p_from) { parameters.from = p_from; }847const Vector3 &get_from() const { return parameters.from; }848849void set_to(const Vector3 &p_to) { parameters.to = p_to; }850const Vector3 &get_to() const { return parameters.to; }851852void set_collision_mask(uint32_t p_mask) { parameters.collision_mask = p_mask; }853uint32_t get_collision_mask() const { return parameters.collision_mask; }854855void set_collide_with_bodies(bool p_enable) { parameters.collide_with_bodies = p_enable; }856bool is_collide_with_bodies_enabled() const { return parameters.collide_with_bodies; }857858void set_collide_with_areas(bool p_enable) { parameters.collide_with_areas = p_enable; }859bool is_collide_with_areas_enabled() const { return parameters.collide_with_areas; }860861void set_hit_from_inside(bool p_enable) { parameters.hit_from_inside = p_enable; }862bool is_hit_from_inside_enabled() const { return parameters.hit_from_inside; }863864void set_hit_back_faces(bool p_enable) { parameters.hit_back_faces = p_enable; }865bool is_hit_back_faces_enabled() const { return parameters.hit_back_faces; }866867void set_exclude(const TypedArray<RID> &p_exclude);868TypedArray<RID> get_exclude() const;869};870871class PhysicsPointQueryParameters3D : public RefCounted {872GDCLASS(PhysicsPointQueryParameters3D, RefCounted);873874PhysicsDirectSpaceState3D::PointParameters parameters;875876protected:877static void _bind_methods();878879public:880const PhysicsDirectSpaceState3D::PointParameters &get_parameters() const { return parameters; }881882void set_position(const Vector3 &p_position) { parameters.position = p_position; }883const Vector3 &get_position() const { return parameters.position; }884885void set_collision_mask(uint32_t p_mask) { parameters.collision_mask = p_mask; }886uint32_t get_collision_mask() const { return parameters.collision_mask; }887888void set_collide_with_bodies(bool p_enable) { parameters.collide_with_bodies = p_enable; }889bool is_collide_with_bodies_enabled() const { return parameters.collide_with_bodies; }890891void set_collide_with_areas(bool p_enable) { parameters.collide_with_areas = p_enable; }892bool is_collide_with_areas_enabled() const { return parameters.collide_with_areas; }893894void set_exclude(const TypedArray<RID> &p_exclude);895TypedArray<RID> get_exclude() const;896};897898class PhysicsShapeQueryParameters3D : public RefCounted {899GDCLASS(PhysicsShapeQueryParameters3D, RefCounted);900901PhysicsDirectSpaceState3D::ShapeParameters parameters;902903Ref<Resource> shape_ref;904905protected:906static void _bind_methods();907908public:909const PhysicsDirectSpaceState3D::ShapeParameters &get_parameters() const { return parameters; }910911void set_shape(const Ref<Resource> &p_shape_ref);912Ref<Resource> get_shape() const { return shape_ref; }913914void set_shape_rid(const RID &p_shape);915RID get_shape_rid() const { return parameters.shape_rid; }916917void set_transform(const Transform3D &p_transform) { parameters.transform = p_transform; }918const Transform3D &get_transform() const { return parameters.transform; }919920void set_motion(const Vector3 &p_motion) { parameters.motion = p_motion; }921const Vector3 &get_motion() const { return parameters.motion; }922923void set_margin(real_t p_margin) { parameters.margin = p_margin; }924real_t get_margin() const { return parameters.margin; }925926void set_collision_mask(uint32_t p_mask) { parameters.collision_mask = p_mask; }927uint32_t get_collision_mask() const { return parameters.collision_mask; }928929void set_collide_with_bodies(bool p_enable) { parameters.collide_with_bodies = p_enable; }930bool is_collide_with_bodies_enabled() const { return parameters.collide_with_bodies; }931932void set_collide_with_areas(bool p_enable) { parameters.collide_with_areas = p_enable; }933bool is_collide_with_areas_enabled() const { return parameters.collide_with_areas; }934935void set_exclude(const TypedArray<RID> &p_exclude);936TypedArray<RID> get_exclude() const;937};938939class PhysicsTestMotionParameters3D : public RefCounted {940GDCLASS(PhysicsTestMotionParameters3D, RefCounted);941942PhysicsServer3D::MotionParameters parameters;943944protected:945static void _bind_methods();946947public:948const PhysicsServer3D::MotionParameters &get_parameters() const { return parameters; }949950const Transform3D &get_from() const { return parameters.from; }951void set_from(const Transform3D &p_from) { parameters.from = p_from; }952953const Vector3 &get_motion() const { return parameters.motion; }954void set_motion(const Vector3 &p_motion) { parameters.motion = p_motion; }955956real_t get_margin() const { return parameters.margin; }957void set_margin(real_t p_margin) { parameters.margin = p_margin; }958959int get_max_collisions() const { return parameters.max_collisions; }960void set_max_collisions(int p_max_collisions) { parameters.max_collisions = p_max_collisions; }961962bool is_collide_separation_ray_enabled() const { return parameters.collide_separation_ray; }963void set_collide_separation_ray_enabled(bool p_enabled) { parameters.collide_separation_ray = p_enabled; }964965TypedArray<RID> get_exclude_bodies() const;966void set_exclude_bodies(const TypedArray<RID> &p_exclude);967968TypedArray<uint64_t> get_exclude_objects() const;969void set_exclude_objects(const TypedArray<uint64_t> &p_exclude);970971bool is_recovery_as_collision_enabled() const { return parameters.recovery_as_collision; }972void set_recovery_as_collision_enabled(bool p_enabled) { parameters.recovery_as_collision = p_enabled; }973};974975class PhysicsTestMotionResult3D : public RefCounted {976GDCLASS(PhysicsTestMotionResult3D, RefCounted);977978PhysicsServer3D::MotionResult result;979980protected:981static void _bind_methods();982983public:984PhysicsServer3D::MotionResult *get_result_ptr() { return &result; }985986Vector3 get_travel() const;987Vector3 get_remainder() const;988real_t get_collision_safe_fraction() const;989real_t get_collision_unsafe_fraction() const;990991int get_collision_count() const;992993Vector3 get_collision_point(int p_collision_index = 0) const;994Vector3 get_collision_normal(int p_collision_index = 0) const;995Vector3 get_collider_velocity(int p_collision_index = 0) const;996ObjectID get_collider_id(int p_collision_index = 0) const;997RID get_collider_rid(int p_collision_index = 0) const;998Object *get_collider(int p_collision_index = 0) const;999int get_collider_shape(int p_collision_index = 0) const;1000int get_collision_local_shape(int p_collision_index = 0) const;1001real_t get_collision_depth(int p_collision_index = 0) const;1002};10031004class PhysicsServer3DManager : public Object {1005GDCLASS(PhysicsServer3DManager, Object);10061007static PhysicsServer3DManager *singleton;10081009struct ClassInfo {1010String name;1011Callable create_callback;10121013ClassInfo() {}10141015ClassInfo(String p_name, Callable p_create_callback) :1016name(p_name),1017create_callback(p_create_callback) {}10181019ClassInfo(const ClassInfo &p_ci) :1020name(p_ci.name),1021create_callback(p_ci.create_callback) {}10221023void operator=(const ClassInfo &p_ci) {1024name = p_ci.name;1025create_callback = p_ci.create_callback;1026}1027};10281029Vector<ClassInfo> physics_servers;1030int default_server_id = -1;1031int default_server_priority = -1;10321033void on_servers_changed();10341035protected:1036static void _bind_methods();10371038public:1039static const String setting_property_name;10401041static PhysicsServer3DManager *get_singleton();10421043void register_server(const String &p_name, const Callable &p_create_callback);1044void set_default_server(const String &p_name, int p_priority = 0);1045int find_server_id(const String &p_name);1046int get_servers_count();1047String get_server_name(int p_id);1048PhysicsServer3D *new_default_server();1049PhysicsServer3D *new_server(const String &p_name);10501051PhysicsServer3DManager();1052~PhysicsServer3DManager();1053};10541055VARIANT_ENUM_CAST(PhysicsServer3D::ShapeType);1056VARIANT_ENUM_CAST(PhysicsServer3D::SpaceParameter);1057VARIANT_ENUM_CAST(PhysicsServer3D::AreaParameter);1058VARIANT_ENUM_CAST(PhysicsServer3D::AreaSpaceOverrideMode);1059VARIANT_ENUM_CAST(PhysicsServer3D::BodyMode);1060VARIANT_ENUM_CAST(PhysicsServer3D::BodyParameter);1061VARIANT_ENUM_CAST(PhysicsServer3D::BodyDampMode);1062VARIANT_ENUM_CAST(PhysicsServer3D::BodyState);1063VARIANT_ENUM_CAST(PhysicsServer3D::BodyAxis);1064VARIANT_ENUM_CAST(PhysicsServer3D::PinJointParam);1065VARIANT_ENUM_CAST(PhysicsServer3D::JointType);1066VARIANT_ENUM_CAST(PhysicsServer3D::HingeJointParam);1067VARIANT_ENUM_CAST(PhysicsServer3D::HingeJointFlag);1068VARIANT_ENUM_CAST(PhysicsServer3D::SliderJointParam);1069VARIANT_ENUM_CAST(PhysicsServer3D::ConeTwistJointParam);1070VARIANT_ENUM_CAST(PhysicsServer3D::G6DOFJointAxisParam);1071VARIANT_ENUM_CAST(PhysicsServer3D::G6DOFJointAxisFlag);1072VARIANT_ENUM_CAST(PhysicsServer3D::AreaBodyStatus);1073VARIANT_ENUM_CAST(PhysicsServer3D::ProcessInfo);107410751076