Issue 391: Adding BIM3 support to bouncer

bouncer/src/repo/manipulator/modelconvertor/import/repo_model_import_3drepo.h

@@ -34,6 +34,7 @@
 #include "../../../core/model/bson/repo_node_mesh.h"
 #include "../../../core/model/bson/repo_node_metadata.h"
 #include "../../../core/model/bson/repo_node_transformation.h"
+#include "../../../core/model/bson/repo_node_texture.h"
 
 namespace repo {
 	namespace manipulator {
@@ -47,82 +48,113 @@ namespace repo {
 			const std::string REPO_IMPORT_METADATA = "metadata";
 			const std::string REPO_IMPORT_GEOMETRY = "geometry";
 			const std::string REPO_IMPORT_MATERIAL = "material";
-
 			const std::string REPO_IMPORT_VERTICES = "vertices";
-			const std::string REPO_IMPORT_NORMALS = "normals";
-			const std::string REPO_IMPORT_INDICES = "indices";
+			const std::string REPO_IMPORT_UV	   = "uv";
+			const std::string REPO_IMPORT_NORMALS  = "normals";
+			const std::string REPO_IMPORT_INDICES  = "indices";
 
 			const std::string REPO_IMPORT_BBOX = "bbox";
 
-			const std::string REPO_V1 = "BIM001";
-			const std::string REPO_V2 = "BIM002";
-
-			const std::set<std::string> supportedFileVersions = { REPO_V1, REPO_V2 };
 			const static int REPO_VERSION_LENGTH = 6;
 
 			class RepoModelImport : public AbstractModelImport
 			{
 			private:
-				std::vector<repo::core::model::RepoNode *> node_map;
-				std::vector<repo::lib::RepoMatrix> trans_map;
-				bool is32Bit = false;
-
-				void createObject(const boost::property_tree::ptree& tree);
+				const std::string REPO_V1 = "BIM001";
+				const std::string REPO_V2 = "BIM002";
+				const std::string REPO_V3 = "BIM003";
+				const std::set<std::string> supportedFileVersions = 
+				{ 
+					REPO_V2,
+					REPO_V3
+				};
 
-				char *geomBuf;
-				std::ifstream *finCompressed;
-				boost::iostreams::filtering_streambuf<boost::iostreams::input> *inbuf;
-				std::istream *fin;
+				const int REPO_V1_FILEMETA_BYTE_LEN = 56;
+				const int REPO_V2_FILEMETA_BYTE_LEN = REPO_V1_FILEMETA_BYTE_LEN;
+				const int REPO_V3_FILEMETA_BYTE_LEN = 72;
 
 				typedef struct
 				{
-					int64_t headerSize;
-					int64_t geometrySize;
-					int64_t sizesStart;
-					int64_t sizesSize;
-					int64_t matStart;
-					int64_t matSize;
-					int64_t numChildren;
+					int64_t jsonSize	 = -1;	//!< Size of the entire JSON segment
+					int64_t dataSize	 = -1;	//!< Size of the entire binary footer segment
+					int64_t sizesStart	 = -1;	//!< Starting location of the JSON sizes array from the top of file in bytes 
+					int64_t sizesSize	 = -1;	//!< Length of the JSON sizes array in bytes
+					int64_t matStart	 = -1;	//!< Starting location of the JSON materials array from the top of the file in bytes 
+					int64_t matSize		 = -1;	//!< Size of the JSON materials array in bytes
+					int64_t numChildren	 = -1;	//!< Number of children of the root node
+					int64_t textureStart = -1;	//!< Starting location of the JSON textures array from the top of the file in bytes 
+					int64_t textureSize  = -1;  //!< Size of the JSON textures array in bytes
 				} fileMeta;
 
-				struct mesh_data_t {
+				struct mesh_data_t 
+				{
+					int parentBimId;
 					std::vector<repo::lib::RepoVector3D64> rawVertices;
 					std::vector<repo::lib::RepoVector3D> normals;
+					std::vector<std::vector<repo::lib::RepoVector2D>> uvChannels;
 					std::vector<repo_face_t> faces;
 					std::vector<std::vector<double>> boundingBox;
 					repo::lib::RepoUUID parent;
 					repo::lib::RepoUUID sharedID;
 				};
 
-				fileMeta file_meta;
-
-				std::vector<long> sizes;
-
-				repo::core::model::MaterialNode* parseMaterial(const boost::property_tree::ptree &pt);
-
+				void parseMaterial(const boost::property_tree::ptree& pt);
+				void parseTexture(const boost::property_tree::ptree& textureTree, char * dataBuffer);
 				repo::core::model::MetadataNode*  createMetadataNode(const boost::property_tree::ptree &metadata, const std::string &parentName, const repo::lib::RepoUUID &parentID);
-				mesh_data_t createMeshRecord(const boost::property_tree::ptree &geometry, const std::string &parentName, const repo::lib::RepoUUID &parentID, const repo::lib::RepoMatrix &trans);
+				mesh_data_t createMeshRecord(int parentBimId, const boost::property_tree::ptree &geometry, const std::string &parentName, const repo::lib::RepoUUID &parentID, const repo::lib::RepoMatrix &trans);
+
+				/**
+				 * @brief Creates a property tree from the current
+				 * position in the fine input stream (fin)
+				 * @param number of chars to read
+				 * @return boost poperty tree
+				*/
 				boost::property_tree::ptree getNextJSON(long jsonSize);
 				void skipAheadInFile(long amount);
 
-				std::vector<repo::core::model::MaterialNode *> matNodeList;
-				std::vector<std::vector<repo::lib::RepoUUID>> matParents;
-
-				std::vector<mesh_data_t> meshEntries;
-				repo::core::model::RepoNodeSet cameras; //!< Cameras
-				repo::core::model::RepoNodeSet materials; //!< Materials
-				repo::core::model::RepoNodeSet metadata; //!< Metadata
-				repo::core::model::RepoNodeSet transformations; //!< Transformations
-				repo::core::model::RepoNodeSet textures;
+				/**
+				 * @brief Creates relevant nodes for given child
+				 * of the root node in the BIM file
+				 * Directly updates:
+				 * trans_matrix_map
+				 * node_map
+				 * transformations
+				 * @param tree 
+				*/
+				void createObject(const boost::property_tree::ptree& tree);
 
+				// File handling variables
 				std::string orgFile;
+				std::ifstream *finCompressed;
+				boost::iostreams::filtering_streambuf<boost::iostreams::input> *inbuf;
+				std::istream *fin;
 
+				// Source file meta data storage
+				fileMeta file_meta;
+				std::vector<long> sizes; //!< Sizes of the nodes component, used for navigation.
+				char *dataBuffer;
+				bool missingTextures = false;
+
+				// Intermediary variables used to keep track of node hierarchy
+				std::vector<repo::core::model::RepoNode *> node_map;				//!< List of all transform nodes in order of decoding
+				std::vector<repo::lib::RepoMatrix> trans_matrix_map;				//!< List of all transformation matrices in same order as node_map
+				std::vector<repo::core::model::MaterialNode *> matNodeList;			//!< Stores a list of materials
+				std::vector<std::vector<repo::lib::RepoUUID>> matParents;			//!< Stores the UUIDs of all parents of a given material node in the same order matNodeList
+				std::map<int, std::vector<repo::lib::RepoUUID>> textureIdToParents; //!< Maps a texture to the UUID of all the parents that reference it 
+				std::vector<mesh_data_t> meshEntries;
+
+				// Variables directly used to instantiate the RepoScene
+				repo::core::model::RepoNodeSet cameras;
+				repo::core::model::RepoNodeSet materials;
+				repo::core::model::RepoNodeSet metadata;
+				repo::core::model::RepoNodeSet transformations;
+				repo::core::model::RepoNodeSet textures;
 				std::vector<double> offset;
 
 			public:
 
 				/**
-				* Create IFCModelImport with specific settings
+				* Create RepoModelImport with specific settings
 				* NOTE: The destructor will destroy the settings object referenced
 				* in this object!
 				* @param settings
@@ -145,9 +177,10 @@ namespace repo {
 				virtual repo::core::model::RepoScene* generateRepoScene(uint8_t &errMsg);
 
 				/**
-				* Import model from a given file
+				* Import model from a given file.
+				* Loads material nodes.
 				* This does not generate the Repo Scene Graph
-				* Use getRepoScene() to generate a Repo Scene Graph.
+				* Use generateRepoScene() to generate a Repo Scene Graph.
 				* @param path to the file
 				* @param error message if failed
 				* @return returns true upon success

bouncer/src/repo/manipulator/modelconvertor/import/repo_model_import_synchro.h

@@ -30,6 +30,7 @@
 #include "../../../core/model/bson/repo_node_metadata.h"
 #include "../../../core/model/bson/repo_node_transformation.h"
 #include "../../../lib/repo_property_tree.h"
+#include "../../../3drepobouncer/bouncer/src/repo/error_codes.h"
 
 namespace repo {
 	namespace manipulator {

test/src/system/st_3drepobouncerClient.cpp

@@ -239,6 +239,61 @@ TEST(RepoClientTest, UploadTestMissingNodes)
 	EXPECT_TRUE(projectExists(db, "missing"));
 }
 
+TEST(RepoClientTest, UploadTestBIM)
+{
+	repo::test::TestLogging::printTestTitleString(
+		"BIM format system tests",
+		"Confirming the correct response from bouncer client for BIM files");
+
+	////this ensures we can run processes
+	ASSERT_TRUE(system(nullptr));
+
+	auto testUpload = [](
+		std::string mongoDbName,
+		std::string projectName,
+		std::string fileName
+		)-> int
+	{
+		std::string bimUpload = produceUploadArgs(
+			mongoDbName,
+			projectName,
+			getDataPath(fileName));
+
+		int errCode = runProcess(bimUpload);
+		;
+		repoInfo << "Error code from bouncer client: " << errCode 
+			<< ", " << repo::test::TestLogging::getStringFromRepoErrorCode(errCode);
+		return errCode;
+	};
+
+	std::string mongoDbName = "stUpload";
+
+	repo::test::TestLogging::printSubTestTitleString("OK BIM003 file with textures");
+	std::string okBim3PrjName = "okBIM3Test";
+	EXPECT_EQ(REPOERR_OK, testUpload(mongoDbName, okBim3PrjName, "RepoModelImport/BrickWalls_bim3.bim"));
+	EXPECT_TRUE(projectExists(mongoDbName, okBim3PrjName));
+
+	repo::test::TestLogging::printSubTestTitleString("OK BIM002 file with no textures");
+	std::string okBim2PrjName = "okBIM2Test";
+	EXPECT_EQ(REPOERR_OK, testUpload(mongoDbName, okBim2PrjName, "RepoModelImport/cube_bim2_navis_2021_repo_4.6.1.bim"));
+	EXPECT_TRUE(projectExists(mongoDbName, okBim2PrjName));
+
+	repo::test::TestLogging::printSubTestTitleString("Spoofed BIM001");
+	std::string spoofedBim1PrjName = "spoofedBIM1Test";
+	EXPECT_EQ(REPOERR_UNSUPPORTED_BIM_VERSION, testUpload(mongoDbName, spoofedBim1PrjName, "RepoModelImport/cube_bim1_spoofed.bim"));
+	EXPECT_FALSE(projectExists(mongoDbName, spoofedBim1PrjName));
+
+	repo::test::TestLogging::printSubTestTitleString("Corrupt BIM003 - Missing \"numImageBytes\" field");
+	std::string corrTxtrBim3PrjName = "corruptedTextureBIM3Test";
+	EXPECT_EQ(REPOERR_LOAD_SCENE_MISSING_TEXTURE, testUpload(mongoDbName, corrTxtrBim3PrjName, "RepoModelImport/BrickWalls_bim3_CorruptedTextureField.bim"));
+	EXPECT_TRUE(projectExists(mongoDbName, corrTxtrBim3PrjName));
+
+	repo::test::TestLogging::printSubTestTitleString("Corrupt BIM003 - Material references a texture id not included in file");
+	std::string corrMatBim3PrjName = "corruptedMaterialBIM3Test";
+	EXPECT_EQ(REPOERR_LOAD_SCENE_MISSING_NODES, testUpload(mongoDbName, corrMatBim3PrjName, "RepoModelImport/BrickWalls_bim3_MissingTexture.bim"));
+	EXPECT_TRUE(projectExists(mongoDbName, corrMatBim3PrjName));
+}
+
 TEST(RepoClientTest, UploadTestIFC)
 {
 	//this ensures we can run processes

test/src/unit/repo/manipulator/modelconvertor/import/CMakeLists.txt

@@ -6,6 +6,7 @@
 
 set(TEST_SOURCES
 	${TEST_SOURCES}
+	${CMAKE_CURRENT_SOURCE_DIR}/ut_repo_model_import_3drepo.cpp
 	${CMAKE_CURRENT_SOURCE_DIR}/ut_repo_model_import_synchro.cpp
 	CACHE STRING "TEST_SOURCES" FORCE)