aboutsummaryrefslogtreecommitdiff
path: root/APEX_1.4/include/emitter/EmitterLodParamDesc.h
blob: 96d1e52ee5987f667f16ca3cd0f29c12ae6c28e2 (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
/*
 * 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 EMITTER_LOD_PARAM_DESC_H
#define EMITTER_LOD_PARAM_DESC_H

#include "Apex.h"

namespace nvidia
{
namespace apex
{


PX_PUSH_PACK_DEFAULT

///LOD parameters fro emitters
class EmitterLodParamDesc : public ApexDesc
{
public:
	float  maxDistance;        ///< Objects greater than this distance from the player will be culled more aggressively
	float  distanceWeight;     ///< Weight given to distance parameter in LOD function
	float  speedWeight;        ///< Weight given to velocity parameter in LOD function
	float  lifeWeight;         ///< Weight given to life remain parameter in LOD function
	float  separationWeight;   ///< Weight given to separation parameter in LOD function
	float  bias;               ///< Bias given to objects spawned by this emitter, relative to other emitters in the same IOS

	/**
	\brief constructor sets to default.
	*/
	PX_INLINE EmitterLodParamDesc() : ApexDesc()
	{
		init();
	}

	/**
	\brief sets members to default values.
	*/
	PX_INLINE void setToDefault()
	{
		ApexDesc::setToDefault();
		init();
	}

	/**
	\brief checks if this is a valid descriptor.
	*/
	PX_INLINE bool isValid() const
	{
		if (distanceWeight < 0.0f || speedWeight < 0.0f || lifeWeight < 0.0f)
		{
			return false;
		}
		if (separationWeight < 0.0f || maxDistance < 0.0f || bias < 0.0f)
		{
			return false;
		}
		return ApexDesc::isValid();
	}

	/**
	\brief enum of manifest versions
	*/
	enum ManifestVersions
	{
		initial,

		count,
		current = count - 1
	};

private:

	PX_INLINE void init()
	{
		// These defaults give you pure distance based LOD weighting
		maxDistance = 0.0f;
		distanceWeight = 1.0f;
		speedWeight = 0.0f;
		lifeWeight = 0.0f;
		separationWeight = 0.0f;
		bias = 1.0f;
	}
};


PX_POP_PACK

}
} // end namespace nvidia

#endif // EMITTER_LOD_PARAM_DESC_H