Struct gdnative::api::Physics2DServerSW

pub struct Physics2DServerSW { /* fields omitted */ }

core class Physics2DServerSW inherits Physics2DServer (unsafe).

Official documentation

See the documentation of this class in the Godot engine's official documentation.

Class hierarchy

Physics2DServerSW inherits methods from:

• Physics2DServer
• Object

Safety

All types in the Godot API have "interior mutability" in Rust parlance. To enforce that the official thread-safety guidelines are followed, the typestate pattern is used in the Ref and TRef smart pointers, and the Instance API. The typestate Access in these types tracks whether the access is unique, shared, or exclusive to the current thread. For more information, see the type-level documentation on Ref.

Methods from Deref<Target = Physics2DServer>

pub const AREA_BODY_ADDED: i64

pub const AREA_BODY_REMOVED: i64

pub const AREA_PARAM_ANGULAR_DAMP: i64

pub const AREA_PARAM_GRAVITY: i64

pub const AREA_PARAM_GRAVITY_DISTANCE_SCALE: i64

pub const AREA_PARAM_GRAVITY_IS_POINT: i64

pub const AREA_PARAM_GRAVITY_POINT_ATTENUATION: i64

pub const AREA_PARAM_GRAVITY_VECTOR: i64

pub const AREA_PARAM_LINEAR_DAMP: i64

pub const AREA_PARAM_PRIORITY: i64

pub const AREA_SPACE_OVERRIDE_COMBINE: i64

pub const AREA_SPACE_OVERRIDE_COMBINE_REPLACE: i64

pub const AREA_SPACE_OVERRIDE_DISABLED: i64

pub const AREA_SPACE_OVERRIDE_REPLACE: i64

pub const AREA_SPACE_OVERRIDE_REPLACE_COMBINE: i64

pub const BODY_MODE_CHARACTER: i64

pub const BODY_MODE_KINEMATIC: i64

pub const BODY_MODE_RIGID: i64

pub const BODY_MODE_STATIC: i64

pub const BODY_PARAM_ANGULAR_DAMP: i64

pub const BODY_PARAM_BOUNCE: i64

pub const BODY_PARAM_FRICTION: i64

pub const BODY_PARAM_GRAVITY_SCALE: i64

pub const BODY_PARAM_INERTIA: i64

pub const BODY_PARAM_LINEAR_DAMP: i64

pub const BODY_PARAM_MASS: i64

pub const BODY_PARAM_MAX: i64

pub const BODY_STATE_ANGULAR_VELOCITY: i64

pub const BODY_STATE_CAN_SLEEP: i64

pub const BODY_STATE_LINEAR_VELOCITY: i64

pub const BODY_STATE_SLEEPING: i64

pub const BODY_STATE_TRANSFORM: i64

pub const CCD_MODE_CAST_RAY: i64

pub const CCD_MODE_CAST_SHAPE: i64

pub const CCD_MODE_DISABLED: i64

pub const DAMPED_STRING_DAMPING: i64

pub const DAMPED_STRING_REST_LENGTH: i64

pub const DAMPED_STRING_STIFFNESS: i64

pub const INFO_ACTIVE_OBJECTS: i64

pub const INFO_COLLISION_PAIRS: i64

pub const INFO_ISLAND_COUNT: i64

pub const JOINT_DAMPED_SPRING: i64

pub const JOINT_GROOVE: i64

pub const JOINT_PARAM_BIAS: i64

pub const JOINT_PARAM_MAX_BIAS: i64

pub const JOINT_PARAM_MAX_FORCE: i64

pub const JOINT_PIN: i64

pub const SHAPE_CAPSULE: i64

pub const SHAPE_CIRCLE: i64

pub const SHAPE_CONCAVE_POLYGON: i64

pub const SHAPE_CONVEX_POLYGON: i64

pub const SHAPE_CUSTOM: i64

pub const SHAPE_LINE: i64

pub const SHAPE_RAY: i64

pub const SHAPE_RECTANGLE: i64

pub const SHAPE_SEGMENT: i64

pub const SPACE_PARAM_BODY_ANGULAR_VELOCITY_SLEEP_THRESHOLD: i64

pub const SPACE_PARAM_BODY_LINEAR_VELOCITY_SLEEP_THRESHOLD: i64

pub const SPACE_PARAM_BODY_MAX_ALLOWED_PENETRATION: i64

pub const SPACE_PARAM_BODY_TIME_TO_SLEEP: i64

pub const SPACE_PARAM_CONSTRAINT_DEFAULT_BIAS: i64

pub const SPACE_PARAM_CONTACT_MAX_SEPARATION: i64

pub const SPACE_PARAM_CONTACT_RECYCLE_RADIUS: i64

pub const SPACE_PARAM_TEST_MOTION_MIN_CONTACT_DEPTH: i64

pub fn area_add_shape(
    &self,
    area: Rid,
    shape: Rid,
    transform: Transform2D<f32, UnknownUnit, UnknownUnit>,
    disabled: bool
)

Adds a shape to the area, along with a transform matrix. Shapes are usually referenced by their index, so you should track which shape has a given index.

Default Arguments

• transform - Transform2D( 1, 0, 0, 1, 0, 0 )
• disabled - false

pub fn area_attach_canvas_instance_id(&self, area: Rid, id: i64)

pub fn area_attach_object_instance_id(&self, area: Rid, id: i64)

Assigns the area to a descendant of [Object], so it can exist in the node tree.

pub fn area_clear_shapes(&self, area: Rid)

Removes all shapes from an area. It does not delete the shapes, so they can be reassigned later.

pub fn area_create(&self) -> Rid

Creates an [Area2D].

pub fn area_get_canvas_instance_id(&self, area: Rid) -> i64

pub fn area_get_object_instance_id(&self, area: Rid) -> i64

Gets the instance ID of the object the area is assigned to.

pub fn area_get_param(&self, area: Rid, param: i64) -> Variant

Returns an area parameter value. See [enum AreaParameter] for a list of available parameters.

pub fn area_get_shape(&self, area: Rid, shape_idx: i64) -> Rid

Returns the [RID] of the nth shape of an area.

pub fn area_get_shape_count(&self, area: Rid) -> i64

Returns the number of shapes assigned to an area.

pub fn area_get_shape_transform(
    &self,
    area: Rid,
    shape_idx: i64
) -> Transform2D<f32, UnknownUnit, UnknownUnit>

Returns the transform matrix of a shape within an area.

pub fn area_get_space(&self, area: Rid) -> Rid

Returns the space assigned to the area.

pub fn area_get_space_override_mode(&self, area: Rid) -> AreaSpaceOverrideMode

Returns the space override mode for the area.

pub fn area_get_transform(
    &self,
    area: Rid
) -> Transform2D<f32, UnknownUnit, UnknownUnit>

Returns the transform matrix for an area.

pub fn area_remove_shape(&self, area: Rid, shape_idx: i64)

Removes a shape from an area. It does not delete the shape, so it can be reassigned later.

pub fn area_set_area_monitor_callback(
    &self,
    area: Rid,
    receiver: impl AsArg<Object>,
    method: impl Into<GodotString>
)

pub fn area_set_collision_layer(&self, area: Rid, layer: i64)

Assigns the area to one or many physics layers.

pub fn area_set_collision_mask(&self, area: Rid, mask: i64)

Sets which physics layers the area will monitor.

pub fn area_set_monitor_callback(
    &self,
    area: Rid,
    receiver: impl AsArg<Object>,
    method: impl Into<GodotString>
)

