SaraP
336 lines
13 KiB
C++
336 lines
13 KiB
C++
/*++
|
|
|
|
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_Model.h defines the Model Class. A model is an in memory representation of the 3MF file.
|
|
|
|
--*/
|
|
|
|
#ifndef __NMR_MODEL
|
|
#define __NMR_MODEL
|
|
|
|
#include "Model/Classes/NMR_ModelTypes.h"
|
|
#include "Common/Platform/NMR_ImportStream.h"
|
|
|
|
#include "Common/Math/NMR_Matrix.h"
|
|
#include "Common/Mesh/NMR_Mesh.h"
|
|
|
|
#include "Model/Classes/NMR_PackageResourceID.h"
|
|
|
|
#include <list>
|
|
#include <map>
|
|
#include <set>
|
|
#include <vector>
|
|
|
|
#include "Common/NMR_UUID.h"
|
|
|
|
#include "Common/NMR_SecureContentTypes.h"
|
|
|
|
namespace NMR {
|
|
|
|
class CModelBuildItem;
|
|
typedef std::shared_ptr <CModelBuildItem> PModelBuildItem;
|
|
|
|
class CModelResource;
|
|
typedef std::shared_ptr <CModelResource> PModelResource;
|
|
|
|
class CModelObject;
|
|
typedef std::shared_ptr <CModelObject> PModelObject;
|
|
|
|
class CModelMetaData;
|
|
typedef std::shared_ptr <CModelMetaData> PModelMetaData;
|
|
|
|
class CModelMetaDataGroup;
|
|
typedef std::shared_ptr <CModelMetaDataGroup> PModelMetaDataGroup;
|
|
|
|
class CModelAttachment;
|
|
typedef std::shared_ptr <CModelAttachment> PModelAttachment;
|
|
|
|
class CModelBaseMaterialResource;
|
|
typedef std::shared_ptr <CModelBaseMaterialResource> PModelBaseMaterialResource;
|
|
|
|
class CModelColorGroupResource;
|
|
typedef std::shared_ptr <CModelColorGroupResource> PModelColorGroupResource;
|
|
|
|
class CModelCompositeMaterialsResource;
|
|
typedef std::shared_ptr <CModelCompositeMaterialsResource> PModelCompositeMaterialsResource;
|
|
|
|
class CModelMultiPropertyGroupResource;
|
|
typedef std::shared_ptr <CModelMultiPropertyGroupResource> PModelMultiPropertyGroupResource;
|
|
|
|
class CModelTexture2DGroupResource;
|
|
typedef std::shared_ptr <CModelTexture2DGroupResource> PModelTexture2DGroupResource;
|
|
|
|
class CModelTexture2DResource;
|
|
typedef std::shared_ptr <CModelTexture2DResource> PModelTexture2DResource;
|
|
|
|
class CModelSliceStack;
|
|
typedef std::shared_ptr <CModelSliceStack> PModelSliceStack;
|
|
|
|
class CKeyStore;
|
|
typedef std::shared_ptr <CKeyStore> PKeyStore;
|
|
|
|
typedef std::map<NMR::UniqueResourceID, NMR::UniqueResourceID> UniqueResourceIDMapping;
|
|
|
|
// The Model class implements the unification of all model-file in a 3MF package
|
|
// It should be understood as a "MultiModel"
|
|
class CModel {
|
|
private:
|
|
PPackageModelPath m_pCurPath;
|
|
PPackageModelPath m_pPath;
|
|
|
|
std::unordered_map<std::string, PUUID> usedUUIDs; // datastructure used to ensure that UUIDs within one model (package) are unique
|
|
|
|
// map of all UniqueResourceIDs to actual object resources of the model
|
|
std::map<UniqueResourceID, PModelResource> m_ResourceMap;
|
|
CResourceHandler m_resourceHandler;
|
|
private:
|
|
std::vector<PModelResource> m_Resources;
|
|
|
|
// Model Build Items
|
|
std::vector<PModelBuildItem> m_BuildItems;
|
|
|
|
// build's UUID. Empty if none defined
|
|
PUUID m_buildUUID;
|
|
|
|
// Model Properties
|
|
nfUint32 m_nHandleCounter;
|
|
eModelUnit m_Unit;
|
|
std::string m_sLanguage;
|
|
// Package Thumbnail as attachment
|
|
PModelAttachment m_pPackageThumbnailAttachment;
|
|
|
|
// Model Metadata
|
|
PModelMetaDataGroup m_MetaDataGroup;
|
|
|
|
// Model Attachments
|
|
std::vector<PModelAttachment> m_Attachments;
|
|
std::unordered_map<std::string, PModelAttachment> m_AttachmentURIMap;
|
|
|
|
// Custom Attachment Content Types
|
|
std::map<std::string, std::string> m_CustomContentTypes;
|
|
|
|
// Production Model Attachments
|
|
std::vector<PModelAttachment> m_ProductionAttachments;
|
|
std::unordered_map<std::string, PModelAttachment> m_ProductionAttachmentURIMap;
|
|
|
|
// Indexed lookup lists for standard resource types
|
|
std::vector<PModelResource> m_ObjectLookup;
|
|
std::vector<PModelResource> m_BaseMaterialLookup;
|
|
std::vector<PModelResource> m_TextureLookup;
|
|
std::vector<PModelResource> m_SliceStackLookup;
|
|
std::vector<PModelResource> m_ColorGroupLookup;
|
|
std::vector<PModelResource> m_Texture2DGroupLookup;
|
|
std::vector<PModelResource> m_CompositeMaterialsLookup;
|
|
std::vector<PModelResource> m_MultiPropertyGroupLookup;
|
|
|
|
// The KeyStore reference
|
|
PKeyStore m_pKeyStore;
|
|
|
|
CryptoRandGenDescriptor m_sRandDescriptor;
|
|
|
|
// Add Resource to resource lookup tables
|
|
void addResourceToLookupTable(_In_ PModelResource pResource);
|
|
|
|
public:
|
|
CModel();
|
|
~CModel();
|
|
|
|
const std::string currentPath();
|
|
PPackageModelPath currentModelPath();
|
|
void setCurrentPath(const std::string sPath);
|
|
|
|
PPackageModelPath rootModelPath();
|
|
const std::string rootPath();
|
|
void setRootPath(const std::string sPath);
|
|
|
|
PPackageModelPath findOrCreateModelPath(std::string sPath);
|
|
std::vector<PPackageModelPath> retrieveAllModelPaths();
|
|
|
|
// Merge all build items into one mesh
|
|
void mergeToMesh(_In_ CMesh * pMesh);
|
|
|
|
// Units setter/getter
|
|
void setUnit(_In_ eModelUnit Unit);
|
|
void setUnitString(_In_ std::string sUnitString);
|
|
eModelUnit getUnit();
|
|
std::string getUnitString();
|
|
|
|
// Language setter/getter
|
|
void setLanguage(_In_ std::string sLanguage);
|
|
std::string getLanguage();
|
|
|
|
// General Resource Handling
|
|
PModelResource findResource(_In_ std::string path, ModelResourceID nID);
|
|
PModelResource findResource(_In_ UniqueResourceID nID);
|
|
PModelResource findResource(_In_ PPackageResourceID pID);
|
|
|
|
PPackageResourceID findPackageResourceID(_In_ std::string path, ModelResourceID nID);
|
|
PPackageResourceID findPackageResourceID(_In_ UniqueResourceID nID);
|
|
|
|
nfUint32 getResourceCount();
|
|
PModelResource getResource(_In_ nfUint32 nIndex);
|
|
void addResource(_In_ PModelResource pResource);
|
|
|
|
// Metadata setter/getter
|
|
PModelMetaData addMetaData(_In_ std::string sNameSpace, _In_ std::string sName, _In_ std::string sValue, _In_ std::string sType, _In_ nfBool bPreserve);
|
|
nfUint32 getMetaDataCount();
|
|
PModelMetaData getMetaData(_In_ nfUint32 nIndex);
|
|
void removeMetaData(_In_ nfUint32 nIndex);
|
|
nfBool hasMetaData(_In_ std::string sKey);
|
|
void mergeMetaData(_In_ CModel * pSourceModel);
|
|
PModelMetaDataGroup getMetaDataGroup();
|
|
|
|
// Build Handling
|
|
void addBuildItem(_In_ PModelBuildItem pBuildItem);
|
|
nfUint32 getBuildItemCount();
|
|
PModelBuildItem getBuildItem(_In_ nfUint32 nIdx);
|
|
// Removes a build item identified by its handle
|
|
void removeBuildItem(_In_ nfUint32 nHandle, _In_ nfBool bThrowExceptionIfNotFound);
|
|
|
|
PUUID buildUUID();
|
|
void setBuildUUID(PUUID pUUID);
|
|
void unRegisterUUID(PUUID pUUID);
|
|
void registerUUID(PUUID pUUID);
|
|
|
|
// Package Thumbnail Attachment
|
|
PModelAttachment addPackageThumbnail(_In_ std::string sPath, _In_ PImportStream pStream);
|
|
PModelAttachment addPackageThumbnail();
|
|
void removePackageThumbnail();
|
|
PModelAttachment getPackageThumbnail();
|
|
|
|
// Retrieve a unique Resource ID
|
|
UniqueResourceID generateResourceID(); // unique per model
|
|
void updateUniqueResourceID(UniqueResourceID nOldID, UniqueResourceID nNewID);
|
|
|
|
PPackageResourceID generatePackageResourceID(_In_ std::string path, ModelResourceID nID); // unique per package
|
|
void removePackageResourceID(PPackageResourceID pID);
|
|
|
|
// Convenience functions for objects
|
|
_Ret_maybenull_ CModelObject * findObject(_In_ UniqueResourceID nResourceID);
|
|
nfUint32 getObjectCount();
|
|
PModelResource getObjectResource(_In_ nfUint32 nIndex);
|
|
nfInt32 compareObjectsByResourceID(CModelResource* pObjectResourceA, CModelResource* pObjectResourceB);
|
|
CModelObject * getObject(_In_ nfUint32 nIndex);
|
|
|
|
// Convenience functions for base materials
|
|
_Ret_maybenull_ PModelBaseMaterialResource findBaseMaterial(_In_ PPackageResourceID pID);
|
|
nfUint32 getBaseMaterialCount();
|
|
PModelResource getBaseMaterialResource(_In_ nfUint32 nIndex);
|
|
CModelBaseMaterialResource * getBaseMaterial(_In_ nfUint32 nIndex);
|
|
void mergeBaseMaterials(_In_ CModel * pSourceModel, _In_ UniqueResourceIDMapping &oldToNewMapping);
|
|
|
|
// Convenience functions for color groups
|
|
_Ret_maybenull_ PModelColorGroupResource findColorGroup(_In_ UniqueResourceID nResourceID);
|
|
nfUint32 getColorGroupCount();
|
|
PModelResource getColorGroupResource(_In_ nfUint32 nIndex);
|
|
CModelColorGroupResource * getColorGroup(_In_ nfUint32 nIndex);
|
|
void mergeColorGroups(_In_ CModel * pSourceModel, _In_ UniqueResourceIDMapping &oldToNewMapping);
|
|
|
|
// Convenience functions for texture2d groups
|
|
_Ret_maybenull_ PModelTexture2DGroupResource findTexture2DGroup(_In_ UniqueResourceID nResourceID);
|
|
nfUint32 getTexture2DGroupCount();
|
|
PModelResource getTexture2DGroupResource(_In_ nfUint32 nIndex);
|
|
CModelTexture2DGroupResource * getTexture2DGroup(_In_ nfUint32 nIndex);
|
|
void mergeTexture2DGroups(_In_ CModel * pSourceModel, _In_ UniqueResourceIDMapping &oldToNewMapping);
|
|
|
|
// Convenience functions for composite materials
|
|
_Ret_maybenull_ PModelCompositeMaterialsResource findCompositeMaterials(_In_ UniqueResourceID nResourceID);
|
|
nfUint32 getCompositeMaterialsCount();
|
|
PModelResource getCompositeMaterialsResource(_In_ nfUint32 nIndex);
|
|
CModelCompositeMaterialsResource * getCompositeMaterials(_In_ nfUint32 nIndex);
|
|
void mergeCompositeMaterials(_In_ CModel * pSourceModel, _In_ UniqueResourceIDMapping &oldToNewMapping);
|
|
|
|
// Convenience functions for multi property groups
|
|
_Ret_maybenull_ PModelMultiPropertyGroupResource findMultiPropertyGroup(_In_ UniqueResourceID nResourceID);
|
|
nfUint32 getMultiPropertyGroupCount();
|
|
PModelResource getMultiPropertyGroupResource(_In_ nfUint32 nIndex);
|
|
CModelMultiPropertyGroupResource * getMultiPropertyGroup(_In_ nfUint32 nIndex);
|
|
void mergeMultiPropertyGroups(_In_ CModel * pSourceModel, _In_ UniqueResourceIDMapping &oldToNewMapping);
|
|
|
|
// Convenience functions for 2D Textures
|
|
_Ret_maybenull_ PModelTexture2DResource findTexture2D(_In_ UniqueResourceID nResourceID);
|
|
nfUint32 getTexture2DCount();
|
|
PModelResource getTexture2DResource(_In_ nfUint32 nIndex);
|
|
CModelTexture2DResource * getTexture2D(_In_ nfUint32 nIndex);
|
|
void mergeTextures2D(_In_ CModel * pSourceModel, _In_ UniqueResourceIDMapping &oldToNewMapping);
|
|
|
|
// Clear all build items and Resources
|
|
void clearAll ();
|
|
|
|
// Creates a unique handle for identifying child classes (e.g. build items)
|
|
nfUint32 createHandle();
|
|
|
|
// Custom Attachments (includes Texture Attachments)
|
|
PModelAttachment addAttachment(_In_ const std::string sPath, _In_ const std::string sRelationShipType, PImportStream pCopiedStream);
|
|
void removeAttachment(_In_ const std::string sPath);
|
|
nfUint32 getAttachmentCount();
|
|
PModelAttachment getModelAttachment(_In_ nfUint32 nIndex);
|
|
std::string getModelAttachmentPath(_In_ nfUint32 nIndex);
|
|
PModelAttachment findModelAttachment(_In_ std::string sPath);
|
|
void mergeModelAttachments(_In_ CModel * pSourceModel);
|
|
|
|
// Custom Content Types
|
|
std::map<std::string, std::string> getCustomContentTypes();
|
|
void addCustomContentType(_In_ const std::string sExtension, _In_ const std::string sContentType);
|
|
void removeCustomContentType(_In_ const std::string sExtension);
|
|
nfBool contentTypeIsDefault(_In_ const std::string sExtension);
|
|
|
|
// Production Extension Attachments
|
|
PModelAttachment addProductionAttachment(_In_ const std::string sPath, _In_ const std::string sRelationShipType, PImportStream pCopiedStream, nfBool bForceUnique);
|
|
void removeProductionAttachment(_In_ const std::string sPath);
|
|
nfUint32 getProductionAttachmentCount();
|
|
PModelAttachment getProductionModelAttachment(_In_ nfUint32 nIndex);
|
|
std::string getProductionModelAttachmentPath(_In_ nfUint32 nIndex);
|
|
PModelAttachment findProductionModelAttachment(_In_ std::string sPath);
|
|
|
|
// Required Extension Handling
|
|
nfBool RequireExtension(_In_ const std::string sExtension);
|
|
|
|
// Convenience functions for slice stacks
|
|
nfUint32 getSliceStackCount();
|
|
PModelResource getSliceStackResource(_In_ nfUint32 nIndex);
|
|
|
|
// Sorts objects by correct dependency
|
|
std::list<CModelObject *> getSortedObjectList ();
|
|
|
|
|
|
// Gets the KeyStore
|
|
PKeyStore getKeyStore();
|
|
void setKeyStore(PKeyStore keyStore);
|
|
|
|
void setCryptoRandCallback(CryptoRandGenDescriptor const & randDescriptor);
|
|
nfBool hasCryptoRandCallbak() const;
|
|
nfUint64 generateRandomBytes(nfByte *, nfUint64);
|
|
|
|
};
|
|
|
|
typedef std::shared_ptr <CModel> PModel;
|
|
}
|
|
|
|
#endif // __NMR_MODEL
|