Struct avian3d::dynamics::rigid_body::ExternalForce

pub struct ExternalForce {
    pub persistent: bool,
    /* private fields */
}

An external force applied continuously to a dynamic rigid body.

The force is stored in world space. If you want to apply forces in local space, you need to use the body’s rotation to transform the local force into world space.

By default, the force persists across frames. You can clear the force manually using clear or set persistent to false.

Example

use avian3d::prelude::*;
use bevy::prelude::*;

fn setup(mut commands: Commands) {
    // Apply a force in world space every physics frame.
    commands.spawn((RigidBody::Dynamic, ExternalForce::new(Vec3::Y)));

    // Apply an initial force and automatically clear it every physics frame.
    commands.spawn((
        RigidBody::Dynamic,
        ExternalForce::new(Vec3::Y).with_persistence(false),
    ));

    // Apply multiple forces.
    let mut force = ExternalForce::default();
    force.apply_force(Vec3::Y).apply_force(Vec3::X);
    commands.spawn((RigidBody::Dynamic, force));

    // Apply a force at a specific point relative to the given center of mass, also applying a torque.
    // In this case, the torque would cause the body to rotate counterclockwise.
    let mut force = ExternalForce::default();
    force.apply_force_at_point(Vec3::Y, Vec3::X, Vec3::ZERO);
    commands.spawn((RigidBody::Dynamic, force));
}

Local forces

The force stored in ExternalForce is in world space.

If you want to apply a force in some direction relative to the body’s frame of reference, you need to rotate the force using the body’s Transform or Rotation.

use avian3d::prelude::*;
use bevy::prelude::*;

fn setup(mut commands: Commands) {
    // Spawn a rotated body and apply a force in the local up direction.
    let transform = Transform::from_rotation(Quat::from_rotation_z(0.2));
    commands.spawn((
        RigidBody::Dynamic,
        ExternalForce::new(transform.rotation * Vec3::Y),
        transform,
    ));
}

Note that the actual force stored in ExternalForce is still in world space. If you want to apply a force in the same local direction every frame, consider setting persistent to false and running apply_force in a system.

Fields

persistent: bool

True if the force persists across frames, and false if the force is automatically cleared every physics frame.

If you clear the force manually, use the clear method. This will clear the force and the torque that is applied when the force is not applied at the center of mass.

Implementations

impl ExternalForce

pub const ZERO: Self = _

Zero external force.

pub fn new(force: Vector) -> Self

Creates a new ExternalForce component with a given world-space force.

pub fn set_force(&mut self, force: Vector) -> &mut Self

Sets the world-space force. Note that the torque caused by any forces will not be reset.

pub fn apply_force(&mut self, force: Vector) -> &mut Self

Adds the given world-space force to the force that will be applied.

pub fn apply_force_at_point( &mut self, force: Vector, point: Vector, center_of_mass: Vector ) -> &mut Self

Applies the given world-space force at a local point, which will also cause torque to be applied.

pub fn force(&self) -> Vector

Returns the force in world space.

pub fn torque(&self) -> Vector

Returns the torque caused by forces applied at certain points using apply_force_at_point.

pub fn with_persistence(self, is_persistent: bool) -> Self

Determines if the force is persistent or if it should be automatically cleared every physics frame.

pub fn clear(&mut self)

Sets the force and the potential torque caused by the force to zero.

Methods from Deref<Target = Vector>

pub const ZERO: Vec3 = _

pub const ONE: Vec3 = _

pub const NEG_ONE: Vec3 = _

pub const MIN: Vec3 = _

pub const MAX: Vec3 = _

pub const NAN: Vec3 = _

pub const INFINITY: Vec3 = _

pub const NEG_INFINITY: Vec3 = _

pub const X: Vec3 = _

pub const Y: Vec3 = _

pub const Z: Vec3 = _

pub const NEG_X: Vec3 = _

pub const NEG_Y: Vec3 = _

pub const NEG_Z: Vec3 = _

pub const AXES: [Vec3; 3] = _

pub fn to_array(&self) -> [f32; 3]

