Clutter Engine 0.0.1
Loading...
Searching...
No Matches
clt::CollisionEvent Class Reference

Manages collision event listeners and notifies them of collision events. More...

#include <CollisionEvent.h>

Public Member Functions

 CollisionEvent ()=default
 Default constructor.
 
 ~CollisionEvent ()
 Destructor.
 
void Subscribe (ICollisionListener *pListener)
 Subscribes a listener to collision events.
 
void UnSubscribe (ICollisionListener *pListener)
 Unsubscribes a listener from collision events.
 
void NotifyEnter (ColliderComponent *collider, hitResult &result)
 Notifies listeners of a collision enter event.
 
void NotifyStay (ColliderComponent *collider, hitResult &result)
 Notifies listeners of a collision stay event.
 
void NotifyExit (ColliderComponent *collider, hitResult &result)
 Notifies listeners of a collision exit event.
 
void TriggerEnter (ColliderComponent *collider, hitResult &result)
 Notifies listeners of a trigger enter event.
 
void TriggerStay (ColliderComponent *collider, hitResult &result)
 Notifies listeners of a trigger stay event.
 
void TriggerExit (ColliderComponent *collider, hitResult &result)
 Notifies listeners of a trigger exit event.
 

Detailed Description

Manages collision event listeners and notifies them of collision events.

Member Function Documentation

◆ NotifyEnter()

void CollisionEvent::NotifyEnter ( ColliderComponent * collider,
hitResult & result )

Notifies listeners of a collision enter event.

Parameters
colliderThe collider component involved in the event.
resultThe hit result data.

◆ NotifyExit()

void CollisionEvent::NotifyExit ( ColliderComponent * collider,
hitResult & result )

Notifies listeners of a collision exit event.

Parameters
colliderThe collider component involved in the event.
resultThe hit result data.

◆ NotifyStay()

void CollisionEvent::NotifyStay ( ColliderComponent * collider,
hitResult & result )

Notifies listeners of a collision stay event.

Parameters
colliderThe collider component involved in the event.
resultThe hit result data.

◆ Subscribe()

void CollisionEvent::Subscribe ( ICollisionListener * pListener)

Subscribes a listener to collision events.

Parameters
pListenerPointer to the listener to subscribe.

◆ TriggerEnter()

void CollisionEvent::TriggerEnter ( ColliderComponent * collider,
hitResult & result )

Notifies listeners of a trigger enter event.

Parameters
colliderThe collider component involved in the event.
resultThe hit result data.

◆ TriggerExit()

void CollisionEvent::TriggerExit ( ColliderComponent * collider,
hitResult & result )

Notifies listeners of a trigger exit event.

Parameters
colliderThe collider component involved in the event.
resultThe hit result data.

◆ TriggerStay()

void CollisionEvent::TriggerStay ( ColliderComponent * collider,
hitResult & result )

Notifies listeners of a trigger stay event.

Parameters
colliderThe collider component involved in the event.
resultThe hit result data.

◆ UnSubscribe()

void CollisionEvent::UnSubscribe ( ICollisionListener * pListener)

Unsubscribes a listener from collision events.

Parameters
pListenerPointer to the listener to unsubscribe.

The documentation for this class was generated from the following files: