Enum heron_core::CollisionEvent
source · [−]pub enum CollisionEvent {
Started(CollisionData, CollisionData),
Stopped(CollisionData, CollisionData),
}
Expand description
An event fired when the collision state between two entities changed
Example
fn detect_collisions(mut events: EventReader<CollisionEvent>) {
for event in events.iter() {
match event {
CollisionEvent::Started(data1, data2) => {
println!("Entity {:?} and {:?} started to collide", data1.rigid_body_entity(), data2.rigid_body_entity())
}
CollisionEvent::Stopped(data1, data2) => {
println!("Entity {:?} and {:?} stopped to collide", data1.rigid_body_entity(), data2.rigid_body_entity())
}
}
}
}
Variants
Started(CollisionData, CollisionData)
The two entities started to collide
Stopped(CollisionData, CollisionData)
The two entities no longer collide
Implementations
sourceimpl CollisionEvent
impl CollisionEvent
sourcepub fn is_started(&self) -> bool
pub fn is_started(&self) -> bool
Returns true if the event represent the “start” of a collision
sourcepub fn is_stopped(&self) -> bool
pub fn is_stopped(&self) -> bool
Returns true if the event represent the “end” of a collision
sourcepub fn data(self) -> (CollisionData, CollisionData)
pub fn data(self) -> (CollisionData, CollisionData)
Returns the data for the two entities that collided
sourcepub fn collision_shape_entities(&self) -> (Entity, Entity)
pub fn collision_shape_entities(&self) -> (Entity, Entity)
Returns the entities containing the CollisionShape
involved in the collision
sourcepub fn rigid_body_entities(&self) -> (Entity, Entity)
pub fn rigid_body_entities(&self) -> (Entity, Entity)
Returns the entities containing the RigidBody
involved in the collision
sourcepub fn collision_layers(&self) -> (CollisionLayers, CollisionLayers)
pub fn collision_layers(&self) -> (CollisionLayers, CollisionLayers)
Returns the two CollisionLayers
involved in the collision
Trait Implementations
sourceimpl Clone for CollisionEvent
impl Clone for CollisionEvent
sourcefn clone(&self) -> CollisionEvent
fn clone(&self) -> CollisionEvent
Returns a copy of the value. Read more
1.0.0 · sourcefn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
Performs copy-assignment from source
. Read more
sourceimpl Debug for CollisionEvent
impl Debug for CollisionEvent
sourceimpl From<CollisionEvent> for (CollisionData, CollisionData)
impl From<CollisionEvent> for (CollisionData, CollisionData)
sourcefn from(event: CollisionEvent) -> Self
fn from(event: CollisionEvent) -> Self
Performs the conversion.
sourceimpl PartialEq<CollisionEvent> for CollisionEvent
impl PartialEq<CollisionEvent> for CollisionEvent
sourcefn eq(&self, other: &CollisionEvent) -> bool
fn eq(&self, other: &CollisionEvent) -> bool
This method tests for self
and other
values to be equal, and is used
by ==
. Read more
sourcefn ne(&self, other: &CollisionEvent) -> bool
fn ne(&self, other: &CollisionEvent) -> bool
This method tests for !=
.
impl Copy for CollisionEvent
impl Eq for CollisionEvent
impl StructuralEq for CollisionEvent
impl StructuralPartialEq for CollisionEvent
Auto Trait Implementations
impl RefUnwindSafe for CollisionEvent
impl Send for CollisionEvent
impl Sync for CollisionEvent
impl Unpin for CollisionEvent
impl UnwindSafe for CollisionEvent
Blanket Implementations
sourceimpl<T> BorrowMut<T> for T where
T: ?Sized,
impl<T> BorrowMut<T> for T where
T: ?Sized,
const: unstable · sourcepub fn borrow_mut(&mut self) -> &mut T
pub fn borrow_mut(&mut self) -> &mut T
Mutably borrows from an owned value. Read more
impl<T> Downcast for T where
T: Any,
impl<T> Downcast for T where
T: Any,
pub fn into_any(self: Box<T, Global>) -> Box<dyn Any + 'static, Global>
pub fn into_any(self: Box<T, Global>) -> Box<dyn Any + 'static, Global>
Convert Box<dyn Trait>
(where Trait: Downcast
) to Box<dyn Any>
. Box<dyn Any>
can
then be further downcast
into Box<ConcreteType>
where ConcreteType
implements Trait
. Read more
pub fn into_any_rc(self: Rc<T>) -> Rc<dyn Any + 'static>
pub fn into_any_rc(self: Rc<T>) -> Rc<dyn Any + 'static>
Convert Rc<Trait>
(where Trait: Downcast
) to Rc<Any>
. Rc<Any>
can then be
further downcast
into Rc<ConcreteType>
where ConcreteType
implements Trait
. Read more
pub fn as_any(&self) -> &(dyn Any + 'static)
pub fn as_any(&self) -> &(dyn Any + 'static)
Convert &Trait
(where Trait: Downcast
) to &Any
. This is needed since Rust cannot
generate &Any
’s vtable from &Trait
’s. Read more
pub fn as_any_mut(&mut self) -> &mut (dyn Any + 'static)
pub fn as_any_mut(&mut self) -> &mut (dyn Any + 'static)
Convert &mut Trait
(where Trait: Downcast
) to &Any
. This is needed since Rust cannot
generate &mut Any
’s vtable from &mut Trait
’s. Read more
sourceimpl<Q, K> Equivalent<K> for Q where
Q: Eq + ?Sized,
K: Borrow<Q> + ?Sized,
impl<Q, K> Equivalent<K> for Q where
Q: Eq + ?Sized,
K: Borrow<Q> + ?Sized,
sourcepub fn equivalent(&self, key: &K) -> bool
pub fn equivalent(&self, key: &K) -> bool
Compare self to key
and return true
if they are equal.
sourceimpl<T> Instrument for T
impl<T> Instrument for T
sourcefn instrument(self, span: Span) -> Instrumented<Self>
fn instrument(self, span: Span) -> Instrumented<Self>
sourcefn in_current_span(self) -> Instrumented<Self>
fn in_current_span(self) -> Instrumented<Self>
sourceimpl<T> ToOwned for T where
T: Clone,
impl<T> ToOwned for T where
T: Clone,
type Owned = T
type Owned = T
The resulting type after obtaining ownership.
sourcepub fn to_owned(&self) -> T
pub fn to_owned(&self) -> T
Creates owned data from borrowed data, usually by cloning. Read more
sourcepub fn clone_into(&self, target: &mut T)
pub fn clone_into(&self, target: &mut T)
toowned_clone_into
)Uses borrowed data to replace owned data, usually by cloning. Read more
impl<T> TypeData for T where
T: 'static + Send + Sync + Clone,
impl<T> TypeData for T where
T: 'static + Send + Sync + Clone,
pub fn clone_type_data(&self) -> Box<dyn TypeData + 'static, Global>
impl<V, T> VZip<V> for T where
V: MultiLane<T>,
impl<V, T> VZip<V> for T where
V: MultiLane<T>,
pub fn vzip(self) -> V
sourceimpl<T> WithSubscriber for T
impl<T> WithSubscriber for T
sourcefn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self> where
S: Into<Dispatch>,
fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self> where
S: Into<Dispatch>,
Attaches the provided Subscriber
to this type, returning a
WithDispatch
wrapper. Read more
sourcefn with_current_subscriber(self) -> WithDispatch<Self>
fn with_current_subscriber(self) -> WithDispatch<Self>
Attaches the current default Subscriber
to this type, returning a
WithDispatch
wrapper. Read more