Tekkotsu Homepage
Demos
Overview
Downloads
Dev. Resources
Reference
Credits

SoundNode Class Reference

#include <SoundNode.h>

Inheritance diagram for SoundNode:

List of all members.


Detailed Description

A simple StateNode that plays a sound upon startup and throws a status event on completion.

Doesn't automatically preload the sound buffer - if you want the sound file to be preloaded, you'll have to make the SoundManager::loadFile() / SoundManager::releaseFile() calls yourself.

By default, sound playback will continue even after this node has been deactivated. If this is not the behavior you desire, set the autostop flag (through setAutoStop())

Definition at line 17 of file SoundNode.h.


Public Member Functions

 SoundNode (const std::string &soundfilename="")
 constructor, specify a sound file to play
 SoundNode (const std::string &nodename, const std::string &soundfilename)
 constructor, specify instance name and sound file to play
virtual void DoStart ()
 activate the node, starts playing the sound
virtual void DoStop ()
 deactivate the node, doesn't stop the sound playback unless the autostop flag has been set
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
bool getAutoStop ()
 returns the current status of the autostop flag
void setAutoStop (bool stop)
 sets the autostop flag

Protected Member Functions

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

Protected Attributes

std::string filename
 filename of sound to play, accessed through setFileName() and getFileName()
SoundManager::Play_ID curplay_id
 holds the playback identification so it can be halted any time
bool autostop
 if set to true by setAutoStop(), when this node is deactivated, playback will be halted. Otherwise, playback will continue even after the node is deactivated

Constructor & Destructor Documentation

SoundNode::SoundNode ( const std::string &  soundfilename = ""  )  [inline]

constructor, specify a sound file to play

Definition at line 25 of file SoundNode.h.

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

constructor, specify instance name and sound file to play

Definition at line 29 of file SoundNode.h.

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

constructor

Definition at line 75 of file SoundNode.h.


Member Function Documentation

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

activate the node, starts playing the sound

Reimplemented from StateNode.

Definition at line 33 of file SoundNode.h.

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

deactivate the node, doesn't stop the sound playback unless the autostop flag has been set

Reimplemented from StateNode.

Definition at line 42 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 50 of file SoundNode.h.

void SoundNode::stopPlay (  )  [inline]

interrupts playing of the current sound

Definition at line 56 of file SoundNode.h.

Referenced by DoStop().

std::string SoundNode::getFileName (  )  [inline]

returns the name of the sound file associated with this node

Definition at line 62 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 65 of file SoundNode.h.

bool SoundNode::getAutoStop (  )  [inline]

returns the current status of the autostop flag

Definition at line 68 of file SoundNode.h.

void SoundNode::setAutoStop ( bool  stop  )  [inline]

sets the autostop flag

Definition at line 71 of file SoundNode.h.


Member Data Documentation

std::string SoundNode::filename [protected]

filename of sound to play, accessed through setFileName() and getFileName()

Definition at line 19 of file SoundNode.h.

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

holds the playback identification so it can be halted any time

Definition at line 20 of file SoundNode.h.

Referenced by DoStart(), processEvent(), and stopPlay().

bool SoundNode::autostop [protected]

if set to true by setAutoStop(), when this node is deactivated, playback will be halted. Otherwise, playback will continue even after the node is deactivated

Definition at line 21 of file SoundNode.h.

Referenced by DoStop(), getAutoStop(), and setAutoStop().


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