MotionSequenceNode< SIZE > Class Template Reference
#include <MotionSequenceNode.h>
Inheritance diagram for MotionSequenceNode< SIZE >:
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 15 of file MotionSequenceNode.h.
Public Member Functions | |
| MotionSequenceNode () | |
| constructor | |
| MotionSequenceNode (const std::string &nm, const std::string &file, bool loop=false) | |
| constructor | |
| ~MotionSequenceNode () | |
| destructor, check if we need to call our teardown | |
| virtual void | DoStart () |
| Transitions should call this when you are entering the state, so it can enable its transitions. | |
| virtual void | DoStop () |
| Transitions should call this when you are leaving the state, so it can disable its transitions. | |
| virtual void | teardown () |
| This is called by DoStop() when you should destruct subnodes. | |
| virtual void | setFile (const std::string &file) |
| sets the file to play | |
| virtual void | setLooping (bool loop) |
| turns looping on or off | |
| virtual void | processEvent (const EventBase &e) |
| By defining here, allows you to get away with not supplying a processEvent() function for the EventListener interface. By default, does nothing. | |
| virtual bool | getLooping () |
| returns true if currently looping | |
| virtual MotionManager::MC_ID | getMSid () |
| use this to access the MS that the MotionSequenceNode is using | |
|
virtual MMAccessor< MotionSequenceMC< SIZE > > | getMSAccessor () |
| use this to access the MS that the MotionSequenceNode is using | |
| virtual bool | ownsMSid () |
| returns true if msid was created (and will be destroyed) by this MotionSequenceNode - false if assigned by setMsid() | |
Protected Member Functions | |
| void | updateMS (const std::string &file) |
| resets the motion command and starts it playing | |
Protected Attributes | |
| MotionManager::MC_ID | msid |
| id of the motion command | |
| bool | msidIsMine |
| true if this class created the current motion command (and therefore should delete it when done) | |
| bool | looping |
| true if we should loop | |
| std::string | filename |
| filename of current motion sequence | |
Member Function Documentation
template<unsigned int SIZE>
| virtual void MotionSequenceNode< SIZE >::teardown | ( | ) | [inline, virtual] |
This is called by DoStop() when you should destruct subnodes.
Default implementation will take care of the subnodes and their transitions, you only need to worry about any *other* memory which may have been allocated. If none, you may not need implement this function at all.
Reimplemented from StateNode.
Definition at line 50 of file MotionSequenceNode.h.
Referenced by MotionSequenceNode< SIZE >::~MotionSequenceNode().
The documentation for this class was generated from the following file:
