1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
|
//
// Redistribution and use in source and binary forms, with or without
// modification, are permitted provided that the following conditions
// are met:
// * Redistributions of source code must retain the above copyright
// notice, this list of conditions and the following disclaimer.
// * 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.
// * Neither the name of NVIDIA CORPORATION nor the names of its
// contributors may be used to endorse or promote products derived
// from this software without specific prior written permission.
//
// THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS ``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 OWNER 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.
//
// Copyright (c) 2018 NVIDIA Corporation. All rights reserved.
#ifndef ASSET_H
#define ASSET_H
/*!
\file
\brief class Asset
*/
#include "ApexInterface.h"
#include "ApexSDK.h"
#include "AssetPreviewScene.h"
namespace nvidia
{
namespace apex
{
PX_PUSH_PACK_DEFAULT
/// Usual typedef
typedef const char* PlatformTag;
class Actor;
class AssetPreview;
/**
\brief Base class of all APEX assets
*/
class Asset : public ApexInterface
{
public:
/**
* \brief Returns the name of this deserialized asset
*/
virtual const char* getName() const = 0;
/**
* \brief Returns the ID of the asset's authorable object type.
*
* Every asset will correspond to an APEX authorable object type.
* The module must register those types with the SDK at startup.
*/
virtual AuthObjTypeID getObjTypeID() const = 0;
/**
* \brief Returns the name of this asset's authorable object type
*/
virtual const char* getObjTypeName() const = 0;
/**
* \brief Returns the number of assets force loaded by all of
* this asset's named asset references
*/
virtual uint32_t forceLoadAssets() = 0;
/**
* \brief Returns the default actor descriptor NvParamaterized interface
* Memory ownership stays with this asset. The user may modify the interface values, but they will not persist past another acll to 'getDefaultActorDesc'
* Typically used to create an actor after making small local editing changes.
*/
virtual ::NvParameterized::Interface* getDefaultActorDesc() = 0;
/**
* \brief Returns the default AssetPreview descriptor NvParamaterized interface
*/
virtual ::NvParameterized::Interface* getDefaultAssetPreviewDesc() = 0;
/**
* \brief Returns the asset's NvParamaterized interface
* This cannot be directly modified! It is read only to the user.
*/
virtual const ::NvParameterized::Interface* getAssetNvParameterized() const = 0;
/**
* \brief Creates an Actor representing the Asset in a Scene
*/
virtual Actor* createApexActor(const ::NvParameterized::Interface& actorParams, Scene& apexScene) = 0;
/**
* \brief Creates an Asset Preview for the asset.
*/
virtual AssetPreview* createApexAssetPreview(const ::NvParameterized::Interface& params, AssetPreviewScene* previewScene) = 0;
/**
* \brief Releases the ApexAsset but returns the NvParameterized::Interface and *ownership* to the caller.
*/
virtual NvParameterized::Interface* releaseAndReturnNvParameterizedInterface(void) = 0;
/**
* \brief Returns true if the asset is in a state that is valid for creating an actor.
* \param actorParams parameters of actor to create
* \returns true if call to createApexActor will return true on inputs, false otherwise
*/
virtual bool isValidForActorCreation(const ::NvParameterized::Interface& actorParams, Scene& /*apexScene*/) const = 0;
/**
* \brief Returns true if the parameterized object of the asset has been modified.
*
* This flag will be reset once the parameterized object has been serialized again.
*/
virtual bool isDirty() const = 0;
protected:
virtual ~Asset() {}; // illegal, do not call
};
/**
\brief base class of all APEX asset authoring classes
*/
class AssetAuthoring : public ApexInterface
{
public:
/**
* \brief Returns the name of asset author
*/
virtual const char* getName() const = 0;
/**
* \brief Returns the name of this APEX authorable object type
*/
virtual const char* getObjTypeName() const = 0;
/**
* \brief Prepares a fully authored Asset Authoring object for a specified platform
*/
virtual bool prepareForPlatform(nvidia::apex::PlatformTag) = 0;
/**
* \brief Returns the asset's NvParameterized interface, may return NULL
*/
virtual ::NvParameterized::Interface* getNvParameterized() const = 0;
/**
* \brief Releases the ApexAsset but returns the NvParameterized::Interface and *ownership* to the caller.
*/
virtual NvParameterized::Interface* releaseAndReturnNvParameterizedInterface(void) = 0;
/**
* \brief Generates a string that is stored in the asset with all the relevant information about the build
*
* \param toolName The name of the tool with proper casing, i.e. "Clothing Tool".
* \param toolVersion The version of the tool as a string, can be NULL.
* \param toolChangelist The CL# of the tool, will use internal tools directory CL if 0
*/
virtual void setToolString(const char* toolName, const char* toolVersion, uint32_t toolChangelist) = 0;
};
PX_POP_PACK
}
} // end namespace nvidia::apex
#endif // ASSET_H
|