Sets the function to call when any body/area enters or exits the area. This callback will be called for any object interacting with the area, and takes five parameters:
				1: [constant AREA_BODY_ADDED] or [constant AREA_BODY_REMOVED], depending on whether the object entered or exited the area.
				2: [RID] of the object that entered/exited the area.
				3: Instance ID of the object that entered/exited the area.
				4: The shape index of the object that entered/exited the area.
				5: The shape index of the area where the object entered/exited.

pub fn area_set_monitorable(&self, area: Rid, monitorable: bool)

pub fn area_set_param(&self, area: Rid, param: i64, value: impl OwnedToVariant)

Sets the value for an area parameter. See [enum AreaParameter] for a list of available parameters.

pub fn area_set_shape(&self, area: Rid, shape_idx: i64, shape: Rid)

Substitutes a given area shape by another. The old shape is selected by its index, the new one by its [RID].

pub fn area_set_shape_disabled(&self, area: Rid, shape_idx: i64, disabled: bool)

Disables a given shape in an area.

pub fn area_set_shape_transform(
    &self,
    area: Rid,
    shape_idx: i64,
    transform: Transform2D<f32, UnknownUnit, UnknownUnit>
)

Sets the transform matrix for an area shape.

pub fn area_set_space(&self, area: Rid, space: Rid)

Assigns a space to the area.

pub fn area_set_space_override_mode(&self, area: Rid, mode: i64)

Sets the space override mode for the area. See [enum AreaSpaceOverrideMode] for a list of available modes.

pub fn area_set_transform(
    &self,
    area: Rid,
    transform: Transform2D<f32, UnknownUnit, UnknownUnit>
)

Sets the transform matrix for an area.

pub fn body_add_central_force(
    &self,
    body: Rid,
    force: Vector2D<f32, UnknownUnit>
)

pub fn body_add_collision_exception(&self, body: Rid, excepted_body: Rid)

Adds a body to the list of bodies exempt from collisions.

pub fn body_add_force(
    &self,
    body: Rid,
    offset: Vector2D<f32, UnknownUnit>,
    force: Vector2D<f32, UnknownUnit>
)

Adds a positioned force to the applied force and torque. As with [method body_apply_impulse], both the force and the offset from the body origin are in global coordinates. A force differs from an impulse in that, while the two are forces, the impulse clears itself after being applied.

pub fn body_add_shape(
    &self,
    body: Rid,
    shape: Rid,
    transform: Transform2D<f32, UnknownUnit, UnknownUnit>,
    disabled: bool
)

Adds a shape to the body, along with a transform matrix. Shapes are usually referenced by their index, so you should track which shape has a given index.

Default Arguments

• transform - Transform2D( 1, 0, 0, 1, 0, 0 )
• disabled - false

pub fn body_add_torque(&self, body: Rid, torque: f64)

pub fn body_apply_central_impulse(
    &self,
    body: Rid,
    impulse: Vector2D<f32, UnknownUnit>
)

pub fn body_apply_impulse(
    &self,
    body: Rid,
    position: Vector2D<f32, UnknownUnit>,
    impulse: Vector2D<f32, UnknownUnit>
)

Adds a positioned impulse to the applied force and torque. Both the force and the offset from the body origin are in global coordinates.

pub fn body_apply_torque_impulse(&self, body: Rid, impulse: f64)

pub fn body_attach_canvas_instance_id(&self, body: Rid, id: i64)

pub fn body_attach_object_instance_id(&self, body: Rid, id: i64)

Assigns the area to a descendant of [Object], so it can exist in the node tree.

pub fn body_clear_shapes(&self, body: Rid)

Removes all shapes from a body.

pub fn body_create(&self) -> Rid

Creates a physics body.

pub fn body_get_canvas_instance_id(&self, body: Rid) -> i64

pub fn body_get_collision_layer(&self, body: Rid) -> i64

Returns the physics layer or layers a body belongs to.

pub fn body_get_collision_mask(&self, body: Rid) -> i64

Returns the physics layer or layers a body can collide with.

pub fn body_get_continuous_collision_detection_mode(&self, body: Rid) -> CcdMode

