@@ -89,7 +99,8 @@ define([ *
* * @param {Object} options Object with the following properties: - * @param {String} options.name The glTF animation name that identifies the animation. + * @param {String} [options.name] The glTF animation name that identifies the animation. Must be defined ifoptions.id is undefined.
+ * @param {Number} [options.index] The glTF animation index that identifies the animation. Must be defined if options.name is undefined.
* @param {JulianDate} [options.startTime] The scene time to start playing the animation. When this is undefined, the animation starts at the next frame.
* @param {Number} [options.delay=0.0] The delay, in seconds, from startTime to start playing.
* @param {JulianDate} [options.stopTime] The scene time to stop playing the animation. When this is undefined, the animation is played for its full duration.
@@ -101,16 +112,23 @@ define([
*
* @exception {DeveloperError} Animations are not loaded. Wait for the {@link Model#readyPromise} to resolve.
* @exception {DeveloperError} options.name must be a valid animation name.
+ * @exception {DeveloperError} options.index must be a valid animation index.
+ * @exception {DeveloperError} Either options.name or options.index must be defined.
* @exception {DeveloperError} options.speedup must be greater than zero.
*
* @example
- * // Example 1. Add an animation
+ * // Example 1. Add an animation by name
* model.activeAnimations.add({
* name : 'animation name'
* });
*
+ * // Example 2. Add an animation by index
+ * model.activeAnimations.add({
+ * index : 0
+ * });
+ *
* @example
- * // Example 2. Add an animation and provide all properties and events
+ * // Example 3. Add an animation and provide all properties and events
* var startTime = Cesium.JulianDate.now();
*
* var animation = model.activeAnimations.add({
@@ -144,24 +162,38 @@ define([
if (!defined(animations)) {
throw new DeveloperError('Animations are not loaded. Wait for Model.readyPromise to resolve.');
}
+ if (!defined(options.name) && !defined(options.index)) {
+ throw new DeveloperError('Either options.name or options.index must be defined.');
+ }
+ if (defined(options.speedup) && (options.speedup <= 0.0)) {
+ throw new DeveloperError('options.speedup must be greater than zero.');
+ }
+ if (defined(options.index) && (options.index >= animations.length || options.index < 0)) {
+ throw new DeveloperError('options.index must be a valid animation index.');
+ }
//>>includeEnd('debug');
- var animation = animations[options.name];
+ if (defined(options.index)) {
+ return add(this, options.index, options);
+ }
- //>>includeStart('debug', pragmas.debug);
- if (!defined(animation)) {
- throw new DeveloperError('options.name must be a valid animation name.');
+ // Find the index of the animation with the given name
+ var index;
+ var length = animations.length;
+ for (var i = 0; i < length; ++i) {
+ if (animations[i].name === options.name) {
+ index = i;
+ break;
+ }
}
- if (defined(options.speedup) && (options.speedup <= 0.0)) {
- throw new DeveloperError('options.speedup must be greater than zero.');
+ //>>includeStart('debug', pragmas.debug);
+ if (!defined(index)) {
+ throw new DeveloperError('options.name must be a valid animation name.');
}
//>>includeEnd('debug');
- var scheduledAnimation = new ModelAnimation(options, model, animation);
- this._scheduledAnimations.push(scheduledAnimation);
- this.animationAdded.raiseEvent(model, scheduledAnimation);
- return scheduledAnimation;
+ return add(this, index, options);
};
/**
@@ -203,14 +235,12 @@ define([
}
//>>includeEnd('debug');
- options = clone(options);
-
var scheduledAnimations = [];
- var animationIds = this._model._animationIds;
- var length = animationIds.length;
+ var model = this._model;
+ var animations = model._runtime.animations;
+ var length = animations.length;
for (var i = 0; i < length; ++i) {
- options.name = animationIds[i];
- scheduledAnimations.push(this.add(options));
+ scheduledAnimations.push(add(this, i, options));
}
return scheduledAnimations;
};
diff --git a/Specs/Scene/ModelSpec.js b/Specs/Scene/ModelSpec.js
index 366752e5853..7ae7ba9e338 100644
--- a/Specs/Scene/ModelSpec.js
+++ b/Specs/Scene/ModelSpec.js
@@ -1135,10 +1135,10 @@ defineSuite([
var spyAdd = jasmine.createSpy('listener');
animations.animationAdded.addEventListener(spyAdd);
var a = animations.add({
- name : 1
+ name : 'animation_1'
});
expect(a).toBeDefined();
- expect(a.name).toEqual(1);
+ expect(a.name).toEqual('animation_1');
expect(a.startTime).not.toBeDefined();
expect(a.delay).toEqual(0.0);
expect(a.stopTime).not.toBeDefined();
@@ -1166,6 +1166,41 @@ defineSuite([
animations.animationRemoved.removeEventListener(spyRemove);
});
+ it('adds an animation by index', function() {
+ var animations = animBoxesModel.activeAnimations;
+ expect(animations.length).toEqual(0);
+
+ var spyAdd = jasmine.createSpy('listener');
+ animations.animationAdded.addEventListener(spyAdd);
+ var a = animations.add({
+ index : 1
+ });
+ expect(a).toBeDefined();
+ expect(a.name).toEqual('animation_1');
+ animations.remove(a);
+ });
+
+ it('add throws when name and index are not defined', function() {
+ var m = new Model();
+ expect(function() {
+ return m.activeAnimations.add();
+ }).toThrowDeveloperError();
+ });
+
+ it('add throws when index is invalid', function() {
+ var m = new Model();
+ expect(function() {
+ return m.activeAnimations.add({
+ index : -1
+ });
+ }).toThrowDeveloperError();
+ expect(function() {
+ return m.activeAnimations.add({
+ index : 2
+ });
+ }).toThrowDeveloperError();
+ });
+
it('add throws when model is not loaded', function() {
var m = new Model();
expect(function() {
@@ -1207,7 +1242,7 @@ defineSuite([
var time = JulianDate.fromDate(new Date('January 1, 2014 12:00:00 UTC'));
var animations = animBoxesModel.activeAnimations;
var a = animations.add({
- name : 1,
+ name : 'animation_1',
startTime : time,
removeOnStop : true
});
@@ -1253,7 +1288,7 @@ defineSuite([
var animations = animBoxesModel.activeAnimations;
var a = animations.add({
- name : 1,
+ name : 'animation_1',
startTime : time,
delay : 1.0
});
@@ -1277,7 +1312,7 @@ defineSuite([
var animations = animBoxesModel.activeAnimations;
var a = animations.add({
- name : 1,
+ name : 'animation_1',
startTime : time,
stopTime : stopTime
});
@@ -1301,7 +1336,7 @@ defineSuite([
var time = JulianDate.fromDate(new Date('January 1, 2014 12:00:00 UTC'));
var animations = animBoxesModel.activeAnimations;
var a = animations.add({
- name : 1,
+ name : 'animation_1',
startTime : time,
speedup : 1.5
});
@@ -1326,7 +1361,7 @@ defineSuite([
var time = JulianDate.fromDate(new Date('January 1, 2014 12:00:00 UTC'));
var animations = animBoxesModel.activeAnimations;
var a = animations.add({
- name : 1,
+ name : 'animation_1',
startTime : time,
reverse : true
});
@@ -1353,7 +1388,7 @@ defineSuite([
var time = JulianDate.fromDate(new Date('January 1, 2014 12:00:00 UTC'));
var animations = animBoxesModel.activeAnimations;
var a = animations.add({
- name : 1,
+ name : 'animation_1',
startTime : time,
loop : ModelAnimationLoop.REPEAT
});
@@ -1383,7 +1418,7 @@ defineSuite([
var time = JulianDate.fromDate(new Date('January 1, 2014 12:00:00 UTC'));
var animations = animBoxesModel.activeAnimations;
var a = animations.add({
- name : 1,
+ name : 'animation_1',
startTime : time,
loop : ModelAnimationLoop.MIRRORED_REPEAT
});
@@ -1417,7 +1452,7 @@ defineSuite([
var time = JulianDate.fromDate(new Date('January 1, 2014 12:00:00 UTC'));
var animations = m.activeAnimations;
var a = animations.add({
- name : 1,
+ name : 'animation_1',
startTime : time
});