CreateCursorSpringConnectorEvent Class Reference

#include <CreateCursorSpringConnectorEvent.h>

Inherits Event.

Collaboration diagram for CreateCursorSpringConnectorEvent:

List of all members.


Public Types

typedef EventFactory
< CreateCursorSpringConnectorEvent
Factory

Public Member Functions

 CreateCursorSpringConnectorEvent ()
 CreateCursorSpringConnectorEvent (PhysicsEntity *entity, User *user)
virtual ~CreateCursorSpringConnectorEvent ()
virtual void encode (NetMessage *message)
virtual void decode (NetMessage *message)
virtual void execute ()
virtual std::string toString ()

Protected Attributes

unsigned userID
 ID of the user interacting with the entity.
unsigned entityID
 ID of the entity to interact with.

Detailed Description

Event for creating a CursorSpringConnector. This event is sent when a user tries to add a CursorSpringConnector to the System. It is executed on every participating host.

Member Typedef Documentation


Constructor & Destructor Documentation

CreateCursorSpringConnectorEvent::CreateCursorSpringConnectorEvent (  ) 

Default Constructor needed for factory.

CreateCursorSpringConnectorEvent::CreateCursorSpringConnectorEvent ( PhysicsEntity entity,
User user 
)

Constructor

CreateCursorSpringConnectorEvent::~CreateCursorSpringConnectorEvent (  )  [virtual]

Empty Destructor


Member Function Documentation

void CreateCursorSpringConnectorEvent::decode ( NetMessage message  )  [virtual]

Reimplemented from Event.

void CreateCursorSpringConnectorEvent::encode ( NetMessage message  )  [virtual]

Todo:
should Event::decode() and Event::encode() be protected?

describe Event::decode() and Event::encode()

Reimplemented from Event.

void CreateCursorSpringConnectorEvent::execute (  )  [virtual]

Process the Event.

Todo:
write more precise description

Implements Event.

std::string CreateCursorSpringConnectorEvent::toString (  )  [virtual]

Return a string representation of the Event, containing all attributes.

Reimplemented from Event.


Member Data Documentation

ID of the entity to interact with.

ID of the user interacting with the entity.


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

Generated on Wed Oct 20 16:11:55 2010 for inVRs by doxygen 1.5.8