Finalizing base class doxy comments

parent a27b0595
...@@ -535,16 +535,17 @@ public: ...@@ -535,16 +535,17 @@ public:
, iType( UNSPECIFIED ) , iType( UNSPECIFIED )
{}; {};
// Signal source destructor
virtual inline ~CVASignalSourceInfo() {}; virtual inline ~CVASignalSourceInfo() {};
//! Initializing constructor //! Initializing constructor
/** /**
* \param sID Identifier string * @param[in] sID Identifier string
* \param iType * @param[in] iType
* \param sName Name of signal source info * @param[in] sName Name of signal source info
* \param sDesc Brief description of signal source info * @param[in] sDesc Brief description of signal source info
* \param sState State description of signal source info * @param[in] sState State description of signal source info
* \param iReference Usage reference counter * @param[in] iReference Usage reference counter
*/ */
inline CVASignalSourceInfo( const std::string& sID, const int iType, const std::string& sName, const std::string& sDesc, const std::string& sState, const int iReferences ) inline CVASignalSourceInfo( const std::string& sID, const int iType, const std::string& sName, const std::string& sDesc, const std::string& sState, const int iReferences )
: sID( sID ) : sID( sID )
...@@ -567,15 +568,17 @@ class VABASE_API CVASceneInfo ...@@ -567,15 +568,17 @@ class VABASE_API CVASceneInfo
public: public:
std::string sID; //!< Scene identifier std::string sID; //!< Scene identifier
std::string sName; //!< Scene name std::string sName; //!< Scene name
bool bEnabled; bool bEnabled; //!< Enabled flag
CVAStruct oParams; //!< Scene parameters CVAStruct oParams; //!< Scene parameters
//! Scene info default constructor
inline CVASceneInfo() inline CVASceneInfo()
: bEnabled( true ) : bEnabled( true )
{ {
}; };
//! Scene info destructor
inline virtual ~CVASceneInfo() inline virtual ~CVASceneInfo()
{ {
}; };
...@@ -632,6 +635,7 @@ public: ...@@ -632,6 +635,7 @@ public:
CVAStruct oParams; //!< Special parameters CVAStruct oParams; //!< Special parameters
//! Constructor for sound source info
inline CVASoundSourceInfo() inline CVASoundSourceInfo()
: iID( -1 ) : iID( -1 )
, bMuted( false ) , bMuted( false )
...@@ -641,6 +645,7 @@ public: ...@@ -641,6 +645,7 @@ public:
, iAuraMode( -1 ) , iAuraMode( -1 )
{}; {};
//! Destructor
virtual inline ~CVASoundSourceInfo() {}; virtual inline ~CVASoundSourceInfo() {};
}; };
...@@ -673,6 +678,7 @@ public: ...@@ -673,6 +678,7 @@ public:
CVAStruct oParams; //!< Special parameters CVAStruct oParams; //!< Special parameters
//! Constructor for sound receiver info
inline CVASoundReceiverInfo() inline CVASoundReceiverInfo()
: iID( -1 ) : iID( -1 )
, iDirectivityID( -1 ) , iDirectivityID( -1 )
...@@ -681,6 +687,7 @@ public: ...@@ -681,6 +687,7 @@ public:
, bEnabled( true ) , bEnabled( true )
{}; {};
//! Destructor
virtual inline ~CVASoundReceiverInfo() {}; virtual inline ~CVASoundReceiverInfo() {};
}; };
...@@ -691,12 +698,12 @@ class VABASE_API CVASoundPortalInfo ...@@ -691,12 +698,12 @@ class VABASE_API CVASoundPortalInfo
public: public:
int iID; //!< ID int iID; //!< ID
std::string sName; //!< Displayed name (optional) std::string sName; //!< Displayed name (optional)
bool bEnabled; bool bEnabled; //!< Enabled flag
int iMaterialID; //!< Material ID with transmission data int iMaterialID; //!< Material ID with transmission data
int iNextPortalID; int iNextPortalID; //!< Next sound portal identifier, if existing
int iSoundReceiverID; int iSoundReceiverID; //!< Source receiver identifier, if existing
int iSoundSourceID; int iSoundSourceID; //!< Source sound identifier, if existing
VAVec3 v3Pos; //!< Position vector [m] VAVec3 v3Pos; //!< Position vector [m]
VAVec3 v3View, v3Up; //!< View-/Up-vector VAVec3 v3View, v3Up; //!< View-/Up-vector
...@@ -704,6 +711,7 @@ public: ...@@ -704,6 +711,7 @@ public:
CVAStruct oParams; //!< Special parameters CVAStruct oParams; //!< Special parameters
//! Default constructor for sound portal
inline CVASoundPortalInfo() inline CVASoundPortalInfo()
: iID( -1 ) : iID( -1 )
, iNextPortalID( -1 ) , iNextPortalID( -1 )
...@@ -712,6 +720,7 @@ public: ...@@ -712,6 +720,7 @@ public:
, iMaterialID( -1 ) , iMaterialID( -1 )
{}; {};
//! Destructor
virtual inline ~CVASoundPortalInfo() {}; virtual inline ~CVASoundPortalInfo() {};
}; };
...@@ -746,6 +755,9 @@ public: ...@@ -746,6 +755,9 @@ public:
inline CVAAcousticMaterial() inline CVAAcousticMaterial()
: iID( -1 ) : iID( -1 )
{}; {};
//! Destructor
virtual inline ~CVAAcousticMaterial() {};
}; };
...@@ -761,29 +773,36 @@ public: ...@@ -761,29 +773,36 @@ public:
class VABASE_API CVAGeometryMesh class VABASE_API CVAGeometryMesh
{ {
public: public:
//! Vertex representation
class CVAVertex class CVAVertex
{ {
public: public:
int iID; int iID; //!< Vertex identifier
VAVec3 v3Point; VAVec3 v3Point; //!< Vertext point / position
//! Constructor initializing defaults
inline CVAVertex() : iID( -1 ) {}; inline CVAVertex() : iID( -1 ) {};
}; };
//! Face representation
class CVAFace class CVAFace
{ {
public: public:
int iID; int iID; //!< Face identifier
int iMaterialID; //!< Assigned material int iMaterialID; //!< Assigned material
std::vector< int > viVertexList; std::vector< int > viVertexList; //!< Face vertices
//! Constructor initializing defaults
inline CVAFace() : iID( -1 ), iMaterialID( -1 ) {}; inline CVAFace() : iID( -1 ), iMaterialID( -1 ) {};
}; };
int iID; int iID; //!< Geometry mesh identifier
bool bEnabled; bool bEnabled; //!< Enabled flag
std::vector< CVAVertex > voVertices; //!< List of available vertices std::vector< CVAVertex > voVertices; //!< List of available vertices
std::vector< CVAFace > voFaces; //!< List of faces defined by vertices std::vector< CVAFace > voFaces; //!< List of faces defined by vertices
CVAStruct oParams; //!< Additional parameters CVAStruct oParams; //!< Additional parameters
//! Constructor initializing members
inline CVAGeometryMesh() inline CVAGeometryMesh()
: iID( -1 ) : iID( -1 )
, bEnabled( true ) , bEnabled( true )
......
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