-
Notifications
You must be signed in to change notification settings - Fork 3.5k
/
ModelAnimation.js
247 lines (230 loc) · 7.69 KB
/
ModelAnimation.js
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
239
240
241
242
243
244
245
246
247
/*global define*/
define([
'../Core/defaultValue',
'../Core/defineProperties',
'../Core/Event',
'../Core/JulianDate',
'./ModelAnimationLoop',
'./ModelAnimationState'
], function(
defaultValue,
defineProperties,
Event,
JulianDate,
ModelAnimationLoop,
ModelAnimationState) {
'use strict';
/**
* An active glTF animation. A glTF asset can contain animations. An active animation
* is an animation that is currently playing or scheduled to be played because it was
* added to a model's {@link ModelAnimationCollection}. An active animation is an
* instance of an animation; for example, there can be multiple active animations
* for the same glTF animation, each with a different start time.
* <p>
* Create this by calling {@link ModelAnimationCollection#add}.
* </p>
*
* @alias ModelAnimation
* @internalConstructor
*
* @see ModelAnimationCollection#add
*/
function ModelAnimation(options, model, runtimeAnimation) {
this._name = options.name;
this._startTime = JulianDate.clone(options.startTime);
this._delay = defaultValue(options.delay, 0.0); // in seconds
this._stopTime = options.stopTime;
/**
* When <code>true</code>, the animation is removed after it stops playing.
* This is slightly more efficient that not removing it, but if, for example,
* time is reversed, the animation is not played again.
*
* @type {Boolean}
* @default false
*/
this.removeOnStop = defaultValue(options.removeOnStop, false);
this._speedup = defaultValue(options.speedup, 1.0);
this._reverse = defaultValue(options.reverse, false);
this._loop = defaultValue(options.loop, ModelAnimationLoop.NONE);
/**
* The event fired when this animation is started. This can be used, for
* example, to play a sound or start a particle system, when the animation starts.
* <p>
* This event is fired at the end of the frame after the scene is rendered.
* </p>
*
* @type {Event}
* @default new Event()
*
* @example
* animation.start.addEventListener(function(model, animation) {
* console.log('Animation started: ' + animation.name);
* });
*/
this.start = new Event();
/**
* The event fired when on each frame when this animation is updated. The
* current time of the animation, relative to the glTF animation time span, is
* passed to the event, which allows, for example, starting new animations at a
* specific time relative to a playing animation.
* <p>
* This event is fired at the end of the frame after the scene is rendered.
* </p>
*
* @type {Event}
* @default new Event()
*
* @example
* animation.update.addEventListener(function(model, animation, time) {
* console.log('Animation updated: ' + animation.name + '. glTF animation time: ' + time);
* });
*/
this.update = new Event();
/**
* The event fired when this animation is stopped. This can be used, for
* example, to play a sound or start a particle system, when the animation stops.
* <p>
* This event is fired at the end of the frame after the scene is rendered.
* </p>
*
* @type {Event}
* @default new Event()
*
* @example
* animation.stop.addEventListener(function(model, animation) {
* console.log('Animation stopped: ' + animation.name);
* });
*/
this.stop = new Event();
this._state = ModelAnimationState.STOPPED;
this._runtimeAnimation = runtimeAnimation;
// Set during animation update
this._computedStartTime = undefined;
this._duration = undefined;
// To avoid allocations in ModelAnimationCollection.update
var that = this;
this._raiseStartEvent = function() {
that.start.raiseEvent(model, that);
};
this._updateEventTime = 0.0;
this._raiseUpdateEvent = function() {
that.update.raiseEvent(model, that, that._updateEventTime);
};
this._raiseStopEvent = function() {
that.stop.raiseEvent(model, that);
};
}
defineProperties(ModelAnimation.prototype, {
/**
* The glTF animation name that identifies this animation.
*
* @memberof ModelAnimation.prototype
*
* @type {String}
* @readonly
*/
name : {
get : function() {
return this._name;
}
},
/**
* The scene time to start playing this animation. When this is <code>undefined</code>,
* the animation starts at the next frame.
*
* @memberof ModelAnimation.prototype
*
* @type {JulianDate}
* @readonly
*
* @default undefined
*/
startTime : {
get : function() {
return this._startTime;
}
},
/**
* The delay, in seconds, from {@link ModelAnimation#startTime} to start playing.
*
* @memberof ModelAnimation.prototype
*
* @type {Number}
* @readonly
*
* @default undefined
*/
delay : {
get : function() {
return this._delay;
}
},
/**
* The scene time to stop playing this animation. When this is <code>undefined</code>,
* the animation is played for its full duration and perhaps repeated depending on
* {@link ModelAnimation#loop}.
*
* @memberof ModelAnimation.prototype
*
* @type {JulianDate}
* @readonly
*
* @default undefined
*/
stopTime : {
get : function() {
return this._stopTime;
}
},
/**
* Values greater than <code>1.0</code> increase the speed that the animation is played relative
* to the scene clock speed; values less than <code>1.0</code> decrease the speed. A value of
* <code>1.0</code> plays the animation at the speed in the glTF animation mapped to the scene
* clock speed. For example, if the scene is played at 2x real-time, a two-second glTF animation
* will play in one second even if <code>speedup</code> is <code>1.0</code>.
*
* @memberof ModelAnimation.prototype
*
* @type {Number}
* @readonly
*
* @default 1.0
*/
speedup : {
get : function() {
return this._speedup;
}
},
/**
* When <code>true</code>, the animation is played in reverse.
*
* @memberof ModelAnimation.prototype
*
* @type {Boolean}
* @readonly
*
* @default false
*/
reverse : {
get : function() {
return this._reverse;
}
},
/**
* Determines if and how the animation is looped.
*
* @memberof ModelAnimation.prototype
*
* @type {ModelAnimationLoop}
* @readonly
*
* @default {@link ModelAnimationLoop.NONE}
*/
loop : {
get : function() {
return this._loop;
}
}
});
return ModelAnimation;
});