File: SoundItem.h

package info (click to toggle)
spring 103.0%2Bdfsg2-1
  • links: PTS, VCS
  • area: main
  • in suites: stretch
  • size: 43,720 kB
  • ctags: 63,685
  • sloc: cpp: 368,283; ansic: 33,988; python: 12,417; java: 12,203; awk: 5,879; sh: 1,846; xml: 655; perl: 405; php: 211; objc: 194; makefile: 77; sed: 2
file content (69 lines) | stat: -rw-r--r-- 1,484 bytes parent folder | download | duplicates (3)
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
63
64
65
66
67
68
69
/* This file is part of the Spring engine (GPL v2 or later), see LICENSE.html */

#ifndef SOUNDITEM_H
#define SOUNDITEM_H

#include <string>
#include <map>
#include <boost/shared_ptr.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(boost::shared_ptr<SoundBuffer> buffer, const std::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:
	boost::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