Struct gdnative::RigidBody

pub struct RigidBody { /* fields omitted */ }

core class RigidBody inherits PhysicsBody (unsafe).

Official documentation

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

Memory management

Non reference counted objects such as the ones of this type are usually owned by the engine.

RigidBody is an unsafe pointer, and all of its methods are unsafe.

In the cases where Rust code owns an object of this type, for example if the object was just created on the Rust side and not passed to the engine yet, ownership should be either given to the engine or the object must be manually destroyed using RigidBody::free.

Class hierarchy

RigidBody inherits methods from:

• PhysicsBody
• CollisionObject
• Spatial
• Node
• Object

Methods

impl RigidBody

Constants

pub const MODE_CHARACTER: i64

pub const MODE_KINEMATIC: i64

pub const MODE_STATIC: i64

pub const MODE_RIGID: i64

impl RigidBody

pub fn new() -> RigidBody

Constructor.

Because this type is not reference counted, the lifetime of the returned object is not automatically managed. Immediately after creation, the object is owned by the caller, and can be passed to the engine (in which case the engine will be responsible for destroying the object) or destroyed manually using RigidBody::free.

pub unsafe fn free(self)

Manually deallocate the object.

pub unsafe fn _body_enter_tree(&mut self, arg0: i64)

pub unsafe fn _body_exit_tree(&mut self, arg0: i64)

pub unsafe fn _direct_state_changed(&mut self, arg0: Option<Object>)

pub unsafe fn _integrate_forces(
    &mut self,
    state: Option<PhysicsDirectBodyState>
)

pub unsafe fn _reload_physics_characteristics(&mut self)

pub unsafe fn add_central_force(&mut self, force: Vector3D<f32, UnknownUnit>)

pub unsafe fn add_force(
    &mut self,
    force: Vector3D<f32, UnknownUnit>,
    position: Vector3D<f32, UnknownUnit>
)

pub unsafe fn add_torque(&mut self, torque: Vector3D<f32, UnknownUnit>)

pub unsafe fn apply_central_impulse(
    &mut self,
    impulse: Vector3D<f32, UnknownUnit>
)

pub unsafe fn apply_impulse(
    &mut self,
    position: Vector3D<f32, UnknownUnit>,
    impulse: Vector3D<f32, UnknownUnit>
)

pub unsafe fn apply_torque_impulse(
    &mut self,
    impulse: Vector3D<f32, UnknownUnit>
)

pub unsafe fn get_angular_damp(&self) -> f64

pub unsafe fn get_angular_velocity(&self) -> Vector3D<f32, UnknownUnit>

pub unsafe fn get_axis_lock(&self, axis: i64) -> bool

pub unsafe fn get_bounce(&self) -> f64

pub unsafe fn get_colliding_bodies(&self) -> VariantArray

pub unsafe fn get_friction(&self) -> f64

pub unsafe fn get_gravity_scale(&self) -> f64

pub unsafe fn get_linear_damp(&self) -> f64

pub unsafe fn get_linear_velocity(&self) -> Vector3D<f32, UnknownUnit>

pub unsafe fn get_mass(&self) -> f64

pub unsafe fn get_max_contacts_reported(&self) -> i64

pub unsafe fn get_mode(&self) -> RigidBodyMode

pub unsafe fn get_physics_material_override(&self) -> Option<PhysicsMaterial>

pub unsafe fn get_weight(&self) -> f64

pub unsafe fn is_able_to_sleep(&self) -> bool

pub unsafe fn is_contact_monitor_enabled(&self) -> bool

pub unsafe fn is_sleeping(&self) -> bool

pub unsafe fn is_using_continuous_collision_detection(&self) -> bool

pub unsafe fn is_using_custom_integrator(&mut self) -> bool

pub unsafe fn set_angular_damp(&mut self, angular_damp: f64)

pub unsafe fn set_angular_velocity(
    &mut self,
    angular_velocity: Vector3D<f32, UnknownUnit>
)

pub unsafe fn set_axis_lock(&mut self, axis: i64, lock: bool)

pub unsafe fn set_axis_velocity(
    &mut self,
    axis_velocity: Vector3D<f32, UnknownUnit>
)

pub unsafe fn set_bounce(&mut self, bounce: f64)

