Aufgrund eines Versionsupdates wird GitLab am 17.12. zwischen 9:00 und 9:30 Uhr kurzzeitig nicht zur Verfügung stehen. / Due to a version upgrade, GitLab won't be accessible at 17.12. between 9 and 9:30 a.m.

Finalizing base class doxy comments

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