/
KmlTour.js
182 lines (172 loc) · 5.5 KB
/
KmlTour.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
define([
'../Core/Event',
'../Core/defined'
], function(
Event,
defined
) {
'use strict';
/**
* @alias KMLTour
* @constructor
*
* @param {String} name name parsed from KML
* @param {String} id id parsed from KML
* @param {Array} playlist array with KMLTourFlyTos, KMLTourWaits and KMLTourSoundCues
*/
function KmlTour(name, id) {
/**
* Id of kml gx:Tour entry
*/
this.id = id;
/**
* Tour name
*/
this.name = name;
/**
* Index of current entry from playlist
* @type Number
*/
this.playlistIndex = 0;
/**
* Array of playlist entries
* @type Array
*/
this.playlist = [];
/**
* Event will be called when tour starts to play,
* before any playlist entry starts to play.
* @type Event
*/
this.tourStart = new Event();
/**
* Event will be called when all playlist entries are
* played, or tour playback being canceled.
*
* If tour playback was terminated, event callback will
* be called with terminated=true parameter.
* @type Event
*/
this.tourEnd = new Event();
/**
* Event will be called when entry from playlist starts to play.
*
* Event callback will be called with curent entry as first parameter.
* @type Event
*/
this.entryStart = new Event();
/**
* Event will be called when entry from playlist ends to play.
*
* Event callback will be called with following parameters:
* 1. entry - entry
* 2. terminated - true if playback was terminated by calling {@link KmlTour#stop}
* @type Event
*/
this.entryEnd = new Event();
this._activeEntries = [];
}
/**
* Add entry to this tour playlist.
*
* @param {KmlTourFlyTo|KmlTourWait} entry an entry to add to the playlist.
*/
KmlTour.prototype.addPlaylistEntry = function(entry) {
this.playlist.push(entry);
};
/**
* Play this tour.
*
* @param {Viewer} viewer viewer widget.
* @param {Object} [cameraOptions] these options will be merged with {@link Camera#flyTo}
* options for FlyTo playlist entries.
*/
KmlTour.prototype.play = function(viewer, cameraOptions) {
this.tourStart.raiseEvent();
var tour = this;
playEntry.call(this, viewer, cameraOptions, function(terminated) {
tour.playlistIndex = 0;
// Stop nonblocking entries
if (!terminated) {
cancelAllEntries(tour._activeEntries);
}
tour.tourEnd.raiseEvent(terminated);
});
};
/**
* Stop curently playing tour.
*/
KmlTour.prototype.stop = function() {
cancelAllEntries(this._activeEntries);
};
/**
* Stop all activeEntries.
* @param {Array} activeEntries
*/
function cancelAllEntries(activeEntries) {
for(var entry = activeEntries.pop(); entry !== undefined; entry = activeEntries.pop()) {
entry.stop();
}
}
/**
* Play playlist entry.
* This function is called recursevly with playNext
* and iterates over all entries from playlist.
*
* @param {ViewerWidget} viewer Cesium viewer.
* @param {Object} cameraOptions see {@link Camera#flyTo}.
* @param {Function} allDone a function will be called when all entries from playlist
* being played or user call {@link KmlTour#stop}.
*/
function playEntry(viewer, cameraOptions, allDone) {
var entry = this.playlist[this.playlistIndex];
if (entry) {
var _playNext = playNext.bind(this, viewer, cameraOptions, allDone);
this._activeEntries.push(entry);
this.entryStart.raiseEvent(entry);
if (entry.blocking) {
entry.play(_playNext, viewer.scene.camera, cameraOptions);
}
else {
var tour = this;
entry.play(function() {
tour.entryEnd.raiseEvent(entry);
var indx = tour._activeEntries.indexOf(entry);
if (indx >= 0) {
tour._activeEntries.splice(indx, 1);
}
});
_playNext(viewer, cameraOptions, allDone);
}
}
else if(defined(allDone)) {
allDone(false);
}
}
/**
* Increment playlistIndex and call playEntry
* if terminated isn't true.
*
* @param {ViewerWidget} viewer passed for recursion.
* @param {Object} cameraOptions passed for recursion.
* @param {Function} allDone passed for recursion.
* @param {Boolean} terminated true if active entry was terminated,
* and the whole tour should be terminated.
*/
function playNext(viewer, cameraOptions, allDone, terminated) {
var entry = this.playlist[this.playlistIndex];
this.entryEnd.raiseEvent(entry, terminated);
if (terminated) {
allDone(terminated);
}
else {
var indx = this._activeEntries.indexOf(entry);
if (indx >= 0) {
this._activeEntries.splice(indx, 1);
}
this.playlistIndex++;
playEntry.call(this, viewer, cameraOptions, allDone);
}
}
return KmlTour;
});