Source: Lights/LightSet.js

  1. /* File: LightSet.js 
  2.  *
  3.  * Support for working with a set of Lights
  4.  */
  6. /*jslint node: true, vars: true */
  7. /*global  */
  8. /* find out more about jslint: http://www.jslint.com/help.html */
  10. "use strict";  // Operate in Strict mode such that variables must be declared before used!
  12. /**
  13.  * Support for working with a set of Lights
  14.  * @returns {LightSet} New instance of LightSet
  15.  * @class LightSet
  16.  */
  17. function LightSet() {
  18.     this.mSet = [];
  19. }
  21. /**
  22.  * Return the count of lights in set
  23.  * @returns {Number} number of lights in set
  24.  * @memberOf LightSet
  25.  */
  26. LightSet.prototype.numLights = function () { return this.mSet.length; };
  28. /**
  29.  * Return the light at index
  30.  * @param {Number} index of light to return
  31.  * @returns {Light} Light at index
  32.  * @memberOf LightSet
  33.  */
  34. LightSet.prototype.getLightAt = function (index) {
  35.     return this.mSet[index];
  36. };
  38. /**
  39.  * Add a light to the current set
  40.  * @param {Light} light to add to set
  41.  * @returns {void}
  42.  * @memberOf LightSet
  43.  */
  44. LightSet.prototype.addToSet = function (light) {
  45.     this.mSet.push(light);
  46. };