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
|
/*
* 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 FORCE_FIELD_ACTOR_H
#define FORCE_FIELD_ACTOR_H
#include "Apex.h"
namespace nvidia
{
namespace apex
{
PX_PUSH_PACK_DEFAULT
class ForceFieldAsset;
class ForceFieldAssetParams;
/**
\brief ForceField Actor
*/
class ForceFieldActor : public Actor
{
protected:
virtual ~ForceFieldActor() {}
public:
/**
Return true if the force field actor is enabled.
*/
virtual bool isEnable() = 0;
/**
Disable force field actor. Default status is enable. Can switch it freely.
A disabled explosion actor still exists there, but has no effect to the scene.
*/
virtual bool disable() = 0;
/**
Enable force field actor. Default status is enable. Can switch it freely.
A disabled explosion actor still exists there, but has no effect to the scene.
*/
virtual bool enable() = 0;
/**
Gets location and orientation of the force field.
*/
virtual PxMat44 getPose() const = 0;
/**
Sets location and orientation of the force field.
*/
virtual void setPose(const PxMat44& pose) = 0;
/**
Gets the force field actor's scale.
*/
PX_DEPRECATED virtual float getScale() const = 0;
/**
Sets the force field actor's scale. (0.0f, +inf)
*/
PX_DEPRECATED virtual void setScale(float scale) = 0;
/**
Gets the force field actor's scale.
*/
PX_DEPRECATED virtual float getCurrentScale() const = 0;
/**
Sets the force field actor's scale. (0.0f, +inf)
*/
PX_DEPRECATED virtual void setCurrentScale(float scale) = 0;
/**
Retrieves the name string for the force field actor.
*/
virtual const char* getName() const = 0;
/**
Set a name string for the force field actor that can be retrieved with getName().
*/
virtual void setName(const char* name) = 0;
/**
Set strength for the force field actor.
*/
virtual void setStrength(const float strength) = 0;
/**
Set lifetime for the force field actor.
*/
virtual void setLifetime(const float lifetime) = 0;
/**
Set falloff type (linear, steep, scurve, custom, none) for the force field actor.
Only works for radial force field types.
*/
PX_DEPRECATED virtual void setFalloffType(const char* type) = 0;
/**
Set falloff multiplier for the force field actor.
Only works for radial force field types.
*/
PX_DEPRECATED virtual void setFalloffMultiplier(const float multiplier) = 0;
/**
Returns the asset the actor has been created from.
*/
virtual ForceFieldAsset* getForceFieldAsset() const = 0;
};
PX_POP_PACK
} // namespace apex
} // namespace nvidia
#endif // FORCE_FIELD_ACTOR_H
|