MotionSequenceNode< SIZE > Class Template Reference
A StateNode for playing a MotionSequence (and looping it if desired). More...
#include <MotionSequenceNode.h>
Detailed Description
template<unsigned int SIZE>
class MotionSequenceNode< SIZE >
A StateNode for playing a MotionSequence (and looping it if desired).
Eventually, i'd like to just build the looping functionality into MotionSequence, but in the mean time we have this.
Definition at line 22 of file MotionSequenceNode.h.
Public Member Functions | |
| MotionSequenceNode () | |
| constructor | |
| MotionSequenceNode (const std::string &name, const std::string &file="", bool loop=false) | |
| constructor | |
| virtual void | preStart () |
| Adds the motion command to the motion manager, add a listener for the motion's completion event. | |
| virtual void | postStart () |
| Called by start() after the doStart(), allows superclasses to complete initialization. | |
| virtual void | setFile (const std::string &file) |
| sets the file to play | |
| virtual void | setLooping (bool loop) |
| turns looping on or off | |
| virtual void | doEvent () |
| Assumes the event is a completion event from the motion, throws a corresponding state node completion event. | |
| virtual bool | getLooping () |
| returns true if currently looping | |
Protected Member Functions | |
| void | update (const std::string &file) |
| resets the motion command and starts it playing | |
Protected Attributes | |
| bool | looping |
| true if we should loop | |
| std::string | filename |
| filename of current motion sequence | |
Constructor & Destructor Documentation
| MotionSequenceNode< SIZE >::MotionSequenceNode | ( | ) |
constructor
Definition at line 25 of file MotionSequenceNode.h.
| MotionSequenceNode< SIZE >::MotionSequenceNode | ( | const std::string & | name, | |
| const std::string & | file = "", |
|||
| bool | loop = false | |||
| ) |
constructor
Definition at line 30 of file MotionSequenceNode.h.
Member Function Documentation
| virtual void MotionSequenceNode< SIZE >::doEvent | ( | ) | [virtual] |
Assumes the event is a completion event from the motion, throws a corresponding state node completion event.
Reimplemented from MCNodeBase.
Definition at line 57 of file MotionSequenceNode.h.
| virtual bool MotionSequenceNode< SIZE >::getLooping | ( | ) | [virtual] |
returns true if currently looping
Definition at line 67 of file MotionSequenceNode.h.
| virtual void MotionSequenceNode< SIZE >::postStart | ( | ) | [virtual] |
Called by start() after the doStart(), allows superclasses to complete initialization.
For robustness to future change, subclasses should be sure to call the superclass implementation.
Reimplemented from BehaviorBase.
Definition at line 41 of file MotionSequenceNode.h.
| virtual void MotionSequenceNode< SIZE >::preStart | ( | ) | [virtual] |
Adds the motion command to the motion manager, add a listener for the motion's completion event.
Reimplemented from MCNodeBase.
Definition at line 34 of file MotionSequenceNode.h.
| virtual void MotionSequenceNode< SIZE >::setFile | ( | const std::string & | file | ) | [virtual] |
sets the file to play
Definition at line 47 of file MotionSequenceNode.h.
| virtual void MotionSequenceNode< SIZE >::setLooping | ( | bool | loop | ) | [virtual] |
turns looping on or off
Definition at line 55 of file MotionSequenceNode.h.
| void MotionSequenceNode< SIZE >::update | ( | const std::string & | file | ) | [protected] |
resets the motion command and starts it playing
Definition at line 72 of file MotionSequenceNode.h.
Referenced by MotionSequenceNode< SIZE >::preStart(), and MotionSequenceNode< SIZE >::setFile().
Member Data Documentation
std::string MotionSequenceNode< SIZE >::filename [protected] |
filename of current motion sequence
Definition at line 83 of file MotionSequenceNode.h.
Referenced by MotionSequenceNode< SIZE >::preStart(), MotionSequenceNode< SIZE >::setFile(), and MotionSequenceNode< SIZE >::update().
bool MotionSequenceNode< SIZE >::looping [protected] |
true if we should loop
Definition at line 82 of file MotionSequenceNode.h.
Referenced by MotionSequenceNode< SIZE >::doEvent(), MotionSequenceNode< SIZE >::getLooping(), and MotionSequenceNode< SIZE >::setLooping().
The documentation for this class was generated from the following file:
