aboutsummaryrefslogtreecommitdiff
path: root/APEX_1.4/module/particles/include/EffectPackageAssetImpl.h
blob: 17ec14e96acc988dc7f89fb74c1393e71343f1ce (plain) (blame)
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
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
/*
 * Copyright (c) 2008-2015, NVIDIA CORPORATION.  All rights reserved.
 *
 * NVIDIA CORPORATION and its licensors retain all intellectual property
 * and proprietary rights in and to this software, related documentation
 * and any modifications thereto.  Any use, reproduction, disclosure or
 * distribution of this software and related documentation without an express
 * license agreement from NVIDIA CORPORATION is strictly prohibited.
 */


#ifndef PARTICLES_EFFECT_PACKAGE_ASSET_H
#define PARTICLES_EFFECT_PACKAGE_ASSET_H

#include "Apex.h"
#include "ApexUsingNamespace.h"
#include "EffectPackageAsset.h"
#include "EffectPackageActor.h"
#include "ApexSDKHelpers.h"
#include "ModuleParticlesImpl.h"
#include "ApexAssetAuthoring.h"
#include "ApexString.h"
#include "ApexAssetTracker.h"
#include "ApexAuthorableObject.h"
#include "EffectPackageAssetParams.h"
#include "ApexRWLockable.h"

#include "ReadCheck.h"
#include "WriteCheck.h"
#include "ApexAuthorableObject.h"

namespace nvidia
{
namespace particles
{

class EffectPackageActorImpl;
class ModuleParticlesImpl;

class EffectPackageAssetImpl : public EffectPackageAsset, public ApexResourceInterface, public ApexResource, public ApexRWLockable
{
	friend class EffectPackageAssetDummyAuthoring;
public:
	APEX_RW_LOCKABLE_BOILERPLATE

	EffectPackageAssetImpl(ModuleParticlesImpl*, ResourceList&, const char* name);
	EffectPackageAssetImpl(ModuleParticlesImpl*, ResourceList&, NvParameterized::Interface*, const char*);

	~EffectPackageAssetImpl();

	/* Asset */
	const char* 					getName() const
	{
		READ_ZONE();
		return mName.c_str();
	}
	AuthObjTypeID					getObjTypeID() const
	{
		READ_ZONE();
		return mAssetTypeID;
	}
	const char* 					getObjTypeName() const
	{
		READ_ZONE();
		return getClassName();
	}

	uint32_t					forceLoadAssets();

	/* ApexResource */
	virtual void					release();

	/* ApexResourceInterface, ApexResource */
	uint32_t					getListIndex() const
	{
		return m_listIndex;
	}

	void							setListIndex(class ResourceList& list, uint32_t index)
	{
		m_list = &list;
		m_listIndex = index;
	}

	/* EffectPackageAsset specific methods */
	void							releaseEffectPackageActor(EffectPackageActor&);
	const EffectPackageAssetParams&	getEffectPackageParameters() const
	{
		return *mParams;
	}
	float					getDefaultScale() const
	{
		return 1;
	}
	void							destroy();

	const NvParameterized::Interface* getAssetNvParameterized() const
	{
		READ_ZONE();
		return mParams;
	}

	virtual float getDuration() const;
	virtual bool useUniqueRenderVolume() const;

	/**
	 * \brief Releases the ApexAsset but returns the NvParameterized::Interface and *ownership* to the caller.
	 */
	virtual NvParameterized::Interface* releaseAndReturnNvParameterizedInterface()
	{
		WRITE_ZONE();
		NvParameterized::Interface* ret = mParams;
		mParams = NULL;
		release();
		return ret;
	}
	NvParameterized::Interface* getDefaultActorDesc();
	NvParameterized::Interface* getDefaultAssetPreviewDesc();
	virtual Actor* createApexActor(const NvParameterized::Interface& /*parms*/, Scene& /*apexScene*/);
	virtual AssetPreview* createApexAssetPreview(const ::NvParameterized::Interface& /*params*/, AssetPreviewScene* /*previewScene*/)
	{
		WRITE_ZONE();
		PX_ALWAYS_ASSERT();
		return NULL;
	}

	virtual bool isValidForActorCreation(const ::NvParameterized::Interface& /*parms*/, Scene& /*apexScene*/) const
	{
		READ_ZONE();
		return true; // TODO implement this method
	}

	virtual bool isDirty() const
	{
		READ_ZONE();
		return false;
	}

	static AuthObjTypeID			mAssetTypeID;

protected:
	static const char* 				getClassName()
	{
		return PARTICLES_EFFECT_PACKAGE_AUTHORING_TYPE_NAME;
	}

	ModuleParticlesImpl*				mModule;

	ResourceList					mEffectPackageActors;
	ApexSimpleString				mName;
	EffectPackageAssetParams*			mParams;
	EffectPackageActorParams*			mDefaultActorParams;

	void							initializeAssetNameTable();

	friend class ModuleParticlesE;
	friend class EffectPackageActorImpl;
	template <class T_Module, class T_Asset, class T_AssetAuthoring> friend class nvidia::apex::ApexAuthorableObject;
};

#ifndef WITHOUT_APEX_AUTHORING
class EffectPackageAssetAuthoringImpl : public EffectPackageAssetImpl, public ApexAssetAuthoring, public EffectPackageAssetAuthoring
{
public:
	APEX_RW_LOCKABLE_BOILERPLATE

	/* EffectPackageAssetAuthoring */
	EffectPackageAssetAuthoringImpl(ModuleParticlesImpl* m, ResourceList& l) :
		EffectPackageAssetImpl(m, l, "EffectPackageAssetAuthoringImpl") {}

	EffectPackageAssetAuthoringImpl(ModuleParticlesImpl* m, ResourceList& l, const char* name) :
		EffectPackageAssetImpl(m, l, name) {}

	EffectPackageAssetAuthoringImpl(ModuleParticlesImpl* m, ResourceList& l, NvParameterized::Interface* params, const char* name) :
		EffectPackageAssetImpl(m, l, params, name) {}

	~EffectPackageAssetAuthoringImpl() {}

	void							destroy()
	{
		delete this;
	}

	/* AssetAuthoring */
	const char* 					getName() const
	{
		READ_ZONE();
		return EffectPackageAssetImpl::getName();
	}
	const char* 					getObjTypeName() const
	{
		READ_ZONE();
		return EffectPackageAssetImpl::getClassName();
	}
	virtual bool					prepareForPlatform(nvidia::apex::PlatformTag)
	{
		WRITE_ZONE();
		APEX_INVALID_OPERATION("Not Implemented.");
		return false;
	}

	void setToolString(const char* toolName, const char* toolVersion, uint32_t toolChangelist)
	{
		WRITE_ZONE();
		ApexAssetAuthoring::setToolString(toolName, toolVersion, toolChangelist);
	}

	// from ApexAssetAuthoring
	virtual void setToolString(const char* toolString);

	/* ApexResource */
	virtual void					release()
	{
		mModule->mSdk->releaseAssetAuthoring(*this);
	}

	NvParameterized::Interface* getNvParameterized() const
	{
		return (NvParameterized::Interface*)getAssetNvParameterized();
	}
	/**
	 * \brief Releases the ApexAsset but returns the NvParameterized::Interface and *ownership* to the caller.
	 */
	virtual NvParameterized::Interface* releaseAndReturnNvParameterizedInterface()
	{
		WRITE_ZONE();
		NvParameterized::Interface* ret = mParams;
		mParams = NULL;
		release();
		return ret;
	}
};
#endif

}
} // end namespace nvidia

#endif // PARTICLES_EFFECT_PACKAGE_ASSET_H