makVrv::DtSharedAudioSettingsSignaler Class Reference

A signaler for the shared audio settings. More...

Inheritance diagram for makVrv::DtSharedAudioSettingsSignaler:

Public Member Functions
virtual	~DtSharedAudioSettingsSignaler ()
	DTOR.
Public Member Functions inherited from makVrv::DtVirtualBaseClass
	DtVirtualBaseClass ()
	Do nothing constructor.
virtual	~DtVirtualBaseClass ()
	Virtual do nothing destructor.

Static Public Member Functions
static DtSharedAudioSettingsSignaler &	instance (const DtSharedSettingsManager &mgr)
	Get the instance of the settings signaler from the settings manager.
static DtSharedAudioSettingsSignaler &	instance (DtEventQueueInterface &eqi)
	Get the instance of the settings signaler from the event queue.
static DtSharedAudioSettingsSignaler *	findInstance (DtEventQueueInterface *eqi)
	Find the instance of the settings signaler from the event queue.

Public Attributes
Signals for the sound settings.
event_signal< void()>	signal_Close
	Emitted when the DtAudioSettingsManager is destroyed.
event_signal< void(bool)>	signal_enableAudioChanged
	Emitted when the audio enabled setting is changed.
event_signal< void(double)>	signal_VolumeChanged
	Emitted when the audio volume is changed.
event_signal< void(double)>	signal_SoundRangeChanged
	Emitted when the audio range is changed.
event_signal< void(bool)>	signal_SoundRangeEnabledChanged
	Emitted when the audio range enabled setting is changed.
Signals for the sound mappings.
event_signal< void()>	signal_MapDataCleared
	Emitted when the entire mapping database has been cleared.
event_signal< void(DtEntitySoundMapRecord, bool)>	signal_EntityMapRecordAdded
	Emitted when a new entity sound-file mapping has been added.
event_signal< void(DtEntitySoundMapRecord, bool)>	signal_EntityMapRecordChanged
	Emitted when an existing entity sound-file mapping has been changed.
event_signal< void(DtEntitySoundMapRecord, bool)>	signal_EntityMapRecordRemoved
	Emitted when an existing entity sound-file mapping has been removed.
event_signal< void(DtFireSoundMapRecord, bool)>	signal_WeaponFireMapRecordAdded
	Emitted when a new weapon-fire sound-file mapping has been added.
event_signal< void(DtFireSoundMapRecord, bool)>	signal_WeaponFireMapRecordChanged
	Emitted when an existing weapon-fire sound-file mapping has been changed.
event_signal< void(DtFireSoundMapRecord, bool)>	signal_WeaponFireMapRecordRemoved
	Emitted when an existing weapon-fire sound-file mapping has been removed.
event_signal< void(DtDetonationSoundMapRecord, bool)>	signal_DetonationMapRecordAdded
	Emitted when a new detonation sound-file mapping has been added.
event_signal< void(DtDetonationSoundMapRecord, bool)>	signal_DetonationMapRecordChanged
	Emitted when an existing detonation sound-file mapping has been changed.
event_signal< void(DtDetonationSoundMapRecord, bool)>	signal_DetonationMapRecordRemoved
	Emitted when an existing detonation sound-file mapping has been removed.
event_signal< void()>	signal_ReloadMapData
	Emitted when the entire mapping database has been cleared.

Protected Member Functions
	DtSharedAudioSettingsSignaler (DtEventQueueInterface &eqi)
	Protected CTOR ( Use ::instance(..) ).

Private Member Functions
	DtSharedAudioSettingsSignaler (const DtSharedAudioSettingsSignaler &sig)
	Copy CTOR (Not implemented).
DtSharedAudioSettingsSignaler &	operator= (const DtSharedAudioSettingsSignaler &sig)
	Assignment Operator (Not implemented).

Detailed Description

A signaler for the shared audio settings.

Constructor & Destructor Documentation

virtual makVrv::DtSharedAudioSettingsSignaler::~DtSharedAudioSettingsSignaler ( )

virtual

DTOR.

makVrv::DtSharedAudioSettingsSignaler::DtSharedAudioSettingsSignaler ( DtEventQueueInterface &  eqi )

protected

Protected CTOR ( Use ::instance(..) ).

makVrv::DtSharedAudioSettingsSignaler::DtSharedAudioSettingsSignaler ( const DtSharedAudioSettingsSignaler &  sig )

private

Copy CTOR (Not implemented).

Member Function Documentation

static DtSharedAudioSettingsSignaler& makVrv::DtSharedAudioSettingsSignaler::instance ( const DtSharedSettingsManager &  mgr )

static

Get the instance of the settings signaler from the settings manager.

Returns

An instance of the settings signaler.

Note

This will return a different signaler depending on what thread this function is called from.

static DtSharedAudioSettingsSignaler& makVrv::DtSharedAudioSettingsSignaler::instance ( DtEventQueueInterface &  eqi )

static

Get the instance of the settings signaler from the event queue.