Returns the continuous collision detection mode.

pub fn body_get_direct_state(
    &self,
    body: Rid
) -> Option<Ref<Physics2DDirectBodyState, Shared>>

Returns the [Physics2DDirectBodyState] of the body.

pub fn body_get_max_contacts_reported(&self, body: Rid) -> i64

Returns the maximum contacts that can be reported. See [method body_set_max_contacts_reported].

pub fn body_get_mode(&self, body: Rid) -> BodyMode

Returns the body mode.

pub fn body_get_object_instance_id(&self, body: Rid) -> i64

Gets the instance ID of the object the area is assigned to.

pub fn body_get_param(&self, body: Rid, param: i64) -> f64

Returns the value of a body parameter. See [enum BodyParameter] for a list of available parameters.

pub fn body_get_shape(&self, body: Rid, shape_idx: i64) -> Rid

Returns the [RID] of the nth shape of a body.

pub fn body_get_shape_count(&self, body: Rid) -> i64

Returns the number of shapes assigned to a body.

pub fn body_get_shape_metadata(&self, body: Rid, shape_idx: i64) -> Variant

Returns the metadata of a shape of a body.

pub fn body_get_shape_transform(
    &self,
    body: Rid,
    shape_idx: i64
) -> Transform2D<f32, UnknownUnit, UnknownUnit>

Returns the transform matrix of a body shape.

pub fn body_get_space(&self, body: Rid) -> Rid

Returns the [RID] of the space assigned to a body.

pub fn body_get_state(&self, body: Rid, state: i64) -> Variant

Returns a body state.

pub fn body_is_omitting_force_integration(&self, body: Rid) -> bool

Returns whether a body uses a callback function to calculate its own physics (see [method body_set_force_integration_callback]).

pub fn body_remove_collision_exception(&self, body: Rid, excepted_body: Rid)

Removes a body from the list of bodies exempt from collisions.

pub fn body_remove_shape(&self, body: Rid, shape_idx: i64)

Removes a shape from a body. The shape is not deleted, so it can be reused afterwards.

pub fn body_set_axis_velocity(
    &self,
    body: Rid,
    axis_velocity: Vector2D<f32, UnknownUnit>
)

Sets an axis velocity. The velocity in the given vector axis will be set as the given vector length. This is useful for jumping behavior.

pub fn body_set_collision_layer(&self, body: Rid, layer: i64)

Sets the physics layer or layers a body belongs to.

pub fn body_set_collision_mask(&self, body: Rid, mask: i64)

Sets the physics layer or layers a body can collide with.

pub fn body_set_continuous_collision_detection_mode(&self, body: Rid, mode: i64)

Sets the continuous collision detection mode using one of the [enum CCDMode] constants.
				Continuous collision detection tries to predict where a moving body will collide, instead of moving it and correcting its movement if it collided.

pub fn body_set_force_integration_callback(
    &self,
    body: Rid,
    receiver: impl AsArg<Object>,
    method: impl Into<GodotString>,
    userdata: impl OwnedToVariant
)

Sets the function used to calculate physics for an object, if that object allows it (see [method body_set_omit_force_integration]).

Default Arguments

• userdata - null

pub fn body_set_max_contacts_reported(&self, body: Rid, amount: i64)

Sets the maximum contacts to report. Bodies can keep a log of the contacts with other bodies, this is enabled by setting the maximum amount of contacts reported to a number greater than 0.

pub fn body_set_mode(&self, body: Rid, mode: i64)

Sets the body mode using one of the [enum BodyMode] constants.

pub fn body_set_omit_force_integration(&self, body: Rid, enable: bool)

Sets whether a body uses a callback function to calculate its own physics (see [method body_set_force_integration_callback]).

pub fn body_set_param(&self, body: Rid, param: i64, value: f64)

Sets a body parameter. See [enum BodyParameter] for a list of available parameters.

pub fn body_set_shape(&self, body: Rid, shape_idx: i64, shape: Rid)

