/*++ Copyright (C) 2019 3MF Consortium All rights reserved. Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met: 1. Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer. 2. Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution. THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. Abstract: NMR_ModelReaderNode100_Object.cpp implements the Model Reader Object Node Class. A object reader model node is a parser for the object node of an XML Model Stream. --*/ #include "Model/Reader/v100/NMR_ModelReaderNode100_Object.h" #include "Model/Reader/v100/NMR_ModelReaderNode100_Mesh.h" #include "Model/Reader/v100/NMR_ModelReaderNode100_MetaDataGroup.h" #include "Model/Reader/v100/NMR_ModelReaderNode100_Components.h" #include "Model/Classes/NMR_ModelConstants.h" #include "Model/Classes/NMR_ModelMeshObject.h" #include "Model/Classes/NMR_ModelAttachment.h" #include "Common/NMR_StringUtils.h" #include "Common/NMR_Exception.h" #include "Common/NMR_Exception_Windows.h" #include "Common/MeshInformation/NMR_MeshInformation_Properties.h" namespace NMR { CModelReaderNode100_Object::CModelReaderNode100_Object(_In_ CModel * pModel, _In_ PModelWarnings pWarnings, _In_ PProgressMonitor pProgressMonitor) : CModelReaderNode(pWarnings, pProgressMonitor) { // Initialize variables m_nID = 0; m_sType = ""; m_bHasType = false; m_pModel = pModel; m_pObject = NULL; m_sThumbnailPath = ""; m_sPartNumber = ""; m_sName = ""; m_bHasThumbnail = false; m_bHasDefaultPropertyID = false; m_bHasDefaultPropertyIndex = false; m_nObjectLevelPropertyModelID = 0; m_nObjectLevelPropertyIndex = 0; m_nSliceStackId = 0; m_eSlicesMeshResolution = MODELSLICESMESHRESOLUTION_FULL; m_bHasMeshResolution = false; } void CModelReaderNode100_Object::parseXML(_In_ CXmlReader * pXMLReader) { // Parse name parseName(pXMLReader); // Parse attribute parseAttributes(pXMLReader); // Use parameter and assign to model Object if (m_nID == 0) throw CNMRException(NMR_ERROR_MISSINGMODELOBJECTID); if (m_nObjectLevelPropertyModelID != 0) { m_pObjectLevelPropertyID = m_pModel->findPackageResourceID(m_pModel->currentPath(), m_nObjectLevelPropertyModelID); } // Parse Content parseContent(pXMLReader); // Check, if we have created an object if (!m_pObject.get()) throw CNMRException(NMR_ERROR_MISSINGOBJECTCONTENT); // Set Object Parameters m_pObject->setName(m_sName); m_pObject->setPartNumber(m_sPartNumber); if (m_MetaDataGroup.get()) { m_pObject->metaDataGroup()->mergeMetaData(m_MetaDataGroup.get()); } if (m_bHasThumbnail) { PModelAttachment pModelAttachment = m_pModel->findModelAttachment(m_sThumbnailPath); if (pModelAttachment) { if (!((pModelAttachment->getRelationShipType() == PACKAGE_TEXTURE_RELATIONSHIP_TYPE) || (pModelAttachment->getRelationShipType() == PACKAGE_THUMBNAIL_RELATIONSHIP_TYPE))) m_pWarnings->addException(CNMRException(NMR_ERROR_NOTEXTURESTREAM), mrwInvalidMandatoryValue); } else m_pWarnings->addException(CNMRException(NMR_ERROR_NOTEXTURESTREAM), mrwInvalidMandatoryValue); m_pObject->setThumbnailAttachment(pModelAttachment, false); } // Set Production references if (!m_UUID.get()) { if (pXMLReader->NamespaceRegistered(XML_3MF_NAMESPACE_PRODUCTIONSPEC)) { m_pWarnings->addException(CNMRException(NMR_ERROR_MISSINGUUID), mrwMissingMandatoryValue); } // m_UUID = std::make_shared(); } m_pObject->setUUID(m_UUID); } void CModelReaderNode100_Object::OnAttribute(_In_z_ const nfChar * pAttributeName, _In_z_ const nfChar * pAttributeValue) { __NMRASSERT(pAttributeName); __NMRASSERT(pAttributeValue); if (strcmp(pAttributeName, XML_3MF_ATTRIBUTE_OBJECT_ID) == 0) { if (m_nID != 0) throw CNMRException(NMR_ERROR_DUPLICATEOBJECTID); // Convert to integer and make a input and range check! m_nID = fnStringToUint32(pAttributeValue); } if (strcmp(pAttributeName, XML_3MF_ATTRIBUTE_OBJECT_TYPE) == 0) { if (m_bHasType) throw CNMRException(NMR_ERROR_DUPLICATEOBJECTTYPE); // Convert to integer and make a input and range check! m_sType = pAttributeValue; m_bHasType = true; } if (strcmp(pAttributeName, XML_3MF_ATTRIBUTE_OBJECT_THUMBNAIL) == 0) { if (m_bHasThumbnail) throw CNMRException(NMR_ERROR_DUPLICATEOBJECTTHUMBNAIL); m_sThumbnailPath = pAttributeValue; m_bHasThumbnail = true; } if (strcmp(pAttributeName, XML_3MF_ATTRIBUTE_OBJECT_NAME) == 0) { m_sName = pAttributeValue; } if (strcmp(pAttributeName, XML_3MF_ATTRIBUTE_OBJECT_PARTNUMBER) == 0) { m_sPartNumber = pAttributeValue; } if (strcmp(pAttributeName, XML_3MF_ATTRIBUTE_OBJECT_PID) == 0) { if (m_bHasDefaultPropertyID) throw CNMRException(NMR_ERROR_DUPLICATEPID); m_bHasDefaultPropertyID = true; m_nObjectLevelPropertyModelID = fnStringToUint32(pAttributeValue); } if (strcmp(pAttributeName, XML_3MF_ATTRIBUTE_OBJECT_PINDEX) == 0) { if (m_bHasDefaultPropertyIndex) throw CNMRException(NMR_ERROR_DUPLICATEPINDEX); m_bHasDefaultPropertyIndex = true; m_nObjectLevelPropertyIndex = fnStringToUint32(pAttributeValue); } } void CModelReaderNode100_Object::OnNSAttribute(_In_z_ const nfChar * pAttributeName, _In_z_ const nfChar * pAttributeValue, _In_z_ const nfChar * pNameSpace) { __NMRASSERT(pAttributeName); __NMRASSERT(pNameSpace); __NMRASSERT(pAttributeValue); if (strcmp(XML_3MF_NAMESPACE_SLICESPEC, pNameSpace) == 0) { if (strcmp(pAttributeName, XML_3MF_ATTRIBUTE_OBJECT_SLICESTACKID) == 0) { if (m_nSliceStackId != 0) m_pWarnings->addException(CNMRException(NMR_ERROR_DUPLICATE_SLICESTACKID), eModelWarningLevel::mrwInvalidOptionalValue); m_nSliceStackId = fnStringToUint32(pAttributeValue); } else if (strcmp(pAttributeName, XML_3MF_ATTRIBUTE_OBJECT_MESHRESOLUTION) == 0) { if (m_bHasMeshResolution) m_pWarnings->addException(CNMRException(NMR_ERROR_DUPLICATE_MESHRESOLUTION), eModelWarningLevel::mrwInvalidOptionalValue); m_bHasMeshResolution = true; if (strcmp(pAttributeValue, XML_3MF_VALUE_OBJECT_MESHRESOLUTION_FULL)==0) { m_eSlicesMeshResolution = MODELSLICESMESHRESOLUTION_FULL; } else if (strcmp(pAttributeValue, XML_3MF_VALUE_OBJECT_MESHRESOLUTION_LOW) == 0) { m_eSlicesMeshResolution = MODELSLICESMESHRESOLUTION_LOW; } else m_pWarnings->addException(CNMRException(NMR_ERROR_INVALID_MESHRESOLUTION), eModelWarningLevel::mrwInvalidOptionalValue); } else m_pWarnings->addException(CNMRException(NMR_ERROR_NAMESPACE_INVALID_ATTRIBUTE), mrwInvalidOptionalValue); } if (strcmp(XML_3MF_NAMESPACE_PRODUCTIONSPEC, pNameSpace) == 0) { if (strcmp(XML_3MF_PRODUCTION_UUID, pAttributeName) == 0) { if (m_UUID.get()) m_pWarnings->addException(CNMRException(NMR_ERROR_DUPLICATEUUID), eModelWarningLevel::mrwInvalidMandatoryValue); m_UUID = std::make_shared(pAttributeValue); } else m_pWarnings->addException(CNMRException(NMR_ERROR_NAMESPACE_INVALID_ATTRIBUTE), mrwInvalidOptionalValue); } } void CModelReaderNode100_Object::OnNSChildElement(_In_z_ const nfChar * pChildName, _In_z_ const nfChar * pNameSpace, _In_ CXmlReader * pXMLReader) { __NMRASSERT(pChildName); __NMRASSERT(pXMLReader); __NMRASSERT(pNameSpace); if (strcmp(pNameSpace, XML_3MF_NAMESPACE_CORESPEC100) == 0) { // Read a mesh object if (strcmp(pChildName, XML_3MF_ELEMENT_MESH) == 0) { // If we already have parsed an object, the node is duplicate if (m_pObject.get()) throw CNMRException(NMR_ERROR_AMBIGUOUSOBJECTDEFINITON); // Create Empty Mesh PMesh pMesh = std::make_shared(); // Create Mesh Object m_pObject = std::make_shared(m_nID, m_pModel, pMesh); // Set Object Type (might fail, if string is invalid) if (m_bHasType) { if (!m_pObject->setObjectTypeString(m_sType, false)) m_pWarnings->addWarning(NMR_ERROR_INVALIDMODELOBJECTTYPE, mrwInvalidOptionalValue); } // Read Mesh PModelReaderNode100_Mesh pXMLNode = std::make_shared(m_pModel, pMesh.get(), m_pWarnings, m_pProgressMonitor, m_pObjectLevelPropertyID, m_nObjectLevelPropertyIndex); pXMLNode->parseXML(pXMLReader); // Add Object to Parent m_pModel->addResource(m_pObject); // Handle BeamLattice Data handleBeamLatticeExtension(pXMLNode.get()); // Create Default Properties createDefaultProperties(); } // Read a component object else if (strcmp(pChildName, XML_3MF_ELEMENT_COMPONENTS) == 0) { // If we already have parsed an object, the node is duplicate if (m_pObject.get()) throw CNMRException(NMR_ERROR_AMBIGUOUSOBJECTDEFINITON); // Create Component List Object PModelComponentsObject pComponentsObject = std::make_shared(m_nID, m_pModel); m_pObject = pComponentsObject; // Set Object Type (might fail, if string is invalid) if (m_bHasType) { if (!m_pObject->setObjectTypeString(m_sType, false)) m_pWarnings->addWarning(NMR_ERROR_INVALIDMODELOBJECTTYPE, mrwInvalidOptionalValue); } // Read Components PModelReaderNode pXMLNode = std::make_shared(pComponentsObject.get(), m_pWarnings); pXMLNode->parseXML(pXMLReader); // Add Object to Parent m_pModel->addResource(m_pObject); if (m_nObjectLevelPropertyIndex != 0) m_pWarnings->addException(CNMRException(NMR_ERROR_OBJECTLEVELPID_ON_COMPONENTSOBJECT), mrwInvalidOptionalValue); } else if (strcmp(pChildName, XML_3MF_ELEMENT_METADATAGROUP) == 0) { PModelReaderNode pXMLNode = std::make_shared(m_pWarnings); pXMLNode->parseXML(pXMLReader); if (m_MetaDataGroup.get()) { m_pWarnings->addException(CNMRException(NMR_ERROR_DUPLICATEMETADATAGROUP), mrwInvalidOptionalValue); } m_MetaDataGroup = dynamic_cast(pXMLNode.get())->getMetaDataGroup(); } else m_pWarnings->addException(CNMRException(NMR_ERROR_NAMESPACE_INVALID_ELEMENT), mrwInvalidOptionalValue); // In any case (component object or mesh object) if ( (m_pObject) && (m_nSliceStackId > 0) ) { PPackageResourceID pID = m_pModel->findPackageResourceID(m_pModel->currentPath(), m_nSliceStackId); if (!pID.get()) throw CNMRException(NMR_ERROR_SLICESTACKRESOURCE_NOT_FOUND); PModelSliceStack pSliceStackResource = std::dynamic_pointer_cast(m_pModel->findResource(pID) ); if (pSliceStackResource) { if ((m_pObject->getObjectType() == MODELOBJECTTYPE_MODEL) || (m_pObject->getObjectType() == MODELOBJECTTYPE_SOLIDSUPPORT)) { if (!pSliceStackResource->areAllPolygonsClosed()) { m_pWarnings->addException(CNMRException(NMR_ERROR_SLICEPOLYGONNOTCLOSED), mrwInvalidMandatoryValue); } } } else throw CNMRException(NMR_ERROR_SLICESTACKRESOURCE_NOT_FOUND); m_pObject->assignSliceStack(pSliceStackResource); m_pObject->setSlicesMeshResolution(m_eSlicesMeshResolution); } } } // Create the object-level property from m_nObjectLevelPropertyID, if defined void CModelReaderNode100_Object::createDefaultProperties() { if (m_pObject.get() == nullptr) return; if (m_bHasDefaultPropertyIndex && m_bHasDefaultPropertyID) { CModelMeshObject* pMeshObject = dynamic_cast(m_pObject.get()); if (pMeshObject) { CMesh * pMesh = pMeshObject->getMesh(); if (pMesh) { // Assign Default Resource Property PModelResource pResource = m_pModel->findResource(m_pModel->currentPath(), m_nObjectLevelPropertyModelID); if (pResource.get() == nullptr) { throw CNMRException(NMR_ERROR_RESOURCENOTFOUND); } if(!pResource->hasResourceIndexMap()) pResource->buildResourceIndexMap(); auto pInformationHandler = pMesh->createMeshInformationHandler(); CMeshInformation_Properties * pInformation = dynamic_cast (pInformationHandler->getInformationByType(0, NMR::emiProperties)); if (pInformation == nullptr) { NMR::PMeshInformation_Properties pNewInformation = std::make_shared(pMesh->getFaceCount()); pInformationHandler->addInformation(pNewInformation); pInformation = pNewInformation.get(); } ModelResourceID pPropertyID; if (pResource->mapResourceIndexToPropertyID(m_nObjectLevelPropertyIndex, pPropertyID)) { NMR::MESHINFORMATION_PROPERTIES * pDefaultData = new NMR::MESHINFORMATION_PROPERTIES; pDefaultData->m_nUniqueResourceID = pResource->getPackageResourceID()->getUniqueID(); pDefaultData->m_nPropertyIDs[0] = pPropertyID; pDefaultData->m_nPropertyIDs[1] = pPropertyID; pDefaultData->m_nPropertyIDs[2] = pPropertyID; pInformation->setDefaultData((NMR::MESHINFORMATIONFACEDATA*)pDefaultData); } else { throw CNMRException(NMR_ERROR_INVALID_RESOURCE_INDEX); } } } } } void CModelReaderNode100_Object::handleBeamLatticeExtension(CModelReaderNode100_Mesh* pXMLNode) { CModelMeshObject* pMeshObject = dynamic_cast(m_pObject.get()); if (pMeshObject == nullptr || pXMLNode == nullptr) return; if (pMeshObject->getMesh()->getBeamCount() > 0) { if ( (pMeshObject->getObjectType() != MODELOBJECTTYPE_MODEL) && (pMeshObject->getObjectType() != MODELOBJECTTYPE_SOLIDSUPPORT)) { m_pWarnings->addException(CNMRException(NMR_ERROR_BEAMLATTICE_INVALID_OBJECTTYPE), mrwInvalidOptionalValue); } } eModelBeamLatticeClipMode eClipMode; nfBool bHasClippingMeshID; ModelResourceID nClippingMeshID; pXMLNode->retrieveClippingInfo(eClipMode, bHasClippingMeshID, nClippingMeshID); if (bHasClippingMeshID) { PPackageResourceID pID = m_pModel->findPackageResourceID(m_pModel->currentPath(), nClippingMeshID); if (!pID.get()) { m_pWarnings->addWarning(NMR_ERROR_BEAMLATTICECLIPPINGRESOURCENOTDEFINED, mrwInvalidMandatoryValue); } else { CModelObject * pModelObject = m_pModel->findObject(pID->getUniqueID()); if (pModelObject) { pMeshObject->getBeamLatticeAttributes()->m_bHasClippingMeshID = bHasClippingMeshID; pMeshObject->getBeamLatticeAttributes()->m_pClippingMeshUniqueID = pID; pMeshObject->getBeamLatticeAttributes()->m_eClipMode = eClipMode; } else { pMeshObject->getBeamLatticeAttributes()->m_bHasClippingMeshID = false; m_pWarnings->addWarning(NMR_ERROR_BEAMLATTICECLIPPINGRESOURCENOTDEFINED, mrwInvalidMandatoryValue); } } } nfBool bHasRepresentationMeshID; ModelResourceID nRepresentationMeshID; pXMLNode->retrieveRepresentationInfo(bHasRepresentationMeshID, nRepresentationMeshID); if (nRepresentationMeshID) { PPackageResourceID pID = m_pModel->findPackageResourceID(m_pModel->currentPath(), nRepresentationMeshID); if (!pID.get()) { m_pWarnings->addWarning(NMR_ERROR_BEAMLATTICE_INVALID_REPRESENTATIONRESOURCE, mrwInvalidMandatoryValue); } else { CModelObject * pModelObject = m_pModel->findObject(pID->getUniqueID()); if (pModelObject) { pMeshObject->getBeamLatticeAttributes()->m_bHasRepresentationMeshID = bHasRepresentationMeshID; pMeshObject->getBeamLatticeAttributes()->m_pRepresentationUniqueID = pID; } else { pMeshObject->getBeamLatticeAttributes()->m_bHasRepresentationMeshID = false; m_pWarnings->addWarning(NMR_ERROR_BEAMLATTICE_INVALID_REPRESENTATIONRESOURCE, mrwInvalidMandatoryValue); } } } } }