Struct gdnative_bindings::Physics2DDirectBodyStateSW

pub struct Physics2DDirectBodyStateSW { /* fields omitted */ }

core class Physics2DDirectBodyStateSW inherits Physics2DDirectBodyState (unsafe).

Official documentation

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

Class hierarchy

Physics2DDirectBodyStateSW inherits methods from:

• Physics2DDirectBodyState
• 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 = Physics2DDirectBodyState>

pub fn add_central_force(&self, force: Vector2)

Adds a constant directional force without affecting rotation.

pub fn add_force(&self, offset: Vector2, force: Vector2)

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

pub fn add_torque(&self, torque: f64)

Adds a constant rotational force.

pub fn apply_central_impulse(&self, impulse: Vector2)

Applies a directional impulse without affecting rotation.

pub fn apply_impulse(&self, offset: Vector2, impulse: Vector2)

Applies a positioned impulse to the body. An impulse is time-independent! Applying an impulse every frame would result in a framerate-dependent force. For this reason, it should only be used when simulating one-time impacts (use the "_force" functions otherwise). The offset uses the rotation of the global coordinate system, but is centered at the object's origin.

pub fn apply_torque_impulse(&self, impulse: f64)

Applies a rotational impulse to the body.

pub fn angular_velocity(&self) -> f64

The body's rotational velocity.

pub fn get_contact_collider(&self, contact_idx: i64) -> Rid

Returns the collider's [RID].

pub fn get_contact_collider_id(&self, contact_idx: i64) -> i64

Returns the collider's object id.

pub fn get_contact_collider_object(
    &self,
    contact_idx: i64
) -> Option<Ref<Object, Shared>>

Returns the collider object. This depends on how it was created (will return a scene node if such was used to create it).

pub fn get_contact_collider_position(&self, contact_idx: i64) -> Vector2

Returns the contact position in the collider.

pub fn get_contact_collider_shape(&self, contact_idx: i64) -> i64

Returns the collider's shape index.

pub fn get_contact_collider_shape_metadata(&self, contact_idx: i64) -> Variant

Returns the collided shape's metadata. This metadata is different from [method Object.get_meta], and is set with [method Physics2DServer.shape_set_data].

pub fn get_contact_collider_velocity_at_position(
    &self,
    contact_idx: i64
) -> Vector2

Returns the linear velocity vector at the collider's contact point.

pub fn get_contact_count(&self) -> i64

Returns the number of contacts this body has with other bodies.
				[b]Note:[/b] By default, this returns 0 unless bodies are configured to monitor contacts. See [member RigidBody2D.contact_monitor].

pub fn get_contact_local_normal(&self, contact_idx: i64) -> Vector2

Returns the local normal at the contact point.

pub fn get_contact_local_position(&self, contact_idx: i64) -> Vector2

Returns the local position of the contact point.

pub fn get_contact_local_shape(&self, contact_idx: i64) -> i64

Returns the local shape index of the collision.

pub fn inverse_inertia(&self) -> f64

The inverse of the inertia of the body.

pub fn inverse_mass(&self) -> f64

The inverse of the mass of the body.

pub fn linear_velocity(&self) -> Vector2

The body's linear velocity.

pub fn get_space_state(&self) -> Option<Ref<Physics2DDirectSpaceState, Shared>>

Returns the current state of the space, useful for queries.

pub fn step(&self) -> f64

The timestep (delta) used for the simulation.

pub fn total_angular_damp(&self) -> f64

The rate at which the body stops rotating, if there are not any other forces moving it.

pub fn total_gravity(&self) -> Vector2

The total gravity vector being currently applied to this body.

pub fn total_linear_damp(&self) -> f64

The rate at which the body stops moving, if there are not any other forces moving it.

pub fn transform(&self) -> Transform2D

The body's transformation matrix.

pub fn integrate_forces(&self)

Calls the built-in force integration code.

pub fn is_sleeping(&self) -> bool

If [code]true[/code], this body is currently sleeping (not active).

pub fn set_angular_velocity(&self, velocity: f64)

The body's rotational velocity.

pub fn set_linear_velocity(&self, velocity: Vector2)

The body's linear velocity.

pub fn set_sleep_state(&self, enabled: bool)

If [code]true[/code], this body is currently sleeping (not active).

pub fn set_transform(&self, transform: Transform2D)

The body's transformation matrix.

Trait Implementations

impl Debug for Physics2DDirectBodyStateSW

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

Formats the value using the given formatter.

impl Deref for Physics2DDirectBodyStateSW

type Target = Physics2DDirectBodyState

The resulting type after dereferencing.

fn deref(&self) -> &Physics2DDirectBodyState

Dereferences the value.

impl DerefMut for Physics2DDirectBodyStateSW

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

Mutably dereferences the value.

impl GodotObject for Physics2DDirectBodyStateSW

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 Sealed for Physics2DDirectBodyStateSW

impl SubClass<Object> for Physics2DDirectBodyStateSW

impl SubClass<Physics2DDirectBodyState> for Physics2DDirectBodyStateSW