Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Expands/Cleans asset functionality #2356

Open
wants to merge 9 commits into
base: development
Choose a base branch
from
Open
28 changes: 26 additions & 2 deletions Engine/source/T3D/assets/ComponentAsset.cpp
Original file line number Diff line number Diff line change
Expand Up @@ -124,7 +124,8 @@ void ComponentAsset::initPersistFields()
addField("componentType", TypeString, Offset(mComponentType, ComponentAsset), "The category of the component for organizing in the editor.");
addField("description", TypeString, Offset(mDescription, ComponentAsset), "Simple description of the component.");

addField("scriptFile", TypeString, Offset(mScriptFile, ComponentAsset), "A script file with additional scripted functionality for this component.");
addProtectedField("scriptFile", TypeAssetLooseFilePath, Offset(mScriptFile, ComponentAsset),
&setScriptFile, &getScriptFile, "A script file with additional scripted functionality for this component.");
}

//------------------------------------------------------------------------------
Expand All @@ -137,12 +138,35 @@ void ComponentAsset::copyTo(SimObject* object)

void ComponentAsset::initializeAsset()
{
mScriptFile = expandAssetFilePath(mScriptFile);

if(Platform::isFile(mScriptFile))
Con::executeFile(mScriptFile, false, false);
}

void ComponentAsset::onAssetRefresh()
{
mScriptFile = expandAssetFilePath(mScriptFile);

if (Platform::isFile(mScriptFile))
Con::executeFile(mScriptFile, false, false);
}
}

void ComponentAsset::setScriptFile(const char* pScriptFile)
{
// Sanity!
AssertFatal(pScriptFile != NULL, "Cannot use a NULL script file.");

// Fetch image file.
pScriptFile = StringTable->insert(pScriptFile);

// Ignore no change,
if (pScriptFile == mScriptFile)
return;

// Update.
mScriptFile = getOwned() ? expandAssetFilePath(pScriptFile) : StringTable->insert(pScriptFile);

// Refresh the asset.
refreshAsset();
}
6 changes: 6 additions & 0 deletions Engine/source/T3D/assets/ComponentAsset.h
Original file line number Diff line number Diff line change
Expand Up @@ -77,9 +77,15 @@ class ComponentAsset : public AssetBase

AssetDefinition* getAssetDefinition() { return mpAssetDefinition; }

void setScriptFile(const char* pScriptFile);
inline StringTableEntry getScriptFile(void) const { return mScriptFile; };

protected:
virtual void initializeAsset(void);
virtual void onAssetRefresh(void);

static bool setScriptFile(void *obj, const char *index, const char *data) { static_cast<ComponentAsset*>(obj)->setScriptFile(data); return false; }
static const char* getScriptFile(void* obj, const char* data) { return static_cast<ComponentAsset*>(obj)->getScriptFile(); }
};

DefineConsoleType(TypeComponentAssetPtr, ComponentAsset)
Expand Down
167 changes: 167 additions & 0 deletions Engine/source/T3D/assets/CppAsset.cpp
Original file line number Diff line number Diff line change
@@ -0,0 +1,167 @@
//-----------------------------------------------------------------------------
// 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 CPP_ASSET_H
#include "CppAsset.h"
#endif

#ifndef _ASSET_MANAGER_H_
#include "assets/assetManager.h"
#endif

#ifndef _CONSOLETYPES_H_
#include "console/consoleTypes.h"
#endif

#ifndef _TAML_
#include "persistence/taml/taml.h"
#endif

#ifndef _ASSET_PTR_H_
#include "assets/assetPtr.h"
#endif

// Debug Profiling.
#include "platform/profiler.h"

//-----------------------------------------------------------------------------

IMPLEMENT_CONOBJECT(CppAsset);

ConsoleType(CppAssetPtr, TypeCppAssetPtr, CppAsset, ASSET_ID_FIELD_PREFIX)

//-----------------------------------------------------------------------------

ConsoleGetType(TypeCppAssetPtr)
{
// Fetch asset Id.
return (*((AssetPtr<CppAsset>*)dptr)).getAssetId();
}

//-----------------------------------------------------------------------------

ConsoleSetType(TypeCppAssetPtr)
{
// Was a single argument specified?
if (argc == 1)
{
// Yes, so fetch field value.
const char* pFieldValue = argv[0];

// Fetch asset pointer.
AssetPtr<CppAsset>* pAssetPtr = dynamic_cast<AssetPtr<CppAsset>*>((AssetPtrBase*)(dptr));

// Is the asset pointer the correct type?
if (pAssetPtr == NULL)
{
// No, so fail.
//Con::warnf("(TypeCppAssetPtr) - Failed to set asset Id '%d'.", pFieldValue);
return;
}

// Set asset.
pAssetPtr->setAssetId(pFieldValue);

return;
}

// Warn.
Con::warnf("(TypeCppAssetPtr) - Cannot set multiple args to a single asset.");
}

//-----------------------------------------------------------------------------

CppAsset::CppAsset() : AssetBase()
{
mCodeFile = StringTable->EmptyString();
mHeaderFile = StringTable->EmptyString();
}

//-----------------------------------------------------------------------------

CppAsset::~CppAsset()
{
// If the asset manager does not own the asset then we own the
// asset definition so delete it.
if (!getOwned())
delete mpAssetDefinition;
}

//-----------------------------------------------------------------------------

void CppAsset::initPersistFields()
{
// Call parent.
Parent::initPersistFields();

addProtectedField("codeFile", TypeAssetLooseFilePath, Offset(mCodeFile, CppAsset),
&setCppFile, &getCppFile, "Path to the cpp file.");

addProtectedField("headerFile", TypeAssetLooseFilePath, Offset(mHeaderFile, CppAsset),
&setHeaderFile, &getHeaderFile, "Path to the h file.");

}

//------------------------------------------------------------------------------

void CppAsset::copyTo(SimObject* object)
{
// Call to parent.
Parent::copyTo(object);
}

void CppAsset::setCppFile(const char* pCppFile)
{
// Sanity!
AssertFatal(pCppFile != NULL, "Cannot use a NULL code file.");

// Fetch image file.
pCppFile = StringTable->insert(pCppFile);

// Ignore no change,
if (pCppFile == mCodeFile)
return;

// Update.
mCodeFile = getOwned() ? expandAssetFilePath(pCppFile) : StringTable->insert(pCppFile);

// Refresh the asset.
refreshAsset();
}

void CppAsset::setHeaderFile(const char* pHeaderFile)
{
// Sanity!
AssertFatal(pHeaderFile != NULL, "Cannot use a NULL header file.");

// Fetch image file.
pHeaderFile = StringTable->insert(pHeaderFile);

// Ignore no change,
if (pHeaderFile == mHeaderFile)
return;

// Update.
mHeaderFile = getOwned() ? expandAssetFilePath(pHeaderFile) : StringTable->insert(pHeaderFile);

// Refresh the asset.
refreshAsset();
}
81 changes: 81 additions & 0 deletions Engine/source/T3D/assets/CppAsset.h
Original file line number Diff line number Diff line change
@@ -0,0 +1,81 @@
//-----------------------------------------------------------------------------
// 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 CPP_ASSET_H
#define CPP_ASSET_H
#pragma once

#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

//-----------------------------------------------------------------------------
class CppAsset : public AssetBase
{
typedef AssetBase Parent;

StringTableEntry mCodeFile;
StringTableEntry mHeaderFile;

public:
CppAsset();
virtual ~CppAsset();

/// Engine.
static void initPersistFields();
virtual void copyTo(SimObject* object);

/// Declare Console Object.
DECLARE_CONOBJECT(CppAsset);

void setCppFile(const char* pCppFile);
inline StringTableEntry getCppFile(void) const { return mCodeFile; };

void setHeaderFile(const char* pHeaderFile);
inline StringTableEntry getHeaderFile(void) const { return mHeaderFile; };

protected:
virtual void initializeAsset(void) {};
virtual void onAssetRefresh(void) {};

static bool setCppFile(void *obj, const char *index, const char *data) { static_cast<CppAsset*>(obj)->setCppFile(data); return false; }
static const char* getCppFile(void* obj, const char* data) { return static_cast<CppAsset*>(obj)->getCppFile(); }

static bool setHeaderFile(void *obj, const char *index, const char *data) { static_cast<CppAsset*>(obj)->setHeaderFile(data); return false; }
static const char* getHeaderFile(void* obj, const char* data) { return static_cast<CppAsset*>(obj)->getHeaderFile(); }
};

DefineConsoleType(TypeCppAssetPtr, CppAsset)

#endif // _ASSET_BASE_H_

Loading