aboutsummaryrefslogtreecommitdiff
path: root/APEX_1.4/common/include/IofxManagerIntl.h
blob: 5d91256b5c0934c1357f703fbb103dfef4b730d0 (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
/*
 * Copyright (c) 2008-2017, 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 IOFX_MANAGER_INTL_H
#define IOFX_MANAGER_INTL_H

#include "PsArray.h"
#include "PxVec3.h"
#include "PxVec4.h"
#include "PxTaskManager.h"

namespace physx
{
	class PxGpuCopyDescQueue;
}

namespace nvidia
{
namespace apex
{
class IofxAsset;
class RenderVolume;

template <class T>
class ApexMirroredArray;


class IofxManagerDescIntl
{
public:
	IofxManagerDescIntl() :
		iosAssetName(NULL),
		iosOutputsOnDevice(false),
		iosSupportsDensity(false),
		iosSupportsCollision(false),
		iosSupportsUserData(false),
		maxObjectCount(0),
		maxInputCount(0),
		maxInStateCount(0)
	{
	}

	const char* iosAssetName;
	bool		iosOutputsOnDevice;
	bool		iosSupportsDensity;
	bool		iosSupportsCollision;
	bool		iosSupportsUserData;
	uint32_t		maxObjectCount;
	uint32_t		maxInputCount;
	uint32_t		maxInStateCount;
};

/// The IOFX will update the volumeID each simulation step, the IOS must
/// persist this output. IOS provides initial volumeID, based on emitter's
/// preferred volume.
struct IofxActorIDIntl
{
	uint32_t		value;

	PX_CUDA_CALLABLE PX_INLINE IofxActorIDIntl() {}
	PX_CUDA_CALLABLE PX_INLINE explicit IofxActorIDIntl(uint32_t arg)
	{
		value = arg;
	}

	PX_CUDA_CALLABLE PX_INLINE void set(uint16_t volumeID, uint16_t actorClassID)
	{
		value = (uint32_t(volumeID) << 16) | uint32_t(actorClassID);
	}

	PX_CUDA_CALLABLE PX_INLINE uint16_t getVolumeID() const
	{
		return uint16_t(value >> 16);
	}
	PX_CUDA_CALLABLE PX_INLINE void setVolumeID(uint16_t volumeID)
	{
		value &= 0x0000FFFFu;
		value |= (uint32_t(volumeID) << 16);
	}

	PX_CUDA_CALLABLE PX_INLINE uint16_t getActorClassID() const
	{
		return uint16_t(value & 0xFFFFu);
	}
	PX_CUDA_CALLABLE PX_INLINE void setActorClassID(uint16_t actorClassID)
	{
		value &= 0xFFFF0000u;
		value |= uint32_t(actorClassID);
	}

	static const uint16_t NO_VOLUME = 0xFFFFu;
	static const uint16_t IPX_ACTOR = 0xFFFFu;
};


/* IOFX Manager returned pointers for simulation data */
class IosBufferDescIntl
{
public:
	/* All arrays are indexed by input ID */
	ApexMirroredArray<PxVec4>*			pmaPositionMass;
	ApexMirroredArray<PxVec4>*			pmaVelocityLife;
	ApexMirroredArray<PxVec4>*			pmaCollisionNormalFlags;
	ApexMirroredArray<float>*			pmaDensity;
	ApexMirroredArray<IofxActorIDIntl>*	pmaActorIdentifiers;
	ApexMirroredArray<uint32_t>*			pmaInStateToInput;
	ApexMirroredArray<uint32_t>*			pmaOutStateToInput;

	ApexMirroredArray<uint32_t>*			pmaUserData;

	//< Value in inStateToInput field indicates a dead particle, input to IOFX
	static const uint32_t NOT_A_PARTICLE = 0xFFFFFFFFu;

	//< Flag in inStateToInput field indicates a new particle, input to IOFX
	static const uint32_t NEW_PARTICLE_FLAG = 0x80000000u;
};

// This is a representative of uint4 on host
struct IofxSlice
{
	uint32_t x, y, z, w;
};

typedef void (*EventCallback)(void*);

class IofxManagerCallbackIntl
{
public:
	virtual void operator()(void* stream = NULL) = 0;
};

class IofxManagerClientIntl
{
public:
	struct Params
	{
		float objectScale;

		Params()
		{
			setDefaults();
		}

		void setDefaults()
		{
			objectScale = 1.0f;
		}
	};
	virtual void getParams(IofxManagerClientIntl::Params& params) const = 0;
	virtual void setParams(const IofxManagerClientIntl::Params& params) = 0;
};


class IofxManagerIntl
{
public:
	//! An IOS Actor will call this once, at creation
	virtual void createSimulationBuffers(IosBufferDescIntl& outDesc) = 0;

	//! An IOS actor will call this once, when it creates its fluid simulation
	virtual void setSimulationParameters(float radius, const PxVec3& up, float gravity, float restDensity) = 0;

	//! An IOS Actor will call this method after each simulation step
	virtual void updateEffectsData(float deltaTime, uint32_t numObjects, uint32_t maxInputID, uint32_t maxStateID, void* extraData = 0) = 0;

	//! An IOS Actor will call this method at the start of each step IOFX will run
	virtual PxTaskID getUpdateEffectsTaskID(PxTaskID) = 0;

	virtual uint16_t getActorClassID(IofxManagerClientIntl* client, uint16_t meshID) = 0;

	virtual IofxManagerClientIntl* createClient(nvidia::apex::IofxAsset* asset, const IofxManagerClientIntl::Params& params) = 0;
	virtual void releaseClient(IofxManagerClientIntl* client) = 0;

	virtual uint16_t getVolumeID(nvidia::apex::RenderVolume* vol) = 0;

	//! Triggers the IOFX Manager to copy host buffers to the device
	//! This is intended for use in an IOS post-update task, if they
	//! need the output buffers on the device.
	virtual void outputHostToDevice(PxGpuCopyDescQueue& copyQueue) = 0;
	
	//! IofxManagerCallbackIntl will be called before Iofx computations
	virtual void setOnStartCallback(IofxManagerCallbackIntl*) = 0;
	//! IofxManagerCallbackIntl will be called after Iofx computations
	virtual void setOnFinishCallback(IofxManagerCallbackIntl*) = 0;

	//! Called when IOS is being deleted
	virtual void release() = 0;

	//get bounding box
	virtual PxBounds3 getBounds() const = 0;

protected:
	virtual ~IofxManagerIntl() {}
};


}
} // end namespace nvidia::apex

#endif // IOFX_MANAGER_INTL_H