1 /*
2 Open Asset Import Library (assimp)
3 ----------------------------------------------------------------------
4 
5 Copyright (c) 2006-2020, assimp team
6 
7 All rights reserved.
8 
9 Redistribution and use of this software in source and binary forms,
10 with or without modification, are permitted provided that the
11 following conditions are met:
12 
13 * Redistributions of source code must retain the above
14   copyright notice, this list of conditions and the
15   following disclaimer.
16 
17 * Redistributions in binary form must reproduce the above
18   copyright notice, this list of conditions and the
19   following disclaimer in the documentation and/or other
20   materials provided with the distribution.
21 
22 * Neither the name of the assimp team, nor the names of its
23   contributors may be used to endorse or promote products
24   derived from this software without specific prior
25   written permission of the assimp team.
26 
27 THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
28 "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
29 LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
30 A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
31 OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
32 SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
33 LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
34 DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
35 THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
36 (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
37 OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
38 
39 ----------------------------------------------------------------------
40 */
41 #pragma once
42 #ifndef OBJ_FILE_IMPORTER_H_INC
43 #define OBJ_FILE_IMPORTER_H_INC
44 
45 #include <assimp/BaseImporter.h>
46 #include <assimp/material.h>
47 #include <vector>
48 
49 struct aiMesh;
50 struct aiNode;
51 
52 namespace Assimp {
53 
54 namespace ObjFile {
55 struct Object;
56 struct Model;
57 } // namespace ObjFile
58 
59 // ------------------------------------------------------------------------------------------------
60 /// \class  ObjFileImporter
61 /// \brief  Imports a waveform obj file
62 // ------------------------------------------------------------------------------------------------
63 class ObjFileImporter : public BaseImporter {
64 public:
65     /// \brief  Default constructor
66     ObjFileImporter();
67 
68     /// \brief  Destructor
69     ~ObjFileImporter() override;
70 
71     /// \brief  Returns whether the class can handle the format of the given file.
72     /// \remark See BaseImporter::CanRead() for details.
73     bool CanRead(const std::string &pFile, IOSystem *pIOHandler, bool checkSig) const override;
74 
75 protected:
76     //! \brief  Appends the supported extension.
77     const aiImporterDesc *GetInfo() const override;
78 
79     //! \brief  File import implementation.
80     void InternReadFile(const std::string &pFile, aiScene *pScene, IOSystem *pIOHandler) override;
81 
82     //! \brief  Create the data from imported content.
83     void CreateDataFromImport(const ObjFile::Model *pModel, aiScene *pScene);
84 
85     //! \brief  Creates all nodes stored in imported content.
86     aiNode *createNodes(const ObjFile::Model *pModel, const ObjFile::Object *pData,
87             aiNode *pParent, aiScene *pScene, std::vector<aiMesh *> &MeshArray);
88 
89     //! \brief  Creates topology data like faces and meshes for the geometry.
90     aiMesh *createTopology(const ObjFile::Model *pModel, const ObjFile::Object *pData,
91             unsigned int uiMeshIndex);
92 
93     //! \brief  Creates vertices from model.
94     void createVertexArray(const ObjFile::Model *pModel, const ObjFile::Object *pCurrentObject,
95             unsigned int uiMeshIndex, aiMesh *pMesh, unsigned int numIndices);
96 
97     //! \brief  Object counter helper method.
98     void countObjects(const std::vector<ObjFile::Object *> &rObjects, int &iNumMeshes);
99 
100     //! \brief  Material creation.
101     void createMaterials(const ObjFile::Model *pModel, aiScene *pScene);
102 
103     /// @brief  Adds special property for the used texture mapping mode of the model.
104     void addTextureMappingModeProperty(aiMaterial *mat, aiTextureType type, int clampMode = 1, int index = 0);
105 
106     //! \brief  Appends a child node to a parent node and updates the data structures.
107     void appendChildToParentNode(aiNode *pParent, aiNode *pChild);
108 
109 private:
110     //! Data buffer
111     std::vector<char> m_Buffer;
112     //! Pointer to root object instance
113     ObjFile::Object *m_pRootObject;
114     //! Absolute pathname of model in file system
115     std::string m_strAbsPath;
116 };
117 
118 // ------------------------------------------------------------------------------------------------
119 
120 } // Namespace Assimp
121 
122 #endif
123