DeleteCursorSpringConnectorEvent Class Reference

#include <DeleteCursorSpringConnectorEvent.h>

Inherits Event.

Collaboration diagram for DeleteCursorSpringConnectorEvent:

List of all members.


Public Types

typedef EventFactory
< DeleteCursorSpringConnectorEvent
Factory

Public Member Functions

 DeleteCursorSpringConnectorEvent ()
 DeleteCursorSpringConnectorEvent (unsigned userID)
virtual ~DeleteCursorSpringConnectorEvent ()
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.

Detailed Description

Event for removing an existing CursorSpringConnector. This Event is sent by a User who wants to stop the manipulation of a PhysicsEntity. It is executed on every host.

Member Typedef Documentation


Constructor & Destructor Documentation

DeleteCursorSpringConnectorEvent::DeleteCursorSpringConnectorEvent (  ) 

Default Constructor needed for factory.

DeleteCursorSpringConnectorEvent::DeleteCursorSpringConnectorEvent ( unsigned  userID  ) 

Constructor initializing the Event.

Parameters:
userID user who wants to stop the manipulation

DeleteCursorSpringConnectorEvent::~DeleteCursorSpringConnectorEvent (  )  [virtual]

Empty Destructor.


Member Function Documentation

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

Reimplemented from Event.

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

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

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

Reimplemented from Event.

void DeleteCursorSpringConnectorEvent::execute (  )  [virtual]

Process the Event.

Todo:
write more precise description

Implements Event.

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

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

Reimplemented from Event.


Member Data Documentation

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