Substitutes a given body shape by another. The old shape is selected by its index, the new one by its [RID].

pub fn body_set_shape_as_one_way_collision(
    &self,
    body: Rid,
    shape_idx: i64,
    enable: bool,
    margin: f64
)

Enables one way collision on body if [code]enable[/code] is [code]true[/code].

pub fn body_set_shape_disabled(&self, body: Rid, shape_idx: i64, disabled: bool)

Disables shape in body if [code]disable[/code] is [code]true[/code].

pub fn body_set_shape_metadata(
    &self,
    body: Rid,
    shape_idx: i64,
    metadata: impl OwnedToVariant
)

Sets metadata of a shape within a body. This metadata is different from [method Object.set_meta], and can be retrieved on shape queries.

pub fn body_set_shape_transform(
    &self,
    body: Rid,
    shape_idx: i64,
    transform: Transform2D<f32, UnknownUnit, UnknownUnit>
)

Sets the transform matrix for a body shape.

pub fn body_set_space(&self, body: Rid, space: Rid)

Assigns a space to the body (see [method space_create]).

pub fn body_set_state(&self, body: Rid, state: i64, value: impl OwnedToVariant)

Sets a body state using one of the [enum BodyState] constants.
				Note that the method doesn't take effect immediately. The state will change on the next physics frame.

pub fn body_test_motion(
    &self,
    body: Rid,
    from: Transform2D<f32, UnknownUnit, UnknownUnit>,
    motion: Vector2D<f32, UnknownUnit>,
    infinite_inertia: bool,
    margin: f64,
    result: impl AsArg<Physics2DTestMotionResult>
) -> bool

Returns [code]true[/code] if a collision would result from moving in the given direction from a given point in space. Margin increases the size of the shapes involved in the collision detection. [Physics2DTestMotionResult] can be passed to return additional information in.

Default Arguments

• margin - 0.08
• result - null

pub fn capsule_shape_create(&self) -> Rid

pub fn circle_shape_create(&self) -> Rid

pub fn concave_polygon_shape_create(&self) -> Rid

pub fn convex_polygon_shape_create(&self) -> Rid

pub fn damped_spring_joint_create(
    &self,
    anchor_a: Vector2D<f32, UnknownUnit>,
    anchor_b: Vector2D<f32, UnknownUnit>,
    body_a: Rid,
    body_b: Rid
) -> Rid

Creates a damped spring joint between two bodies. If not specified, the second body is assumed to be the joint itself.

pub fn damped_string_joint_get_param(&self, joint: Rid, param: i64) -> f64

Returns the value of a damped spring joint parameter.

pub fn damped_string_joint_set_param(&self, joint: Rid, param: i64, value: f64)

Sets a damped spring joint parameter. See [enum DampedStringParam] for a list of available parameters.

pub fn free_rid(&self, rid: Rid)

Destroys any of the objects created by Physics2DServer. If the [RID] passed is not one of the objects that can be created by Physics2DServer, an error will be sent to the console.

pub fn get_process_info(&self, process_info: i64) -> i64

Returns information about the current state of the 2D physics engine. See [enum ProcessInfo] for a list of available states.

pub fn groove_joint_create(
    &self,
    groove1_a: Vector2D<f32, UnknownUnit>,
    groove2_a: Vector2D<f32, UnknownUnit>,
    anchor_b: Vector2D<f32, UnknownUnit>,
    body_a: Rid,
    body_b: Rid
) -> Rid

Creates a groove joint between two bodies. If not specified, the bodies are assumed to be the joint itself.

pub fn joint_get_param(&self, joint: Rid, param: i64) -> f64

Returns the value of a joint parameter.

pub fn joint_get_type(&self, joint: Rid) -> JointType

Returns a joint's type (see [enum JointType]).

pub fn joint_set_param(&self, joint: Rid, param: i64, value: f64)

