aboutsummaryrefslogtreecommitdiff
path: root/APEX_1.4/include/emitter/ModuleEmitter.h
blob: 3cde6caead910b43610530cacaddae9edf184715 (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
//
// 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 MODULE_EMITTER_H
#define MODULE_EMITTER_H

#include "Apex.h"

namespace nvidia
{
namespace apex
{


PX_PUSH_PACK_DEFAULT

class EmitterAsset;
class EmitterAssetAuthoring;

class GroundEmitterAsset;
class GroundEmitterAssetAuthoring;

class ImpactEmitterAsset;
class ImpactEmitterAssetAuthoring;


/**
\brief An APEX Module that provides generic Emitter classes
*/
class ModuleEmitter : public Module
{
protected:
	virtual ~ModuleEmitter() {}

public:

	/// get rate scale. Rate parameter in all emitters will be multiplied by rate scale.
	virtual float 	getRateScale() const = 0;
	
	/// get density scale. Density parameter in all emitters except ground emitters will be multiplied by density scale.
	virtual float 	getDensityScale() const = 0;
	
	/// get ground density scale. Density parameter in all ground emitters will be multiplied by ground density scale.
	virtual float 	getGroundDensityScale() const = 0;

	/// set rate scale. Rate parameter in all module emitters will be multiplied by rate scale.
	virtual void 	setRateScale(float rateScale) = 0;

	/// set density scale. Density parameter in all emitters except ground emitters will be multiplied by density scale.
	virtual void 	setDensityScale(float densityScale) = 0;

	/// set ground density scale. Density parameter in all ground emitters will be multiplied by ground density scale.
	virtual void 	setGroundDensityScale(float groundDensityScale) = 0;
};



PX_POP_PACK

}
} // end namespace nvidia

#endif // MODULE_EMITTER_H