ComponentAsset.h

Public Functions

DefineConsoleType(TypeComponentAssetPtr , ComponentAsset )

 1
 2#pragma once
 3//-----------------------------------------------------------------------------
 4// Copyright (c) 2013 GarageGames, LLC
 5//
 6// Permission is hereby granted, free of charge, to any person obtaining a copy
 7// of this software and associated documentation files (the "Software"), to
 8// deal in the Software without restriction, including without limitation the
 9// rights to use, copy, modify, merge, publish, distribute, sublicense, and/or
10// sell copies of the Software, and to permit persons to whom the Software is
11// furnished to do so, subject to the following conditions:
12//
13// The above copyright notice and this permission notice shall be included in
14// all copies or substantial portions of the Software.
15//
16// THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
17// IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
18// FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
19// AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
20// LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
21// FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS
22// IN THE SOFTWARE.
23//-----------------------------------------------------------------------------
24#ifndef COMPONENT_ASSET_H
25#define COMPONENT_ASSET_H
26
27#ifndef _ASSET_BASE_H_
28#include "assets/assetBase.h"
29#endif
30
31#ifndef _ASSET_DEFINITION_H_
32#include "assets/assetDefinition.h"
33#endif
34
35#ifndef _STRINGUNIT_H_
36#include "string/stringUnit.h"
37#endif
38
39#ifndef _ASSET_FIELD_TYPES_H_
40#include "assets/assetFieldTypes.h"
41#endif
42
43//-----------------------------------------------------------------------------
44class ComponentAsset : public AssetBase
45{
46   typedef AssetBase Parent;
47
48   AssetManager*           mpOwningAssetManager;
49   bool                    mAssetInitialized;
50   AssetDefinition*        mpAssetDefinition;
51   U32                     mAcquireReferenceCount;
52
53   StringTableEntry mComponentName;
54   StringTableEntry mComponentClass;
55   StringTableEntry mFriendlyName;
56   StringTableEntry mComponentType;
57   StringTableEntry mDescription;
58
59public:
60   ComponentAsset();
61   virtual ~ComponentAsset();
62
63   /// Engine.
64   static void initPersistFields();
65   virtual void copyTo(SimObject* object);
66
67   /// Declare Console Object.
68   DECLARE_CONOBJECT(ComponentAsset);
69
70   StringTableEntry getComponentName() { return mComponentName; }
71   StringTableEntry getComponentClass() { return mComponentClass; }
72   StringTableEntry getFriendlyName() { return mFriendlyName; }
73   StringTableEntry getFriendlyType() { return mComponentType; }
74   StringTableEntry getDescription() { return mDescription; }
75
76protected:
77   virtual void            initializeAsset(void) {}
78   virtual void            onAssetRefresh(void) {}
79};
80
81DefineConsoleType(TypeComponentAssetPtr, ComponentAsset)
82
83#endif // _ASSET_BASE_H_
84
85