Returns

An instance of the settings signaler.

Note

This will return the same signaler independent of the thread.

static DtSharedAudioSettingsSignaler* makVrv::DtSharedAudioSettingsSignaler::findInstance ( DtEventQueueInterface *  eqi )

static

Find the instance of the settings signaler from the event queue.

Returns

An instance of the settings signaler or NULL of the instance does not exist.

Note

If a settings signaler is not registered with the event queue, this method will not create one.

DtSharedAudioSettingsSignaler& makVrv::DtSharedAudioSettingsSignaler::operator= ( const DtSharedAudioSettingsSignaler &  sig )

private

Assignment Operator (Not implemented).

Member Data Documentation

event_signal<void ()> makVrv::DtSharedAudioSettingsSignaler::signal_Close

Emitted when the DtAudioSettingsManager is destroyed.

event_signal<void (bool)> makVrv::DtSharedAudioSettingsSignaler::signal_enableAudioChanged

Emitted when the audio enabled setting is changed.

See Also

DtSharedAudioSettings::setAudioEnabled.

event_signal<void (double)> makVrv::DtSharedAudioSettingsSignaler::signal_VolumeChanged

Emitted when the audio volume is changed.

See Also

DtSharedAudioSettings::setVolume.

event_signal<void (double)> makVrv::DtSharedAudioSettingsSignaler::signal_SoundRangeChanged

Emitted when the audio range is changed.

See Also

DtSharedAudioSettings::setSoundRange.

event_signal<void (bool)> makVrv::DtSharedAudioSettingsSignaler::signal_SoundRangeEnabledChanged

Emitted when the audio range enabled setting is changed.

See Also

DtSharedAudioSettings::setSoundRangeEnabled.

event_signal<void ()> makVrv::DtSharedAudioSettingsSignaler::signal_MapDataCleared

Emitted when the entire mapping database has been cleared.

See Also

DtSharedAudioSettings::setFromRecord.

event_signal<void (DtEntitySoundMapRecord, bool)> makVrv::DtSharedAudioSettingsSignaler::signal_EntityMapRecordAdded

Emitted when a new entity sound-file mapping has been added.

See Also

DtSharedAudioSettings::entityMapAdd.

event_signal<void (DtEntitySoundMapRecord, bool)> makVrv::DtSharedAudioSettingsSignaler::signal_EntityMapRecordChanged

Emitted when an existing entity sound-file mapping has been changed.

See Also

DtSharedAudioSettings::entityMapAdd.

event_signal<void (DtEntitySoundMapRecord, bool)> makVrv::DtSharedAudioSettingsSignaler::signal_EntityMapRecordRemoved

Emitted when an existing entity sound-file mapping has been removed.

See Also

DtSharedAudioSettings::entityMapRemove.

event_signal<void (DtFireSoundMapRecord, bool)> makVrv::DtSharedAudioSettingsSignaler::signal_WeaponFireMapRecordAdded

Emitted when a new weapon-fire sound-file mapping has been added.

See Also

DtSharedAudioSettings::weaponFireMapAdd.

event_signal<void (DtFireSoundMapRecord, bool)> makVrv::DtSharedAudioSettingsSignaler::signal_WeaponFireMapRecordChanged

Emitted when an existing weapon-fire sound-file mapping has been changed.

See Also

DtSharedAudioSettings::weaponFireMapAdd.

event_signal<void (DtFireSoundMapRecord, bool)> makVrv::DtSharedAudioSettingsSignaler::signal_WeaponFireMapRecordRemoved

Emitted when an existing weapon-fire sound-file mapping has been removed.

See Also

DtSharedAudioSettings::weaponFireMapRemove.

event_signal<void (DtDetonationSoundMapRecord, bool)> makVrv::DtSharedAudioSettingsSignaler::signal_DetonationMapRecordAdded

Emitted when a new detonation sound-file mapping has been added.

See Also

DtSharedAudioSettings::detonationMapAdd.

event_signal<void (DtDetonationSoundMapRecord, bool)> makVrv::DtSharedAudioSettingsSignaler::signal_DetonationMapRecordChanged

Emitted when an existing detonation sound-file mapping has been changed.

See Also

DtSharedAudioSettings::detonationMapAdd.

event_signal<void (DtDetonationSoundMapRecord, bool)> makVrv::DtSharedAudioSettingsSignaler::signal_DetonationMapRecordRemoved

Emitted when an existing detonation sound-file mapping has been removed.

See Also

DtSharedAudioSettings::detonationMapRemove.

event_signal<void ()> makVrv::DtSharedAudioSettingsSignaler::signal_ReloadMapData

Emitted when the entire mapping database has been cleared.

See Also

DtSharedAudioSettings::setFilename.

Deprecated:

This signal has been deprecated.

---

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

• /exports/nfedora7-1/nightly/docs/vrforcesDevelopment.vrf4-3-branch/include/vrvAudioCommon/DtSharedAudioSettingsSignaler.h