Homepage Demos Overview Downloads Tutorials Reference
Credits

LookForSoundBehavior Class Reference

#include <LookForSoundBehavior.h>

Inheritance diagram for LookForSoundBehavior:

Inheritance graph
[legend]
List of all members.

Detailed Description

Turns head to sound source, estimated by average volume difference between left and right ears.

Definition at line 10 of file LookForSoundBehavior.h.

Public Member Functions

 LookForSoundBehavior ()
 constructor
virtual void DoStart ()
 By default, merely adds to the reference counter (through AddReference()); Note you should still call this from your overriding methods.
virtual void DoStop ()
 By default, subtracts from the reference counter (RemoveReference()), and thus may deletex if zero; Don't forget to still call this when you override this; Warning: call this at the end of your DoStop(), not beginning (it might delete this ).
virtual void processEvent (const EventBase &event)
 By defining here, allows you to get away with not supplying a processEvent() function for the EventListener interface. By default, does nothing.
virtual std::string getDescription () const
 Gives a short description of what this particular instantiation does (in case a more specific description is needed on an individual basis).

Static Public Member Functions

static std::string getClassDescription ()
 Gives a short description of what this class of behaviors does... you should override this (but don't have to).

Protected Attributes

MotionManager::MC_ID mc_id
 the id of the HeadPointerMC which does the looking


Constructor & Destructor Documentation

LookForSoundBehavior::LookForSoundBehavior  )  [inline]
 

constructor

Definition at line 13 of file LookForSoundBehavior.h.


Member Function Documentation

virtual void LookForSoundBehavior::DoStart  )  [inline, virtual]
 

By default, merely adds to the reference counter (through AddReference()); Note you should still call this from your overriding methods.

Reimplemented from BehaviorBase.

Definition at line 15 of file LookForSoundBehavior.h.

virtual void LookForSoundBehavior::DoStop  )  [inline, virtual]
 

By default, subtracts from the reference counter (RemoveReference()), and thus may deletex if zero; Don't forget to still call this when you override this; Warning: call this at the end of your DoStop(), not beginning (it might delete this ).

Reimplemented from BehaviorBase.

Definition at line 24 of file LookForSoundBehavior.h.

static std::string LookForSoundBehavior::getClassDescription  )  [inline, static]
 

Gives a short description of what this class of behaviors does... you should override this (but don't have to).

If you do override this, also consider overriding getDescription() to return it

Reimplemented from BehaviorBase.

Definition at line 65 of file LookForSoundBehavior.h.

Referenced by getDescription().

virtual std::string LookForSoundBehavior::getDescription  )  const [inline, virtual]
 

Gives a short description of what this particular instantiation does (in case a more specific description is needed on an individual basis).

By default simply returns getName(), because any calls from a BehaviorBase function to getClassDescription() are going to call BehaviorBase::getClassDescription(), not ~YourSubClass~::getClassDescription(), because static functions can't be virtual in C++ (doh!)

This means that getDescription called on a pointer to a BehaviorBase of unknown subtype would always return an empty string, which is pretty useless. So instead we return the name in this situation. If you want getDescription to return getClassDescription, you'll have to override it in your subclass to do so.

Reimplemented from BehaviorBase.

Definition at line 66 of file LookForSoundBehavior.h.

virtual void LookForSoundBehavior::processEvent const EventBase event  )  [inline, virtual]
 

By defining here, allows you to get away with not supplying a processEvent() function for the EventListener interface. By default, does nothing.

Reimplemented from BehaviorBase.

Definition at line 31 of file LookForSoundBehavior.h.


Member Data Documentation

MotionManager::MC_ID LookForSoundBehavior::mc_id [protected]
 

the id of the HeadPointerMC which does the looking

Definition at line 69 of file LookForSoundBehavior.h.

Referenced by DoStart(), DoStop(), LookForSoundBehavior(), and processEvent().


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

Tekkotsu v2.2.2
Generated Tue Jan 4 15:45:27 2005 by Doxygen 1.4.0