glc_stltoworld.cpp

Go to the documentation of this file.

/****************************************************************************

 This file is part of the GLC-lib library.
 Copyright (C) 2005-2008 Laurent Ribon (laumaya@users.sourceforge.net)
 Version 2.0.0 Beta 1, packaged on April 2010.

 http://glc-lib.sourceforge.net

 GLC-lib is free software; you can redistribute it and/or modify
 it under the terms of the GNU General Public License as published by
 the Free Software Foundation; either version 2 of the License, or
 (at your option) any later version.

 GLC-lib is distributed in the hope that it will be useful,
 but WITHOUT ANY WARRANTY; without even the implied warranty of
 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 GNU General Public License for more details.

 You should have received a copy of the GNU General Public License
 along with GLC-lib; if not, write to the Free Software
 Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301  USA

*****************************************************************************/


#include "glc_stltoworld.h"
#include "../sceneGraph/glc_world.h"
#include "../glc_fileformatexception.h"
#include "../sceneGraph/glc_structreference.h"
#include "../sceneGraph/glc_structinstance.h"
#include "../sceneGraph/glc_structoccurence.h"

#include <QTextStream>
#include <QFileInfo>
#include <QGLContext>
#include <QDataStream>

GLC_StlToWorld::GLC_StlToWorld()
: QObject()
, m_pWorld(NULL)
, m_FileName()
, m_CurrentLineNumber(0)
, m_StlStream()
, m_pCurrentMesh(NULL)
, m_CurrentFace()
, m_VertexBulk()
, m_NormalBulk()
, m_CurrentIndex(0)
{

}

GLC_StlToWorld::~GLC_StlToWorld()
{
        clear();
}

// Set Functions

// Create an GLC_World from an input STL File
GLC_World* GLC_StlToWorld::CreateWorldFromStl(QFile &file)
{
        clear();
        m_FileName= file.fileName();
        // Test if the file exist and can be opened
        if (!file.open(QIODevice::ReadOnly))
        {
                QString message(QString("GLC_StlToWorld::CreateWorldFromStl File ") + m_FileName + QString(" doesn't exist"));
                qDebug() << message;
                GLC_FileFormatException fileFormatException(message, m_FileName, GLC_FileFormatException::FileNotFound);
                throw(fileFormatException);
        }
        // Init member
        m_pWorld= new GLC_World;

        // Create Working variables
        int currentQuantumValue= 0;
        int previousQuantumValue= 0;
        int numberOfLine= 0;

        // Attach the stream to the file
        m_StlStream.setDevice(&file);

        // QString buffer
        QString lineBuff;

        // Count the number of lines of the STL file
        while (!m_StlStream.atEnd())
        {
                ++numberOfLine;
                m_StlStream.readLine();
        }

        // Reset the stream
        m_StlStream.resetStatus();
        m_StlStream.seek(0);
        // Read Buffer and create the world

        emit currentQuantum(currentQuantumValue);
        m_CurrentLineNumber= 0;
        // Search Object section in the STL

        // Test if the STL File is ASCII or Binary
        ++m_CurrentLineNumber;
        lineBuff= m_StlStream.readLine();
        lineBuff= lineBuff.trimmed().toLower();
        if (!lineBuff.startsWith("solid"))
        {
                // The STL File is not ASCII trying to load Binary STL File
                m_pCurrentMesh= new GLC_Mesh();
                file.reset();
                LoadBinariStl(file);
                m_pCurrentMesh->addTriangles(NULL, m_CurrentFace);
                m_CurrentFace.clear();
                m_pCurrentMesh->addVertice(m_VertexBulk.toVector());
                m_VertexBulk.clear();
                m_pCurrentMesh->addNormals(m_NormalBulk.toVector());
                m_NormalBulk.clear();
                m_pCurrentMesh->finish();
                GLC_3DRep* pRep= new GLC_3DRep(m_pCurrentMesh);
                m_pCurrentMesh= NULL;
                m_pWorld->rootOccurence()->addChild(new GLC_StructOccurence(pRep));
        }
        else
        {
                // The STL File is ASCII
                lineBuff.remove(0, 5);
                lineBuff= lineBuff.trimmed();
                m_pCurrentMesh= new GLC_Mesh();
                m_pCurrentMesh->setName(lineBuff);
                // Read the mesh facet
                while (!m_StlStream.atEnd())
                {
                        scanFacet();

                        currentQuantumValue = static_cast<int>((static_cast<double>(m_CurrentLineNumber) / numberOfLine) * 100);
                        if (currentQuantumValue > previousQuantumValue)
                        {
                                emit currentQuantum(currentQuantumValue);
                        }
                        previousQuantumValue= currentQuantumValue;
                }
        }
        file.close();

        return m_pWorld;
}

// Private services Functions

// clear stlToWorld allocate memmory and reset member
void GLC_StlToWorld::clear()
{
        if (NULL != m_pCurrentMesh)
        {
                delete m_pCurrentMesh;
                m_pCurrentMesh= NULL;
        }
        m_pWorld= NULL;
        m_FileName.clear();
        m_CurrentLineNumber= 0;
        m_pCurrentMesh= NULL;
        m_CurrentFace.clear();
}

