MouseInputAgent Class Reference
[Input classes]

#include <MouseInputAgent.h>

Inherits AbstractMouseInputAgent.

Collaboration diagram for MouseInputAgent:

Collaboration graph
[legend]
List of all members.

Detailed Description

Definition at line 42 of file MouseInputAgent.h.

Public Member Functions

 MouseInputAgent ()
 ~MouseInputAgent ()
void handleMouseMove (MicoleBus *app, int argc, const char **argv)
virtual void onMove (const float &x, const float &y)
virtual void onButtonDown (const int &button)
virtual void onButtonUp (const int &button)
string getAgentName ()
string getAgentType ()
void onApplicationConnected (MicoleBus *app)
void onApplicationDisconnected (MicoleBus *app)
void handlePingMessage (MicoleBus *app, int argc, const char **argv)
void handleQuitMessage (MicoleBus *app, int argc, const char **argv)
void handleSuspendMessage (MicoleBus *app, int argc, const char **argv)
void handleResumeMessage (MicoleBus *app, int argc, const char **argv)
void handleRegisterReply (MicoleBus *app, int argc, const char **argv)
void handleStartMessage (MicoleBus *app, int argc, const char **argv)
void handlePrintIDMessage (MicoleBus *app, int argc, const char **argv)
int sendMessage (const char *message)
 Sends a message using bus->SendMsg.
int sendMessage (const string message)
 Sends a message using bus->SendMsg.
void sendMessage (const char *to, const char *message)
 Sends a message to the MicoleBus *app by calling app->SendMsg(const char *message) The message goes only to agent specified by const char *to.

Protected Member Functions

int bindMessage (const char *regexp, MicoleCallback *cb)
 Binds a callback method to bus.
void unBindMessage (int messageId)
void unBindMessage (MicoleBinding &binding)
virtual void suspendAgent ()
 Suspends the agent.
virtual void resumeAgent ()
 Resumes the agent.
virtual void stopAgent ()
 Gives inheriting class a chance to save state when the agent receives Quit-message.
void obtainIdentifier ()
 Obtains identifier from the RegistryAgent.

Protected Attributes

Vec2f _pos
vector< MicoleBindingbindings
AgentState state
int resumeId

Static Protected Attributes

static MicoleBusbus = 0


Constructor & Destructor Documentation

MouseInputAgent::MouseInputAgent (  ) 

Definition at line 28 of file MouseInputAgent.cpp.

MouseInputAgent::~MouseInputAgent (  ) 

Definition at line 34 of file MouseInputAgent.cpp.


Member Function Documentation

int MicoleAgent::bindMessage ( const char *  regexp,
MicoleCallback cb 
) [protected, inherited]

Binds a callback method to bus.

When a message that satisfies condition given in *regexp is received, the call back method is called by the bus. Methods that are bound with this message are not called when the agent is SUSPENDED. Methods that are bound using bus->BindMsg() are called also when the agent's state is SUSPENDED.

Definition at line 88 of file MicoleAgent.cpp.

string MicoleAgent::getAgentName (  )  [inherited]

Definition at line 62 of file MicoleAgent.cpp.

string MicoleAgent::getAgentType (  )  [inherited]

Definition at line 67 of file MicoleAgent.cpp.

void MouseInputAgent::handleMouseMove ( MicoleBus app,
int  argc,
const char **  argv 
)

Definition at line 38 of file MouseInputAgent.cpp.

void MicoleAgent::handlePingMessage ( MicoleBus app,
int  argc,
const char **  argv 
) [inherited]

Definition at line 130 of file MicoleAgent.cpp.

void MicoleAgent::handlePrintIDMessage ( MicoleBus app,
int  argc,
const char **  argv 
) [inherited]

Definition at line 180 of file MicoleAgent.cpp.

void MicoleAgent::handleQuitMessage ( MicoleBus app,
int  argc,
const char **  argv 
) [inherited]

Reimplemented in RegistryAgent, and SoundPlayerAgent.

Definition at line 111 of file MicoleAgent.cpp.

