Main Page | Namespace List | Class Hierarchy | Alphabetical List | Class List | File List | Namespace Members | Class Members | File Members | Related Pages

mortic::IEvent Class Reference

An event generated by the engine. More...

Inheritance diagram for mortic::IEvent:

mortic::IObject List of all members.

Public Member Functions

 IEvent (IRoot *root)
 Constructor.
virtual ~IEvent ()
 Destructor.
virtual enum EEventType getEventType ()=0
 Get the Event Type.
virtual unsigned int getCount ()=0
 Returns the number of event arguments.
virtual enum EValueType getValueType (unsigned int i)=0
 Returns the type of value.
virtual union UValue getValue (unsigned int i)=0
 Returns the value.
virtual std::string getEventName ()=0
 Gets the Event Name.
virtual irr::SEvent getIrrlichtEvent ()=0
 Return the Irrlicht Event.

Detailed Description

An event generated by the engine.

This is an event generated by the engine. See IEventManager a list of events as well as more info.

See also:
IEventManager

Definition at line 74 of file IEventManager.h.


Constructor & Destructor Documentation

mortic::IEvent::IEvent IRoot root  )  [inline]
 

Constructor.

Definition at line 78 of file IEventManager.h.

virtual mortic::IEvent::~IEvent  )  [inline, virtual]
 

Destructor.

Definition at line 81 of file IEventManager.h.


Member Function Documentation

virtual unsigned int mortic::IEvent::getCount  )  [pure virtual]
 

Returns the number of event arguments.

These arguments can be accessed through getValueType() and getValue().

Returns:
the number of arguments
See also:
getValueType()

getValue()

virtual std::string mortic::IEvent::getEventName  )  [pure virtual]
 

Gets the Event Name.

The event name is arbitrary, but is almost always used to identify the event.

Returns:
the name of the event

virtual enum EEventType mortic::IEvent::getEventType  )  [pure virtual]
 

Get the Event Type.

The event type determines the origin of the event. It could be user-generated, made by the mortic engine, etc.

Returns:
the type of event
See also:
EEventType

virtual irr::SEvent mortic::IEvent::getIrrlichtEvent  )  [pure virtual]
 

Return the Irrlicht Event.

This only works if the event originated from Irrlicht.

Returns:
the Irrlicht event

virtual union UValue mortic::IEvent::getValue unsigned int  i  )  [pure virtual]
 

Returns the value.

This returns the value at index i, but be sure to access the right member of the UValue!

  • i - the argument to get
    Returns:
    the value of the argument at index i
    See also:
    UValue

virtual enum EValueType mortic::IEvent::getValueType unsigned int  i  )  [pure virtual]
 

Returns the type of value.

This returns the type of value at index i.

  • i - the index of the argument to get the type of
    Returns:
    the type of argument at index i
    See also:
    EValueType


Generated on Sat Dec 30 21:21:59 2006 for mortic by  doxygen 1.4.4