DtSharedAudioSettings.h

Go to the documentation of this file.

/*******************************************************************************
 * Copyright (c) 2012 MAK Technologies, Inc.
 * All rights reserved.
 ******************************************************************************/


#pragma once

#include <vrvAudioCommon/vrvAudioCommon.h>
#include <vrvAudioCommon/DtAudioSettingsRecord.h>

#include <vrvCore/vrvCore.h>
#include <vrvCore/DtSharedSettings.h>
#include <vrvCore/DtRecordSettingsBackup.h>


namespace makVrv
{

   class DtSharedAudioSettingsSignaler;
   class DtSharedAudioSettings;

   typedef DtSharedRecordSettingsBackup<DtSharedAudioSettings,
      DtAudioSettingsRecord> DtAudioSettingsBackup;

   class DT_DLL_VRVAUDIOCOMMON DtSharedAudioSettings : public DtSharedSettings
   {
   public:

      virtual ~DtSharedAudioSettings();


      virtual void setAudioEnabled( bool val );

      virtual bool audioEnabled() const;

      virtual void setVolume( double val );

      virtual double volume() const;

      virtual void setSoundRangeEnabled( bool val );

      virtual bool soundRangeEnabled() const;

      virtual void setSoundRange( double val );

      virtual double soundRange() const;



      virtual unsigned int entityMapSize() const;

      virtual unsigned int weaponFireMapSize() const;

      virtual unsigned int detonationMapSize() const;

      virtual const DtEntitySoundMapRecord&
         entityMapAt( unsigned int index ) const;

      virtual const DtEntitySoundMapRecord&
         weaponFireMapAt( unsigned int index ) const;

      virtual const DtEntitySoundMapRecord&
         detonationMapAt( unsigned int index ) const;

      virtual unsigned int
         entityMapIndex( const DtEntitySoundMapRecord& record ) const;

      virtual unsigned int
         weaponFireMapIndex( const DtFireSoundMapRecord& record ) const;

      virtual unsigned int
         detonationMapIndex( const DtDetonationSoundMapRecord& record ) const;

      virtual void entityMapAdd(
         const DtEntitySoundMapRecord& record, bool reload = true );

      virtual void entityMapRemove(
         const DtEntitySoundMapRecord& record, bool reload = true );

      virtual void weaponFireMapAdd(
         const DtFireSoundMapRecord& record, bool reload = false );

      virtual void weaponFireMapRemove(
         const DtEntitySoundMapRecord& record, bool reload = false );

      virtual void detonationMapAdd(
         const DtDetonationSoundMapRecord& record, bool reload = false );

      virtual void detonationMapRemove(
         const DtEntitySoundMapRecord& record, bool reload = false );



      virtual void setFilename( const std::string& mtlFile );

      virtual const std::string& filename() const;



      virtual void setFromRecord( const DtAudioSettingsRecord& rec );

      virtual void getRecord( DtAudioSettingsRecord& rec ) const;

      virtual const DtAudioSettingsBackup* settingsBackup() const;

      virtual DtAudioSettingsBackup* settingsBackup();

      virtual void backup();


      static std::string className();

   protected:

      friend class DtReadSettingsLock<DtSharedAudioSettings>;
      friend class DtWriteSettingsLock<DtSharedAudioSettings>;

      DtSharedAudioSettings( DtSharedSettingsManager& manager );

   protected:

      int myControllerId;

      DtAudioSettingsRecord myRecord;

      DtAudioSettingsBackup* mySettingsBackup;

   };

}