pub unsafe fn set_can_sleep(&mut self, able_to_sleep: bool)

pub unsafe fn set_contact_monitor(&mut self, enabled: bool)

pub unsafe fn set_friction(&mut self, friction: f64)

pub unsafe fn set_gravity_scale(&mut self, gravity_scale: f64)

pub unsafe fn set_linear_damp(&mut self, linear_damp: f64)

pub unsafe fn set_linear_velocity(
    &mut self,
    linear_velocity: Vector3D<f32, UnknownUnit>
)

pub unsafe fn set_mass(&mut self, mass: f64)

pub unsafe fn set_max_contacts_reported(&mut self, amount: i64)

pub unsafe fn set_mode(&mut self, mode: i64)

pub unsafe fn set_physics_material_override(
    &mut self,
    physics_material_override: Option<PhysicsMaterial>
)

pub unsafe fn set_sleeping(&mut self, sleeping: bool)

pub unsafe fn set_use_continuous_collision_detection(&mut self, enable: bool)

pub unsafe fn set_use_custom_integrator(&mut self, enable: bool)

pub unsafe fn set_weight(&mut self, weight: f64)

pub unsafe fn to_physics_body(&self) -> PhysicsBody

Up-cast.

pub unsafe fn to_collision_object(&self) -> CollisionObject

Up-cast.

pub unsafe fn to_spatial(&self) -> Spatial

Up-cast.

pub unsafe fn to_node(&self) -> Node

Up-cast.

pub unsafe fn to_object(&self) -> Object

Up-cast.

pub unsafe fn cast<T>(&self) -> Option<T> where
    T: GodotObject, 

Generic dynamic cast.

Methods from Deref<Target = PhysicsBody>

pub unsafe fn _get_layers(&self) -> i64

pub unsafe fn _set_layers(&mut self, mask: i64)

pub unsafe fn add_collision_exception_with(&mut self, body: Option<Node>)

pub unsafe fn get_collision_exceptions(&mut self) -> VariantArray

pub unsafe fn get_collision_layer(&self) -> i64

pub unsafe fn get_collision_layer_bit(&self, bit: i64) -> bool

pub unsafe fn get_collision_mask(&self) -> i64

pub unsafe fn get_collision_mask_bit(&self, bit: i64) -> bool

pub unsafe fn remove_collision_exception_with(&mut self, body: Option<Node>)

pub unsafe fn set_collision_layer(&mut self, layer: i64)

pub unsafe fn set_collision_layer_bit(&mut self, bit: i64, value: bool)

pub unsafe fn set_collision_mask(&mut self, mask: i64)

pub unsafe fn set_collision_mask_bit(&mut self, bit: i64, value: bool)

pub unsafe fn to_collision_object(&self) -> CollisionObject

Up-cast.

pub unsafe fn to_spatial(&self) -> Spatial

Up-cast.

pub unsafe fn to_node(&self) -> Node

Up-cast.

pub unsafe fn to_object(&self) -> Object

Up-cast.

pub unsafe fn cast<T>(&self) -> Option<T> where
    T: GodotObject, 

Generic dynamic cast.

Trait Implementations

impl Clone for RigidBody

fn clone(&self) -> RigidBody

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Copy for RigidBody

impl Debug for RigidBody

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

Formats the value using the given formatter.

impl Deref for RigidBody

type Target = PhysicsBody

The resulting type after dereferencing.

fn deref(&self) -> &PhysicsBody

Dereferences the value.

impl DerefMut for RigidBody

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

Mutably dereferences the value.

impl Free for RigidBody

unsafe fn godot_free(self)

impl FromVariant for RigidBody

fn from_variant(variant: &Variant) -> Result<RigidBody, FromVariantError>

impl GodotObject for RigidBody

fn class_name() -> &'static str

unsafe fn from_sys(obj: *mut c_void) -> RigidBody

unsafe fn from_return_position_sys(obj: *mut c_void) -> RigidBody

unsafe fn to_sys(&self) -> *mut c_void

impl Instanciable for RigidBody

fn construct() -> RigidBody

impl QueueFree for RigidBody

unsafe fn godot_queue_free(&mut self)

impl ToVariant for RigidBody

fn to_variant(&self) -> Variant