Om  1.0.0
A universal framework for multimedia simulation
Public Member Functions | List of all members
om::engine::base::Event< void > Class Template Reference

A class that stores information about an engine event. More...

#include <omEngineEvent.h>

Public Member Functions

 Event (const OpaqueResource &newTarget=OpaqueResource(), const OpaqueResource &newSender=OpaqueResource(), const EngineSystem *newSystemSender=((void *) 0), const Time &newTime=Time::getCurrent())
 Create an event with the specified parameters. More...
 
const OpaqueResourcegetTarget () const
 Return an opaque reference to the resource which should recieve this event. More...
 
const OpaqueResourcegetSender () const
 Return an opaque reference to the resource which sent this event. More...
 
const EngineSystemgetSystem () const
 Return a pointer to the entity system that produced this event, or NULL if there is no system sender. More...
 
const TimegetTime () const
 Return an object that represents the time when this event occurred, relative to an arbitrary base time. More...
 

Detailed Description

template<>
class om::engine::base::Event< void >

A class that stores information about an engine event.

Constructor & Destructor Documentation

om::engine::base::Event< void >::Event ( const OpaqueResource newTarget = OpaqueResource(),
const OpaqueResource newSender = OpaqueResource(),
const EngineSystem newSystemSender = ((void *)0),
const Time newTime = Time::getCurrent() 
)
inline

Create an event with the specified parameters.

Member Function Documentation

const OpaqueResource& om::engine::base::Event< void >::getTarget ( ) const
inline

Return an opaque reference to the resource which should recieve this event.

const OpaqueResource& om::engine::base::Event< void >::getSender ( ) const
inline

Return an opaque reference to the resource which sent this event.

const EngineSystem* om::engine::base::Event< void >::getSystem ( ) const
inline

Return a pointer to the entity system that produced this event, or NULL if there is no system sender.

const Time& om::engine::base::Event< void >::getTime ( ) const
inline

Return an object that represents the time when this event occurred, relative to an arbitrary base time.


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