Homepage Demos Overview Downloads Tutorials Reference
Credits
Main Page | Namespace List | Class Hierarchy | Alphabetical List | Class List | Directories | File List | Namespace Members | Class Members | File Members | Related Pages | Search for 

SoundNode Class Reference

#include <SoundNode.h>

Inheritance diagram for SoundNode:

Inheritance graph
[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 Member Functions

 SoundNode (std::string &classname, std::string &nodename, std::string &soundfilename)
 constructor

Protected Attributes

std::string filename
SoundManager::Play_ID curplay_id

Constructor & Destructor Documentation

SoundNode::SoundNode (  std::string  nodename = "SoundNode",
std::string  soundfilename = ""
)  [inline]
 

constructor

Definition at line 17 of file SoundNode.h.

SoundNode::SoundNode (  std::string &  classname,
std::string &  nodename,
std::string &  soundfilename
)  [inline, protected]
 

constructor

Definition at line 52 of file SoundNode.h.

Member Function Documentation

virtual void SoundNode::DoStart (   )  [inline, virtual]
 

activate the node

Reimplemented from StateNode.

Definition at line 21 of file SoundNode.h.

virtual void SoundNode::DoStop (   )  [inline, virtual]
 

deactivate the node

Reimplemented from StateNode.

Definition at line 28 of file SoundNode.h.

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

SoundManager::Play_ID SoundNode::curplay_id [protected]
 

Definition at line 13 of file SoundNode.h.

Referenced by DoStart(), SoundNode(), and StopPlay().

std::string SoundNode::filename [protected]
 

Definition at line 12 of file SoundNode.h.

Referenced by DoStart(), setFileName(), and SoundNode().

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

Tekkotsu v2.2.1
 		Generated Tue Nov 23 16:37:52 2004 by Doxygen 1.3.9.1