annotate interfaces/ape.js @ 1341:bbb6462cf446

Moved interfaces into their own sub-directory
author Nicholas Jillings <nickjillings@users.noreply.github.com>
date Wed, 13 Jan 2016 09:34:46 +0000
parents
children 92f26057b934
rev   line source
nickjillings@1341 1 /**
nickjillings@1341 2 * ape.js
nickjillings@1341 3 * Create the APE interface
nickjillings@1341 4 */
nickjillings@1341 5
nickjillings@1341 6
nickjillings@1341 7 // Once this is loaded and parsed, begin execution
nickjillings@1341 8 loadInterface();
nickjillings@1341 9
nickjillings@1341 10 function loadInterface() {
nickjillings@1341 11
nickjillings@1341 12 // Get the dimensions of the screen available to the page
nickjillings@1341 13 var width = window.innerWidth;
nickjillings@1341 14 var height = window.innerHeight;
nickjillings@1341 15
nickjillings@1341 16 // The injection point into the HTML page
nickjillings@1341 17 interfaceContext.insertPoint = document.getElementById("topLevelBody");
nickjillings@1341 18 var testContent = document.createElement('div');
nickjillings@1341 19
nickjillings@1341 20 testContent.id = 'testContent';
nickjillings@1341 21
nickjillings@1341 22 // Bindings for interfaceContext
nickjillings@1341 23 interfaceContext.checkAllPlayed = function()
nickjillings@1341 24 {
nickjillings@1341 25 hasBeenPlayed = audioEngineContext.checkAllPlayed();
nickjillings@1341 26 if (hasBeenPlayed.length > 0) // if a fragment has not been played yet
nickjillings@1341 27 {
nickjillings@1341 28 str = "";
nickjillings@1341 29 if (hasBeenPlayed.length > 1) {
nickjillings@1341 30 for (var i=0; i<hasBeenPlayed.length; i++) {
nickjillings@1341 31 str = str + hasBeenPlayed[i];
nickjillings@1341 32 if (i < hasBeenPlayed.length-2){
nickjillings@1341 33 str += ", ";
nickjillings@1341 34 } else if (i == hasBeenPlayed.length-2) {
nickjillings@1341 35 str += " or ";
nickjillings@1341 36 }
nickjillings@1341 37 }
nickjillings@1341 38 alert('You have not played fragments ' + str + ' yet. Please listen, rate and comment all samples before submitting.');
nickjillings@1341 39 } else {
nickjillings@1341 40 alert('You have not played fragment ' + hasBeenPlayed[0] + ' yet. Please listen, rate and comment all samples before submitting.');
nickjillings@1341 41 }
nickjillings@1341 42 return false;
nickjillings@1341 43 }
nickjillings@1341 44 return true;
nickjillings@1341 45 };
nickjillings@1341 46
nickjillings@1341 47 interfaceContext.checkAllMoved = function() {
nickjillings@1341 48 var state = true;
nickjillings@1341 49 var str = 'You have not moved the following sliders. ';
nickjillings@1341 50 for (var i=0; i<this.interfaceSliders.length; i++)
nickjillings@1341 51 {
nickjillings@1341 52 var interfaceTID = [];
nickjillings@1341 53 for (var j=0; j<this.interfaceSliders[i].metrics.length; j++)
nickjillings@1341 54 {
nickjillings@1341 55 if (this.interfaceSliders[i].metrics[j].wasMoved == false)
nickjillings@1341 56 {
nickjillings@1341 57 state = false;
nickjillings@1341 58 interfaceTID.push(j);
nickjillings@1341 59 }
nickjillings@1341 60 }
nickjillings@1341 61 if (interfaceTID.length != 0)
nickjillings@1341 62 {
nickjillings@1341 63 var interfaceName = this.interfaceSliders[i].interfaceObject.title;
nickjillings@1341 64 if (interfaceName == undefined) {
nickjillings@1341 65 str += 'On axis '+String(i+1)+' you must move ';
nickjillings@1341 66 } else {
nickjillings@1341 67 str += 'On axis "'+interfaceName+'" you must move ';
nickjillings@1341 68 }
nickjillings@1341 69 if (interfaceTID.length == 1)
nickjillings@1341 70 {
nickjillings@1341 71 str += 'slider '+interfaceTID[0]+'. ';
nickjillings@1341 72 }
nickjillings@1341 73 else {
nickjillings@1341 74 str += 'sliders ';
nickjillings@1341 75 for (var k=0; k<interfaceTID.length-1; k++)
nickjillings@1341 76 {
nickjillings@1341 77 str += interfaceTID[k]+', ';
nickjillings@1341 78 }
nickjillings@1341 79 str += interfaceTID[interfaceTID.length-1] +'. ';
nickjillings@1341 80 }
nickjillings@1341 81 }
nickjillings@1341 82 }
nickjillings@1341 83 if (state != true)
nickjillings@1341 84 {
nickjillings@1341 85 alert(str);
nickjillings@1341 86 console.log(str);
nickjillings@1341 87 }
nickjillings@1341 88 return state;
nickjillings@1341 89 };
nickjillings@1341 90
nickjillings@1341 91 Interface.prototype.checkAllCommented = function() {
nickjillings@1341 92 var audioObjs = audioEngineContext.audioObjects;
nickjillings@1341 93 var audioHolder = testState.stateMap[testState.stateIndex];
nickjillings@1341 94 var state = true;
nickjillings@1341 95 if (audioHolder.elementComments) {
nickjillings@1341 96 var strNums = [];
nickjillings@1341 97 for (var i=0; i<audioObjs.length; i++)
nickjillings@1341 98 {
nickjillings@1341 99 if (audioObjs[i].commentDOM.trackCommentBox.value.length == 0) {
nickjillings@1341 100 state = false;
nickjillings@1341 101 strNums.push(i);
nickjillings@1341 102 }
nickjillings@1341 103 }
nickjillings@1341 104 if (state == false) {
nickjillings@1341 105 if (strNums.length > 1) {
nickjillings@1341 106 var str = "";
nickjillings@1341 107 for (var i=0; i<strNums.length; i++) {
nickjillings@1341 108 str = str + strNums[i];
nickjillings@1341 109 if (i < strNums.length-2){
nickjillings@1341 110 str += ", ";
nickjillings@1341 111 } else if (i == strNums.length-2) {
nickjillings@1341 112 str += " or ";
nickjillings@1341 113 }
nickjillings@1341 114 }
nickjillings@1341 115 alert('You have not commented on fragments ' + str + ' yet. Please listen, rate and comment all samples before submitting.');
nickjillings@1341 116 } else {
nickjillings@1341 117 alert('You have not commented on fragment ' + strNums[0] + ' yet. Please listen, rate and comment all samples before submitting.');
nickjillings@1341 118 }
nickjillings@1341 119 }
nickjillings@1341 120 }
nickjillings@1341 121 return state;
nickjillings@1341 122 };
nickjillings@1341 123
nickjillings@1341 124 Interface.prototype.checkScaleRange = function()
nickjillings@1341 125 {
nickjillings@1341 126 var audioObjs = audioEngineContext.audioObjects;
nickjillings@1341 127 var audioHolder = testState.stateMap[testState.stateIndex];
nickjillings@1341 128 var state = true;
nickjillings@1341 129 var str = '';
nickjillings@1341 130 for (var i=0; i<this.interfaceSliders.length; i++)
nickjillings@1341 131 {
nickjillings@1341 132 var minScale;
nickjillings@1341 133 var maxScale;
nickjillings@1341 134 var interfaceObject = interfaceContext.interfaceSliders[0].interfaceObject;
nickjillings@1341 135 for (var j=0; j<interfaceObject.options.length; j++)
nickjillings@1341 136 {
nickjillings@1341 137 if (interfaceObject.options[j].check == "scalerange") {
nickjillings@1341 138 minScale = interfaceObject.options[j].min;
nickjillings@1341 139 maxScale = interfaceObject.options[j].max;
nickjillings@1341 140 break;
nickjillings@1341 141 }
nickjillings@1341 142 }
nickjillings@1341 143 var minRanking = convSliderPosToRate(this.interfaceSliders[i].sliders[0]);
nickjillings@1341 144 var maxRanking = minRanking;
nickjillings@1341 145 for (var j=1; j<this.interfaceSliders[i].sliders.length; j++)
nickjillings@1341 146 {
nickjillings@1341 147 var ranking = convSliderPosToRate(this.interfaceSliders[i].sliders[j]);
nickjillings@1341 148 if (ranking < minRanking)
nickjillings@1341 149 {
nickjillings@1341 150 minRanking = ranking;
nickjillings@1341 151 } else if (ranking > maxRanking)
nickjillings@1341 152 {
nickjillings@1341 153 maxRanking = ranking;
nickjillings@1341 154 }
nickjillings@1341 155 }
nickjillings@1341 156 if (minRanking > minScale || maxRanking < maxScale)
nickjillings@1341 157 {
nickjillings@1341 158 state = false;
nickjillings@1341 159 str += 'On axis "'+this.interfaceSliders[i].interfaceObject.title+'" you have not used the full width of the scale. ';
nickjillings@1341 160 }
nickjillings@1341 161 }
nickjillings@1341 162 if (state != true)
nickjillings@1341 163 {
nickjillings@1341 164 alert(str);
nickjillings@1341 165 console.log(str);
nickjillings@1341 166 }
nickjillings@1341 167 return state;
nickjillings@1341 168 };
nickjillings@1341 169
nickjillings@1341 170 Interface.prototype.objectSelected = null;
nickjillings@1341 171 Interface.prototype.objectMoved = false;
nickjillings@1341 172 Interface.prototype.selectObject = function(object)
nickjillings@1341 173 {
nickjillings@1341 174 if (this.objectSelected == null)
nickjillings@1341 175 {
nickjillings@1341 176 this.objectSelected = object;
nickjillings@1341 177 this.objectMoved = false;
nickjillings@1341 178 }
nickjillings@1341 179 };
nickjillings@1341 180 Interface.prototype.moveObject = function()
nickjillings@1341 181 {
nickjillings@1341 182 if (this.objectMoved == false)
nickjillings@1341 183 {
nickjillings@1341 184 this.objectMoved = true;
nickjillings@1341 185 }
nickjillings@1341 186 };
nickjillings@1341 187 Interface.prototype.releaseObject = function()
nickjillings@1341 188 {
nickjillings@1341 189 this.objectSelected = null;
nickjillings@1341 190 this.objectMoved = false;
nickjillings@1341 191 };
nickjillings@1341 192 Interface.prototype.getSelectedObject = function()
nickjillings@1341 193 {
nickjillings@1341 194 return this.objectSelected;
nickjillings@1341 195 };
nickjillings@1341 196 Interface.prototype.hasSelectedObjectMoved = function()
nickjillings@1341 197 {
nickjillings@1341 198 return this.objectMoved;
nickjillings@1341 199 };
nickjillings@1341 200
nickjillings@1341 201 // Bindings for slider interfaces
nickjillings@1341 202 Interface.prototype.interfaceSliders = [];
nickjillings@1341 203
nickjillings@1341 204 // Bindings for audioObjects
nickjillings@1341 205
nickjillings@1341 206 // Create the top div for the Title element
nickjillings@1341 207 var titleAttr = specification.title;
nickjillings@1341 208 var title = document.createElement('div');
nickjillings@1341 209 title.className = "title";
nickjillings@1341 210 title.align = "center";
nickjillings@1341 211 var titleSpan = document.createElement('span');
nickjillings@1341 212
nickjillings@1341 213 // Set title to that defined in XML, else set to default
nickjillings@1341 214 if (titleAttr != undefined) {
nickjillings@1341 215 titleSpan.textContent = titleAttr;
nickjillings@1341 216 } else {
nickjillings@1341 217 titleSpan.textContent = 'Listening test';
nickjillings@1341 218 }
nickjillings@1341 219 // Insert the titleSpan element into the title div element.
nickjillings@1341 220 title.appendChild(titleSpan);
nickjillings@1341 221
nickjillings@1341 222 // Create Interface buttons!
nickjillings@1341 223 var interfaceButtons = document.createElement('div');
nickjillings@1341 224 interfaceButtons.id = 'interface-buttons';
nickjillings@1341 225
nickjillings@1341 226 // Create playback start/stop points
nickjillings@1341 227 var playback = document.createElement("button");
nickjillings@1341 228 playback.innerHTML = 'Stop';
nickjillings@1341 229 playback.id = 'playback-button';
nickjillings@1341 230 // onclick function. Check if it is playing or not, call the correct function in the
nickjillings@1341 231 // audioEngine, change the button text to reflect the next state.
nickjillings@1341 232 playback.onclick = function() {
nickjillings@1341 233 if (audioEngineContext.status == 1) {
nickjillings@1341 234 audioEngineContext.stop();
nickjillings@1341 235 this.innerHTML = 'Stop';
nickjillings@1341 236 var time = audioEngineContext.timer.getTestTime();
nickjillings@1341 237 console.log('Stopped at ' + time); // DEBUG/SAFETY
nickjillings@1341 238 }
nickjillings@1341 239 };
nickjillings@1341 240 // Create Submit (save) button
nickjillings@1341 241 var submit = document.createElement("button");
nickjillings@1341 242 submit.innerHTML = 'Submit';
nickjillings@1341 243 submit.onclick = buttonSubmitClick;
nickjillings@1341 244 submit.id = 'submit-button';
nickjillings@1341 245 // Append the interface buttons into the interfaceButtons object.
nickjillings@1341 246 interfaceButtons.appendChild(playback);
nickjillings@1341 247 interfaceButtons.appendChild(submit);
nickjillings@1341 248
nickjillings@1341 249 var sliderHolder = document.createElement("div");
nickjillings@1341 250 sliderHolder.id = "slider-holder";
nickjillings@1341 251
nickjillings@1341 252
nickjillings@1341 253 // Global parent for the comment boxes on the page
nickjillings@1341 254 var feedbackHolder = document.createElement('div');
nickjillings@1341 255 feedbackHolder.id = 'feedbackHolder';
nickjillings@1341 256
nickjillings@1341 257 testContent.style.zIndex = 1;
nickjillings@1341 258 interfaceContext.insertPoint.innerHTML = null; // Clear the current schema
nickjillings@1341 259
nickjillings@1341 260 // Inject into HTML
nickjillings@1341 261 testContent.appendChild(title); // Insert the title
nickjillings@1341 262 testContent.appendChild(interfaceButtons);
nickjillings@1341 263 testContent.appendChild(sliderHolder);
nickjillings@1341 264 testContent.appendChild(feedbackHolder);
nickjillings@1341 265 interfaceContext.insertPoint.appendChild(testContent);
nickjillings@1341 266
nickjillings@1341 267 // Load the full interface
nickjillings@1341 268 testState.initialise();
nickjillings@1341 269 testState.advanceState();
nickjillings@1341 270
nickjillings@1341 271 }
nickjillings@1341 272
nickjillings@1341 273 function loadTest(audioHolderObject)
nickjillings@1341 274 {
nickjillings@1341 275 var width = window.innerWidth;
nickjillings@1341 276 var height = window.innerHeight;
nickjillings@1341 277 var id = audioHolderObject.id;
nickjillings@1341 278
nickjillings@1341 279 interfaceContext.interfaceSliders = [];
nickjillings@1341 280
nickjillings@1341 281 var feedbackHolder = document.getElementById('feedbackHolder');
nickjillings@1341 282 var sliderHolder = document.getElementById('slider-holder');
nickjillings@1341 283 feedbackHolder.innerHTML = null;
nickjillings@1341 284 sliderHolder.innerHTML = null;
nickjillings@1341 285
nickjillings@1341 286 // Delete outside reference
nickjillings@1341 287 var outsideReferenceHolder = document.getElementById('outside-reference');
nickjillings@1341 288 if (outsideReferenceHolder != null) {
nickjillings@1341 289 document.getElementById('interface-buttons').removeChild(outsideReferenceHolder);
nickjillings@1341 290 }
nickjillings@1341 291
nickjillings@1341 292 var interfaceObj = audioHolderObject.interfaces;
nickjillings@1341 293 for (var k=0; k<interfaceObj.length; k++) {
nickjillings@1341 294 // Create the div box to center align
nickjillings@1341 295 interfaceContext.interfaceSliders.push(new interfaceSliderHolder(interfaceObj[k]));
nickjillings@1341 296 for (var i=0; i<interfaceObj[k].options.length; i++)
nickjillings@1341 297 {
nickjillings@1341 298 if (interfaceObj[k].options[i].type == 'option' && interfaceObj[k].options[i].name == 'playhead')
nickjillings@1341 299 {
nickjillings@1341 300 var playbackHolder = document.getElementById('playback-holder');
nickjillings@1341 301 if (playbackHolder == null)
nickjillings@1341 302 {
nickjillings@1341 303 playbackHolder = document.createElement('div');
nickjillings@1341 304 playbackHolder.style.width = "100%";
nickjillings@1341 305 playbackHolder.align = 'center';
nickjillings@1341 306 playbackHolder.appendChild(interfaceContext.playhead.object);
nickjillings@1341 307 feedbackHolder.appendChild(playbackHolder);
nickjillings@1341 308 }
nickjillings@1341 309 } else if (interfaceObj[k].options[i].type == 'option' && interfaceObj[k].options[i].name == 'page-count')
nickjillings@1341 310 {
nickjillings@1341 311 var pagecountHolder = document.getElementById('page-count');
nickjillings@1341 312 if (pagecountHolder == null)
nickjillings@1341 313 {
nickjillings@1341 314 pagecountHolder = document.createElement('div');
nickjillings@1341 315 pagecountHolder.id = 'page-count';
nickjillings@1341 316 }
nickjillings@1341 317 pagecountHolder.innerHTML = '<span>Page '+(audioHolderObject.presentedId+1)+' of '+specification.audioHolders.length+'</span>';
nickjillings@1341 318 var inject = document.getElementById('interface-buttons');
nickjillings@1341 319 inject.appendChild(pagecountHolder);
nickjillings@1341 320 }
nickjillings@1341 321 }
nickjillings@1341 322 }
nickjillings@1341 323
nickjillings@1341 324 var commentBoxPrefix = "Comment on fragment";
nickjillings@1341 325
nickjillings@1341 326 var commentShow = audioHolderObject.elementComments;
nickjillings@1341 327
nickjillings@1341 328 var loopPlayback = audioHolderObject.loop;
nickjillings@1341 329
nickjillings@1341 330 currentTestHolder = document.createElement('audioHolder');
nickjillings@1341 331 currentTestHolder.id = audioHolderObject.id;
nickjillings@1341 332 currentTestHolder.repeatCount = audioHolderObject.repeatCount;
nickjillings@1341 333
nickjillings@1341 334 // Find all the audioElements from the audioHolder
nickjillings@1341 335 $(audioHolderObject.audioElements).each(function(index,element){
nickjillings@1341 336 // Find URL of track
nickjillings@1341 337 // In this jQuery loop, variable 'this' holds the current audioElement.
nickjillings@1341 338 var audioObject = audioEngineContext.newTrack(element);
nickjillings@1341 339 // Check if an outside reference
nickjillings@1341 340 if (element.type == 'outside-reference')
nickjillings@1341 341 {
nickjillings@1341 342 // Construct outside reference;
nickjillings@1341 343 var orNode = new outsideReferenceDOM(audioObject,index,document.getElementById('interface-buttons'));
nickjillings@1341 344 audioObject.bindInterface(orNode);
nickjillings@1341 345 } else {
nickjillings@1341 346 var node = interfaceContext.createCommentBox(audioObject);
nickjillings@1341 347 // Create a slider per track
nickjillings@1341 348 var sliderNode = new sliderObject(audioObject,interfaceObj);
nickjillings@1341 349 audioObject.bindInterface(sliderNode);
nickjillings@1341 350 }
nickjillings@1341 351 });
nickjillings@1341 352
nickjillings@1341 353 // Initialse the interfaceSlider object metrics
nickjillings@1341 354
nickjillings@1341 355 $('.track-slider').mousedown(function(event) {
nickjillings@1341 356 interfaceContext.selectObject($(this)[0]);
nickjillings@1341 357 });
nickjillings@1341 358 $('.track-slider').on('touchstart',null,function(event) {
nickjillings@1341 359 interfaceContext.selectObject($(this)[0]);
nickjillings@1341 360 });
nickjillings@1341 361
nickjillings@1341 362 $('.track-slider').mousemove(function(event) {
nickjillings@1341 363 event.preventDefault();
nickjillings@1341 364 });
nickjillings@1341 365
nickjillings@1341 366 $('.slider').mousemove(function(event) {
nickjillings@1341 367 event.preventDefault();
nickjillings@1341 368 var obj = interfaceContext.getSelectedObject();
nickjillings@1341 369 if (obj == null) {return;}
nickjillings@1341 370 $(obj).css("left",event.clientX + "px");
nickjillings@1341 371 interfaceContext.moveObject();
nickjillings@1341 372 });
nickjillings@1341 373
nickjillings@1341 374 $('.slider').on('touchmove',null,function(event) {
nickjillings@1341 375 event.preventDefault();
nickjillings@1341 376 var obj = interfaceContext.getSelectedObject();
nickjillings@1341 377 if (obj == null) {return;}
nickjillings@1341 378 var move = event.originalEvent.targetTouches[0].clientX - 6;
nickjillings@1341 379 $(obj).css("left",move + "px");
nickjillings@1341 380 interfaceContext.moveObject();
nickjillings@1341 381 });
nickjillings@1341 382
nickjillings@1341 383 $(document).mouseup(function(event){
nickjillings@1341 384 event.preventDefault();
nickjillings@1341 385 var obj = interfaceContext.getSelectedObject();
nickjillings@1341 386 if (obj == null) {return;}
nickjillings@1341 387 var interfaceID = obj.parentElement.getAttribute("interfaceid");
nickjillings@1341 388 var trackID = obj.getAttribute("trackindex");
nickjillings@1341 389 if (interfaceContext.hasSelectedObjectMoved() == true)
nickjillings@1341 390 {
nickjillings@1341 391 var l = $(obj).css("left");
nickjillings@1341 392 var id = obj.getAttribute('trackIndex');
nickjillings@1341 393 var time = audioEngineContext.timer.getTestTime();
nickjillings@1341 394 var rate = convSliderPosToRate(obj);
nickjillings@1341 395 audioEngineContext.audioObjects[id].metric.moved(time,rate);
nickjillings@1341 396 interfaceContext.interfaceSliders[interfaceID].metrics[trackID].moved(time,rate);
nickjillings@1341 397 console.log("slider "+id+" moved to "+rate+' ('+time+')');
nickjillings@1341 398 } else {
nickjillings@1341 399 var id = Number(obj.attributes['trackIndex'].value);
nickjillings@1341 400 //audioEngineContext.metric.sliderPlayed(id);
nickjillings@1341 401 audioEngineContext.play(id);
nickjillings@1341 402 // Currently playing track red, rest green
nickjillings@1341 403
nickjillings@1341 404 $('.track-slider').removeClass('track-slider-playing');
nickjillings@1341 405 var name = ".track-slider-"+obj.getAttribute("trackindex");
nickjillings@1341 406 $(name).addClass('track-slider-playing');
nickjillings@1341 407 $('.comment-div').removeClass('comment-box-playing');
nickjillings@1341 408 $('#comment-div-'+id).addClass('comment-box-playing');
nickjillings@1341 409 var outsideReference = document.getElementById('outside-reference');
nickjillings@1341 410 if (outsideReference != undefined)
nickjillings@1341 411 $(outsideReference).removeClass('track-slider-playing');
nickjillings@1341 412 }
nickjillings@1341 413 interfaceContext.releaseObject();
nickjillings@1341 414 });
nickjillings@1341 415
nickjillings@1341 416 $('.slider').on('touchend',null,function(event){
nickjillings@1341 417 var obj = interfaceContext.getSelectedObject();
nickjillings@1341 418 if (obj == null) {return;}
nickjillings@1341 419 var interfaceID = obj.parentElement.getAttribute("interfaceid");
nickjillings@1341 420 var trackID = obj.getAttribute("trackindex");
nickjillings@1341 421 if (interfaceContext.hasSelectedObjectMoved() == true)
nickjillings@1341 422 {
nickjillings@1341 423 var l = $(obj).css("left");
nickjillings@1341 424 var id = obj.getAttribute('trackIndex');
nickjillings@1341 425 var time = audioEngineContext.timer.getTestTime();
nickjillings@1341 426 var rate = convSliderPosToRate(obj);
nickjillings@1341 427 audioEngineContext.audioObjects[id].metric.moved(time,rate);
nickjillings@1341 428 interfaceContext.interfaceSliders[interfaceID].metrics[trackID].moved(time,rate);
nickjillings@1341 429 console.log("slider "+id+" moved to "+rate+' ('+time+')');
nickjillings@1341 430 }
nickjillings@1341 431 interfaceContext.releaseObject();
nickjillings@1341 432 });
nickjillings@1341 433
nickjillings@1341 434
nickjillings@1341 435 if (audioHolderObject.showElementComments) {
nickjillings@1341 436 interfaceContext.showCommentBoxes(feedbackHolder,true);
nickjillings@1341 437 }
nickjillings@1341 438
nickjillings@1341 439 $(audioHolderObject.commentQuestions).each(function(index,element) {
nickjillings@1341 440 var node = interfaceContext.createCommentQuestion(element);
nickjillings@1341 441 feedbackHolder.appendChild(node.holder);
nickjillings@1341 442 });
nickjillings@1341 443
nickjillings@1341 444
nickjillings@1341 445 //testWaitIndicator();
nickjillings@1341 446 }
nickjillings@1341 447
nickjillings@1341 448 function interfaceSliderHolder(interfaceObject)
nickjillings@1341 449 {
nickjillings@1341 450 this.sliders = [];
nickjillings@1341 451 this.metrics = [];
nickjillings@1341 452 this.id = document.getElementsByClassName("sliderCanvasDiv").length;
nickjillings@1341 453 this.name = interfaceObject.name;
nickjillings@1341 454 this.interfaceObject = interfaceObject;
nickjillings@1341 455 this.sliderDOM = document.createElement('div');
nickjillings@1341 456 this.sliderDOM.className = 'sliderCanvasDiv';
nickjillings@1341 457 this.sliderDOM.id = 'sliderCanvasHolder-'+this.id;
nickjillings@1341 458
nickjillings@1341 459 var pagetitle = document.createElement('div');
nickjillings@1341 460 pagetitle.className = "pageTitle";
nickjillings@1341 461 pagetitle.align = "center";
nickjillings@1341 462 var titleSpan = document.createElement('span');
nickjillings@1341 463 titleSpan.id = "pageTitle-"+this.id;
nickjillings@1341 464 if (interfaceObject.title != undefined && typeof interfaceObject.title == "string")
nickjillings@1341 465 {
nickjillings@1341 466 titleSpan.textContent = interfaceObject.title;
nickjillings@1341 467 } else {
nickjillings@1341 468 titleSpan.textContent = "Axis "+String(this.id+1);
nickjillings@1341 469 }
nickjillings@1341 470 pagetitle.appendChild(titleSpan);
nickjillings@1341 471 this.sliderDOM.appendChild(pagetitle);
nickjillings@1341 472
nickjillings@1341 473 // Create the slider box to hold the slider elements
nickjillings@1341 474 this.canvas = document.createElement('div');
nickjillings@1341 475 if (this.name != undefined)
nickjillings@1341 476 this.canvas.id = 'slider-'+this.name;
nickjillings@1341 477 else
nickjillings@1341 478 this.canvas.id = 'slider-'+this.id;
nickjillings@1341 479 this.canvas.setAttribute("interfaceid",this.id);
nickjillings@1341 480 this.canvas.className = 'slider';
nickjillings@1341 481 this.canvas.align = "left";
nickjillings@1341 482 this.canvas.addEventListener('dragover',function(event){
nickjillings@1341 483 event.preventDefault();
nickjillings@1341 484 event.dataTransfer.effectAllowed = 'none';
nickjillings@1341 485 event.dataTransfer.dropEffect = 'copy';
nickjillings@1341 486 return false;
nickjillings@1341 487 },false);
nickjillings@1341 488 var sliderMargin = document.createAttribute('marginsize');
nickjillings@1341 489 sliderMargin.nodeValue = 42; // Set default margins to 42px either side
nickjillings@1341 490 // Must have a known EXACT width, as this is used later to determine the ratings
nickjillings@1341 491 var w = (Number(sliderMargin.nodeValue)+8)*2;
nickjillings@1341 492 this.canvas.style.width = window.innerWidth - w +"px";
nickjillings@1341 493 this.canvas.style.marginLeft = sliderMargin.nodeValue +'px';
nickjillings@1341 494 this.canvas.setAttributeNode(sliderMargin);
nickjillings@1341 495 this.sliderDOM.appendChild(this.canvas);
nickjillings@1341 496
nickjillings@1341 497 // Create the div to hold any scale objects
nickjillings@1341 498 this.scale = document.createElement('div');
nickjillings@1341 499 this.scale.className = 'sliderScale';
nickjillings@1341 500 this.scale.id = 'sliderScaleHolder-'+this.id;
nickjillings@1341 501 this.scale.align = 'left';
nickjillings@1341 502 this.sliderDOM.appendChild(this.scale);
nickjillings@1341 503 var positionScale = this.canvas.style.width.substr(0,this.canvas.style.width.length-2);
nickjillings@1341 504 var offset = Number(this.canvas.attributes['marginsize'].value);
nickjillings@1341 505 for (var scaleObj of interfaceObject.scales)
nickjillings@1341 506 {
nickjillings@1341 507 var value = document.createAttribute('value');
nickjillings@1341 508 var position = Number(scaleObj.position)*0.01;
nickjillings@1341 509 value.nodeValue = position;
nickjillings@1341 510 var pixelPosition = (position*positionScale)+offset;
nickjillings@1341 511 var scaleDOM = document.createElement('span');
nickjillings@1341 512 scaleDOM.textContent = scaleObj.text;
nickjillings@1341 513 this.scale.appendChild(scaleDOM);
nickjillings@1341 514 scaleDOM.style.left = Math.floor((pixelPosition-($(scaleDOM).width()/2)))+'px';
nickjillings@1341 515 scaleDOM.setAttributeNode(value);
nickjillings@1341 516 }
nickjillings@1341 517
nickjillings@1341 518 var dest = document.getElementById("slider-holder");
nickjillings@1341 519 dest.appendChild(this.sliderDOM);
nickjillings@1341 520
nickjillings@1341 521 this.createSliderObject = function(audioObject)
nickjillings@1341 522 {
nickjillings@1341 523 var trackObj = document.createElement('div');
nickjillings@1341 524 trackObj.className = 'track-slider track-slider-disabled track-slider-'+audioObject.id;
nickjillings@1341 525 trackObj.id = 'track-slider-'+this.id+'-'+audioObject.id;
nickjillings@1341 526 trackObj.setAttribute('trackIndex',audioObject.id);
nickjillings@1341 527 if (this.name != undefined) {
nickjillings@1341 528 trackObj.setAttribute('interface-name',this.name);
nickjillings@1341 529 } else {
nickjillings@1341 530 trackObj.setAttribute('interface-name',this.id);
nickjillings@1341 531 }
nickjillings@1341 532 var offset = Number(this.canvas.attributes['marginsize'].value);
nickjillings@1341 533 // Distribute it randomnly
nickjillings@1341 534 var w = window.innerWidth - (offset+8)*2;
nickjillings@1341 535 w = Math.random()*w;
nickjillings@1341 536 w = Math.floor(w+(offset+8));
nickjillings@1341 537 trackObj.style.left = w+'px';
nickjillings@1341 538 this.canvas.appendChild(trackObj);
nickjillings@1341 539 this.sliders.push(trackObj);
nickjillings@1341 540 this.metrics.push(new metricTracker(this));
nickjillings@1341 541 trackObj.innerHTML = '<span>'+(this.metrics.length-1)+'</span>';
nickjillings@1341 542 this.metrics[this.metrics.length-1].initialise(convSliderPosToRate(trackObj));
nickjillings@1341 543 return trackObj;
nickjillings@1341 544 };
nickjillings@1341 545
nickjillings@1341 546 this.resize = function(event)
nickjillings@1341 547 {
nickjillings@1341 548 var holdValues = [];
nickjillings@1341 549 for (var index = 0; index < this.sliders.length; index++)
nickjillings@1341 550 {
nickjillings@1341 551 holdValues.push(convSliderPosToRate(this.sliders[index]));
nickjillings@1341 552 }
nickjillings@1341 553 var width = event.target.innerWidth;
nickjillings@1341 554 var sliderDiv = this.canvas;
nickjillings@1341 555 var sliderScaleDiv = this.scale;
nickjillings@1341 556 var marginsize = Number(sliderDiv.attributes['marginsize'].value);
nickjillings@1341 557 var w = (marginsize+8)*2;
nickjillings@1341 558 sliderDiv.style.width = width - w + 'px';
nickjillings@1341 559 var width = width - w;
nickjillings@1341 560 // Move sliders into new position
nickjillings@1341 561 for (var index = 0; index < this.sliders.length; index++)
nickjillings@1341 562 {
nickjillings@1341 563 var pos = holdValues[index];
nickjillings@1341 564 var pix = pos * width;
nickjillings@1341 565 this.sliders[index].style.left = pix+marginsize+'px';
nickjillings@1341 566 }
nickjillings@1341 567
nickjillings@1341 568 // Move scale labels
nickjillings@1341 569 for (var index = 0; index < this.scale.children.length; index++)
nickjillings@1341 570 {
nickjillings@1341 571 var scaleObj = this.scale.children[index];
nickjillings@1341 572 var position = Number(scaleObj.attributes['value'].value);
nickjillings@1341 573 var pixelPosition = (position*width)+marginsize;
nickjillings@1341 574 scaleObj.style.left = Math.floor((pixelPosition-($(scaleObj).width()/2)))+'px';
nickjillings@1341 575 }
nickjillings@1341 576 };
nickjillings@1341 577 }
nickjillings@1341 578
nickjillings@1341 579 function sliderObject(audioObject,interfaceObjects) {
nickjillings@1341 580 // Create a new slider object;
nickjillings@1341 581 this.parent = audioObject;
nickjillings@1341 582 this.trackSliderObjects = [];
nickjillings@1341 583 for (var i=0; i<interfaceContext.interfaceSliders.length; i++)
nickjillings@1341 584 {
nickjillings@1341 585 var trackObj = interfaceContext.interfaceSliders[i].createSliderObject(audioObject);
nickjillings@1341 586 this.trackSliderObjects.push(trackObj);
nickjillings@1341 587 }
nickjillings@1341 588
nickjillings@1341 589 // Onclick, switch playback to that track
nickjillings@1341 590
nickjillings@1341 591 this.enable = function() {
nickjillings@1341 592 if (this.parent.state == 1)
nickjillings@1341 593 {
nickjillings@1341 594 $(this.trackSliderObjects).each(function(i,trackObj){
nickjillings@1341 595 $(trackObj).removeClass('track-slider-disabled');
nickjillings@1341 596 });
nickjillings@1341 597 }
nickjillings@1341 598 };
nickjillings@1341 599 this.updateLoading = function(progress)
nickjillings@1341 600 {
nickjillings@1341 601 if (progress != 100)
nickjillings@1341 602 {
nickjillings@1341 603 progress = String(progress);
nickjillings@1341 604 progress = progress.split('.')[0];
nickjillings@1341 605 this.trackSliderObjects[0].children[0].textContent = progress+'%';
nickjillings@1341 606 } else {
nickjillings@1341 607 this.trackSliderObjects[0].children[0].textContent = this.parent.id;
nickjillings@1341 608 }
nickjillings@1341 609 };
nickjillings@1341 610 this.exportXMLDOM = function(audioObject) {
nickjillings@1341 611 // Called by the audioObject holding this element. Must be present
nickjillings@1341 612 var obj = [];
nickjillings@1341 613 $(this.trackSliderObjects).each(function(i,trackObj){
nickjillings@1341 614 var node = storage.document.createElement('value');
nickjillings@1341 615 node.setAttribute("interface-name",trackObj.getAttribute("interface-name"));
nickjillings@1341 616 node.textContent = convSliderPosToRate(trackObj);
nickjillings@1341 617 obj.push(node);
nickjillings@1341 618 });
nickjillings@1341 619
nickjillings@1341 620 return obj;
nickjillings@1341 621 };
nickjillings@1341 622 this.getValue = function() {
nickjillings@1341 623 return convSliderPosToRate(this.trackSliderObjects[0]);
nickjillings@1341 624 };
nickjillings@1341 625 this.getPresentedId = function()
nickjillings@1341 626 {
nickjillings@1341 627 return this.trackSliderObjects[0].children[0].textContent;
nickjillings@1341 628 };
nickjillings@1341 629 this.canMove = function()
nickjillings@1341 630 {
nickjillings@1341 631 return true;
nickjillings@1341 632 };
nickjillings@1341 633 }
nickjillings@1341 634
nickjillings@1341 635 function outsideReferenceDOM(audioObject,index,inject)
nickjillings@1341 636 {
nickjillings@1341 637 this.parent = audioObject;
nickjillings@1341 638 this.outsideReferenceHolder = document.createElement('div');
nickjillings@1341 639 this.outsideReferenceHolder.id = 'outside-reference';
nickjillings@1341 640 this.outsideReferenceHolder.className = 'outside-reference track-slider-disabled';
nickjillings@1341 641 var outsideReferenceHolderspan = document.createElement('span');
nickjillings@1341 642 outsideReferenceHolderspan.textContent = 'Reference';
nickjillings@1341 643 this.outsideReferenceHolder.appendChild(outsideReferenceHolderspan);
nickjillings@1341 644 this.outsideReferenceHolder.setAttribute('track-id',index);
nickjillings@1341 645
nickjillings@1341 646 this.outsideReferenceHolder.onclick = function(event)
nickjillings@1341 647 {
nickjillings@1341 648 audioEngineContext.play(event.currentTarget.getAttribute('track-id'));
nickjillings@1341 649 $('.track-slider').removeClass('track-slider-playing');
nickjillings@1341 650 $('.comment-div').removeClass('comment-box-playing');
nickjillings@1341 651 if (event.currentTarget.nodeName == 'DIV') {
nickjillings@1341 652 $(event.currentTarget).addClass('track-slider-playing');
nickjillings@1341 653 } else {
nickjillings@1341 654 $(event.currentTarget.parentElement).addClass('track-slider-playing');
nickjillings@1341 655 }
nickjillings@1341 656 };
nickjillings@1341 657 inject.appendChild(this.outsideReferenceHolder);
nickjillings@1341 658 this.enable = function()
nickjillings@1341 659 {
nickjillings@1341 660 if (this.parent.state == 1)
nickjillings@1341 661 {
nickjillings@1341 662 $(this.outsideReferenceHolder).removeClass('track-slider-disabled');
nickjillings@1341 663 }
nickjillings@1341 664 };
nickjillings@1341 665 this.updateLoading = function(progress)
nickjillings@1341 666 {
nickjillings@1341 667 if (progress != 100)
nickjillings@1341 668 {
nickjillings@1341 669 progress = String(progress);
nickjillings@1341 670 progress = progress.split('.')[0];
nickjillings@1341 671 this.outsideReferenceHolder[0].children[0].textContent = progress+'%';
nickjillings@1341 672 } else {
nickjillings@1341 673 this.outsideReferenceHolder[0].children[0].textContent = "Play Reference";
nickjillings@1341 674 }
nickjillings@1341 675 };
nickjillings@1341 676 this.exportXMLDOM = function(audioObject)
nickjillings@1341 677 {
nickjillings@1341 678 return null;
nickjillings@1341 679 };
nickjillings@1341 680 this.getValue = function()
nickjillings@1341 681 {
nickjillings@1341 682 return 0;
nickjillings@1341 683 };
nickjillings@1341 684 this.getPresentedId = function()
nickjillings@1341 685 {
nickjillings@1341 686 return 'reference';
nickjillings@1341 687 };
nickjillings@1341 688 this.canMove = function()
nickjillings@1341 689 {
nickjillings@1341 690 return false;
nickjillings@1341 691 };
nickjillings@1341 692 }
nickjillings@1341 693
nickjillings@1341 694 function buttonSubmitClick()
nickjillings@1341 695 {
nickjillings@1341 696 var checks = [];
nickjillings@1341 697 checks = checks.concat(testState.currentStateMap.interfaces[0].options);
nickjillings@1341 698 checks = checks.concat(specification.interfaces.options);
nickjillings@1341 699 var canContinue = true;
nickjillings@1341 700
nickjillings@1341 701 // Check that the anchor and reference objects are correctly placed
nickjillings@1341 702 if (interfaceContext.checkHiddenAnchor() == false) {return;}
nickjillings@1341 703 if (interfaceContext.checkHiddenReference() == false) {return;}
nickjillings@1341 704
nickjillings@1341 705 for (var i=0; i<checks.length; i++) {
nickjillings@1341 706 if (checks[i].type == 'check')
nickjillings@1341 707 {
nickjillings@1341 708 switch(checks[i].name) {
nickjillings@1341 709 case 'fragmentPlayed':
nickjillings@1341 710 // Check if all fragments have been played
nickjillings@1341 711 var checkState = interfaceContext.checkAllPlayed();
nickjillings@1341 712 if (checkState == false) {canContinue = false;}
nickjillings@1341 713 break;
nickjillings@1341 714 case 'fragmentFullPlayback':
nickjillings@1341 715 // Check all fragments have been played to their full length
nickjillings@1341 716 var checkState = interfaceContext.checkFragmentsFullyPlayed();
nickjillings@1341 717 if (checkState == false) {canContinue = false;}
nickjillings@1341 718 break;
nickjillings@1341 719 case 'fragmentMoved':
nickjillings@1341 720 // Check all fragment sliders have been moved.
nickjillings@1341 721 var checkState = interfaceContext.checkAllMoved();
nickjillings@1341 722 if (checkState == false) {canContinue = false;}
nickjillings@1341 723 break;
nickjillings@1341 724 case 'fragmentComments':
nickjillings@1341 725 // Check all fragment sliders have been moved.
nickjillings@1341 726 var checkState = interfaceContext.checkAllCommented();
nickjillings@1341 727 if (checkState == false) {canContinue = false;}
nickjillings@1341 728 break;
nickjillings@1341 729 case 'scalerange':
nickjillings@1341 730 // Check the scale is used to its full width outlined by the node
nickjillings@1341 731 var checkState = interfaceContext.checkScaleRange();
nickjillings@1341 732 if (checkState == false) {canContinue = false;}
nickjillings@1341 733 break;
nickjillings@1341 734 default:
nickjillings@1341 735 console.log("WARNING - Check option "+checks[i].name+" is not supported on this interface");
nickjillings@1341 736 break;
nickjillings@1341 737 }
nickjillings@1341 738
nickjillings@1341 739 }
nickjillings@1341 740 if (!canContinue) {break;}
nickjillings@1341 741 }
nickjillings@1341 742
nickjillings@1341 743 if (canContinue) {
nickjillings@1341 744 if (audioEngineContext.status == 1) {
nickjillings@1341 745 var playback = document.getElementById('playback-button');
nickjillings@1341 746 playback.click();
nickjillings@1341 747 // This function is called when the submit button is clicked. Will check for any further tests to perform, or any post-test options
nickjillings@1341 748 } else
nickjillings@1341 749 {
nickjillings@1341 750 if (audioEngineContext.timer.testStarted == false)
nickjillings@1341 751 {
nickjillings@1341 752 alert('You have not started the test! Please click a fragment to begin the test!');
nickjillings@1341 753 return;
nickjillings@1341 754 }
nickjillings@1341 755 }
nickjillings@1341 756 testState.advanceState();
nickjillings@1341 757 }
nickjillings@1341 758 }
nickjillings@1341 759
nickjillings@1341 760 function convSliderPosToRate(trackSlider)
nickjillings@1341 761 {
nickjillings@1341 762 var slider = trackSlider.parentElement;
nickjillings@1341 763 var w = slider.style.width;
nickjillings@1341 764 var marginsize = Number(slider.attributes['marginsize'].value);
nickjillings@1341 765 var maxPix = w.substr(0,w.length-2);
nickjillings@1341 766 var pix = trackSlider.style.left;
nickjillings@1341 767 pix = pix.substr(0,pix.length-2);
nickjillings@1341 768 var rate = (pix-marginsize)/maxPix;
nickjillings@1341 769 return rate;
nickjillings@1341 770 }
nickjillings@1341 771
nickjillings@1341 772 function resizeWindow(event){
nickjillings@1341 773 // Function called when the window has been resized.
nickjillings@1341 774 // MANDATORY FUNCTION
nickjillings@1341 775
nickjillings@1341 776 // Resize the slider objects
nickjillings@1341 777 for (var i=0; i<interfaceContext.interfaceSliders.length; i++)
nickjillings@1341 778 {
nickjillings@1341 779 interfaceContext.interfaceSliders[i].resize(event);
nickjillings@1341 780 }
nickjillings@1341 781 }
nickjillings@1341 782
nickjillings@1341 783 function pageXMLSave(store, pageSpecification)
nickjillings@1341 784 {
nickjillings@1341 785 // MANDATORY
nickjillings@1341 786 // Saves a specific test page
nickjillings@1341 787 // You can use this space to add any extra nodes to your XML <audioHolder> saves
nickjillings@1341 788 // Get the current <page> information in store (remember to appendChild your data to it)
nickjillings@1341 789 // pageSpecification is the current page node configuration
nickjillings@1341 790 // To create new XML nodes, use storage.document.createElement();
nickjillings@1341 791
nickjillings@1341 792 if (interfaceContext.interfaceSliders.length == 1)
nickjillings@1341 793 {
nickjillings@1341 794 // If there is only one axis, there only needs to be one metric return
nickjillings@1341 795 return;
nickjillings@1341 796 }
nickjillings@1341 797 var audioelements = store.getElementsByTagName("audioelement");
nickjillings@1341 798 for (var i=0; i<audioelements.length; i++)
nickjillings@1341 799 {
nickjillings@1341 800 // Have to append the metric specific nodes
nickjillings@1341 801 if (pageSpecification.outsideReference == null || pageSpecification.outsideReference.id != audioelements[i].id)
nickjillings@1341 802 {
nickjillings@1341 803 var inject = audioelements[i].getElementsByTagName("metric");
nickjillings@1341 804 if (inject.length == 0)
nickjillings@1341 805 {
nickjillings@1341 806 inject = storage.document.createElement("metric");
nickjillings@1341 807 } else {
nickjillings@1341 808 inject = inject[0];
nickjillings@1341 809 }
nickjillings@1341 810 for (var k=0; k<interfaceContext.interfaceSliders.length; k++)
nickjillings@1341 811 {
nickjillings@1341 812 var mrnodes = interfaceContext.interfaceSliders[k].metrics[i].exportXMLDOM(inject);
nickjillings@1341 813 for (var j=0; j<mrnodes.length; j++)
nickjillings@1341 814 {
nickjillings@1341 815 var name = mrnodes[j].getAttribute("name");
nickjillings@1341 816 if (name == "elementTracker" || name == "elementTrackerFull" || name == "elementInitialPosition" || name == "elementFlagMoved")
nickjillings@1341 817 {
nickjillings@1341 818 mrnodes[j].setAttribute("interface-name",interfaceContext.interfaceSliders[k].name);
nickjillings@1341 819 mrnodes[j].setAttribute("interface-id",k);
nickjillings@1341 820 inject.appendChild(mrnodes[j]);
nickjillings@1341 821 }
nickjillings@1341 822 }
nickjillings@1341 823 }
nickjillings@1341 824 }
nickjillings@1341 825 }
nickjillings@1341 826 }