CeresEngine::EntityEventType Class Reference

A type that describes and provides type-erased operations on a entity event. More...

#include <CeresEngine/Entity/Event.hpp>

Inheritance diagram for CeresEngine::EntityEventType:

Public Member Functions
	EntityEventType (const EntityEventType &)=delete
EntityEventType &	operator= (const EntityEventType &)=delete
	EntityEventType (EntityEventType &&)=delete
EntityEventType &	operator= (EntityEventType &&)=delete

Static Public Member Functions
template<typename E >
static const EntityEventType &	get () noexcept
	The type instance for a event of the E.

Public Attributes
const EntityEventID	eventID
	The event type ID.

Protected Member Functions
	EntityEventType (const EntityEventID eventID)

Static Protected Attributes
static EntityEventID	nextEventID = 0
	The next event ID to be statically allocated by the compiler.

Friends
bool	operator== (const EntityEventType &lhs, const EntityEventType &rhs) noexcept
	Compares two EntityEventType instances for equality.
bool	operator!= (const EntityEventType &lhs, const EntityEventType &rhs) noexcept
	Compares two EntityEventType instances for inequality.

Detailed Description

A type that describes and provides type-erased operations on a entity event.

Constructor & Destructor Documentation

EntityEventType() [1/3]

CeresEngine::EntityEventType::EntityEventType ( const EntityEventID  eventID )

inlineexplicitprotected

EntityEventType() [2/3]

CeresEngine::EntityEventType::EntityEventType ( const EntityEventType &  )

delete

EntityEventType() [3/3]

CeresEngine::EntityEventType::EntityEventType ( EntityEventType &&  )

delete

Member Function Documentation

get()

template<typename E >

const EntityEventType & CeresEngine::EntityEventType::get ( )

inlinestaticnoexcept

The type instance for a event of the E.

This instance is unique for any given event type E and is safe to perform pointer comparisons on the type.

Template Parameters

E	The type of event to return the type descriptor for.

operator=() [1/2]

EntityEventType & CeresEngine::EntityEventType::operator= ( const EntityEventType &  )

delete

operator=() [2/2]

EntityEventType & CeresEngine::EntityEventType::operator= ( EntityEventType &&  )

delete

Friends And Related Symbol Documentation

operator!=

bool operator!= ( const EntityEventType &  lhs, const EntityEventType &  rhs  )

friend

Compares two EntityEventType instances for inequality.

If true, lhs and rhs instances represent different entityEvent types.

operator==

bool operator== ( const EntityEventType &  lhs, const EntityEventType &  rhs  )

friend

Compares two EntityEventType instances for equality.

If true, lhs and `rhs instances represent the same entityEvent type.

Member Data Documentation

eventID

const EntityEventID CeresEngine::EntityEventType::eventID

The event type ID.

Used as a value that uniquely identifies the event.

nextEventID

EntityEventID CeresEngine::EntityEventType::nextEventID = 0

inlinestaticprotected

The next event ID to be statically allocated by the compiler.

---

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

• /Users/Rogiel/Developer/CeresEngine/Engine/Sources/CeresEngine/Entity/Event.hpp