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

Interface for receiving collision and trigger events from the physics engine. More...

#include <ICollisionListener.h>

Inheritance diagram for clt::ICollisionListener:
clt::PlayerController BowlingController DoomController clt::CameraController clt::EditorController clt::FPSController clt::PlayerController2D

Public Member Functions

virtual ~ICollisionListener ()=default
 Virtual destructor for safe polymorphic destruction.
 
virtual void OnCollisionEnter (ColliderComponent *collider, const hitResult &result)
 Called when a collision begins with this listener's collider.
 
virtual void OnCollisionStay (ColliderComponent *collider, const hitResult &result)
 Called while a collision is ongoing with this listener's collider.
 
virtual void OnCollisionExit (ColliderComponent *collider, const hitResult &result)
 Called when a collision ends with this listener's collider.
 
virtual void OnTriggerEnter (ColliderComponent *collider, const hitResult &result)
 Called when a trigger event begins with this listener's collider.
 
virtual void OnTriggerStay (ColliderComponent *collider, const hitResult &result)
 Called while a trigger event is ongoing with this listener's collider.
 
virtual void OnTriggerExit (ColliderComponent *collider, const hitResult &result)
 Called when a trigger event ends with this listener's collider.
 

Detailed Description

Interface for receiving collision and trigger events from the physics engine.

Member Function Documentation

◆ OnCollisionEnter()

virtual void clt::ICollisionListener::OnCollisionEnter ( ColliderComponent * collider,
const hitResult & result )
inlinevirtual

Called when a collision begins with this listener's collider.

Parameters
colliderThe collider component involved in the collision.
resultDetailed information about the collision.

Reimplemented in clt::CameraController, clt::EditorController, clt::FPSController, clt::PlayerController2D, and clt::PlayerController.

◆ OnCollisionExit()

virtual void clt::ICollisionListener::OnCollisionExit ( ColliderComponent * collider,
const hitResult & result )
inlinevirtual

Called when a collision ends with this listener's collider.

Parameters
colliderThe collider component involved in the collision.
resultDetailed information about the collision.

Reimplemented in clt::CameraController, clt::EditorController, clt::FPSController, clt::PlayerController2D, and clt::PlayerController.

◆ OnCollisionStay()

virtual void clt::ICollisionListener::OnCollisionStay ( ColliderComponent * collider,
const hitResult & result )
inlinevirtual

Called while a collision is ongoing with this listener's collider.

Parameters
colliderThe collider component involved in the collision.
resultDetailed information about the collision.

Reimplemented in clt::CameraController, clt::EditorController, clt::FPSController, clt::PlayerController2D, and clt::PlayerController.

◆ OnTriggerEnter()

virtual void clt::ICollisionListener::OnTriggerEnter ( ColliderComponent * collider,
const hitResult & result )
inlinevirtual

Called when a trigger event begins with this listener's collider.

Parameters
colliderThe collider component involved in the trigger event.
resultDetailed information about the trigger event.

Reimplemented in clt::CameraController, clt::EditorController, clt::FPSController, and clt::PlayerController.

◆ OnTriggerExit()

virtual void clt::ICollisionListener::OnTriggerExit ( ColliderComponent * collider,
const hitResult & result )
inlinevirtual

Called when a trigger event ends with this listener's collider.

Parameters
colliderThe collider component involved in the trigger event.
resultDetailed information about the trigger event.

Reimplemented in clt::CameraController, clt::EditorController, clt::FPSController, and clt::PlayerController.

◆ OnTriggerStay()

virtual void clt::ICollisionListener::OnTriggerStay ( ColliderComponent * collider,
const hitResult & result )
inlinevirtual

Called while a trigger event is ongoing with this listener's collider.

Parameters
colliderThe collider component involved in the trigger event.
resultDetailed information about the trigger event.

Reimplemented in clt::CameraController, clt::EditorController, clt::FPSController, and clt::PlayerController.


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