Tekkotsu Homepage
Demos
Overview
Downloads
Dev. Resources
Reference
Credits

BehaviorActivatorControl Class Reference

#include <BehaviorActivatorControl.h>

Inheritance diagram for BehaviorActivatorControl:

List of all members.


Detailed Description

Upon activation, will start, stop, or toggle a behavior.

Definition at line 8 of file BehaviorActivatorControl.h.


Public Types

enum  Mode_t { start, stop, toggle }
 lets you tell it what action to perform More...

Public Member Functions

virtual ~BehaviorActivatorControl ()
 destructor
virtual ControlBaseactivate (MotionManager::MC_ID disp_id, Socket *gui)
 performs the action denoted by mode
 BehaviorActivatorControl (BehaviorBase *behave, Mode_t m=toggle)
 constructors
 BehaviorActivatorControl (const std::string &n, BehaviorBase *behave, Mode_t m=toggle)
 constructors
 BehaviorActivatorControl (const std::string &n, const std::string &d, BehaviorBase *behave, Mode_t m=toggle)
 constructors

Protected Member Functions

void init ()
 adds to target's reference counter

Protected Attributes

BehaviorBasetarget
 The behavior to activate/deactivate.
Mode_t mode
 the mode this control is in

Private Member Functions

 BehaviorActivatorControl (const BehaviorActivatorControl &)
 don't copy this class
BehaviorActivatorControl operator= (const BehaviorActivatorControl &)
 don't assign this class

Member Enumeration Documentation

lets you tell it what action to perform

Enumerator:
start  Passed to constructor, indicates this control should start the behavior when activated.
stop  Passed to constructor, indicates this control should stop the behavior when activated.
toggle  Passed to constructor, indicates this control should toggle the behavior when activated.

Definition at line 11 of file BehaviorActivatorControl.h.


Constructor & Destructor Documentation

BehaviorActivatorControl::BehaviorActivatorControl ( BehaviorBase behave,
Mode_t  m = toggle 
) [inline]

constructors

Definition at line 19 of file BehaviorActivatorControl.h.

BehaviorActivatorControl::BehaviorActivatorControl ( const std::string &  n,
BehaviorBase behave,
Mode_t  m = toggle 
) [inline]

constructors

Definition at line 20 of file BehaviorActivatorControl.h.

BehaviorActivatorControl::BehaviorActivatorControl ( const std::string &  n,
const std::string &  d,
BehaviorBase behave,
Mode_t  m = toggle 
) [inline]

constructors

Definition at line 21 of file BehaviorActivatorControl.h.

virtual BehaviorActivatorControl::~BehaviorActivatorControl (  )  [inline, virtual]

destructor

Definition at line 25 of file BehaviorActivatorControl.h.

BehaviorActivatorControl::BehaviorActivatorControl ( const BehaviorActivatorControl  )  [private]

don't copy this class


Member Function Documentation

virtual ControlBase* BehaviorActivatorControl::activate ( MotionManager::MC_ID  disp_id,
Socket gui 
) [inline, virtual]

performs the action denoted by mode

Reimplemented from NullControl.

Definition at line 28 of file BehaviorActivatorControl.h.

void BehaviorActivatorControl::init (  )  [inline, protected]

adds to target's reference counter

Definition at line 52 of file BehaviorActivatorControl.h.

Referenced by BehaviorActivatorControl().

BehaviorActivatorControl BehaviorActivatorControl::operator= ( const BehaviorActivatorControl  )  [private]

don't assign this class


Member Data Documentation

The behavior to activate/deactivate.

Definition at line 56 of file BehaviorActivatorControl.h.

Referenced by activate(), init(), and ~BehaviorActivatorControl().

the mode this control is in

Definition at line 57 of file BehaviorActivatorControl.h.

Referenced by activate().


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

Tekkotsu v4.0
Generated Thu Nov 22 00:58:10 2007 by Doxygen 1.5.4