Struct ExternalImpulse

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

An external impulse applied instantly to a dynamic rigid body.

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

By default, the impulse is cleared every frame. You can set persistent to true in order to persist the impulse across frames.

Example

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

fn setup(mut commands: Commands) {
    // Apply an impulse in world space.
    commands.spawn((RigidBody::Dynamic, ExternalImpulse::new(Vec3::Y)));

    // Apply an impulse every physics frame.
    commands.spawn((
        RigidBody::Dynamic,
        ExternalImpulse::new(Vec3::Y).with_persistence(true),
    ));

    // Apply multiple impulses.
    let mut impulse = ExternalImpulse::default();
    impulse.apply_impulse(Vec3::Y).apply_impulse(Vec3::X);
    commands.spawn((RigidBody::Dynamic, impulse));

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

Local Impulses

The impulse stored in ExternalImpulse is in world space.

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

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

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

Fields

persistent: bool

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

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

Implementations

impl ExternalImpulse

pub const ZERO: Self = _

Zero external impulse.

pub fn new(impulse: Vector) -> Self

Creates a new ExternalImpulse component with a given world-space impulse.

pub fn set_impulse(&mut self, impulse: Vector) -> &mut Self

Sets the world-space impulse. Note that the angular impulse caused by any impulses will not be reset.

pub fn apply_impulse(&mut self, impulse: Vector) -> &mut Self

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

pub fn apply_impulse_at_point( &mut self, impulse: Vector, point: Vector, center_of_mass: Vector, ) -> &mut Self

Applies the given impulse at the specified point, which will also cause an angular impulse to be applied.

The impulse, point, and center of mass must be given in world space.

pub fn impulse(&self) -> Vector

Returns the impulse in world space.

pub fn angular_impulse(&self) -> Vector

Returns the angular impulse caused by impulses applied at certain points using apply_impulse_at_point.

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

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

pub fn clear(&mut self)

Sets the impulse and the potential angular impulse caused by the impulse 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_i8vec3(&self) -> I8Vec3

Casts all elements of self to i8.

pub fn as_u8vec3(&self) -> U8Vec3

Casts all elements of self to u8.

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 ExternalImpulse

fn clone(&self) -> ExternalImpulse

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Component for ExternalImpulse

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_required_components( requiree: ComponentId, components: &mut Components, storages: &mut Storages, required_components: &mut RequiredComponents, inheritance_depth: u16, )

Registers required components.

fn register_component_hooks(hooks: &mut ComponentHooks)

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

impl Debug for ExternalImpulse

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

Formats the value using the given formatter.

impl Default for ExternalImpulse

fn default() -> Self

Returns the “default value” for a type.

impl Deref for ExternalImpulse

type Target = Vec3

The resulting type after dereferencing.

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

Dereferences the value.

impl DerefMut for ExternalImpulse

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

Mutably dereferences the value.

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

fn from(value: (Vector, bool, Vector)) -> Self

Converts to this type from the input type.

impl FromReflect for ExternalImpulse

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

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

Constructs a concrete instance of Self from a reflected value.

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

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

impl GetTypeRegistration for ExternalImpulse

where ExternalImpulse: Any + Send + Sync, Vector: FromReflect + TypePath + MaybeTyped + RegisterForReflection, bool: FromReflect + TypePath + MaybeTyped + 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 ExternalImpulse

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

Tests for self and other values to be equal, and is used by ==.

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

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

impl PartialReflect for ExternalImpulse

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

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

Returns the TypeInfo of the type represented by this value.

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

Clones the value as a Reflect trait object.

fn try_apply(&mut self, value: &dyn PartialReflect) -> 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 try_into_reflect( self: Box<Self>, ) -> Result<Box<dyn Reflect>, Box<dyn PartialReflect>>

Attempts to cast this type to a boxed, fully-reflected value.

fn try_as_reflect(&self) -> Option<&dyn Reflect>

Attempts to cast this type to a fully-reflected value.

fn try_as_reflect_mut(&mut self) -> Option<&mut dyn Reflect>

Attempts to cast this type to a mutable, fully-reflected value.

fn into_partial_reflect(self: Box<Self>) -> Box<dyn PartialReflect>

Casts this type to a boxed, reflected value.

fn as_partial_reflect(&self) -> &dyn PartialReflect

Casts this type to a reflected value.

fn as_partial_reflect_mut(&mut self) -> &mut dyn PartialReflect

Casts this type to a mutable, reflected value.

fn reflect_partial_eq(&self, value: &dyn PartialReflect) -> 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 PartialReflect + '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 Reflect for ExternalImpulse

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

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, fully-reflected value.

fn as_reflect(&self) -> &dyn Reflect

Casts this type to a fully-reflected value.

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

Casts this type to a mutable, fully-reflected value.

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

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

impl Struct for ExternalImpulse

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

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

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

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

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

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

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

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

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

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.

fn get_represented_struct_info(&self) -> Option<&'static StructInfo>

Will return None if TypeInfo is not available.

impl TypePath for ExternalImpulse

where ExternalImpulse: 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 ExternalImpulse

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

fn type_info() -> &'static TypeInfo

Returns the compile-time info for the underlying type.

impl Copy for ExternalImpulse

impl StructuralPartialEq for ExternalImpulse