//----------------------------------------------------------------------------- // Copyright (c) 2013 GarageGames, LLC // // Permission is hereby granted, free of charge, to any person obtaining a copy // of this software and associated documentation files (the "Software"), to // deal in the Software without restriction, including without limitation the // rights to use, copy, modify, merge, publish, distribute, sublicense, and/or // sell copies of the Software, and to permit persons to whom the Software is // furnished to do so, subject to the following conditions: // // 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. //----------------------------------------------------------------------------- #ifndef SHAPE_ASSET_H #define SHAPE_ASSET_H #ifndef _ASSET_BASE_H_ #include "assets/assetBase.h" #endif #ifndef _ASSET_DEFINITION_H_ #include "assets/assetDefinition.h" #endif #ifndef _STRINGUNIT_H_ #include "string/stringUnit.h" #endif #ifndef _ASSET_FIELD_TYPES_H_ #include "assets/assetFieldTypes.h" #endif #ifndef _TSSHAPE_H_ #include "ts/tsShape.h" #endif #ifndef __RESOURCE_H__ #include "core/resource.h" #endif #ifndef _ASSET_PTR_H_ #include "assets/assetPtr.h" #endif #ifndef MATERIALASSET_H #include "MaterialAsset.h" #endif #ifndef SHAPE_ANIMATION_ASSET_H #include "ShapeAnimationAsset.h" #endif #ifdef TORQUE_TOOLS #include "gui/editor/guiInspectorTypes.h" #endif #ifndef _BITSTREAM_H_ #include "core/stream/bitStream.h" #endif //----------------------------------------------------------------------------- class ShapeAsset : public AssetBase { typedef AssetBase Parent; protected: StringTableEntry mFileName; StringTableEntry mConstructorFileName; StringTableEntry mFilePath; StringTableEntry mConstructorFilePath; Resource mShape; //Material assets we're dependent on and use Vector mMaterialAssetIds; Vector> mMaterialAssets; //Animation assets we're dependent on and use Vector mAnimationAssetIds; Vector> mAnimationAssets; typedef Signal ShapeAssetChanged; ShapeAssetChanged mChangeSignal; typedef Signal ShapeAssetArrayChanged; ShapeAssetArrayChanged mChangeArraySignal; public: enum ShapeAssetErrCode { TooManyVerts = AssetErrCode::Extended, TooManyBones, MissingAnimatons, Extended }; static StringTableEntry smNoShapeAssetFallback; static const String mErrCodeStrings[ShapeAssetErrCode::Extended - Parent::Extended + 1]; static U32 getAssetErrCode(AssetPtr shapeAsset) { if (shapeAsset) return shapeAsset->mLoadedState; else return 0; } static String getAssetErrstrn(U32 errCode) { if (errCode < Parent::Extended) return Parent::getAssetErrstrn(errCode); if (errCode > ShapeAssetErrCode::Extended) return "undefined error"; return mErrCodeStrings[errCode]; }; ShapeAsset(); virtual ~ShapeAsset(); /// Set up some global script interface stuff. static void consoleInit(); /// Engine. static void initPersistFields(); virtual void copyTo(SimObject* object); virtual void setDataField(StringTableEntry slotName, StringTableEntry array, StringTableEntry value); virtual void initializeAsset(); /// Declare Console Object. DECLARE_CONOBJECT(ShapeAsset); bool loadShape(); TSShape* getShape() { return mShape; } Resource getShapeResource() { return mShape; } void SplitSequencePathAndName(String& srcPath, String& srcName); StringTableEntry getShapeFileName() { return mFileName; } StringTableEntry getShapePath() { return mFilePath; } U32 getShapeFilenameHash() { return _StringTable::hashString(mFilePath); } Vector> getMaterialAssets() { return mMaterialAssets; } inline AssetPtr getMaterialAsset(U32 matId) { if (matId >= mMaterialAssets.size()) return nullptr; else return mMaterialAssets[matId]; } void clearMaterialAssets() { mMaterialAssets.clear(); } void addMaterialAssets(AssetPtr matPtr) { mMaterialAssets.push_back(matPtr); } S32 getMaterialCount() { return mMaterialAssets.size(); } S32 getAnimationCount() { return mAnimationAssets.size(); } ShapeAnimationAsset* getAnimation(S32 index); void _onResourceChanged(const Torque::Path& path); ShapeAssetChanged& getChangedSignal() { return mChangeSignal; } ShapeAssetArrayChanged& getChangedArraySignal() { return mChangeArraySignal; } void setShapeFile(const char* pScriptFile); inline StringTableEntry getShapeFile(void) const { return mFileName; }; void setShapeConstructorFile(const char* pScriptFile); inline StringTableEntry getShapeConstructorFile(void) const { return mConstructorFileName; }; inline StringTableEntry getShapeFilePath(void) const { return mFilePath; }; inline StringTableEntry getShapeConstructorFilePath(void) const { return mConstructorFilePath; }; static U32 getAssetByFilename(StringTableEntry fileName, AssetPtr* shapeAsset); static StringTableEntry getAssetIdByFilename(StringTableEntry fileName); static U32 getAssetById(StringTableEntry assetId, AssetPtr* shapeAsset); #ifdef TORQUE_TOOLS const char* generateCachedPreviewImage(S32 resolution); #endif protected: virtual void onAssetRefresh(void); static bool setShapeFile(void* obj, StringTableEntry index, StringTableEntry data) { static_cast(obj)->setShapeFile(data); return false; } static const char* getShapeFile(void* obj, const char* data) { return static_cast(obj)->getShapeFile(); } static bool setShapeConstructorFile(void* obj, const char* index, const char* data) { static_cast(obj)->setShapeConstructorFile(data); return false; } static const char* getShapeConstructorFile(void* obj, const char* data) { return static_cast(obj)->getShapeConstructorFile(); } }; #ifdef TORQUE_TOOLS DefineConsoleType(TypeShapeAssetPtr, S32) DefineConsoleType(TypeShapeAssetId, String) //----------------------------------------------------------------------------- // TypeAssetId GuiInspectorField Class //----------------------------------------------------------------------------- class GuiInspectorTypeShapeAssetPtr : public GuiInspectorTypeFileName { typedef GuiInspectorTypeFileName Parent; public: GuiBitmapButtonCtrl* mShapeEdButton; DECLARE_CONOBJECT(GuiInspectorTypeShapeAssetPtr); static void consoleInit(); virtual GuiControl* constructEditControl(); virtual bool updateRects(); }; class GuiInspectorTypeShapeAssetId : public GuiInspectorTypeShapeAssetPtr { typedef GuiInspectorTypeShapeAssetPtr Parent; public: DECLARE_CONOBJECT(GuiInspectorTypeShapeAssetId); static void consoleInit(); }; #endif #pragma region Singular Asset Macros #define DECLARE_SHAPEASSET(className,name,changeFunc) public: \ Resourcem##name;\ StringTableEntry m##name##Name; \ StringTableEntry m##name##AssetId;\ AssetPtr m##name##Asset;\ public: \ const StringTableEntry get##name##File() const { return StringTable->insert(m##name##Name); }\ void set##name##Name(const FileName &_in) { m##name##Name = _in;}\ const AssetPtr & get##name##Asset() const { return m##name##Asset; }\ void set##name##Asset(const AssetPtr &_in) { m##name##Asset = _in;}\ \ bool _set##name(StringTableEntry _in)\ {\ if(m##name##AssetId != _in || m##name##Name != _in)\ {\ if (m##name##Asset.notNull())\ {\ m##name##Asset->getChangedSignal().remove(this, &className::changeFunc);\ }\ if (_in == NULL || _in == StringTable->EmptyString())\ {\ m##name##Name = StringTable->EmptyString();\ m##name##AssetId = StringTable->EmptyString();\ m##name##Asset = NULL;\ m##name = NULL;\ return true;\ }\ \ if (AssetDatabase.isDeclaredAsset(_in))\ {\ m##name##AssetId = _in;\ \ U32 assetState = ShapeAsset::getAssetById(m##name##AssetId, &m##name##Asset);\ \ if (ShapeAsset::Ok == assetState)\ {\ m##name##Name = StringTable->EmptyString();\ }\ }\ else\ {\ StringTableEntry assetId = ShapeAsset::getAssetIdByFilename(_in);\ if (assetId != StringTable->EmptyString())\ {\ m##name##AssetId = assetId;\ if (ShapeAsset::getAssetById(m##name##AssetId, &m##name##Asset) == ShapeAsset::Ok)\ {\ m##name##Name = StringTable->EmptyString();\ }\ }\ else\ {\ m##name##Name = _in;\ m##name##AssetId = StringTable->EmptyString();\ m##name##Asset = NULL;\ }\ }\ }\ if (get##name() != StringTable->EmptyString() && m##name##Asset.notNull())\ {\ m##name = m##name##Asset->getShapeResource();\ \ m##name##Asset->getChangedSignal().notify(this, &className::changeFunc);\ }\ else\ {\ m##name = NULL;\ }\ \ if(get##name() == StringTable->EmptyString())\ return true;\ \ if (m##name##Asset.notNull() && m##name##Asset->getStatus() != ShapeAsset::Ok)\ {\ Con::errorf("%s(%s)::_set%s() - shape asset failure \"%s\" due to [%s]", macroText(className), getName(), macroText(name), _in, ShapeAsset::getAssetErrstrn(m##name##Asset->getStatus()).c_str());\ return false; \ }\ else if (m##name)\ {\ Con::errorf("%s(%s)::_set%s() - Couldn't load shape \"%s\"", macroText(className), getName(), macroText(name), _in);\ return false;\ }\ return true;\ }\ \ const StringTableEntry get##name() const\ {\ if (m##name##Asset && (m##name##Asset->getShapePath() != StringTable->EmptyString()))\ return m##name##Asset->getShapePath();\ else if (m##name##AssetId != StringTable->EmptyString())\ return m##name##AssetId;\ else if (m##name##Name != StringTable->EmptyString())\ return m##name##Name;\ else\ return StringTable->EmptyString();\ }\ Resource get##name##Resource() \ {\ return m##name;\ } #define DECLARE_SHAPEASSET_SETGET(className, name)\ static bool _set##name##Data(void* obj, const char* index, const char* data)\ {\ bool ret = false;\ className* object = static_cast(obj);\ ret = object->_set##name(StringTable->insert(data));\ return ret;\ } #define DECLARE_SHAPEASSET_NET_SETGET(className, name, bitmask)\ static bool _set##name##Data(void* obj, const char* index, const char* data)\ {\ bool ret = false;\ className* object = static_cast(obj);\ ret = object->_set##name(StringTable->insert(data));\ if(ret)\ object->setMaskBits(bitmask);\ return ret;\ } #define DEF_SHAPEASSET_BINDS(className,name)\ DefineEngineMethod(className, get##name, String, (), , "get name")\ {\ return object->get##name(); \ }\ DefineEngineMethod(className, get##name##Asset, String, (), , assetText(name, asset reference))\ {\ return object->m##name##AssetId; \ }\ DefineEngineMethod(className, set##name, bool, (const char* shape), , assetText(name,assignment. first tries asset then flat file.))\ {\ return object->_set##name(StringTable->insert(shape));\ } #define INIT_SHAPEASSET(name) \ m##name##Name = StringTable->EmptyString(); \ m##name##AssetId = StringTable->EmptyString(); \ m##name##Asset = NULL; \ m##name = NULL; #ifdef TORQUE_SHOW_LEGACY_FILE_FIELDS #define INITPERSISTFIELD_SHAPEASSET(name, consoleClass, docs) \ addProtectedField(assetText(name, File), TypeShapeFilename, Offset(m##name##Name, consoleClass), _set##name##Data, & defaultProtectedGetFn, assetText(name, docs)); \ addProtectedField(assetText(name, Asset), TypeShapeAssetId, Offset(m##name##AssetId, consoleClass), _set##name##Data, & defaultProtectedGetFn, assetText(name, asset reference.)); #else #define INITPERSISTFIELD_SHAPEASSET(name, consoleClass, docs) \ addProtectedField(assetText(name, File), TypeShapeFilename, Offset(m##name##Name, consoleClass), _set##name##Data, & defaultProtectedGetFn, assetText(name, docs), AbstractClassRep::FIELD_HideInInspectors); \ addProtectedField(assetText(name, Asset), TypeShapeAssetId, Offset(m##name##AssetId, consoleClass), _set##name##Data, & defaultProtectedGetFn, assetText(name, asset reference.)); #endif // SHOW_LEGACY_FILE_FIELDS #define CLONE_SHAPEASSET(name) \ m##name##Name = other.m##name##Name;\ m##name##AssetId = other.m##name##AssetId;\ m##name##Asset = other.m##name##Asset;\ #define PACKDATA_SHAPEASSET(name)\ if (stream->writeFlag(m##name##Asset.notNull()))\ {\ stream->writeString(m##name##Asset.getAssetId());\ }\ else\ stream->writeString(m##name##Name); #define UNPACKDATA_SHAPEASSET(name)\ if (stream->readFlag())\ {\ m##name##AssetId = stream->readSTString();\ _set##name(m##name##AssetId);\ }\ else\ m##name##Name = stream->readSTString(); #define PACK_SHAPEASSET(netconn, name)\ if (stream->writeFlag(m##name##Asset.notNull()))\ {\ NetStringHandle assetIdStr = m##name##Asset.getAssetId();\ netconn->packNetStringHandleU(stream, assetIdStr);\ }\ else\ stream->writeString(m##name##Name); #define UNPACK_SHAPEASSET(netconn, name)\ if (stream->readFlag())\ {\ m##name##AssetId = StringTable->insert(netconn->unpackNetStringHandleU(stream).getString());\ _set##name(m##name##AssetId);\ }\ else\ m##name##Name = stream->readSTString(); #pragma endregion #pragma region Arrayed Asset Macros #define DECLARE_SHAPEASSET_ARRAY(className,name,max) public: \ static const U32 sm##name##Count = max;\ Resourcem##name[max];\ StringTableEntry m##name##Name[max]; \ StringTableEntry m##name##AssetId[max];\ AssetPtr m##name##Asset[max];\ public: \ const StringTableEntry get##name##File(const U32& index) const { return m##name##Name[index]; }\ void set##name##Name(const FileName &_in, const U32& index) { m##name##Name[index] = _in;}\ const AssetPtr & get##name##Asset(const U32& index) const { return m##name##Asset[index]; }\ void set##name##Asset(const AssetPtr &_in, const U32& index) { m##name##Asset[index] = _in;}\ \ bool _set##name(StringTableEntry _in, const U32& index)\ {\ if(m##name##AssetId[index] != _in || m##name##Name[index] != _in)\ {\ if(index >= sm##name##Count || index < 0)\ return false;\ if (_in == NULL || _in == StringTable->EmptyString())\ {\ m##name##Name[index] = StringTable->EmptyString();\ m##name##AssetId[index] = StringTable->EmptyString();\ m##name##Asset[index] = NULL;\ m##name[index] = NULL;\ return true;\ }\ \ if (AssetDatabase.isDeclaredAsset(_in))\ {\ m##name##AssetId[index] = _in;\ \ U32 assetState = ShapeAsset::getAssetById(m##name##AssetId[index], &m##name##Asset[index]);\ \ if (ShapeAsset::Ok == assetState)\ {\ m##name##Name[index] = StringTable->EmptyString();\ }\ }\ else\ {\ StringTableEntry assetId = ShapeAsset::getAssetIdByFilename(_in);\ if (assetId != StringTable->EmptyString())\ {\ m##name##AssetId[index] = assetId;\ if (ShapeAsset::getAssetById(m##name##AssetId[index], &m##name##Asset[index]) == ShapeAsset::Ok)\ {\ m##name##Name[index] = StringTable->EmptyString();\ }\ }\ else\ {\ m##name##Name[index] = _in;\ m##name##AssetId[index] = StringTable->EmptyString();\ m##name##Asset[index] = NULL;\ }\ }\ }\ if (get##name(index) != StringTable->EmptyString() && m##name##Asset[index].notNull())\ {\ m##name[index] = m##name##Asset[index]->getShapeResource();\ }\ else\ {\ m##name[index] = NULL;\ }\ \ if(get##name(index) == StringTable->EmptyString())\ return true;\ \ if (m##name##Asset[index].notNull() && m##name##Asset[index]->getStatus() != ShapeAsset::Ok)\ {\ Con::errorf("%s(%s)::_set%s(%i) - shape asset failure \"%s\" due to [%s]", macroText(className), getName(), macroText(name), index, _in, ShapeAsset::getAssetErrstrn(m##name##Asset[index]->getStatus()).c_str());\ return false; \ }\ else if (bool(m##name[index]) == NULL)\ {\ Con::errorf("%s(%s)::_set%s(%i) - Couldn't load shape \"%s\"", macroText(className), getName(), macroText(name), index, _in);\ return false; \ }\ return true;\ }\ \ const StringTableEntry get##name(const U32& index) const\ {\ if (m##name##Asset[index] && (m##name##Asset[index]->getShapePath() != StringTable->EmptyString()))\ return m##name##Asset[index]->getShapePath();\ else if (m##name##AssetId[index] != StringTable->EmptyString())\ return m##name##AssetId[index];\ else if (m##name##Name[index] != StringTable->EmptyString())\ return StringTable->insert(m##name##Name[index]);\ else\ return StringTable->EmptyString();\ }\ Resource get##name##Resource(const U32& index) \ {\ if(index >= sm##name##Count || index < 0)\ return ResourceManager::get().load( "" );\ return m##name[index];\ } #define DECLARE_SHAPEASSET_ARRAY_SETGET(className, name)\ static bool _set##name##Data(void* obj, const char* index, const char* data)\ {\ if (!index) return false;\ U32 idx = dAtoi(index);\ if (idx >= sm##name##Count)\ return false;\ bool ret = false;\ className* object = static_cast(obj);\ ret = object->_set##name(StringTable->insert(data), idx);\ return ret;\ } #define DECLARE_SHAPEASSET_ARRAY_NET_SETGET(className, name, bitmask)\ static bool _set##name##Data(void* obj, const char* index, const char* data)\ {\ if (!index) return false;\ U32 idx = dAtoi(index);\ if (idx >= sm##name##Count)\ return false;\ bool ret = false;\ className* object = static_cast(obj);\ ret = object->_set##name(StringTable->insert(data), idx);\ if(ret)\ object->setMaskBits(bitmask);\ return ret;\ } #define DEF_SHAPEASSET_ARRAY_BINDS(className,name)\ DefineEngineMethod(className, get##name, String, (S32 index), , "get name")\ {\ return object->get##name(index); \ }\ DefineEngineMethod(className, get##name##Asset, String, (S32 index), , assetText(name, asset reference))\ {\ if(index >= className::sm##name##Count || index < 0)\ return "";\ return object->m##name##AssetId[index]; \ }\ DefineEngineMethod(className, set##name, bool, (const char* shape, S32 index), , assetText(name,assignment. first tries asset then flat file.))\ {\ return object->_set##name(StringTable->insert(shape), index);\ } #define INIT_SHAPEASSET_ARRAY(name, index) \ {\ m##name##Name[index] = StringTable->EmptyString(); \ m##name##AssetId[index] = StringTable->EmptyString(); \ m##name##Asset[index] = NULL; \ m##name[index] = NULL;\ } #ifdef TORQUE_SHOW_LEGACY_FILE_FIELDS #define INITPERSISTFIELD_SHAPEASSET_ARRAY(name, arraySize, consoleClass, docs) \ addProtectedField(assetText(name, File), TypeShapeFilename, Offset(m##name##Name, consoleClass), _set##name##Data, & defaultProtectedGetFn, arraySize, assetText(name, docs)); \ addProtectedField(assetText(name, Asset), TypeShapeAssetId, Offset(m##name##AssetId, consoleClass), _set##name##Data, & defaultProtectedGetFn, arraySize, assetText(name, asset reference.)); #else #define INITPERSISTFIELD_SHAPEASSET_ARRAY(name, arraySize, consoleClass, docs) \ addProtectedField(assetText(name, File), TypeShapeFilename, Offset(m##name##Name, consoleClass), _set##name##Data, & defaultProtectedGetFn, arraySize, assetText(name, docs), AbstractClassRep::FIELD_HideInInspectors); \ addProtectedField(assetText(name, Asset), TypeShapeAssetId, Offset(m##name##AssetId, consoleClass), _set##name##Data, & defaultProtectedGetFn, arraySize,assetText(name, asset reference.)); #endif // SHOW_LEGACY_FILE_FIELDS #define CLONE_SHAPEASSET_ARRAY(name, index) \ {\ m##name##Name[index] = other.m##name##Name[index];\ m##name##AssetId[index] = other.m##name##AssetId[index];\ m##name##Asset[index] = other.m##name##Asset[index];\ } #define PACKDATA_SHAPEASSET_ARRAY(name, index)\ if (stream->writeFlag(m##name##Asset[index].notNull()))\ {\ stream->writeString(m##name##Asset[index].getAssetId());\ }\ else\ stream->writeString(m##name##Name[index]); #define UNPACKDATA_SHAPEASSET_ARRAY(name, index)\ if (stream->readFlag())\ {\ m##name##AssetId[index] = stream->readSTString();\ _set##name(m##name##AssetId[index], index);\ }\ else\ m##name##Name[index] = stream->readSTString(); #define PACK_SHAPEASSET_ARRAY(netconn, name, index)\ if (stream->writeFlag(m##name##Asset[index].notNull()))\ {\ NetStringHandle assetIdStr = m##name##Asset[index].getAssetId();\ netconn->packNetStringHandleU(stream, assetIdStr);\ }\ else\ stream->writeString(m##name##Name[index]); #define UNPACK_SHAPEASSET_ARRAY(netconn, name, index)\ if (stream->readFlag())\ {\ m##name##AssetId[index] = StringTable->insert(netconn->unpackNetStringHandleU(stream).getString());\ _set##name(m##name##AssetId[index], index);\ }\ else\ m##name##Name[index] = stream->readSTString(); #pragma endregion #endif