surface.h

Go to the documentation of this file.

//=============================================================================================================
#ifndef SURFACE_H
#define SURFACE_H
 
//=============================================================================================================
// INCLUDES
//=============================================================================================================
 
#include "fs_global.h"
 
//=============================================================================================================
// QT INCLUDES
//=============================================================================================================
 
#include <QSharedPointer>
 
//=============================================================================================================
// EIGEN INCLUDES
//=============================================================================================================
 
#include <Eigen/Core>
 
//=============================================================================================================
// DEFINE NAMESPACE FSLIB
//=============================================================================================================
 
namespace FSLIB
{
 
//=============================================================================================================
// FORWARD DECLARATIONS
//=============================================================================================================
 
//=============================================================================================================
class FSSHARED_EXPORT Surface
{
public:
    typedef QSharedPointer<Surface> SPtr;            
    typedef QSharedPointer<const Surface> ConstSPtr; 
    //=========================================================================================================
    Surface();
 
    //=========================================================================================================
    explicit Surface(const QString& p_sFile);
 
    //=========================================================================================================
    explicit Surface(const QString &subject_id, qint32 hemi, const QString &surf, const QString &subjects_dir);
 
    //=========================================================================================================
    explicit Surface(const QString &path, qint32 hemi, const QString &surf);
 
    //=========================================================================================================
    ~Surface();
    
    //=========================================================================================================
    void clear();
 
    //=========================================================================================================
    inline qint32 hemi() const;
 
    //=========================================================================================================
    inline bool isEmpty() const;
 
    //=========================================================================================================
    inline QString surf() const;
 
    //=========================================================================================================
    static bool read(const QString &subject_id, qint32 hemi, const QString &surf, const QString &subjects_dir, Surface &p_Surface, bool p_bLoadCurvature = true);
 
    //=========================================================================================================
    static bool read(const QString &path, qint32 hemi, const QString &surf, Surface &p_Surface, bool p_bLoadCurvature = true);
 
    //=========================================================================================================
    static bool read(const QString &p_sFileName, Surface &p_Surface, bool p_bLoadCurvature = true);
 
    //=========================================================================================================
    static Eigen::VectorXf read_curv(const QString &p_sFileName);
 
    //=========================================================================================================
    static Eigen::MatrixX3f compute_normals(const Eigen::MatrixX3f& rr, const Eigen::MatrixX3i& tris);
 
    //=========================================================================================================
    inline const Eigen::MatrixX3f& rr() const;
 
    //=========================================================================================================
    inline const Eigen::MatrixX3i& tris() const;
 
    //=========================================================================================================
    inline const Eigen::MatrixX3f& nn() const;
 
    //=========================================================================================================
    inline const Eigen::VectorXf& curv() const;
 
    //=========================================================================================================
    inline const Eigen::Vector3f& offset() const;
 
    //=========================================================================================================
    inline Eigen::Vector3f& offset();
 
    //=========================================================================================================
    inline QString filePath() const;
 
    //=========================================================================================================
    inline QString fileName() const;
 
private:
    QString m_sFilePath;    
    QString m_sFileName;    
    qint32 m_iHemi;         
    QString m_sSurf;        
    Eigen::MatrixX3f m_matRR;      
    Eigen::MatrixX3i m_matTris;    
    Eigen::MatrixX3f m_matNN;      
    Eigen::VectorXf m_vecCurv;     
    Eigen::Vector3f m_vecOffset; 
};
 
//=============================================================================================================
// INLINE DEFINITIONS
//=============================================================================================================
 
inline qint32 Surface::hemi() const
{
    return m_iHemi;
}
 
//=============================================================================================================
 
inline bool Surface::isEmpty() const
{
    return m_iHemi == -1;
}
 
//=============================================================================================================
 
inline QString Surface::surf() const
{
    return m_sSurf;
}
 
//=============================================================================================================
 
inline const Eigen::MatrixX3f& Surface::rr() const
{
    return m_matRR;
}
 
//=============================================================================================================
 
inline const Eigen::MatrixX3i& Surface::tris() const
{
    return m_matTris;
}
 
//=============================================================================================================
 
inline const Eigen::MatrixX3f& Surface::nn() const
{
    return m_matNN;
}
 
//=============================================================================================================
 
inline const Eigen::VectorXf& Surface::curv() const
{
    return m_vecCurv;
}
 
//=============================================================================================================
 
inline const Eigen::Vector3f& Surface::offset() const
{
    return m_vecOffset;
}
 
//=============================================================================================================
 
inline Eigen::Vector3f& Surface::offset()
{
    return m_vecOffset;
}
 
//=============================================================================================================
 
inline QString Surface::filePath() const
{
    return m_sFilePath;
}
 
//=============================================================================================================
 
inline QString Surface::fileName() const
{
    return m_sFileName;
}
} // NAMESPACE
 
#endif // SURFACE_H