Sets a joint parameter. See [enum JointParam] for a list of available parameters.

pub fn line_shape_create(&self) -> Rid

pub fn pin_joint_create(
    &self,
    anchor: Vector2D<f32, UnknownUnit>,
    body_a: Rid,
    body_b: Rid
) -> Rid

Creates a pin joint between two bodies. If not specified, the second body is assumed to be the joint itself.

pub fn ray_shape_create(&self) -> Rid

pub fn rectangle_shape_create(&self) -> Rid

pub fn segment_shape_create(&self) -> Rid

pub fn set_active(&self, active: bool)

Activates or deactivates the 2D physics engine.

pub fn shape_get_data(&self, shape: Rid) -> Variant

Returns the shape data.

pub fn shape_get_type(&self, shape: Rid) -> ShapeType

Returns a shape's type (see [enum ShapeType]).

pub fn shape_set_data(&self, shape: Rid, data: impl OwnedToVariant)

Sets the shape data that defines its shape and size. The data to be passed depends on the kind of shape created [method shape_get_type].

pub fn space_create(&self) -> Rid

Creates a space. A space is a collection of parameters for the physics engine that can be assigned to an area or a body. It can be assigned to an area with [method area_set_space], or to a body with [method body_set_space].

pub fn space_get_direct_state(
    &self,
    space: Rid
) -> Option<Ref<Physics2DDirectSpaceState, Shared>>

Returns the state of a space, a [Physics2DDirectSpaceState]. This object can be used to make collision/intersection queries.

pub fn space_get_param(&self, space: Rid, param: i64) -> f64

Returns the value of a space parameter.

pub fn space_is_active(&self, space: Rid) -> bool

Returns whether the space is active.

pub fn space_set_active(&self, space: Rid, active: bool)

Marks a space as active. It will not have an effect, unless it is assigned to an area or body.

pub fn space_set_param(&self, space: Rid, param: i64, value: f64)

Sets the value for a space parameter. See [enum SpaceParameter] for a list of available parameters.

Trait Implementations

impl Debug for Physics2DServerSW

fn fmt(&self, f: &mut Formatter<'_>) -> Result<(), Error>

Formats the value using the given formatter.

impl Deref for Physics2DServerSW

type Target = Physics2DServer

The resulting type after dereferencing.

fn deref(&self) -> &Physics2DServer

Dereferences the value.

impl DerefMut for Physics2DServerSW

fn deref_mut(&mut self) -> &mut Physics2DServer

Mutably dereferences the value.

impl GodotObject for Physics2DServerSW

type RefKind = ManuallyManaged

The memory management kind of this type. This modifies the behavior of the Ref smart pointer. See its type-level documentation for more information.

fn class_name() -> &'static str

fn null() -> Null<Self>

Creates an explicitly null reference of Self as a method argument. This makes type inference easier for the compiler compared to Option.

fn new() -> Ref<Self, Unique> where
    Self: Instanciable, 

Creates a new instance of Self using a zero-argument constructor, as a Unique reference.

fn cast<T>(&self) -> Option<&T> where
    T: GodotObject + SubClass<Self>, 

Performs a dynamic reference downcast to target type.

fn upcast<T>(&self) -> &T where
    Self: SubClass<T>,
    T: GodotObject, 

Performs a static reference upcast to a supertype that is guaranteed to be valid.

unsafe fn assume_shared(&self) -> Ref<Self, Shared>

Creates a persistent reference to the same Godot object with shared thread access.

unsafe fn assume_thread_local(&self) -> Ref<Self, ThreadLocal> where
    Self: GodotObject<RefKind = RefCounted>, 

Creates a persistent reference to the same Godot object with thread-local thread access.

unsafe fn assume_unique(&self) -> Ref<Self, Unique>

Creates a persistent reference to the same Godot object with unique access.

impl SubClass<Object> for Physics2DServerSW

impl SubClass<Physics2DServer> for Physics2DServerSW