Struct ImpulseJoint 

pub struct ImpulseJoint {
    pub parent: Entity,
    pub data: TypedJoint,
}

An impulse-based joint attached to two entities.

The first end-point of the joint is the rigid-body attached to ImpulseJoint::parent. The second endpoint of the joint is the rigid-body attached to the entity (or the parent of the entity) containing this ImpulseJoint component.

To attach multiple impulse joints to the same rigid-body, multiple joints can be added in the children of the entity containing that rigid-body (this is similar to the technique used to attach multiple colliders to the same rigid-body).

Modifying parent re-attaches the joint to the rigid-body of the new parent entity. Add the ImpulseJointDisabled component to disable the joint, and read the impulses it applied during the last simulation step from the ImpulseJointImpulses component.

Note that the user_data of the underlying Rapier joint is reserved: it stores the bits of the entity containing this component.

Fields

parent: Entity

The entity containing the rigid-body used as the first endpoint of this joint.

data: TypedJoint

The joint’s description.

Implementations

impl ImpulseJoint

pub fn new(parent: Entity, data: impl Into<TypedJoint>) -> Self

Initializes an impulse-based joint from its first endpoint and the joint description.

Trait Implementations

impl Clone for ImpulseJoint

fn clone(&self) -> ImpulseJoint

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Component for ImpulseJoint

where Self: Send + Sync + 'static,

Required Components: ImpulseJointImpulses.

A component’s Required Components are inserted whenever it is inserted. Note that this will also insert the required components of the required components, recursively, in depth-first order.

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

A constant indicating the storage type used for this component.

type Mutability = Mutable

A marker type to assist Bevy with determining if this component is mutable, or immutable. Mutable components will have Component<Mutability = Mutable>, while immutable components will instead have Component<Mutability = Immutable>.

fn register_required_components( _requiree: ComponentId, required_components: &mut RequiredComponentsRegistrator<'_, '_>, )

Registers required components.

fn clone_behavior() -> ComponentCloneBehavior

Called when registering this component, allowing to override clone function (or disable cloning altogether) for this component.

fn relationship_accessor() -> Option<ComponentRelationshipAccessor<Self>>

Returns ComponentRelationshipAccessor required for working with relationships in dynamic contexts.

fn on_add() -> Option<for<'w> fn(DeferredWorld<'w>, HookContext)>

Gets the on_add ComponentHook for this Component if one is defined.

fn on_insert() -> Option<for<'w> fn(DeferredWorld<'w>, HookContext)>

Gets the on_insert ComponentHook for this Component if one is defined.

fn on_discard() -> Option<for<'w> fn(DeferredWorld<'w>, HookContext)>

Gets the on_discard ComponentHook for this Component if one is defined.

fn on_remove() -> Option<for<'w> fn(DeferredWorld<'w>, HookContext)>

Gets the on_remove ComponentHook for this Component if one is defined.

fn on_despawn() -> Option<for<'w> fn(DeferredWorld<'w>, HookContext)>

Gets the on_despawn ComponentHook for this Component if one is defined.

fn map_entities<E>(_this: &mut Self, _mapper: &mut E)

where E: EntityMapper,

Maps the entities on this component using the given EntityMapper. This is used to remap entities in contexts like scenes and entity cloning. When deriving Component, this is populated by annotating fields containing entities with #[entities]

const HAS_SUMMARY_TICK: bool = false

Set this constant to true if the component should track a summary tick.

impl Copy for ImpulseJoint

impl Debug for ImpulseJoint

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

Formats the value using the given formatter.

impl PartialEq for ImpulseJoint

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

Equality operator ==.

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

Inequality operator !=.

impl StructuralPartialEq for ImpulseJoint