SolidCollisionEvent Class

Event emitted when a solid collision is detected. More...

Declaration

class helios::engine::modules::physics::collision::events::SolidCollisionEvent { ... }

Public Constructors Index

	SolidCollisionEvent (const helios::engine::ecs::EntityHandle source, const collision::types::CollisionContext &collisionContext)
	Constructs a SolidCollisionEvent. More...

Public Member Functions Index

const collision::types::CollisionContext &	collisionContext () const noexcept
	Returns the collision context. More...
helios::engine::ecs::EntityHandle	source () const noexcept
	Returns the source entity handle. More...

Private Member Attributes Index

collision::types::CollisionContext	collisionContext_
	Context data describing the collision. More...
helios::engine::ecs::EntityHandle	source_
	Handle of the entity that reported the collision. More...

Description

Event emitted when a solid collision is detected.

Solid collisions represent physical interactions between entities that can block movement or trigger physics responses. This event is published to the event bus when an entity with PassEvent behavior detects a solid collision.

Definition at line 24 of file SolidCollisionEvent.ixx.

Public Constructors

SolidCollisionEvent()

helios::engine::modules::physics::collision::events::SolidCollisionEvent::SolidCollisionEvent (const helios::engine::ecs::EntityHandle source, const collision::types::CollisionContext & collisionContext)

inline explicit

Constructs a SolidCollisionEvent.

Parameters

source	Handle of the reporting entity.
collisionContext	Context data describing the collision.

Definition at line 44 of file SolidCollisionEvent.ixx.

44 explicit SolidCollisionEvent(

45 const helios::engine::ecs::EntityHandle source,

46 const collision::types::CollisionContext& collisionContext

47 ) : collisionContext_(collisionContext), source_(source) {}

References collisionContext and source.

Public Member Functions

collisionContext()

const collision::types::CollisionContext & helios::engine::modules::physics::collision::events::SolidCollisionEvent::collisionContext ()

inline nodiscard noexcept

Returns the collision context.

Returns

Reference to the collision context data.

Definition at line 54 of file SolidCollisionEvent.ixx.

54 [[nodiscard]] const collision::types::CollisionContext& collisionContext() const noexcept {

55 return collisionContext_;

56 }

Referenced by SolidCollisionEvent.

source()

helios::engine::ecs::EntityHandle helios::engine::modules::physics::collision::events::SolidCollisionEvent::source ()

inline nodiscard noexcept

Returns the source entity handle.

Returns

Handle of the entity that reported the collision.

Definition at line 63 of file SolidCollisionEvent.ixx.

63 [[nodiscard]] helios::engine::ecs::EntityHandle source() const noexcept {

64 return source_;

65 }

Referenced by SolidCollisionEvent.

Private Member Attributes

collisionContext_

collision::types::CollisionContext helios::engine::modules::physics::collision::events::SolidCollisionEvent::collisionContext_

Context data describing the collision.

Definition at line 29 of file SolidCollisionEvent.ixx.

29 collision::types::CollisionContext collisionContext_;

source_

helios::engine::ecs::EntityHandle helios::engine::modules::physics::collision::events::SolidCollisionEvent::source_

Handle of the entity that reported the collision.

Definition at line 34 of file SolidCollisionEvent.ixx.

34 helios::engine::ecs::EntityHandle source_;

---

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

• SolidCollisionEvent.ixx

---

Generated via doxygen2docusaurus 2.0.0 by Doxygen 1.15.0.