1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
|
/* This file is part of the Spring engine (GPL v2 or later), see LICENSE.html */
#ifndef SOUNDITEM_H
#define SOUNDITEM_H
#include <string>
#include <memory>
#include "System/UnorderedMap.hpp"
class SoundBuffer;
/**
* @brief A class representing a sound which can be played
*
* This can be played by CSoundSource.
* Each soundsource has exactly one SoundBuffer it wraps around, while one buffer can be shared among multiple Items.
* You can adjust various playing parameters within this class, sou you can have 1 buffer and multiple SoundItems
* which differ in pitch, volume etc.
*/
class SoundItem
{
friend class CSoundSource;
public:
SoundItem(std::shared_ptr<SoundBuffer> buffer, const spring::unordered_map<std::string, std::string>& items);
bool PlayNow();
void StopPlay();
float MaxDistance() const { return maxDist; }
const std::string& Name() const { return name; }
const int GetPriority() const { return priority; }
float GetGain() const;
float GetPitch() const;
private:
std::shared_ptr<SoundBuffer> buffer;
/// unique identifier (if no name is specified, this will be the filename)
std::string name;
/// volume gain, applied to this sound
float gain;
float gainMod;
/// sound pitch (multiplied with globalPitch from CSoundSource when played)
float pitch;
float pitchMod;
float dopplerScale;
float maxDist;
float rolloff;
int priority;
unsigned maxConcurrent;
unsigned currentlyPlaying;
unsigned loopTime;
bool in3D;
};
#endif
|