// Scan a line previously extracted from STL file
void GLC_StlToWorld::scanFacet()
{
        ++m_CurrentLineNumber;
        QString lineBuff(m_StlStream.readLine());
        lineBuff= lineBuff.trimmed().toLower();
        // Test if this is the end of current solid
        if (lineBuff.startsWith("endsolid") || lineBuff.startsWith("end solid"))
        {
                m_pCurrentMesh->addTriangles(NULL, m_CurrentFace);
                m_CurrentFace.clear();
                m_pCurrentMesh->addVertice(m_VertexBulk.toVector());
                m_VertexBulk.clear();
                m_pCurrentMesh->addNormals(m_NormalBulk.toVector());
                m_NormalBulk.clear();

                m_pCurrentMesh->finish();
                GLC_3DRep* pRep= new GLC_3DRep(m_pCurrentMesh);
                m_pCurrentMesh= NULL;
                m_pWorld->rootOccurence()->addChild(new GLC_StructOccurence(pRep));
                return;
        }
        // Test if this is the start of new solid
        if (lineBuff.startsWith("solid"))
        {
                // The STL File is ASCII
                lineBuff.remove(0, 5);
                lineBuff= lineBuff.trimmed();
                m_pCurrentMesh= new GLC_Mesh();
                m_pCurrentMesh->setName(lineBuff);
                return;
        }

        // lineBuff Must begin with "facet normal"
        if (!lineBuff.startsWith("facet normal"))
        {
                QString message= "GLC_StlToWorld::scanFacet : \"facet normal\" not found!";
                message.append("\nAt line : ");
                message.append(QString::number(m_CurrentLineNumber));
                GLC_FileFormatException fileFormatException(message, m_FileName, GLC_FileFormatException::WrongFileFormat);
                clear();
                qDebug() << message;
                throw(fileFormatException);
        }
        lineBuff.remove(0,12); // Remove first 12 chars
        lineBuff= lineBuff.trimmed().toLower();
        GLC_Vector3df cur3dVect= extract3dVect(lineBuff);
        for (int i= 0; i < 3; ++i)
        {
                m_NormalBulk.append(cur3dVect.X());
                m_NormalBulk.append(cur3dVect.Y());
                m_NormalBulk.append(cur3dVect.Z());
        }

        ++m_CurrentLineNumber;
        lineBuff= m_StlStream.readLine();
        lineBuff= lineBuff.trimmed().toLower();
        // lineBuff Must begin with "outer loop"
        if (!lineBuff.startsWith("outer loop"))
        {
                QString message= "GLC_StlToWorld::scanFacet : \"outer loop\" not found!";
                message.append("\nAt line : ");
                message.append(QString::number(m_CurrentLineNumber));
                GLC_FileFormatException fileFormatException(message, m_FileName, GLC_FileFormatException::WrongFileFormat);
                clear();
                qDebug() << message;
                throw(fileFormatException);
        }


        for (int i= 0; i < 3; ++i)
        {
                ++m_CurrentLineNumber;
                lineBuff= m_StlStream.readLine();
                lineBuff= lineBuff.trimmed().toLower();
                // lineBuff Must begin with "vertex"
                if (!lineBuff.startsWith("vertex"))
                {
                        QString message= "GLC_StlToWorld::scanFacet : \"vertex\" not found!";
                        message.append("\nAt line : ");
                        message.append(QString::number(m_CurrentLineNumber));
                        GLC_FileFormatException fileFormatException(message, m_FileName, GLC_FileFormatException::WrongFileFormat);
                        clear();
                        throw(fileFormatException);
                }
                lineBuff.remove(0,6); // Remove first 6 chars
                lineBuff= lineBuff.trimmed();

                cur3dVect= extract3dVect(lineBuff);
                m_VertexBulk.append(cur3dVect.X());
                m_VertexBulk.append(cur3dVect.Y());
                m_VertexBulk.append(cur3dVect.Z());

                m_CurrentFace.append(m_CurrentIndex);
                ++m_CurrentIndex;
        }

        ++m_CurrentLineNumber;
        lineBuff= m_StlStream.readLine();
        lineBuff= lineBuff.trimmed().toLower();
        // lineBuff Must begin with "endloop"
        if (!lineBuff.startsWith("endloop"))
        {
                QString message= "GLC_StlToWorld::scanFacet : \"endloop\" not found!";
                message.append("\nAt line : ");
                message.append(QString::number(m_CurrentLineNumber));
                GLC_FileFormatException fileFormatException(message, m_FileName, GLC_FileFormatException::WrongFileFormat);
                clear();
                qDebug() << message;
                throw(fileFormatException);
        }

        ++m_CurrentLineNumber;
        lineBuff= m_StlStream.readLine();
        lineBuff= lineBuff.trimmed().toLower();
        // lineBuff Must begin with "endfacet"
        if (!lineBuff.startsWith("endfacet"))
        {
                QString message= "GLC_StlToWorld::scanFacet : \"endfacet\" not found!";
                message.append("\nAt line : ");
                message.append(QString::number(m_CurrentLineNumber));
                GLC_FileFormatException fileFormatException(message, m_FileName, GLC_FileFormatException::WrongFileFormat);
                clear();
                qDebug() << message;
                throw(fileFormatException);
        }

}

// Extract a Vector from a string
GLC_Vector3df GLC_StlToWorld::extract3dVect(QString &line)
{
        float x=0.0f;
        float y=0.0f;
        float z=0.0f;

        GLC_Vector3df vectResult;
        QTextStream stringVecteur(&line);

        QString xString, yString, zString;

        if (((stringVecteur >> xString >> yString >> zString).status() == QTextStream::Ok))
        {
                bool xOk, yOk, zOk;
                x= xString.toFloat(&xOk);
                y= yString.toFloat(&yOk);
                z= zString.toFloat(&zOk);
                if (!(xOk && yOk && zOk))
                {
                        QString message= "GLC_StlToWorld::extract3dVect : failed to convert vector component to float";
                        message.append("\nAt ligne : ");
                        message.append(QString::number(m_CurrentLineNumber));
                        GLC_FileFormatException fileFormatException(message, m_FileName, GLC_FileFormatException::WrongFileFormat);
                        clear();
                        qDebug() << message;
                        throw(fileFormatException);
                }
                else
                {
                        vectResult.setVect(x, y, z);
                }
        }

        return vectResult;

}
// Load Binarie STL File
void GLC_StlToWorld::LoadBinariStl(QFile &file)
{
        // Create Working variables
        int currentQuantumValue= 0;
        int previousQuantumValue= 0;

        QDataStream stlBinFile(&file);
        stlBinFile.setVersion(QDataStream::Qt_4_6);
        stlBinFile.setFloatingPointPrecision(QDataStream::SinglePrecision);
        stlBinFile.setByteOrder(QDataStream::LittleEndian);

        // Skip 80 Bytes STL header
        int SkipedData= stlBinFile.skipRawData(80);
        // Check if an error occur
        if (-1 == SkipedData)
        {
                QString message= "GLC_StlToWorld::LoadBinariStl : Failed to skip Header of binary STL";
                GLC_FileFormatException fileFormatException(message, m_FileName, GLC_FileFormatException::WrongFileFormat);
                clear();
                qDebug() << message;
                throw(fileFormatException);
        }
        // Read the number of facet
        quint32 numberOfFacet= 0;
        stlBinFile >> numberOfFacet;
        // Check if an error occur
        if (QDataStream::Ok != stlBinFile.status())
        {
                QString message= "GLC_StlToWorld::LoadBinariStl : Failed to read the number of facets of binary STL";
                GLC_FileFormatException fileFormatException(message, m_FileName, GLC_FileFormatException::WrongFileFormat);
                clear();
                qDebug() << message;
                throw(fileFormatException);
        }
        for (quint32 i= 0; i < numberOfFacet; ++i)
        {
                // Extract the facet normal
                float nx, ny, nz;
                stlBinFile >> nx >> ny >> nz;
                // Check if an error occur
                if (QDataStream::Ok != stlBinFile.status())
                {
                        QString message= "GLC_StlToWorld::LoadBinariStl : Failed to read the Normal of binary STL";
                        GLC_FileFormatException fileFormatException(message, m_FileName, GLC_FileFormatException::WrongFileFormat);
                        clear();
                        qDebug() << message;
                        throw(fileFormatException);
                }

                // Extract the 3 Vertexs
                for (int j= 0; j < 3; ++j)
                {
                        float x, y, z;
                        stlBinFile >> x >> y >> z;
                        // Check if an error occur
                        if (QDataStream::Ok != stlBinFile.status())
                        {
                                QString message= "GLC_StlToWorld::LoadBinariStl : Failed to read the Vertex of binary STL";
                                GLC_FileFormatException fileFormatException(message, m_FileName, GLC_FileFormatException::WrongFileFormat);
                                clear();
                                qDebug() << message;
                                throw(fileFormatException);
                        }
                        m_VertexBulk.append(x);
                        m_VertexBulk.append(y);
                        m_VertexBulk.append(z);

                        m_NormalBulk.append(nx);
                        m_NormalBulk.append(ny);
                        m_NormalBulk.append(nz);

                        m_CurrentFace.append(m_CurrentIndex);
                        ++m_CurrentIndex;
                }
                currentQuantumValue = static_cast<int>((static_cast<double>(i + 1) / numberOfFacet) * 100);
                if (currentQuantumValue > previousQuantumValue)
                {
                        emit currentQuantum(currentQuantumValue);
                }
                previousQuantumValue= currentQuantumValue;

                // Skip 2 fill-bytes not needed !!!!
                stlBinFile.skipRawData(2);

        }
}