Audaspace 1.5.0
A high level audio library.
Loading...
Searching...
No Matches
I3DHandle.h
Go to the documentation of this file.
1/*******************************************************************************
2 * Copyright 2009-2016 Jörg Müller
3 *
4 * Licensed under the Apache License, Version 2.0 (the "License");
5 * you may not use this file except in compliance with the License.
6 * You may obtain a copy of the License at
7 *
8 * http://www.apache.org/licenses/LICENSE-2.0
9 *
10 * Unless required by applicable law or agreed to in writing, software
11 * distributed under the License is distributed on an "AS IS" BASIS,
12 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13 * See the License for the specific language governing permissions and
14 * limitations under the License.
15 ******************************************************************************/
16
17#pragma once
18
25#include "util/Math3D.h"
26
28
39{
40public:
44 virtual ~I3DHandle() {}
45
50 virtual Vector3 getLocation()=0;
51
59 virtual bool setLocation(const Vector3& location)=0;
60
65 virtual Vector3 getVelocity()=0;
66
74 virtual bool setVelocity(const Vector3& velocity)=0;
75
81
91 virtual bool setOrientation(const Quaternion& orientation)=0;
92
93
99 virtual bool isRelative()=0;
100
108 virtual bool setRelative(bool relative)=0;
109
114 virtual float getVolumeMaximum()=0;
115
121 virtual bool setVolumeMaximum(float volume)=0;
122
127 virtual float getVolumeMinimum()=0;
128
134 virtual bool setVolumeMinimum(float volume)=0;
135
142 virtual float getDistanceMaximum()=0;
143
151 virtual bool setDistanceMaximum(float distance)=0;
152
157 virtual float getDistanceReference()=0;
158
164 virtual bool setDistanceReference(float distance)=0;
165
170 virtual float getAttenuation()=0;
171
178 virtual bool setAttenuation(float factor)=0;
179
185 virtual float getConeAngleOuter()=0;
186
193 virtual bool setConeAngleOuter(float angle)=0;
194
201 virtual float getConeAngleInner()=0;
202
210 virtual bool setConeAngleInner(float angle)=0;
211
219 virtual float getConeVolumeOuter()=0;
220
229 virtual bool setConeVolumeOuter(float volume)=0;
230};
231
#define AUD_NAMESPACE_END
Closes the audaspace namespace aud.
Definition Audaspace.h:119
#define AUD_NAMESPACE_BEGIN
Opens the audaspace namespace aud.
Definition Audaspace.h:116
#define AUD_API
Used for exporting symbols in the shared library.
Definition Audaspace.h:93
Defines the Vector3 and Quaternion classes.
The I3DHandle interface represents a playback handle for 3D sources.
Definition I3DHandle.h:39
virtual bool isRelative()=0
Checks whether the source location, velocity and orientation are relative to the listener.
virtual Vector3 getVelocity()=0
Retrieves the velocity of the source.
virtual bool setVolumeMinimum(float volume)=0
Sets the minimum volume of a source.
virtual bool setAttenuation(float factor)=0
Sets the attenuation of a source.
virtual bool setVolumeMaximum(float volume)=0
Sets the maximum volume of a source.
virtual ~I3DHandle()
Destroys the handle.
Definition I3DHandle.h:44
virtual float getConeAngleInner()=0
Retrieves the inner opening angle of the cone of a source.
virtual bool setOrientation(const Quaternion &orientation)=0
Sets the orientation of the source.
virtual bool setLocation(const Vector3 &location)=0
Sets the location of the source.
virtual bool setDistanceMaximum(float distance)=0
Sets the maximum distance of a source.
virtual bool setRelative(bool relative)=0
Sets whether the source location, velocity and orientation are relative to the listener.
virtual float getVolumeMinimum()=0
Retrieves the minimum volume of a source.
virtual Vector3 getLocation()=0
Retrieves the location of the source.
virtual bool setConeVolumeOuter(float volume)=0
Sets the outer volume of the cone of a source.
virtual bool setDistanceReference(float distance)=0
Sets the reference distance of a source.
virtual float getVolumeMaximum()=0
Retrieves the maximum volume of a source.
virtual bool setConeAngleOuter(float angle)=0
Sets the outer opening angle of the cone of a source.
virtual Quaternion getOrientation()=0
Retrieves the orientation of the source.
virtual float getConeAngleOuter()=0
Retrieves the outer opening angle of the cone of a source.
virtual float getConeVolumeOuter()=0
Retrieves the outer volume of the cone of a source.
virtual float getDistanceReference()=0
Retrieves the reference distance of a source.
virtual float getDistanceMaximum()=0
Retrieves the maximum distance of a source.
virtual float getAttenuation()=0
Retrieves the attenuation of a source.
virtual bool setVelocity(const Vector3 &velocity)=0
Sets the velocity of the source.
virtual bool setConeAngleInner(float angle)=0
Sets the inner opening angle of the cone of a source.
This class represents a quaternion used for 3D rotations.
Definition Math3D.h:206
This class represents a 3 dimensional vector.
Definition Math3D.h:36