NDEVRFileImporter.h

Go to the documentation of this file.

/**--------------------------------------------------------------------------------------------
Copyright (c) 2021, NDEVR LLC
tyler.parke@ndevr.org
  __    __   ____     _____ __     __  _______
 |  \  |  | |  __ \  |  ___|\ \   / / |   __  \
 |   \ |  | | |  \ \ | |___  \ \ / /  |  |__)  |
 |  . \|  | | |__/ / | |___   \ V /   |   _   /
 |  |\    |_|_____/__|_____|___\_/____|  | \  \
 |__| \__________________________________|  \__\
 
Subject to the terms of the Enterprise+ Agreement, NDEVR hereby grants
Licensee a limited, non-exclusive, non-transferable, royalty-free license
(without the right to sublicense) to use the API solely for the purpose of
Licensee's internal development efforts to develop applications for which
the API was provided.
 
The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.
 
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED,
INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR
PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR
OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER
DEALINGS IN THE SOFTWARE.
 
Library: Base
File: Angle
Included in API: True
Author(s): Tyler Parke
 *-----------------------------------------------------------------------------------------**/
#ifndef NDEVR_FILE_IMPORTER_H_INC
#define NDEVR_FILE_IMPORTER_H_INC
#include "DLLInfo.h"
#ifndef ASSIMP_BUILD_NO_NDV_IMPORTER
#include <assimp/BaseImporter.h>
 
struct aiMesh;
struct aiNode;
 
namespace Assimp {
 
    namespace ObjFile {
        struct Object;
        struct Model;
    } // namespace ObjFile
 
    /**------------------------------------------------------------------------------------------------
    \brief  Helper class to import a given scene to an NDV file.
    To Add to Assimp, add the following line to Common/ImporterRegistry.cpp,
 
    at top of file:
    #include <[path to this file]>
 
    In function 'GetImporterInstanceList(std::vector<BaseImporter*>&)'
    add the following line:
 
    out.push_back(new NDEVRFileImporter());
    */
    // ------------------------------------------------------------------------------------------------
    class NDEVRFileImporter : public BaseImporter {
    public:
        /// \brief  Default constructor
        ASSIMP_INTERFACE_API NDEVRFileImporter();
 
        /// \brief  Destructor
        ~NDEVRFileImporter();
 
    public:
        /// \brief  Returns whether the class can handle the format of the given file.
        /// \remark See BaseImporter::CanRead() for details.
        bool CanRead(const std::string& pFile, IOSystem* pIOHandler, bool checkSig) const override;
 
    private:
        //! \brief  Appends the supported extension.
        const aiImporterDesc* GetInfo() const override;
 
        // -------------------------------------------------------------------
        /** Imports the given file into the given scene structure. The
         * function is expected to throw an ImportErrorException if there is
         * an error. If it terminates normally, the data in aiScene is
         * expected to be correct. Override this function to implement the
         * actual importing.
         * <br>
         *  The output scene must meet the following requirements:<br>
         * <ul>
         * <li>At least a root node must be there, even if its only purpose
         *     is to reference one mesh.</li>
         * <li>aiMesh::mPrimitiveTypes may be 0. The types of primitives
         *   in the mesh are determined automatically in this case.</li>
         * <li>the vertex data is stored in a pseudo-indexed "verbose" format.
         *   In fact this means that every vertex that is referenced by
         *   a face is unique. Or the other way round: a vertex index may
         *   not occur twice in a single aiMesh.</li>
         * <li>aiAnimation::mDuration may be -1. Assimp determines the length
         *   of the animation automatically in this case as the length of
         *   the longest animation channel.</li>
         * <li>aiMesh::mBitangents may be NULL if tangents and normals are
         *   given. In this case bitangents are computed as the cross product
         *   between normal and tangent.</li>
         * <li>There needn't be a material. If none is there a default material
         *   is generated. However, it is recommended practice for loaders
         *   to generate a default material for yourself that matches the
         *   default material setting for the file format better than Assimp's
         *   generic default material. Note that default materials *should*
         *   be named AI_DEFAULT_MATERIAL_NAME if they're just color-shaded
         *   or AI_DEFAULT_TEXTURED_MATERIAL_NAME if they define a (dummy)
         *   texture. </li>
         * </ul>
         * If the AI_SCENE_FLAGS_INCOMPLETE-Flag is <b>not</b> set:<ul>
         * <li> at least one mesh must be there</li>
         * <li> there may be no meshes with 0 vertices or faces</li>
         * </ul>
         * This won't be checked (except by the validation step): Assimp will
         * crash if one of the conditions is not met!
         *
         * @param pFile Path of the file to be imported.
         * @param pScene The scene object to hold the imported data.
         * NULL is not a valid parameter.
         * @param pIOHandler The IO handler to use for any file access.
         * NULL is not a valid parameter. */
        void InternReadFile(const std::string& pFile, aiScene* pScene, IOSystem* pIOHandler) override;
        
    };
 
    // ------------------------------------------------------------------------------------------------
 
} // Namespace Assimp
 
#endif
#endif