Starting to remove unused classes

parent d1fd3764
This diff is collapsed.
......@@ -292,20 +292,38 @@ public:
* | | *
* +----------------------------------------------------------+ */
//! Loads a HRIR dataset
//! Loads a HRIR dataset from a file
/**
* Load a dataset of head-related impulse responses (HRIRs) from
* Load a dataset of head-related impulse responses (HRIRs) from a file, i.e. DAFF format.
*
* @param[in] sFilePath File path, relative or absolute, @sa AddSearchPath
* @param[in] sName Name (optional, e.g. "Artificial head")
*
* @return Directivity identifier
*
* @note Slashes and backslashes may safely be used. Paths are automatically converted into the system's convention.
*/
inline int CreateReceiverDirectivityFromFile( const std::string& sFilePath, const std::string& sName = "" )
{
CVAStruct oDirectivityParams;
oDirectivityParams[ "FilePath" ] = sFilePath;
return CreateReceiverDirectivity( oDirectivityParams, sName );
};
//! Creates a receiver directivity, e.g. a HRTF, HRIR, binaural model
/**
* Create any receiver directivity
* a DAFF file.
*
* \param sFilePath Filename
* \param sName Name (optional, e.g. "Artificial head")
* @param[in] oParams Parameters that provide further information, i.e. for HATO hrtfs, generic models, etc.
* @param[in] sName Name (optional, e.g. "Artificial head")
*
* \return HRIR-ID
* @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;
virtual int CreateReceiverDirectivity( const CVAStruct& oParams, const std::string& sName = "" ) = 0;
//! Frees a HRIR dataset
/**
......@@ -318,66 +336,14 @@ public:
* \return true, if the HRIR dataset was successfully freed.
* false, otherwise
*/
virtual bool FreeHRIRDataset( int iHRIRID ) = 0;
virtual bool RemoveReceiverDirectivity( const int iHRIRID ) = 0;
//! Retrieves information of a loaded HRIR dataset
virtual CVAHRIRInfo GetHRIRInfo( int iHRIRID ) const = 0;
virtual CVAHRIRInfo GetReceiverDirectivityInfo( const int iHRIRID ) const = 0;
//! Retrieves information of all loaded HRIR datasets
virtual void GetHRIRInfos( std::vector< CVAHRIRInfo >& vhiDest ) const = 0;
virtual void GetReceiverDirectivityInfos( std::vector< CVAHRIRInfo >& vhiDest ) const = 0;
/* +----------------------------------------------------------+ *
* | | *
* | Sounds (deprecated, see AmbientSound) | *
* | | *
* +----------------------------------------------------------+ */
//! 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
/**
* Frees a sound and releases its memory.
* This is only possible if the sound is not in use.
* Otherwise the method will do nothing.
*
* \param iSoundID Sound-ID
*
* \return true, if the sound was successfully freed.
* false, otherwise
*/
virtual bool FreeSound( int iSoundID ) = 0;
//! Retrieves information of a loaded sound
virtual CVASoundInfo GetSoundInfo( int iSoundID ) const = 0;
//! Retrieves information of all loaded sounds
virtual void GetSoundInfos( std::vector< CVASoundInfo >& vsiDest ) const = 0;
//! Plays a sound
/**
* Plays a sound (immediately). This function does not perform any spatialization or audio
* rendering. It can be used to playback warning or information sounds (diffuse).
*
* \param iSoundID Sound-ID
* \param dGain Playback gain (>0) [optional, default: 1]
*
* \return Playback-ID>0, if successful
* -1, otherwise
*/
virtual int PlaySound( int iSoundID, double dVolume = 1.0 ) const = 0;
/* +----------------------------------------------------------+ *
* | | *
......
......@@ -22,8 +22,8 @@ std::ostream& operator<<( std::ostream& os, const VAVec3& oVec )
<< "< " << oVec.x << ", " << oVec.y << ", " << oVec.z << " >";
}
std::ostream& operator<<( std::ostream& os, const VAOrientYPR& oOrient )
std::ostream& operator<<( std::ostream& os, const VAQuat& oOrient )
{
return os << std::fixed << std::setprecision( 2 )
<< "< " << oOrient.yaw << ", " << oOrient.pitch << ", " << oOrient.roll << " >";
<< "< " << oOrient.x << ", " << oOrient.y << ", " << oOrient.z << ", '" << oOrient.w << "' >";
}
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment