Merged with trunk r37717.
[blender.git] / intern / audaspace / intern / AUD_I3DDevice.h
1 /*
2  * $Id$
3  *
4  * ***** BEGIN GPL LICENSE BLOCK *****
5  *
6  * Copyright 2009-2011 Jörg Hermann Müller
7  *
8  * This file is part of AudaSpace.
9  *
10  * Audaspace is free software; you can redistribute it and/or modify
11  * it under the terms of the GNU General Public License as published by
12  * the Free Software Foundation; either version 2 of the License, or
13  * (at your option) any later version.
14  *
15  * AudaSpace is distributed in the hope that it will be useful,
16  * but WITHOUT ANY WARRANTY; without even the implied warranty of
17  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
18  * GNU General Public License for more details.
19  *
20  * You should have received a copy of the GNU General Public License
21  * along with Audaspace; if not, write to the Free Software Foundation,
22  * Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
23  *
24  * ***** END GPL LICENSE BLOCK *****
25  */
26
27 /** \file audaspace/intern/AUD_I3DDevice.h
28  *  \ingroup audaspaceintern
29  */
30
31
32 #ifndef AUD_I3DDEVICE
33 #define AUD_I3DDEVICE
34
35 #include "AUD_Space.h"
36 #include "AUD_3DMath.h"
37
38 /**
39  * This class represents an output device for 3D sound.
40  */
41 class AUD_I3DDevice
42 {
43 public:
44         /**
45          * Retrieves the listener location.
46          * \return The listener location.
47          */
48         virtual AUD_Vector3 getListenerLocation() const=0;
49
50         /**
51          * Sets the listener location.
52          * \param location The new location.
53          */
54         virtual void setListenerLocation(const AUD_Vector3& location)=0;
55
56         /**
57          * Retrieves the listener velocity.
58          * \return The listener velocity.
59          */
60         virtual AUD_Vector3 getListenerVelocity() const=0;
61
62         /**
63          * Sets the listener velocity.
64          * \param velocity The new velocity.
65          */
66         virtual void setListenerVelocity(const AUD_Vector3& velocity)=0;
67
68         /**
69          * Retrieves the listener orientation.
70          * \return The listener orientation as quaternion.
71          */
72         virtual AUD_Quaternion getListenerOrientation() const=0;
73
74         /**
75          * Sets the listener orientation.
76          * \param orientation The new orientation as quaternion.
77          */
78         virtual void setListenerOrientation(const AUD_Quaternion& orientation)=0;
79
80
81         /**
82          * Retrieves the speed of sound.
83          * This value is needed for doppler effect calculation.
84          * \return The speed of sound.
85          */
86         virtual float getSpeedOfSound() const=0;
87
88         /**
89          * Sets the speed of sound.
90          * This value is needed for doppler effect calculation.
91          * \param speed The new speed of sound.
92          */
93         virtual void setSpeedOfSound(float speed)=0;
94
95         /**
96          * Retrieves the doppler factor.
97          * This value is a scaling factor for the velocity vectors of sources and
98          * listener which is used while calculating the doppler effect.
99          * \return The doppler factor.
100          */
101         virtual float getDopplerFactor() const=0;
102
103         /**
104          * Sets the doppler factor.
105          * This value is a scaling factor for the velocity vectors of sources and
106          * listener which is used while calculating the doppler effect.
107          * \param factor The new doppler factor.
108          */
109         virtual void setDopplerFactor(float factor)=0;
110
111         /**
112          * Retrieves the distance model.
113          * \return The distance model.
114          */
115         virtual AUD_DistanceModel getDistanceModel() const=0;
116
117         /**
118          * Sets the distance model.
119          * \param model distance model.
120          */
121         virtual void setDistanceModel(AUD_DistanceModel model)=0;
122 };
123
124 #endif //AUD_I3DDEVICE