SoundNode Class Reference#include <SoundNode.h>
Inheritance diagram for SoundNode:
[legend]List of all members.
Detailed Description
A simple StateNode that plays a sound upon startup and throws a status event on completion.
Definition at line 10 of file SoundNode.h.
|
Public Member Functions |
| SoundNode (std::string nodename="SoundNode", std::string soundfilename="") |
| constructor
|
virtual void | DoStart () |
| activate the node
|
virtual void | DoStop () |
| deactivate the node
|
virtual void | processEvent (const EventBase &) |
| receive audioEGID status event and throw stateMachineEGID status event
|
void | StopPlay () |
| interrupts playing of the current sound
|
std::string | getFileName () |
| returns the name of the sound file associated with this node
|
void | setFileName (std::string &soundfilename) |
| sets the name of the sound file associated with this node
|
Protected Attributes |
std::string | filename |
SoundManager::Play_ID | curplay_id |
Constructor & Destructor Documentation
SoundNode::SoundNode |
( |
std::string |
nodename = "SoundNode" , |
|
|
std::string |
soundfilename = "" |
|
) |
[inline] |
|
Member Function Documentation
virtual void SoundNode::DoStart |
( |
|
) |
[inline, virtual] |
|
virtual void SoundNode::DoStop |
( |
|
) |
[inline, virtual] |
|
std::string SoundNode::getFileName |
( |
|
) |
[inline] |
|
|
returns the name of the sound file associated with this node
Definition at line 45 of file SoundNode.h. |
virtual void SoundNode::processEvent |
( |
const EventBase & |
|
) |
[inline, virtual] |
|
|
receive audioEGID status event and throw stateMachineEGID status event
Reimplemented from BehaviorBase.
Definition at line 34 of file SoundNode.h. |
void SoundNode::setFileName |
( |
std::string & |
soundfilename |
) |
[inline] |
|
|
sets the name of the sound file associated with this node
Definition at line 48 of file SoundNode.h. |
void SoundNode::StopPlay |
( |
|
) |
[inline] |
|
|
interrupts playing of the current sound
Definition at line 39 of file SoundNode.h. |
Member Data Documentation
The documentation for this class was generated from the following file:
|