void MicoleAgent::handleRegisterReply ( MicoleBus app,
int  argc,
const char **  argv 
) [inherited]

Definition at line 138 of file MicoleAgent.cpp.

void MicoleAgent::handleResumeMessage ( MicoleBus app,
int  argc,
const char **  argv 
) [inherited]

Definition at line 105 of file MicoleAgent.cpp.

void MicoleAgent::handleStartMessage ( MicoleBus app,
int  argc,
const char **  argv 
) [inherited]

Definition at line 175 of file MicoleAgent.cpp.

void MicoleAgent::handleSuspendMessage ( MicoleBus app,
int  argc,
const char **  argv 
) [inherited]

Definition at line 99 of file MicoleAgent.cpp.

void MicoleAgent::obtainIdentifier (  )  [protected, inherited]

Obtains identifier from the RegistryAgent.

Definition at line 185 of file MicoleAgent.cpp.

void MicoleAgent::onApplicationConnected ( MicoleBus app  )  [inherited]

void MicoleAgent::onApplicationDisconnected ( MicoleBus app  )  [inherited]

virtual void AbstractMouseInputAgent::onButtonDown ( const int &  button  )  [inline, virtual, inherited]

Reimplemented in VTPlayerInputAgent.

Definition at line 52 of file AbstractMouseInputagent.h.

virtual void AbstractMouseInputAgent::onButtonUp ( const int &  button  )  [inline, virtual, inherited]

Reimplemented in VTPlayerInputAgent.

Definition at line 53 of file AbstractMouseInputagent.h.

virtual void AbstractMouseInputAgent::onMove ( const float &  x,
const float &  y 
) [inline, virtual, inherited]

Definition at line 51 of file AbstractMouseInputagent.h.

void MicoleAgent::resumeAgent (  )  [protected, virtual, inherited]

Resumes the agent.

Re-binds all callback methods.

Reimplemented in MicoleAgentThread.

Definition at line 158 of file MicoleAgent.cpp.

void MicoleAgent::sendMessage ( const char *  to,
const char *  message 
) [inherited]

Sends a message to the MicoleBus *app by calling app->SendMsg(const char *message) The message goes only to agent specified by const char *to.

The receiving agent must have appropriate regexp bound to process the message.

int MicoleAgent::sendMessage ( const string  message  )  [inherited]

Sends a message using bus->SendMsg.

The message goes to all agents.

Definition at line 79 of file MicoleAgent.cpp.

int MicoleAgent::sendMessage ( const char *  message  )  [inherited]

Sends a message using bus->SendMsg.

The message goes to all agents.

Definition at line 72 of file MicoleAgent.cpp.

void MicoleAgent::stopAgent (  )  [protected, virtual, inherited]

Gives inheriting class a chance to save state when the agent receives Quit-message.

Reimplemented in MicoleAgentThread.

Definition at line 170 of file MicoleAgent.cpp.

void MicoleAgent::suspendAgent (  )  [protected, virtual, inherited]

Suspends the agent.

Unbinds all callback methods that are bound using MicoleAgent::bindMessage()

Reimplemented in MicoleAgentThread.

Definition at line 146 of file MicoleAgent.cpp.

void MicoleAgent::unBindMessage ( MicoleBinding binding  )  [protected, inherited]

void MicoleAgent::unBindMessage ( int  messageId  )  [protected, inherited]


Member Data Documentation

Vec2f MouseInputAgent::_pos [protected]

Definition at line 54 of file MouseInputAgent.h.

vector<MicoleBinding> MicoleAgent::bindings [protected, inherited]

Definition at line 158 of file MicoleAgent.h.

MicoleBus * MicoleAgent::bus = 0 [static, protected, inherited]

Definition at line 156 of file MicoleAgent.h.

int MicoleAgent::resumeId [protected, inherited]

Definition at line 160 of file MicoleAgent.h.

AgentState MicoleAgent::state [protected, inherited]

Definition at line 159 of file MicoleAgent.h.


The documentation for this class was generated from the following files:
Generated on Tue Oct 16 17:11:01 2007 for Micole by  doxygen 1.4.7