Commit f8f6b443 authored by Dipl.-Ing. Jonas Stienen's avatar Dipl.-Ing. Jonas Stienen
Browse files

Updating head for open source release

parent b9fba22f
/*
* --------------------------------------------------------------------------------------------
*
* VVV VVV A
* VVV VVV AAA Virtual Acoustics (VA)
* VVV VVV AAA Real-time auralisation for virtual reality
* VVV VVV AAA
* VVVVVV AAA (c) Copyright Institute of Technical Acoustics (ITA), 2015-2017
* VVVV AAA RWTH Aachen University (http://www.akustik.rwth-aachen.de)
* VVV VVV A Virtual Acoustics (VA) | http://www.virtualacoustics.org
* VVV VVV AAA Licensed under the Apache License, Version 2.0
* VVV VVV AAA
* VVV VVV AAA Copyright 2015-2017
* VVVVVV AAA Institute of Technical Acoustics (ITA)
* VVVV AAA RWTH Aachen University
*
* --------------------------------------------------------------------------------------------
*/
......
/*
* --------------------------------------------------------------------------------------------
*
* VVV VVV A
* VVV VVV AAA Virtual Acoustics (VA)
* VVV VVV AAA Real-time auralisation for virtual reality
* VVV VVV AAA
* VVVVVV AAA (c) Copyright Institute of Technical Acoustics (ITA), 2015-2017
* VVVV AAA RWTH Aachen University (http://www.akustik.rwth-aachen.de)
* VVV VVV A Virtual Acoustics (VA) | http://www.virtualacoustics.org
* VVV VVV AAA Licensed under the Apache License, Version 2.0
* VVV VVV AAA
* VVV VVV AAA Copyright 2015-2017
* VVVVVV AAA Institute of Technical Acoustics (ITA)
* VVVV AAA RWTH Aachen University
*
* --------------------------------------------------------------------------------------------
*/
......
/*
* --------------------------------------------------------------------------------------------
*
* VVV VVV A
* VVV VVV AAA Virtual Acoustics (VA)
* VVV VVV AAA Real-time auralisation for virtual reality
* VVV VVV AAA
* VVVVVV AAA (c) Copyright Institute of Technical Acoustics (ITA), 2015-2017
* VVVV AAA RWTH Aachen University (http://www.akustik.rwth-aachen.de)
* VVV VVV A Virtual Acoustics (VA) | http://www.virtualacoustics.org
* VVV VVV AAA Licensed under the Apache License, Version 2.0
* VVV VVV AAA
* VVV VVV AAA Copyright 2015-2017
* VVVVVV AAA Institute of Technical Acoustics (ITA)
* VVVV AAA RWTH Aachen University
*
* --------------------------------------------------------------------------------------------
*/
......
......@@ -18,7 +18,7 @@
#include <string>
// Forward declarations
// Forward declarations
class VABASE_API CVACoreVersionInfo;
class VABASE_API CVAProgress;
class VABASE_API CVAStruct;
......@@ -121,7 +121,7 @@ public:
* | | *
* +----------------------------------------------------------+ */
//! Returns the state of the core
//! Returns the state of the core
virtual int GetState() const = 0;
//! Initializes the core
......@@ -171,13 +171,13 @@ public:
* | | *
* +----------------------------------------------------------+ */
//! Attaches a handler for core events to the core instance
/**
* \important Attaching event handlers it always possible,
* regardless of the state of the core.
* This method can therefore be called anytime,
* also before initialization and after finalization.
*/
//! Attaches a handler for core events to the core instance
/**
* \important Attaching event handlers it always possible,
* regardless of the state of the core.
* This method can therefore be called anytime,
* also before initialization and after finalization.
*/
virtual void AttachCoreEventHandler( IVACoreEventHandler* pCoreEventHandler ) = 0;
//! Detaches a handler for core events from the core instance
......@@ -198,7 +198,7 @@ public:
* | | *
* +----------------------------------------------------------+ */
//! Enumerates all modules of the core
//! Enumerates all modules of the core
virtual void EnumerateModules( std::vector< CVAModuleInfo >& viModuleInfos ) const = 0;
//! Calls a module of the core with arguments and return data
......@@ -217,19 +217,19 @@ public:
* | | *
* +----------------------------------------------------------+ */
//! Load a directivity
/**
* Loads a directivity from a file.
*
* \param sFilename Filename
* \param sName Name (optional, e.g. "Trumpet")
*
* \return Directivity-ID
*
* \note Slashes and backslashed may safely be used.
* Paths are automatically converted into the system's convention.
*/
virtual int LoadDirectivity( const std::string& sFilename, const std::string& sName = "" ) = 0;
//! Load a directivity
/**
* Loads a directivity from a file.
*
* \param sFilePath Filename
* \param sName Name (optional, e.g. "Trumpet")
*
* \return Directivity-ID
*
* \note Slashes and backslashed may safely be used.
* Paths are automatically converted into the system's convention.
*/
virtual int LoadDirectivity( const std::string& sFilePath, const std::string& sName = "" ) = 0;
//! Frees a directivity
/**
......@@ -256,20 +256,20 @@ public:
* | | *
* +----------------------------------------------------------+ */
//! Loads a HRIR dataset
/**
* Load a dataset of head-related impulse responses (HRIRs) from
* a DAFF file.
*
* \param sFilename Filename
* \param sName Name (optional, e.g. "Artificial head")
*
* \return HRIR-ID
*
* \note Slashes and backslashes may safely be used.
* Paths are automatically converted into the system's convention.
*/
virtual int LoadHRIRDataset( const std::string& sFilename, const std::string& sName = "" ) = 0;
//! Loads a HRIR dataset
/**
* Load a dataset of head-related impulse responses (HRIRs) from
* a DAFF file.
*
* \param sFilePath Filename
* \param sName Name (optional, e.g. "Artificial head")
*
* \return HRIR-ID
*
* \note Slashes and backslashes may safely be used.
* Paths are automatically converted into the system's convention.
*/
virtual int LoadHRIRDataset( const std::string& sFilePath, const std::string& sName = "" ) = 0;
//! Frees a HRIR dataset
/**
......@@ -296,21 +296,20 @@ public:
* | | *
* +----------------------------------------------------------+ */
//! Loads a sound
/**
* Loads a sound from an audiofile.
*
* \param sFilename Filename
* \param sName Name (optional, e.g. "door handle")
*
* \return Sound-ID
*
* \note The sound must be mono (single channel only)
* \note Slashes and backslashes may safely be used.
* Paths are automatically converted into the system's convention.
*/
virtual int LoadSound( const std::string& sFilename,
const std::string& sName = "" ) = 0;
//! Loads a sound
/**
* Loads a sound from an audiofile.
*
* \param sFilePath Filename
* \param sName Name (optional, e.g. "door handle")
*
* \return Sound-ID
*
* \note The sound must be mono (single channel only)
* \note Slashes and backslashes may safely be used.
* Paths are automatically converted into the system's convention.
*/
virtual int LoadSound( const std::string& sFilePath, const std::string& sName = "" ) = 0;
//! Frees a sound
/**
......@@ -329,7 +328,7 @@ public:
virtual CVASoundInfo GetSoundInfo( int iSoundID ) const = 0;
//! Retrieves information of all loaded sounds
virtual void GetSoundInfos( std::vector<CVASoundInfo>& vsiDest ) const = 0;
virtual void GetSoundInfos( std::vector< CVASoundInfo >& vsiDest ) const = 0;
//! Plays a sound
/**
......@@ -350,24 +349,24 @@ public:
* | | *
* +----------------------------------------------------------+ */
//! Creates an audiofile signal source
/**
* Creates a signal source which streams the samples of an audiofile.
* The audiofile must be mono and its sampling rate must match that
* of the core.
*
* \param sFilename Filename/path
* \param sName Name (optional, e.g. "Trumpet")
*
* \return Signal source ID
*/
virtual std::string CreateAudiofileSignalSource( const std::string& sFilename, const std::string& sName = "" ) = 0;
//! Creates an audiofile signal source
/**
* Creates a signal source which streams the samples of an audiofile.
* The audiofile must be mono and its sampling rate must match that
* of the core.
*
* \param sFilePath Filename/path
* \param sName Name (optional, e.g. "Trumpet")
*
* \return Signal source ID
*/
virtual std::string CreateAudiofileSignalSource( const std::string& sFilePath, const std::string& sName = "" ) = 0;
//! Creates a text-to-speech (TTS) signal source
/**
* Creates a signal source which streams generated samples from a text input.
*
* @param[in] sName Name (optional, e.g. "Penny")
* @param[in] sName Name (optional, e.g. "Penny")
*
* @return Signal source ID
*/
......@@ -586,7 +585,7 @@ public:
* | | *
* +----------------------------------------------------------+ */
//! Returns wheather a synchronized scene modification is in progress
//! Returns wheather a synchronized scene modification is in progress
virtual bool IsSceneLocked() const = 0;
//! Begins a synchronized scene modification
......@@ -614,7 +613,7 @@ public:
* | | *
* +----------------------------------------------------------+ */
//! Return all sound source IDs
//! Return all sound source IDs
virtual void GetSoundSourceIDs( std::vector< int >& vSoundSourceIDs ) = 0;
//! Create a sound source
......@@ -629,7 +628,7 @@ public:
* \return ID of the new sound source, if the method succeeded
* -1, otherwise
*/
virtual int CreateSoundSource( const std::string& sName, int iAuralizationMode = VA_AURAMODE_ALL, double dVolume = 1 ) = 0;
virtual int CreateSoundSource( const std::string& sName, int iAuralizationMode = VA_AURAMODE_ALL, double dVolume = 1 ) = 0;
//! Create a sound source explicitly for a certain renderer
/**
......@@ -790,26 +789,26 @@ public:
virtual void SetSoundSourceMuted( int iSoundSourceID, bool bMuted ) = 0;
//! Position einer Schallquelle zurückgeben (Positionsvektor)
virtual void GetSoundSourcePosition( int iSoundSourceID, double& x, double& y, double& z ) = 0;
virtual void GetSoundSourcePosition( int iSoundSourceID, double& x, double& y, double& z ) = 0;
//! Orientierung einer Schallquelle zurückgeben (Yaw-Pitch-Roll Winkel)
/**
* Achtung: Winkel in Grad
*/
virtual void GetSoundSourceOrientationYPR( int iSoundSourceID, double& yaw, double& pitch, double& roll ) = 0;
virtual void GetSoundSourceOrientationYPR( int iSoundSourceID, double& yaw, double& pitch, double& roll ) = 0;
//! Orientierung einer Schallquelle zurückgeben (View- und Up-Vektor)
virtual void GetSoundSourceOrientationVU( int iSoundSourceID, double& vx, double& vy, double& vz, double& ux, double& uy, double& uz ) = 0;
virtual void GetSoundSourceOrientationVU( int iSoundSourceID, double& vx, double& vy, double& vz, double& ux, double& uy, double& uz ) = 0;
//! Position und Orientierung einer Schallquelle zurückgeben (Positionsvektor + Yaw-Pitch-Roll Winkel)
/**
* Achtung: Winkel in Grad
* TODO: Dokumentation für Yaw-Pitch-Roll
*/
virtual void GetSoundSourcePositionOrientationYPR( int iSoundSourceID, double& x, double& y, double& z, double& yaw, double& pitch, double& roll ) = 0;
virtual void GetSoundSourcePositionOrientationYPR( int iSoundSourceID, double& x, double& y, double& z, double& yaw, double& pitch, double& roll ) = 0;
//! Position und Orientierung einer Schallquelle zurückgeben (Position-, View- und Up-Vektor)
virtual void GetSoundSourcePositionOrientationVU( int iSoundSourceID, double& px, double& py, double& pz, double& vx, double& vy, double& vz, double& ux, double& uy, double& uz ) = 0;
virtual void GetSoundSourcePositionOrientationVU( int iSoundSourceID, double& px, double& py, double& pz, double& vx, double& vy, double& vz, double& ux, double& uy, double& uz ) = 0;
//! Returns the position, orientation and translation velocities of a sound source (yaw-pitch-roll angles)
/**
......@@ -817,30 +816,30 @@ public:
* - Angles are expressed in degrees [°] (NOT radians)
* - Velocities are expressed in meters/second [m/s]
*/
virtual void GetSoundSourcePositionOrientationVelocityYPR( int iSoundSourceID, double& dPosX, double& dPosY, double& dPosZ, double& dYaw, double& dPitch, double& dRoll, double& dVelocityX, double& dVelocityY, double& dVelocityZ ) = 0;
virtual void GetSoundSourcePositionOrientationVelocityYPR( int iSoundSourceID, double& dPosX, double& dPosY, double& dPosZ, double& dYaw, double& dPitch, double& dRoll, double& dVelocityX, double& dVelocityY, double& dVelocityZ ) = 0;
//! Returns the position, orientation and translation velocities of a sound source (view-up vectors)
/**
* - Positions are expressed in meters [m]
* - Velocities are expressed in meters/second [m/s]
*/
virtual void GetSoundSourcePositionOrientationVelocityVU( int iSoundSourceID, double& dPosX, double& dPosY, double& dPosZ, double& dViewX, double& dViewY, double& dViewZ, double& dUpX, double& dUpY, double& dUpZ, double& dVelocityX, double& dVelocityY, double& dVelocityZ ) = 0;
virtual void GetSoundSourcePositionOrientationVelocityVU( int iSoundSourceID, double& dPosX, double& dPosY, double& dPosZ, double& dViewX, double& dViewY, double& dViewZ, double& dUpX, double& dUpY, double& dUpZ, double& dVelocityX, double& dVelocityY, double& dVelocityZ ) = 0;
//! Position einer Schallquelle setzen (Positionsvektor)
/**
* - Sets the velocity of the sound source to zero
*/
virtual void SetSoundSourcePosition( int iSoundSourceID, double x, double y, double z ) = 0;
virtual void SetSoundSourcePosition( int iSoundSourceID, double x, double y, double z ) = 0;
//! Orientierung einer Schallquelle setzen (View- und Up-Vektor)
/**
* Achtung: Winkel in Grad
* TODO: Dokumentation für Yaw-Pitch-Roll
*/
virtual void SetSoundSourceOrientationYPR( int iSoundSourceID, double yaw, double pitch, double roll ) = 0;
virtual void SetSoundSourceOrientationYPR( int iSoundSourceID, double yaw, double pitch, double roll ) = 0;
//! Orientierung einer Schallquelle setzen (View- und Up-Vektor)
virtual void SetSoundSourceOrientationVU( int iSoundSourceID, double vx, double vy, double vz, double ux, double uy, double uz ) = 0;
virtual void SetSoundSourceOrientationVU( int iSoundSourceID, double vx, double vy, double vz, double ux, double uy, double uz ) = 0;
//! Position und Orientierung einer Schallquelle setzen (Positionsvektor + Yaw-Pitch-Roll)
/**
......@@ -848,13 +847,13 @@ public:
*
* TODO: Dokumentation für Yaw-Pitch-Roll
*/
virtual void SetSoundSourcePositionOrientationYPR( int iSoundSourceID, double x, double y, double z, double yaw, double pitch, double roll ) = 0;
virtual void SetSoundSourcePositionOrientationYPR( int iSoundSourceID, double x, double y, double z, double yaw, double pitch, double roll ) = 0;
//! Position und Orientierung einer Schallquelle setzen (Position-, View- und Up-Vektor)
/**
* - Sets the velocity of the sound source to zero
*/
virtual void SetSoundSourcePositionOrientationVU( int iSoundSourceID, double px, double py, double pz, double vx, double vy, double vz, double ux, double uy, double uz ) = 0;
virtual void SetSoundSourcePositionOrientationVU( int iSoundSourceID, double px, double py, double pz, double vx, double vy, double vz, double ux, double uy, double uz ) = 0;
//! Sets the position, orientation and translation velocities of a sound source (yaw-pitch-roll angles)
/**
......@@ -862,14 +861,14 @@ public:
* - Angles are expressed in degrees [°] (NOT radians)
* - Velocities are expressed in meters/second [m/s]
*/
virtual void SetSoundSourcePositionOrientationVelocityYPR( int iSoundSourceID, double dPosX, double dPosY, double dPosZ, double dYaw, double dPitch, double dRoll, double dVelocityX, double dVelocityY, double dVelocityZ ) = 0;
virtual void SetSoundSourcePositionOrientationVelocityYPR( int iSoundSourceID, double dPosX, double dPosY, double dPosZ, double dYaw, double dPitch, double dRoll, double dVelocityX, double dVelocityY, double dVelocityZ ) = 0;
//! Sets the position, orientation and translation velocities of a sound source (view-up vectors)
/**
* - Positions are expressed in meters [m]
* - Velocities are expressed in meters/second [m/s]
*/
virtual void SetSoundSourcePositionOrientationVelocityVU( int iSoundSourceID, double dPosX, double dPosY, double dPosZ, double dViewX, double dViewY, double dViewZ, double dUpX, double dUpY, double dUpZ, double dVelocityX, double dVelocityY, double dVelocityZ ) = 0;
virtual void SetSoundSourcePositionOrientationVelocityVU( int iSoundSourceID, double dPosX, double dPosY, double dPosZ, double dViewX, double dViewY, double dViewZ, double dUpX, double dUpY, double dUpZ, double dVelocityX, double dVelocityY, double dVelocityZ ) = 0;
/* +----------------------------------------------------------+ *
* | | *
......@@ -877,7 +876,7 @@ public:
* | | *
* +----------------------------------------------------------+ */
//! Return all listener IDs
//! Return all listener IDs
virtual void GetListenerIDs( std::vector<int>& vListenerIDs ) = 0;
//! Creates a listener
......@@ -890,7 +889,7 @@ public:
* \return ID of the new listener, if the method succeeded
* -1, otherwise
*/
virtual int CreateListener( const std::string& sName, int iAuralizationMode = VA_AURAMODE_ALL, int iHRIRDatasetID = -1 ) = 0;
virtual int CreateListener( const std::string& sName, int iAuralizationMode = VA_AURAMODE_ALL, int iHRIRDatasetID = -1 ) = 0;
//! Creates a listener explicitly for a given renderer
/**
......@@ -1001,26 +1000,26 @@ public:
virtual void SetListenerHRIRDataset( int iListenerID, int iHRIRDatasetID ) = 0;
//! Position eines Hörers zurückgeben (Positionsvektor)
virtual void GetListenerPosition( int iListenerID, double& x, double& y, double& z ) = 0;
virtual void GetListenerPosition( int iListenerID, double& x, double& y, double& z ) = 0;
//! Orientierung eines Hörers zurückgeben (Yaw-Pitch-Roll Winkel)
/**
* Achtung: Winkel in Grad
*/
virtual void GetListenerOrientationYPR( int iListenerID, double& yaw, double& pitch, double& roll ) = 0;
virtual void GetListenerOrientationYPR( int iListenerID, double& yaw, double& pitch, double& roll ) = 0;
//! Orientierung eines Hörers zurückgeben (View- und Up-Vektor)
virtual void GetListenerOrientationVU( int iListenerID, double& vx, double& vy, double& vz, double& ux, double& uy, double& uz ) = 0;
virtual void GetListenerOrientationVU( int iListenerID, double& vx, double& vy, double& vz, double& ux, double& uy, double& uz ) = 0;
//! Position und Orientierung eines Hörers zurückgeben (Positionsvektor + Yaw-Pitch-Roll Winkel)
/**
* Achtung: Winkel in Grad
* TODO: Dokumentation für Yaw-Pitch-Roll
*/
virtual void GetListenerPositionOrientationYPR( int iListenerID, double& x, double& y, double& z, double& yaw, double& pitch, double& roll ) = 0;
virtual void GetListenerPositionOrientationYPR( int iListenerID, double& x, double& y, double& z, double& yaw, double& pitch, double& roll ) = 0;
//! Position und Orientierung eines Hörers zurückgeben (Position-, View- und Up-Vektor)
virtual void GetListenerPositionOrientationVU( int iListenerID, double& px, double& py, double& pz, double& vx, double& vy, double& vz, double& ux, double& uy, double& uz ) = 0;
virtual void GetListenerPositionOrientationVU( int iListenerID, double& px, double& py, double& pz, double& vx, double& vy, double& vz, double& ux, double& uy, double& uz ) = 0;
//! Returns the position, orientation and translation velocities of a listener (yaw-pitch-roll angles)
/**
......@@ -1028,30 +1027,30 @@ public:
* - Angles are expressed in degrees [°] (NOT radians)
* - Velocities are expressed in meters/second [m/s]
*/
virtual void GetListenerPositionOrientationVelocityYPR( int iListenerID, double& dPosX, double& dPosY, double& dPosZ, double& dYaw, double& dPitch, double& dRoll, double& dVelocityX, double& dVelocityY, double& dVelocityZ ) = 0;
virtual void GetListenerPositionOrientationVelocityYPR( int iListenerID, double& dPosX, double& dPosY, double& dPosZ, double& dYaw, double& dPitch, double& dRoll, double& dVelocityX, double& dVelocityY, double& dVelocityZ ) = 0;
//! Returns the position, orientation and translation velocities of a listener (view-up vectors)
/**
* - Positions are expressed in meters [m]
* - Velocities are expressed in meters/second [m/s]
*/
virtual void GetListenerPositionOrientationVelocityVU( int iListenerID, double& dPosX, double& dPosY, double& dPosZ, double& dViewX, double& dViewY, double& dViewZ, double& dUpX, double& dUpY, double& dUpZ, double& dVelocityX, double& dVelocityY, double& dVelocityZ ) = 0;
virtual void GetListenerPositionOrientationVelocityVU( int iListenerID, double& dPosX, double& dPosY, double& dPosZ, double& dViewX, double& dViewY, double& dViewZ, double& dUpX, double& dUpY, double& dUpZ, double& dVelocityX, double& dVelocityY, double& dVelocityZ ) = 0;
//! Position eines Hörers setzen (Positionsvektor)
/**
* - Sets the velocity of the listener to zero
*/
virtual void SetListenerPosition( int iListenerID, double x, double y, double z ) = 0;
virtual void SetListenerPosition( int iListenerID, double x, double y, double z ) = 0;
//! Orientierung eines Hörers setzen (View- und Up-Vektor)
/**
* Achtung: Winkel in Grad
* TODO: Dokumentation für Yaw-Pitch-Roll
*/
virtual void SetListenerOrientationYPR( int iListenerID, double yaw, double pitch, double roll ) = 0;
virtual void SetListenerOrientationYPR( int iListenerID, double yaw, double pitch, double roll ) = 0;
//! Orientierung eines Hörers setzen (View- und Up-Vektor)
virtual void SetListenerOrientationVU( int iListenerID, double vx, double vy, double vz, double ux, double uy, double uz ) = 0;
virtual void SetListenerOrientationVU( int iListenerID, double vx, double vy, double vz, double ux, double uy, double uz ) = 0;
//! Position und Orientierung eines Hörers setzen (Positionsvektor + Yaw-Pitch-Roll)
/**
......@@ -1059,13 +1058,13 @@ public:
*
* TODO: Dokumentation für Yaw-Pitch-Roll
*/
virtual void SetListenerPositionOrientationYPR( int iListenerID, double x, double y, double z, double yaw, double pitch, double roll ) = 0;
virtual void SetListenerPositionOrientationYPR( int iListenerID, double x, double y, double z, double yaw, double pitch, double roll ) = 0;
//! Position und Orientierung eines Hörers setzen (Position-, View- und Up-Vektor)
/**
* - Sets the velocity of the listener to zero
*/
virtual void SetListenerPositionOrientationVU( int iListenerID, double px, double py, double pz, double vx, double vy, double vz, double ux, double uy, double uz ) = 0;
virtual void SetListenerPositionOrientationVU( int iListenerID, double px, double py, double pz, double vx, double vy, double vz, double ux, double uy, double uz ) = 0;
//! Sets the position, orientation and translation velocities of a listener (yaw-pitch-roll angles)
/**
......@@ -1073,14 +1072,14 @@ public:
* - Angles are expressed in degrees [°] (NOT radians)
* - Velocities are expressed in meters/second [m/s]
*/
virtual void SetListenerPositionOrientationVelocityYPR( int iListenerID, double dPosX, double dPosY, double dPosZ, double dYaw, double dPitch, double dRoll, double dVelocityX, double dVelocityY, double dVelocityZ ) = 0;
virtual void SetListenerPositionOrientationVelocityYPR( int iListenerID, double dPosX, double dPosY, double dPosZ, double dYaw, double dPitch, double dRoll, double dVelocityX, double dVelocityY, double dVelocityZ ) = 0;
//! Sets the position, orientation and translation velocities of a listener (view-up vectors)
/**
* - Positions are expressed in meters [m]
* - Velocities are expressed in meters/second [m/s]
*/
virtual void SetListenerPositionOrientationVelocityVU( int iListenerID, double dPosX, double dPosY, double dPosZ, double dViewX, double dViewY, double dViewZ, double dUpX, double dUpY, double dUpZ, double dVelocityX, double dVelocityY, double dVelocityZ ) = 0;
virtual void SetListenerPositionOrientationVelocityVU( int iListenerID, double dPosX, double dPosY, double dPosZ, double dViewX, double dViewY, double dViewZ, double dUpX, double dUpY, double dUpZ, double dVelocityX, double dVelocityY, double dVelocityZ ) = 0;
//! Returns the position and orientation of the real-world listener's head
/**
......@@ -1090,7 +1089,7 @@ public:
* \important Coordinates refer the to center of the head on the axis
* which goes through both ears.
*/
virtual void GetListenerRealWorldHeadPositionOrientationVU( int iListenerID, double& px, double& py, double& pz, double& vx, double& vy, double& vz, double& ux, double& uy, double& uz ) const = 0;
virtual void GetListenerRealWorldHeadPositionOrientationVU( int iListenerID, double& px, double& py, double& pz, double& vx, double& vy, double& vz, double& ux, double& uy, double& uz ) const = 0;
//! Updates the position and orientation of the real-world listener's head
/**
......@@ -1103,7 +1102,7 @@ public:
* \important Coordinates refer the to center of the head on the axis
* which goes through both ears.
*/
virtual void SetListenerRealWorldHeadPositionOrientationVU( int iListenerID, double px, double py, double pz, double vx, double vy, double vz, double ux, double uy, double uz ) = 0;
virtual void SetListenerRealWorldHeadPositionOrientationVU( int iListenerID, double px, double py, double pz, double vx, double vy, double vz, double ux, double uy, double uz ) = 0;
/* +----------------------------------------------------------+ *
* | | *
......@@ -1111,8 +1110,8 @@ public:
* | | *
* +----------------------------------------------------------+ */
//! Loads a scene from a file (e.g. RAVEN project file)
virtual void LoadScene( const std::string& sFilename ) = 0;
//! Loads a scene from a file (e.g. RAVEN project file)
virtual void LoadScene( const std::string& sFilePath ) = 0;
//! Returns if a scene is loaded
virtual bool IsSceneLoaded() const = 0;
......@@ -1150,11 +1149,11 @@ public:
* | | *
* +----------------------------------------------------------+ */
//! Returns all available renderers (default: only those that are enabled)
/**
* @param [out] voRenderer List of renderers modules
* @param [in] bFilterEnabled If true, only enabled renderers are returned (via configuration, during runtime)
*/
//! Returns all available renderers (default: only those that are enabled)
/**
* @param [out] voRenderer List of renderers modules
* @param [in] bFilterEnabled If true, only enabled renderers are returned (via configuration, during runtime)
*/
virtual void GetRenderingModules( std::vector< CVAAudioRendererInfo >& voRenderer, bool bFilterEnabled = true ) const = 0;
//! Mutes a rendering module audio output
......@@ -1175,11 +1174,11 @@ public:
* | | *
* +----------------------------------------------------------+ */
//! Returns all available reproductions (default: only those that are enabled)
/**
* @param [out] voReproductions List of reproduction modules
* @param [in] bFilterEnabled If true, only enabled renderers are returned (via configuration, during runtime)
*/
//! Returns all available reproductions (default: only those that are enabled)
/**
* @param [out] voReproductions List of reproduction modules
* @param [in] bFilterEnabled If true, only enabled renderers are returned (via configuration, during runtime)
*/
virtual void GetReproductionModules( std::vector< CVAAudioReproductionInfo >& voReproductions, bool bFilterEnabled = true ) const = 0;
//! Mutes a rendering module audio output
......@@ -1200,7 +1199,7 @@ public:
* | | *
* +----------------------------------------------------------+ */
//! Verstärkung der Eingangkanäle (Geräteeingang) zurückgeben [Faktor]
//! Verstärkung der Eingangkanäle (Geräteeingang) zurückgeben [Faktor]
virtual double GetInputGain() const = 0;
//! Verstärkung der Eingangkanäle (Geräteeingang) setzen [Faktor]
......
/*
* --------------------------------------------------------------------------------------------
*
* VVV VVV A
* VVV VVV AAA Virtual Acoustics (VA)
* VVV VVV AAA Real-time auralisation for virtual reality
* VVV VVV AAA
* VVVVVV AAA (c) Copyright Institute of Technical Acoustics (ITA), 2015-2017
* VVVV AAA RWTH Aachen University (http://www.akustik.rwth-aachen.de)
* VVV VVV A Virtual Acoustics (VA) | http://www.virtualacoustics.org
* VVV VVV AAA Licensed under the Apache License, Version 2.0
* VVV VVV AAA
* VVV VVV AAA Copyright 2015-2017
* VVVVVV AAA Institute of Technical Acoustics (ITA)
* VVVV AAA RWTH Aachen University
*
* --------------------------------------------------------------------------------------------
*/
......
/*
* --------------------------------------------------------------------------------------------
*
* VVV VVV A
* VVV VVV AAA Virtual Acoustics (VA)
* VVV VVV AAA Real-time auralisation for virtual reality
* VVV VVV AAA
* VVVVVV AAA (c) Copyright Institute of Technical Acoustics (ITA), 2015-2017
* VVVV AAA RWTH Aachen University (http://www.akustik.rwth-aachen.de)
* VVV VVV A Virtual Acoustics (VA) | http://www.virtualacoustics.org
* VVV VVV AAA Licensed under the Apache License, Version 2.0
* VVV VVV AAA
* VVV VVV AAA Copyright 2015-2017
* VVVVVV AAA Institute of Technical Acoustics (ITA)
* VVVV AAA RWTH Aachen University
*
* --------------------------------------------------------------------------------------------
*/
......