[x, y, z]

pub fn move_towards(&self, rhs: Vec3, d: f32) -> Vec3

Moves towards rhs based on the value d.

When d is 0.0, the result will be equal to self. When d is equal to self.distance(rhs), the result will be equal to rhs. Will not go past rhs.

pub fn any_orthogonal_vector(&self) -> Vec3

Returns some vector that is orthogonal to the given one.

The input vector must be finite and non-zero.

The output vector is not necessarily unit length. For that use Self::any_orthonormal_vector() instead.

pub fn any_orthonormal_vector(&self) -> Vec3

Returns any unit vector that is orthogonal to the given one.

The input vector must be unit length.

Panics

Will panic if self is not normalized when glam_assert is enabled.

pub fn any_orthonormal_pair(&self) -> (Vec3, Vec3)

Given a unit vector return two other vectors that together form an orthonormal basis. That is, all three vectors are orthogonal to each other and are normalized.

Panics

Will panic if self is not normalized when glam_assert is enabled.

pub fn as_dvec3(&self) -> DVec3

Casts all elements of self to f64.

pub fn as_i16vec3(&self) -> I16Vec3

Casts all elements of self to i16.

pub fn as_u16vec3(&self) -> U16Vec3

Casts all elements of self to u16.

pub fn as_ivec3(&self) -> IVec3

Casts all elements of self to i32.

pub fn as_uvec3(&self) -> UVec3

Casts all elements of self to u32.

pub fn as_i64vec3(&self) -> I64Vec3

Casts all elements of self to i64.

pub fn as_u64vec3(&self) -> U64Vec3

Casts all elements of self to u64.

Trait Implementations

impl Clone for ExternalForce

fn clone(&self) -> ExternalForce

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Component for ExternalForce

where Self: Send + Sync + 'static,

const STORAGE_TYPE: StorageType = bevy::ecs::component::StorageType::Table

A constant indicating the storage type used for this component.

fn register_component_hooks(_hooks: &mut ComponentHooks)

Called when registering this component, allowing mutable access to its ComponentHooks.

impl Debug for ExternalForce

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

Formats the value using the given formatter.

impl Default for ExternalForce

fn default() -> Self

Returns the “default value” for a type.

impl Deref for ExternalForce

type Target = Vec3

The resulting type after dereferencing.

fn deref(&self) -> &Self::Target

Dereferences the value.

impl DerefMut for ExternalForce

fn deref_mut(&mut self) -> &mut Self::Target

Mutably dereferences the value.

impl From<(Vec3, bool, Vec3)> for ExternalForce

fn from(original: (Vector, bool, Vector)) -> ExternalForce

Converts to this type from the input type.

impl FromReflect for ExternalForce

where Self: Any + Send + Sync, Vector: FromReflect + TypePath + RegisterForReflection, bool: FromReflect + TypePath + RegisterForReflection,

fn from_reflect(reflect: &dyn Reflect) -> Option<Self>

Constructs a concrete instance of Self from a reflected value.

fn take_from_reflect( reflect: Box<dyn Reflect> ) -> Result<Self, Box<dyn Reflect>>

Attempts to downcast the given value to Self using, constructing the value using from_reflect if that fails.

impl GetTypeRegistration for ExternalForce

where Self: Any + Send + Sync, Vector: FromReflect + TypePath + RegisterForReflection, bool: FromReflect + TypePath + RegisterForReflection,

fn get_type_registration() -> TypeRegistration

Returns the default TypeRegistration for this type.

fn register_type_dependencies(registry: &mut TypeRegistry)

Registers other types needed by this type.

impl PartialEq for ExternalForce

fn eq(&self, other: &ExternalForce) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Reflect for ExternalForce

where Self: Any + Send + Sync, Vector: FromReflect + TypePath + RegisterForReflection, bool: FromReflect + TypePath + RegisterForReflection,

fn get_represented_type_info(&self) -> Option<&'static TypeInfo>

Returns the TypeInfo of the type represented by this value.

fn into_any(self: Box<Self>) -> Box<dyn Any>

