Struct ContactForceEvent

pub struct ContactForceEvent {
    pub collider1: Entity,
    pub collider2: Entity,
    pub total_force: Vect,
    pub total_force_magnitude: Real,
    pub max_force_direction: Vect,
    pub max_force_magnitude: Real,
}

Event occurring when the sum of the magnitudes of the contact forces between two colliders exceed a threshold (ContactForceEventThreshold).

This will only get triggered if the entity has the ActiveEvents::CONTACT_FORCE_EVENTS flag enabled.

Fields

collider1: Entity

The first collider involved in the contact.

collider2: Entity

The second collider involved in the contact.

total_force: Vect

The sum of all the forces between the two colliders.

total_force_magnitude: Real

The sum of the magnitudes of each force between the two colliders.

Note that this is not the same as the magnitude of self.total_force. Here we are summing the magnitude of all the forces, instead of taking the magnitude of their sum.

max_force_direction: Vect

The world-space (unit) direction of the force with strongest magnitude.

max_force_magnitude: Real

The magnitude of the largest force at a contact point of this contact pair.

Trait Implementations

impl Clone for ContactForceEvent

fn clone(&self) -> ContactForceEvent

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Component for ContactForceEvent

where Self: Send + Sync + 'static,

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

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.

fn register_required_components( _component_id: ComponentId, _components: &mut Components, _storages: &mut Storages, _required_components: &mut RequiredComponents, _inheritance_depth: u16, )

Registers required components.

impl Debug for ContactForceEvent

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

Formats the value using the given formatter.

impl Event for ContactForceEvent

where Self: Send + Sync + 'static,

const AUTO_PROPAGATE: bool = false

When true, this event will always attempt to propagate when triggered, without requiring a call to Trigger::propagate.

type Traversal = ()

The component that describes which Entity to propagate this event to next, when propagation is enabled.

impl PartialEq for ContactForceEvent

fn eq(&self, other: &ContactForceEvent) -> 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 Copy for ContactForceEvent

impl StructuralPartialEq for ContactForceEvent