FF3DDeviceInputAgent Class Reference
[Input classes]

#include <FF3DDeviceInputAgent.h>

Inherited by GuidanceAgent, and PicobgAgent.

Collaboration diagram for FF3DDeviceInputAgent:

Detailed Description

helper and autobind of FF3DDeviceOutputAgent messages

plugged on the micole bus, FF3DDeviceInputAgent provide auto parsing of "IN FF3D :" messages. Inherited class can define onInput, onButtonDown and onButtonUp function

Definition at line 50 of file FF3DDeviceInputAgent.h.

Public Member Functions

FF3DDeviceInputAgent (void)

default constructor

virtual ~FF3DDeviceInputAgent (void)

default destructor

void handleInput (MicoleBus *app, int argc, const char **argv)

handle input store position and button state and call callback functions if needed

virtual void onInput ()

onInput is called after each update of position

virtual void onButtonDown ()

onButtonDown is called after each "button down" event

virtual void onButtonUp ()

onButtondown is called after each time you release 3D device 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

Vec3f _position

FF3D Device position.

bool _buttonPressed

Button state.

vector< MicoleBinding > bindings

AgentState state

int resumeId

Static Protected Attributes

static MicoleBus * bus = 0

Constructor & Destructor Documentation

FF3DDeviceInputAgent::FF3DDeviceInputAgent ( void )

default constructor

Definition at line 30 of file FF3DDeviceInputAgent.cpp.

FF3DDeviceInputAgent::~FF3DDeviceInputAgent ( void ) [virtual]

default destructor

Definition at line 36 of file FF3DDeviceInputAgent.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 FF3DDeviceInputAgent::handleInput	(	MicoleBus *	app,
		int	argc,
		const char **	argv
	)

handle input store position and button state and call callback functions if needed

Definition at line 40 of file FF3DDeviceInputAgent.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 FF3DDeviceInputAgent::onButtonDown ( ) [inline, virtual]

onButtonDown is called after each "button down" event

Reimplemented in PicobgAgent.

Definition at line 75 of file FF3DDeviceInputAgent.h.

virtual void FF3DDeviceInputAgent::onButtonUp ( ) [inline, virtual]

onButtondown is called after each time you release 3D device button

Definition at line 79 of file FF3DDeviceInputAgent.h.

virtual void FF3DDeviceInputAgent::onInput ( ) [inline, virtual]

onInput is called after each update of position

Reimplemented in GuidanceAgent.

Definition at line 71 of file FF3DDeviceInputAgent.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

bool FF3DDeviceInputAgent::_buttonPressed [protected]

Button state.

Definition at line 83 of file FF3DDeviceInputAgent.h.

Vec3f FF3DDeviceInputAgent::_position [protected]

FF3D Device position.

Definition at line 82 of file FF3DDeviceInputAgent.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:10:53 2007 for Micole by

1.4.7


Public Member Functions
	FF3DDeviceInputAgent (void)
	default constructor
virtual	~FF3DDeviceInputAgent (void)
	default destructor
void	handleInput (MicoleBus app, int argc, const char *argv)
	handle input store position and button state and call callback functions if needed
virtual void	onInput ()
	onInput is called after each update of position
virtual void	onButtonDown ()
	onButtonDown is called after each "button down" event
virtual void	onButtonUp ()
	onButtondown is called after each time you release 3D device 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
Vec3f	_position
	FF3D Device position.
bool	_buttonPressed
	Button state.
vector< MicoleBinding >	bindings
AgentState	state
int	resumeId
Static Protected Attributes
static MicoleBus *	bus = 0

FF3DDeviceInputAgent Class Reference [Input classes]

Detailed Description

Public Member Functions

Protected Member Functions

Protected Attributes

Static Protected Attributes

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation

FF3DDeviceInputAgent Class Reference
[Input classes]