Removing Listener

include/VABase.h

@@ -471,7 +471,7 @@ public:
 };
 
 
-//! Data class containing information of a listener (acoustic receiver)
+//! Data class containing information of a sound receiver (acoustic receiver)
 class VABASE_API CVASoundReceiverInfo
 {
 public:

include/VAEvent.h

@@ -69,7 +69,7 @@ public:
 	static const uint64_t VA_EVENT_PORTAL_CHANGED_POSE = VA_BIT64( 27 );
 	static const uint64_t VA_EVENT_PORTAL_CHANGED_PARAMETER = VA_BIT64( 41 );
 
-	static const uint64_t VA_EVENT_ACTIVE_LISTENER_CHANGED = VA_BIT64( 28 );
+	static const uint64_t VA_EVENT_ACTIVE_SOUND_RECEIVER_CHANGED = VA_BIT64( 28 );
 	static const uint64_t VA_EVENT_INPUTGAIN_CHANGED = VA_BIT64( 29 );
 	static const uint64_t VA_EVENT_INPUTMUTING_CHANGED = VA_BIT64( 30 );
 	static const uint64_t VA_EVENT_OUTPUTGAIN_CHANGED = VA_BIT64( 31 );
@@ -106,8 +106,8 @@ public:
 		VA_EVENT_SOUND_SOURCE_CHANGED_POSE |
 		VA_EVENT_SOUND_SOURCE_CHANGED_DIRECTIVITY;
 
-	// Selector mask for listener related events
-	static const uint64_t VA_EVENT_LISTENER_EVENT = VA_EVENT_SOUND_RECEIVER_CREATED |
+	// Selector mask for sound receiver related events
+	static const uint64_t VA_EVENT_SOUND_RECEIVER_EVENT = VA_EVENT_SOUND_RECEIVER_CREATED |
 		VA_EVENT_SOUND_RECEIVER_DELETED |
 		VA_EVENT_SOUND_RECEIVER_CHANGED_NAME |
 		VA_EVENT_SOUND_RECEIVER_CHANGED_AURALIZATIONMODE |
@@ -128,8 +128,8 @@ public:
 		VA_EVENT_SOUND_SOURCE_CHANGED_POSE |
 		VA_EVENT_SOUND_SOURCE_CHANGED_DIRECTIVITY;
 
-	// Selector mask for listener modification event
-	static const uint64_t VA_EVENT_LISTENER_MODIFICATION = VA_EVENT_SOUND_RECEIVER_CHANGED_NAME |
+	// Selector mask for sound receiver modification event
+	static const uint64_t VA_EVENT_SOUND_RECEIVER_MODIFICATION = VA_EVENT_SOUND_RECEIVER_CHANGED_NAME |
 		VA_EVENT_SOUND_RECEIVER_CHANGED_AURALIZATIONMODE |
 		VA_EVENT_SOUND_RECEIVER_CHANGED_DIRECTIVITY |
 		VA_EVENT_SOUND_RECEIVER_CHANGED_POSE;

include/VAInterface.h

@@ -725,7 +725,7 @@ public:
 	//! Get sound source parameters
 	/**
 	  * This general parameter getter can be used for quick solutions retrieving
-	  * listener parameters without introducing new methods to the main interface.
+	  * sound receiver parameters without introducing new methods to the main interface.
 	  *
 	  * \param iSoundSourceID Sound source identifier
 	  * \param oParams Magic struct with the parameters that are requested
@@ -784,24 +784,24 @@ public:
 
 	//! Creates a sound receiver
 	/**
-	 * This method creates a new sound receiver (listener).
+	 * This method creates a new sound receiver (sound receiver).
 	 *
 	 * @param[in] sName		Name (optional)
 	 *
-	 * \return ID of the new listener, if the method succeeded, -1, otherwise
+	 * \return ID of the new sound receiver, if the method succeeded, -1, otherwise
 	 */
 	virtual int CreateSoundReceiver( const std::string& sName = "" ) = 0;
 
-	//! Creates a listener explicitly for a given renderer
+	//! Creates a sound receiver explicitly for a given renderer
 	/**
-	 * This method creates a new listener for a special renderer, only.
-	 * the listener will be skipped by all other renderers. See
+	 * This method creates a new sound receiver for a special renderer, only.
+	 * the sound receiver will be skipped by all other renderers. See
 	 * GetRendererLister() for a list of all available renderer identifier.
 	 *
 	 * \param	sName			Name
 	 * \param	sRendererID		Renderer identifier
 	 *
-	 * \return ID of the new listener, if the method succeeded and -1, otherwise
+	 * \return ID of the new sound receiver, if the method succeeded and -1, otherwise
 	 */
 	virtual int CreateSoundReceiverExplicitRenderer( const std::string& sRendererID, const std::string& sName = "" ) = 0;
 
@@ -817,21 +817,21 @@ public:
 
 	virtual CVASoundReceiverInfo GetSoundReceiverInfo( const int iID ) const = 0;
 
-	//! Enables or disables a virtual listener (removes the listener from audio processing)
+	//! Enables or disables a virtual sound receiver (removes the sound receiver from audio processing)
 	/**
-	  * @param[in] iListenerID	Listener identifier
+	  * @param[in] iSoundReceiverID	SoundReceiver identifier
 	  * @param[in] bEnabled		Enable (true) or disable (false) sound source
 	  *
-	  * @sa GetListenerEnabled()
+	  * @sa GetSoundReceiverEnabled()
 	  */
 	virtual void SetSoundReceiverEnabled( const int iID, const bool bEnabled = true ) = 0;
 
 	//! Returns sound receiver enabled/disabled status
 	/**
-	  * @param[in] iListenerID	Listener identifier
+	  * @param[in] iSoundReceiverID	SoundReceiver identifier
 	  * @return				Enabled (true) or disabled (false)
 	  *
-	  * @sa SetListenerEnabled()
+	  * @sa SetSoundReceiverEnabled()
 	  */
 	virtual bool GetSoundReceiverEnabled( const int iID ) const = 0;
 
@@ -850,31 +850,31 @@ public:
 	 */
 	virtual void SetSoundReceiverAuralizationMode( const int iSoundReceiverID, const int iAuralizationMode ) = 0;
 
-	//! Set listener parameters
+	//! Set sound receiver parameters
 	/**
 	  * This general parameter setter can be used for quick solutions changing
-	  * listener parameters without introducing new methods to the main interface.
+	  * sound receiver parameters without introducing new methods to the main interface.
 	  *
-	  * \param iListenerID Listener identifier
+	  * \param iSoundReceiverID SoundReceiver identifier
 	  * \param oParams Magic struct with the parameters
 	  */
 	virtual void SetSoundReceiverParameters( const int iID, const CVAStruct& oParams ) = 0;
 
-	//! Get listener parameters
+	//! Get sound receiver parameters
 	/**
 	  * This general parameter getter can be used for quick solutions retrieving
-	  * listener parameters without introducing new methods to the main interface.
+	  * sound receiver parameters without introducing new methods to the main interface.
 	  *
-	  * \param iListenerID Listener identifier
+	  * \param iSoundReceiverID SoundReceiver identifier
 	  * \param oParams Magic struct with the parameters that are requested
 	  * \return Magic struct with the parameter values requested
 	  */
 	virtual CVAStruct GetSoundReceiverParameters( const int iID, const CVAStruct& oArgs ) const = 0;
 
-	//! Returns for a listener the ID of the assigned HRIR dataset
+	//! Returns for a sound receiver the ID of the assigned HRIR dataset
 	virtual int GetSoundReceiverDirectivity( const int iID ) const = 0;
 
-	//! Set the HRIR dataset for a listener
+	//! Set the HRIR dataset for a sound receiver
 	/**
 	* \note In order to set no HRIR dataset, you can pass -1 to the method.
 	*/
@@ -895,7 +895,7 @@ public:
 
 	//! Position eines Hörers setzen (Positionsvektor) 
 	/**
-	 * - Sets the velocity of the listener to zero
+	 * - Sets the velocity of the sound receiver to zero
 	 */
 	virtual void SetSoundReceiverPosition( const int iID, const VAVec3& v3Pos ) = 0;
 
@@ -914,9 +914,9 @@ public:
 	virtual VAQuat GetSoundReceiverHeadAboveTorsoOrientation( const int iID ) const = 0;
 	virtual void SetSoundReceiverHeadAboveTorsoOrientation( const int iID, const VAQuat& qOrient ) = 0;
 
-	//! Returns the position and orientation of the real-world listener's head
+	//! Returns the position and orientation of the real-world sound receiver's head
 	/**
-	* \note The parameter iListenerID has been added for future versions and is
+	* \note The parameter iSoundReceiverID has been added for future versions and is
 	*       currently unsupported. You can set it any value you like.
 	*
 	* @note Coordinates refer the to center of the head on the axis
@@ -924,12 +924,12 @@ public:
 	*/
 	virtual void GetSoundReceiverRealWorldPositionOrientationVU( const int iID, VAVec3& v3Pos, VAVec3& v3View, VAVec3& v3Up ) const = 0;
 
-	//! Updates the position and orientation of the real-world listener's head
+	//! Updates the position and orientation of the real-world sound receiver's head
 	/**
 	* This function is used to provide the crosstalk-cancellation module
-	* with the current position of the listeners head in the real-world.
+	* with the current position of the sound receivers head in the real-world.
 	*
-	* \note The parameter iListenerID has been added for future versions and is
+	* \note The parameter iSoundReceiverID has been added for future versions and is
 	*       currently unsupported. You can set it any value you like.
 	*
 	* @note Coordinates refer the to center of the head on the axis
@@ -1141,52 +1141,52 @@ public:
 	 */
 	virtual void SetGlobalAuralizationMode( const int iAuralizationMode ) = 0;
 
-	//! Returns the (global) active listener
+	//! Returns the (global) active sound receiver
 	/**
-	  * The (global) active listener is the virtual listener for which
-	  * the renderers will route the output for, if the listener is
+	  * The (global) active sound receiver is the virtual sound receiver for which
+	  * the renderers will route the output for, if the sound receiver is
 	  * not used explicitly for a given renderer.
 	  *
-	  * @return Active listener id or -1, if no (global) active listener
+	  * @return Active sound receiver id or -1, if no (global) active sound receiver
 	  *
-	  * @sa GetActiveListenerExplicitRenderer
+	  * @sa GetActiveSoundReceiverExplicitRenderer
 	  */
-	virtual int GetActiveListener() const = 0;
+	virtual int GetActiveSoundReceiver() const = 0;
 
-	//! Sets the active listener
+	//! Sets the active sound receiver
 	/**
-	  * The renderers produce the output of this listener, only
-	  * (if listener is not explicitly created for another renderer)
+	  * The renderers produce the output of this sound receiver, only
+	  * (if sound receiver is not explicitly created for another renderer)
 	  *
-	  * @param[in] iListenerID	Listener identifier
+	  * @param[in] iSoundReceiverID	SoundReceiver identifier
 	  *
-	  * @sa GetActiveListener
-	  * @sa SetActiveListenerExplicitRenderer
+	  * @sa GetActiveSoundReceiver
+	  * @sa SetActiveSoundReceiverExplicitRenderer
 	  */
-	virtual void SetActiveListener( const int iSoundReceiverID ) = 0;
+	virtual void SetActiveSoundReceiver( const int iSoundReceiverID ) = 0;
 
-	//! Returns the active listener of an explicit renderer
+	//! Returns the active sound receiver of an explicit renderer
 	/**
 	  * @param[in] sRendererID	Renderer identifier
-	  * @return Active listener id or -1, if the listener is not activated explicitly
+	  * @return Active sound receiver id or -1, if the sound receiver is not activated explicitly
 	  *
-	  * @sa GetActiveListener
-	  * @sa SetActiveListenerExplicitRenderer
+	  * @sa GetActiveSoundReceiver
+	  * @sa SetActiveSoundReceiverExplicitRenderer
 	  */
-	virtual int GetActiveListenerExplicitRenderer( const std::string& sRendererID ) const = 0;
+	virtual int GetActiveSoundReceiverExplicitRenderer( const std::string& sRendererID ) const = 0;
 
-	//! Sets the active listener for an explicit renderer
+	//! Sets the active sound receiver for an explicit renderer
 	/**
-	 * The renderers forward the output of this listener, only
-	 * (if listener is not explicitly created for another renderer)
+	 * The renderers forward the output of this sound receiver, only
+	 * (if sound receiver is not explicitly created for another renderer)
 	 *
-	 * @param[in] iListenerID	Listener identifier
+	 * @param[in] iSoundReceiverID	SoundReceiver identifier
 	 * @param[in] sRendererID	Renderer identifier
 	 *
-	 * @sa GetActiveListenerExplicitRenderer
-	 * @sa SetActiveListener
+	 * @sa GetActiveSoundReceiverExplicitRenderer
+	 * @sa SetActiveSoundReceiver
 	 */
-	virtual void SetActiveListenerExplicitRenderer( const int iSoundReceiverID, const std::string& sRendererID ) = 0;
+	virtual void SetActiveSoundReceiverExplicitRenderer( const int iSoundReceiverID, const std::string& sRendererID ) = 0;
 
 	//! Get current core time
 	/**

src/VAEvent.cpp

@@ -110,28 +110,28 @@ std::string CVAEvent::ToString() const
 		break;
 
 	case VA_EVENT_SOUND_RECEIVER_CREATED:
-		ss << "Listener created (ID = " << iObjectID
+		ss << "Sound receiver created (ID = " << iObjectID
 			<< ", amode = " << IVAInterface::GetAuralizationModeStr( iAuralizationMode ) << ")";
 		break;
 
 	case VA_EVENT_SOUND_RECEIVER_DELETED:
-		ss << "Listener " << iObjectID << " deleted";
+		ss << "Sound receiver " << iObjectID << " deleted";
 		break;
 
 	case VA_EVENT_SOUND_RECEIVER_CHANGED_NAME:
-		ss << "Listener " << iObjectID << " changed name to \"" << sName << "\"";
+		ss << "Sound receiver " << iObjectID << " changed name to \"" << sName << "\"";
 		break;
 
 	case VA_EVENT_SOUND_RECEIVER_CHANGED_AURALIZATIONMODE:
-		ss << "Listener " << iObjectID << " changed auralization mode to " << IVAInterface::GetAuralizationModeStr( iAuralizationMode );
+		ss << "Sound receiver " << iObjectID << " changed auralization mode to " << IVAInterface::GetAuralizationModeStr( iAuralizationMode );
 		break;
 
 	case VA_EVENT_SOUND_RECEIVER_CHANGED_DIRECTIVITY:
-		ss << "Listener " << iObjectID << " is assigned HRIR dataset " << iParamID;
+		ss << "Sound receiver " << iObjectID << " is assigned HRIR dataset " << iParamID;
 		break;
 
 	case VA_EVENT_SOUND_RECEIVER_CHANGED_POSE:
-		ss << "Listener " << iObjectID << " changed position orientation" << std::endl
+		ss << "Sound receiver " << iObjectID << " changed position orientation" << std::endl
 			<< "P=" << vPos << ", "
 			<< "V=" << vView << ", "
 			<< "U=" << vUp;
@@ -145,8 +145,8 @@ std::string CVAEvent::ToString() const
 		ss << "Portal " << iObjectID << " changed state to \"" << std::setprecision( 3 ) << std::fixed << dState << "\"";
 		break;
 
-	case VA_EVENT_ACTIVE_LISTENER_CHANGED:
-		ss << "Listener " << iObjectID << " set as active listener";
+	case VA_EVENT_ACTIVE_SOUND_RECEIVER_CHANGED:
+		ss << "Sound receiver " << iObjectID << " set as active sound receiver";
 		break;
 
 	case VA_EVENT_INPUTGAIN_CHANGED: