Tekkotsu Homepage
Demos
Overview
Downloads
Dev. Resources
Reference
Credits

SimulatorAdvanceFrameControl Class Reference

#include <SimulatorAdvanceFrameControl.h>

Inheritance diagram for SimulatorAdvanceFrameControl:

List of all members.


Detailed Description

Requests the next camera frame and sensor data, for use when running in simulation.

Note that this won't increment the simulator time if triggered while paused...

Definition at line 14 of file SimulatorAdvanceFrameControl.h.


Public Member Functions

 SimulatorAdvanceFrameControl ()
 default constructor
 SimulatorAdvanceFrameControl (const std::string &n)
 constructor which allows a custom name
virtual ControlBaseactivate (MotionManager::MC_ID disp_id, Socket *gui)
 returns NULL
virtual std::string getName () const
 returns the name of the control
virtual std::string getDescription () const
 returns a short description of what the control does

Protected Member Functions

bool canManuallyAdvance () const
 ideally, this should return true only when the simulator is paused or the data source is frozen...

Constructor & Destructor Documentation

SimulatorAdvanceFrameControl::SimulatorAdvanceFrameControl (  )  [inline]

default constructor

Definition at line 18 of file SimulatorAdvanceFrameControl.h.

SimulatorAdvanceFrameControl::SimulatorAdvanceFrameControl ( const std::string &  n  )  [inline]

constructor which allows a custom name

Definition at line 22 of file SimulatorAdvanceFrameControl.h.


Member Function Documentation

virtual ControlBase* SimulatorAdvanceFrameControl::activate ( MotionManager::MC_ID  ,
Socket  
) [inline, virtual]

returns NULL

Reimplemented from NullControl.

Definition at line 29 of file SimulatorAdvanceFrameControl.h.

virtual std::string SimulatorAdvanceFrameControl::getName (  )  const [inline, virtual]

returns the name of the control

Reimplemented from ControlBase.

Definition at line 34 of file SimulatorAdvanceFrameControl.h.

virtual std::string SimulatorAdvanceFrameControl::getDescription (  )  const [inline, virtual]

returns a short description of what the control does

Reimplemented from ControlBase.

Definition at line 40 of file SimulatorAdvanceFrameControl.h.

bool SimulatorAdvanceFrameControl::canManuallyAdvance (  )  const [inline, protected]

ideally, this should return true only when the simulator is paused or the data source is frozen...

Definition at line 48 of file SimulatorAdvanceFrameControl.h.

Referenced by getDescription(), and getName().


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

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