//---------------------------------------------------------------------------------------------------------------------------------------------------
// <copyright file="Cue3D.cs" company="DarkWynter Studios">
//     Copyright (C)2007 DarkWynter Studios.  All rights reserved.
// </copyright>
//---------------------------------------------------------------------------------------------------------------------------------------------------
// {Contact : darkwynter.com for licensing information
//---------------------------------------------------------------------------------------------------------------------------------------------------

namespace DarkWynter.Engine.Audio
{

    using System;
    using System.Collections.Generic;
    using System.Diagnostics;
    using Microsoft.Xna.Framework;
    using Microsoft.Xna.Framework.Audio;
    using Microsoft.Xna.Framework.Content;
    using Microsoft.Xna.Framework.Graphics;
    using Microsoft.Xna.Framework.Input;
    using Microsoft.Xna.Framework.Storage;
    using System.Xml;

    /// <summary>
    /// Contains the neccessary information to us a 3D sound cue.
    /// </summary>
    public class Cue3D
    {
        /// <summary>
        /// Name of the audio track.
        /// This name corresponds with the name given it in XACT.
        /// </summary>
        public string name;
        /// <summary>
        /// Cue contatining sound used in 3D audio.
        /// </summary>
        public Cue cue;
        /// <summary>
        /// A sound generator.
        /// </summary>
        public AudioEmitter emitter;
        /// <summary>
        /// A sound receiver.
        /// </summary>
        public AudioListener listener;
        /// <summary>
        /// Delay before playing another terrainMod cue.
        /// Used to stop too many sounds from being played at once.
        /// </summary>
        public Stopwatch terrainModSoundTimer;

        public Cue3D(string cueName)
        {
            name = cueName;
            cue = Audio.soundBank.GetCue(name);
            terrainModSoundTimer = new Stopwatch();
            terrainModSoundTimer.Start();
            listener = new AudioListener();
            emitter = new AudioEmitter();
        }

    }

}