SGXmlSound Class Reference

Class for handling one sound event. More...

#include <xmlsound.hxx>

List of all members.

Public Member Functions

virtual void init (SGPropertyNode *, SGPropertyNode *, SGSampleGroup *, SGSampleGroup *, const string &)
 Initialize the sound event.
virtual void update (double dt)
 Check whether an event has happened and if action has to be taken.
void stop ()
 Stop taking action on the pre-defined events.

Detailed Description

Class for handling one sound event.

This class handles everything for a particular sound event, by scanning an a pre-loaded property tree structure for sound settings, setting up its internal states, and managing sound playback whenever such an event happens.

Definition at line 55 of file xmlsound.hxx.


Member Function Documentation

void SGXmlSound::init ( SGPropertyNode root,
SGPropertyNode node,
SGSampleGroup *  sgrp,
SGSampleGroup *  avionics,
const string &  path 
) [virtual]

Initialize the sound event.

Prior to initialization of the sound event the program's property root has to be defined, the sound configuration XML tree has to be loaded and a sound manager class has to be defined.

A sound configuration file would look like this: <fx> <event_name> <name> Define the name of the event. For reference only. <mode> Either: looped: play this sound looped. in-transit: play looped while the event is happening. once: play this sound once. <path> The relative path to the audio file. <property> Take action if this property becomes true. <condition> Take action if this condition becomes true. <delay-sec/> Time after which the sound should be played. <volume> or <pitch> Define volume or pitch settings. <property> Take the value of this property as a reference for the result. <internal> Either: dt_start: the time elapsed since this sound is playing. dt_stop: the time elapsed since this sound has stopped. <offset> Add this value to the result. <factor> Multiply the result by this factor. <min> Make sure the value is never less than this value. <max> Make sure the value is never larger than this value. </volume> or </pitch> </event_name>

<event_name> </event_name> </fx>

Parameters:
root The root node of the programs property tree.
child A pointer to the location of the current event as defined in the configuration file.
sgrp A pointer to a pre-initialized sample group class.
avionics A pointer to the pre-initialized avionics sample group.
path The path where the audio files remain.

Definition at line 84 of file xmlsound.cxx.


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

Generated on 23 Feb 2010 for SimGear by  doxygen 1.6.1