CustomEvent Class Reference

Custom event. More...

#include <CustomEvent.h>

Inherits Event.

Inherited by ContactEvent2D, and ContactEvent3D.

Public Member Functions
	CustomEvent (std::string_view eventName)
	Constructor.
void	setUserData (void *data)
	Sets user data.
void *	getUserData () const
	Gets user data.
std::string_view	getEventName () const
	Gets event name.
Public Member Functions inherited from Event
	Event (Type type)
	Constructor.
virtual	~Event ()
	Destructor.
Type	getType () const
	Gets the event type.
void	stopPropagation ()
	Stops propagation for current event.
bool	isStopped () const
	Checks whether the event has been stopped.
Node *	getCurrentTarget ()
	Gets current target of the event.
Public Member Functions inherited from Object
void	retain ()
	Retains the ownership.
void	release ()
	Releases the ownership immediately.
Object *	autorelease ()
	Releases the ownership sometime soon automatically.
unsigned int	getReferenceCount () const
	Returns the Object's current reference count.
uint64_t	getObjectID () const noexcept
	Returns the process-local diagnostic identifier assigned at construction.
virtual	~Object ()
	Destructor.

Additional Inherited Members
Public Types inherited from Event
enum class	Type
	Type Event type.

Detailed Description

Custom event.

Constructor & Destructor Documentation

CustomEvent()

CustomEvent

(

std::string_view

eventName

)

Constructor.

Parameters

eventName

A given name of the custom event.

Member Function Documentation

setUserData()

void setUserData ( void * data )

inline

Sets user data.

Parameters

data	The user data pointer, it's a void*.

getUserData()

void * getUserData ( ) const

inline

Gets user data.

Returns

The user data pointer, it's a void*.

getEventName()

std::string_view getEventName ( ) const

inline

Gets event name.

Returns

The name of the event.

---

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

• CustomEvent.h