Returns the value as a Box<dyn Any>.

fn as_any(&self) -> &dyn Any

Returns the value as a &dyn Any.

fn as_any_mut(&mut self) -> &mut dyn Any

Returns the value as a &mut dyn Any.

fn into_reflect(self: Box<Self>) -> Box<dyn Reflect>

Casts this type to a boxed reflected value.

fn as_reflect(&self) -> &dyn Reflect

Casts this type to a reflected value.

fn as_reflect_mut(&mut self) -> &mut dyn Reflect

Casts this type to a mutable reflected value.

fn clone_value(&self) -> Box<dyn Reflect>

Clones the value as a Reflect trait object.

fn set(&mut self, value: Box<dyn Reflect>) -> Result<(), Box<dyn Reflect>>

Performs a type-checked assignment of a reflected value to this value.

fn try_apply(&mut self, value: &dyn Reflect) -> Result<(), ApplyError>

Tries to apply a reflected value to this value.

fn reflect_kind(&self) -> ReflectKind

Returns a zero-sized enumeration of “kinds” of type.

fn reflect_ref(&self) -> ReflectRef<'_>

Returns an immutable enumeration of “kinds” of type.

fn reflect_mut(&mut self) -> ReflectMut<'_>

Returns a mutable enumeration of “kinds” of type.

fn reflect_owned(self: Box<Self>) -> ReflectOwned

Returns an owned enumeration of “kinds” of type.

fn reflect_partial_eq(&self, value: &dyn Reflect) -> Option<bool>

Returns a “partial equality” comparison result.

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

Debug formatter for the value.

fn apply(&mut self, value: &(dyn Reflect + 'static))

Applies a reflected value to this value.

fn reflect_hash(&self) -> Option<u64>

Returns a hash of the value (which includes the type).

fn serializable(&self) -> Option<Serializable<'_>>

Returns a serializable version of the value.

fn is_dynamic(&self) -> bool

Indicates whether or not this type is a dynamic type.

impl Struct for ExternalForce

where Self: Any + Send + Sync, Vector: FromReflect + TypePath + RegisterForReflection, bool: FromReflect + TypePath + RegisterForReflection,

fn field(&self, name: &str) -> Option<&dyn Reflect>

Returns a reference to the value of the field named name as a &dyn Reflect.

fn field_mut(&mut self, name: &str) -> Option<&mut dyn Reflect>

Returns a mutable reference to the value of the field named name as a &mut dyn Reflect.

fn field_at(&self, index: usize) -> Option<&dyn Reflect>

Returns a reference to the value of the field with index index as a &dyn Reflect.

fn field_at_mut(&mut self, index: usize) -> Option<&mut dyn Reflect>

Returns a mutable reference to the value of the field with index index as a &mut dyn Reflect.

fn name_at(&self, index: usize) -> Option<&str>

Returns the name of the field with index index.

fn field_len(&self) -> usize

Returns the number of fields in the struct.

fn iter_fields(&self) -> FieldIter<'_>

Returns an iterator over the values of the reflectable fields for this struct.

fn clone_dynamic(&self) -> DynamicStruct

Clones the struct into a DynamicStruct.

impl TypePath for ExternalForce

where Self: Any + Send + Sync,

fn type_path() -> &'static str

Returns the fully qualified path of the underlying type.

fn short_type_path() -> &'static str

Returns a short, pretty-print enabled path to the type.

fn type_ident() -> Option<&'static str>

Returns the name of the type, or None if it is anonymous.

fn crate_name() -> Option<&'static str>

Returns the name of the crate the type is in, or None if it is anonymous.

fn module_path() -> Option<&'static str>

Returns the path to the module the type is in, or None if it is anonymous.

impl Typed for ExternalForce

where Self: Any + Send + Sync, Vector: FromReflect + TypePath + RegisterForReflection, bool: FromReflect + TypePath + RegisterForReflection,

fn type_info() -> &'static TypeInfo

Returns the compile-time info for the underlying type.

impl Copy for ExternalForce

impl StructuralPartialEq for ExternalForce