unify include guard defines, __$FILENAME__
[blender-staging.git] / intern / audaspace / intern / AUD_I3DHandle.h
1 /*
2  * ***** BEGIN GPL LICENSE BLOCK *****
3  *
4  * Copyright 2009-2011 Jörg Hermann Müller
5  *
6  * This file is part of AudaSpace.
7  *
8  * Audaspace is free software; you can redistribute it and/or modify
9  * it under the terms of the GNU General Public License as published by
10  * the Free Software Foundation; either version 2 of the License, or
11  * (at your option) any later version.
12  *
13  * AudaSpace is distributed in the hope that it will be useful,
14  * but WITHOUT ANY WARRANTY; without even the implied warranty of
15  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
16  * GNU General Public License for more details.
17  *
18  * You should have received a copy of the GNU General Public License
19  * along with Audaspace; if not, write to the Free Software Foundation,
20  * Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
21  *
22  * ***** END GPL LICENSE BLOCK *****
23  */
24
25 /** \file audaspace/intern/AUD_I3DHandle.h
26  *  \ingroup audaspaceintern
27  */
28
29
30 #ifndef __AUD_I3DHANDLE_H__
31 #define __AUD_I3DHANDLE_H__
32
33 #include "AUD_Space.h"
34 #include "AUD_3DMath.h"
35
36 /**
37  * This class represents a playback handle for 3D sources.
38  */
39 class AUD_I3DHandle
40 {
41 public:
42         /**
43          * Destroys the handle.
44          */
45         virtual ~AUD_I3DHandle() {}
46
47         /**
48          * Retrieves the location of a source.
49          * \return The location.
50          */
51         virtual AUD_Vector3 getSourceLocation()=0;
52
53         /**
54          * Sets the location of a source.
55          * \param location The new location.
56          * \return Whether the action succeeded.
57          */
58         virtual bool setSourceLocation(const AUD_Vector3& location)=0;
59
60         /**
61          * Retrieves the velocity of a source.
62          * \return The velocity.
63          */
64         virtual AUD_Vector3 getSourceVelocity()=0;
65
66         /**
67          * Sets the velocity of a source.
68          * \param velocity The new velocity.
69          * \return Whether the action succeeded.
70          */
71         virtual bool setSourceVelocity(const AUD_Vector3& velocity)=0;
72
73         /**
74          * Retrieves the orientation of a source.
75          * \return The orientation as quaternion.
76          */
77         virtual AUD_Quaternion getSourceOrientation()=0;
78
79         /**
80          * Sets the orientation of a source.
81          * \param orientation The new orientation as quaternion.
82          * \return Whether the action succeeded.
83          */
84         virtual bool setSourceOrientation(const AUD_Quaternion& orientation)=0;
85
86
87         /**
88          * Checks whether the source location, velocity and orientation are relative
89          * to the listener.
90          * \return Whether the source is relative.
91          */
92         virtual bool isRelative()=0;
93
94         /**
95          * Sets whether the source location, velocity and orientation are relative
96          * to the listener.
97          * \param relative Whether the source is relative.
98          * \return Whether the action succeeded.
99          */
100         virtual bool setRelative(bool relative)=0;
101
102         /**
103          * Retrieves the maximum volume of a source.
104          * \return The maximum volume.
105          */
106         virtual float getVolumeMaximum()=0;
107
108         /**
109          * Sets the maximum volume of a source.
110          * \param volume The new maximum volume.
111          * \return Whether the action succeeded.
112          */
113         virtual bool setVolumeMaximum(float volume)=0;
114
115         /**
116          * Retrieves the minimum volume of a source.
117          * \return The minimum volume.
118          */
119         virtual float getVolumeMinimum()=0;
120
121         /**
122          * Sets the minimum volume of a source.
123          * \param volume The new minimum volume.
124          * \return Whether the action succeeded.
125          */
126         virtual bool setVolumeMinimum(float volume)=0;
127
128         /**
129          * Retrieves the maximum distance of a source.
130          * If a source is further away from the reader than this distance, the
131          * volume will automatically be set to 0.
132          * \return The maximum distance.
133          */
134         virtual float getDistanceMaximum()=0;
135
136         /**
137          * Sets the maximum distance of a source.
138          * If a source is further away from the reader than this distance, the
139          * volume will automatically be set to 0.
140          * \param distance The new maximum distance.
141          * \return Whether the action succeeded.
142          */
143         virtual bool setDistanceMaximum(float distance)=0;
144
145         /**
146          * Retrieves the reference distance of a source.
147          * \return The reference distance.
148          */
149         virtual float getDistanceReference()=0;
150
151         /**
152          * Sets the reference distance of a source.
153          * \param distance The new reference distance.
154          * \return Whether the action succeeded.
155          */
156         virtual bool setDistanceReference(float distance)=0;
157
158         /**
159          * Retrieves the attenuation of a source.
160          * \return The attenuation.
161          */
162         virtual float getAttenuation()=0;
163
164         /**
165          * Sets the attenuation of a source.
166          * This value is used for distance calculation.
167          * \param factor The new attenuation.
168          * \return Whether the action succeeded.
169          */
170         virtual bool setAttenuation(float factor)=0;
171
172         /**
173          * Retrieves the outer angle of the cone of a source.
174          * \return The outer angle of the cone.
175          */
176         virtual float getConeAngleOuter()=0;
177
178         /**
179          * Sets the outer angle of the cone of a source.
180          * \param angle The new outer angle of the cone.
181          * \return Whether the action succeeded.
182          */
183         virtual bool setConeAngleOuter(float angle)=0;
184
185         /**
186          * Retrieves the inner angle of the cone of a source.
187          * \return The inner angle of the cone.
188          */
189         virtual float getConeAngleInner()=0;
190
191         /**
192          * Sets the inner angle of the cone of a source.
193          * \param angle The new inner angle of the cone.
194          * \return Whether the action succeeded.
195          */
196         virtual bool setConeAngleInner(float angle)=0;
197
198         /**
199          * Retrieves the outer volume of the cone of a source.
200          * The volume between inner and outer angle is interpolated between inner
201          * volume and this value.
202          * \return The outer volume of the cone.
203          */
204         virtual float getConeVolumeOuter()=0;
205
206         /**
207          * Sets the outer volume of the cone of a source.
208          * The volume between inner and outer angle is interpolated between inner
209          * volume and this value.
210          * \param volume The new outer volume of the cone.
211          * \return Whether the action succeeded.
212          */
213         virtual bool setConeVolumeOuter(float volume)=0;
214 };
215
216 #endif //__AUD_I3DHANDLE_H__