Spinning Topp Logo BlackTopp Studios
inc
listener.h
1 // © Copyright 2010 - 2016 BlackTopp Studios Inc.
2 /* This file is part of The Mezzanine Engine.
3 
4  The Mezzanine Engine is free software: you can redistribute it and/or modify
5  it under the terms of the GNU General Public License as published by
6  the Free Software Foundation, either version 3 of the License, or
7  (at your option) any later version.
8 
9  The Mezzanine Engine is distributed in the hope that it will be useful,
10  but WITHOUT ANY WARRANTY; without even the implied warranty of
11  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
12  GNU General Public License for more details.
13 
14  You should have received a copy of the GNU General Public License
15  along with The Mezzanine Engine. If not, see <http://www.gnu.org/licenses/>.
16 */
17 /* The original authors have included a copy of the license specified above in the
18  'Docs' folder. See 'gpl.txt'
19 */
20 /* We welcome the use of the Mezzanine engine to anyone, including companies who wish to
21  Build professional software and charge for their product.
22 
23  However there are some practical restrictions, so if your project involves
24  any of the following you should contact us and we will try to work something
25  out:
26  - DRM or Copy Protection of any kind(except Copyrights)
27  - Software Patents You Do Not Wish to Freely License
28  - Any Kind of Linking to Non-GPL licensed Works
29  - Are Currently In Violation of Another Copyright Holder's GPL License
30  - If You want to change our code and not add a few hundred MB of stuff to
31  your distribution
32 
33  These and other limitations could cause serious legal problems if you ignore
34  them, so it is best to simply contact us or the Free Software Foundation, if
35  you have any questions.
36 
37  Joseph Toppi - toppij@gmail.com
38  John Blackwood - makoenergy02@gmail.com
39 */
40 // Copyright (c) 2008-2010 Raynaldo (Wildicv) Rivera, Joshua (Dark_Kilauea) Jones
41 // This file is part of the "cAudio Engine"
42 // For conditions of distribution and use, see copyright notice in cAudio-ZLIBLicense.txt
43 #ifndef _audiolistener_h
44 #define _audiolistener_h
45 
46 #include "worldproxy.h"
47 
48 namespace Mezzanine
49 {
50  namespace Audio
51  {
52  ///////////////////////////////////////////////////////////////////////////////
53  /// @brief This is an interface class for a listener (such as a player) in the 3D audio world.
54  /// @details
55  ///////////////////////////////////////
56  class iListener : public WorldProxy
57  {
58  public:
59  /// @brief Class constructor.
60  /// @param ID The unique ID of this listener.
61  iListener(const UInt32 ID) :
62  WorldProxy(ID)
63  { }
64  /// @brief Class destructor.
65  virtual ~iListener()
66  { }
67 
68  ///////////////////////////////////////////////////////////////////////////////
69  // Utility
70 
71  /// @brief Sets the moving velocity of this listener.
72  /// @param Vel The velocity this listener is to be given.
73  virtual void SetVelocity(const Vector3& Vel) = 0;
74  /// @brief Gets the current velocity of this listener.
75  /// @return Returns a Vector3 containing the current velocity of this listener.
76  virtual Vector3 GetVelocity() const = 0;
77 
78  /// @brief Sets the modifier to use that will adjust the volume of all audio heard by this listener.
79  /// @param Vol The modifier to be set. Range 0.0 to +Inf.
80  virtual void SetVolumeModifier(const Real Vol) = 0;
81  /// @brief Gets the modifier applied to all audio heard by this listener.
82  /// @return Returns the currently set volume modifier.
83  virtual Real GetVolumeModifier() const = 0;
84  /// @brief Sets the number of meters in a single unit of world space.
85  /// @param Meters The number of meters in a single unit of world space.
86  virtual void SetMetersPerUnit(const Real Meters) = 0;
87  /// @brief Gets the currently set number of meters in a single unit of world space.
88  /// @return Returns a Real representing the number of meters in a unit of world space.
89  virtual Real GetMetersPerUnit() const = 0;
90 
91  ///////////////////////////////////////////////////////////////////////////////
92  // Serialization
93 
94  /// @brief Get the name of the the XML tag the Renderable class will leave behind as its instances are serialized.
95  /// @return A string containing the name of this class.
96  static String GetSerializableName() { return "iListener"; }
97  };//iListener
98  }//Audio
99 }//Mezzanine
100 
101 #endif
virtual Real GetVolumeModifier() const =0
Gets the modifier applied to all audio heard by this listener.
float Real
A Datatype used to represent a real floating point number.
Definition: datatypes.h:141
static String GetSerializableName()
Get the name of the the XML tag the Renderable class will leave behind as its instances are serialize...
Definition: listener.h:96
virtual void SetVolumeModifier(const Real Vol)=0
Sets the modifier to use that will adjust the volume of all audio heard by this listener.
This is the base class for proxy objects belonging to the various 3D subsystems.
Definition: worldproxy.h:53
uint32_t UInt32
An 32-bit unsigned integer.
Definition: datatypes.h:126
virtual void SetVelocity(const Vector3 &Vel)=0
Sets the moving velocity of this listener.
virtual Vector3 GetVelocity() const =0
Gets the current velocity of this listener.
This is an interface class for a listener (such as a player) in the 3D audio world.
Definition: listener.h:56
virtual void SetMetersPerUnit(const Real Meters)=0
Sets the number of meters in a single unit of world space.
This is used to represent a point in space, or a vector through space.
Definition: vector3.h:77
virtual ~iListener()
Class destructor.
Definition: listener.h:65
The bulk of the engine components go in this namspace.
Definition: actor.cpp:56
iListener(const UInt32 ID)
Class constructor.
Definition: listener.h:61
virtual Real GetMetersPerUnit() const =0
Gets the currently set number of meters in a single unit of world space.
std::string String
A datatype used to a series of characters.
Definition: datatypes.h:159