Source: Core/Resources/Engine_DefaultResources.js

  1. /*
  2.  * File: Engine_DefaultResources.js 
  3.  */
  4. /*jslint node: true, vars: true, evil: true, white: true */
  5. /*global SimpleShader, TextureShader, SpriteShader,
  6.   LineShader, LightShader, IllumShader, ShadowCasterShader, vec4 */
  7. /* 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.  * Static refrence to gEngine
  14.  * @type gEngine
  15.  */
  16. var gEngine = gEngine || { };
  18. /**
  19.  * 
  20.  * @class gEngine.DefaultResources
  21.  * @type Function|Engine_DefaultResources_L21.mPublic
  22.  */
  23. gEngine.DefaultResources = (function () {
  24.     // Global Ambient color
  25.     var mGlobalAmbientColor = [0.3, 0.3, 0.3, 1];
  26.     var mGlobalAmbientIntensity = 1;
  27.     
  28.     /**
  29.      * Return Global Ambient Intensity Value
  30.      * @memberOf gEngine.DefaultResources
  31.      * @returns {Number} Global Ambient Intensity Value
  32.      */
  33.     var getGlobalAmbientIntensity = function () { return mGlobalAmbientIntensity; };
  34.     
  35.     /**
  36.      * Set Global Ambient Intensity Value
  37.      * @memberOf gEngine.DefaultResources
  38.      * @param {Number} v Global Ambient Intensity Value
  39.      * @returns {void}
  40.      */
  41.     var setGlobalAmbientIntensity = function (v) { mGlobalAmbientIntensity = v; };
  42.     
  43.     /**
  44.      * Return Global Ambient Color [R, G, B, A]
  45.      * @memberOf gEngine.DefaultResources
  46.      * @returns {Float[]} Global Ambient Color
  47.      */
  48.     var getGlobalAmbientColor = function () { return mGlobalAmbientColor; };
  49.     
  50.     /**
  51.      * Set Global Ambient Color [R, G, B, A]
  52.      * @memberOf gEngine.DefaultResources
  53.      * @param {type} v Global Ambient Color
  54.      * @returns {void}
  55.      */
  56.     var setGlobalAmbientColor = function (v) { mGlobalAmbientColor = vec4.fromValues(v[0], v[1], v[2], v[3]); };
  57.     // Unlit Shader
  58.     var kUnlitFS = "src/GLSLShaders/UnlitFS.glsl";  // Path to the unlit FragmentShader
  59.     var mUnlitShader = null;
  61.     // Unlit Texture Shader
  62.     var kUnlitTextureFS = "src/GLSLShaders/UnlitTextureFS.glsl";  // Path to the texture FragmentShader
  63.     var mUnlitTextureShader = null;
  64.     var mUnlitSpriteShader = null;
  66.     // Simple Shader
  67.     var kSimpleVS = "src/GLSLShaders/SimpleVS.glsl";  // Path to the VertexShader 
  68.     var kSimpleFS = "src/GLSLShaders/SimpleFS.glsl";  // Path to the simple FragmentShader
  69.     var mConstColorShader = null;
  71.     // Texture Shader
  72.     var kTextureVS = "src/GLSLShaders/TextureVS.glsl";  // Path to the VertexShader 
  73.     var kTextureFS = "src/GLSLShaders/TextureFS.glsl";  // Path to the texture FragmentShader
  74.     var mTextureShader = null;
  75.     var mSpriteShader = null;
  76.     var kLineFS = "src/GLSLShaders/LineFS.glsl";        // Path to the Line FragmentShader
  77.     var mLineShader = null;
  79.     // Light Shader
  80.     var kLightFS = "src/GLSLShaders/LightFS.glsl";  // Path to the Light FragmentShader
  81.     var mLightShader = null;
  83.     // Illumination Shader
  84.     var kIllumFS = "src/GLSLShaders/IllumFS.glsl";  // Path to the Illumination FragmentShader
  85.     var mIllumShader = null;
  87.     // Shadow shaders
  88.     var kShadowReceiverFS = "src/GLSLShaders/ShadowReceiverFS.glsl";  // Path to the FragmentShader
  89.     var mShadowReceiverShader = null;
  90.     var kShadowCasterFS = "src/GLSLShaders/ShadowCasterFS.glsl";  // Path to the FragmentShader
  91.     var mShadowCasterShader = null;
  92.     
  93.     var kParticleFS = "src/GLSLShaders/ParticleFS.glsl";
  94.     var mParticleShader = null;
  96.     // Default font
  97.     var kDefaultFont = "assets/fonts/system-default-font";
  98.     // Particles
  99.     var kParticleTexture = "assets/ParticleSystem/particle.png";
  100.     var fireParticleTexture = "assets/ParticleSystem/flameparticle.png";
  101.     var smokeParticleTexture = "assets/ParticleSystem/smokeparticle.png";
  102.     var snowParticleTexture = "assets/ParticleSystem/snowparticle.png";
  103.     var tinyParticleTexture = "assets/ParticleSystem/tiny.png";
  104.     var dustParticleTexture = "assets/ParticleSystem/dust.png";
  105.     var dust2ParticleTexture = "assets/ParticleSystem/dust2.png";
  106.     var flareParticleTexture = "assets/ParticleSystem/flare.png";
  107.     var shockParticleTexture = "assets/ParticleSystem/shock.png";
  108.     var shock2ParticleTexture = "assets/ParticleSystem/shock2.png";
  109.     var targetParticleTexture = "assets/Fire/target.png";
  110.     var sparkleParticleTexture = "assets/ParticleSystem/sparkle.png";
  111.     var bubbleParticleTexture = "assets/ParticleSystem/bubble.png";
  112.     
  113.     // UI
  114.     var UIRadarButtonTexture = "assets/UI/radarbutton.png";
  115.     var UIDropDownArrow = "assets/UI/ddarrow.png";
  116.     var BarStencil = "assets/UI/BarStencil.png";
  117.     var VBarStencil = "assets/UI/VBarStencil.png";
  118.     var SliderHandle = "assets/UI/SliderHandle.png";
  119.     var VSliderHandle = "assets/UI/VSliderHandle.png";
  120.     var SwitchToggleHandle = "assets/UI/SwitchToggleHandle.png";
  121.     var SwitchToggleStencil = "assets/UI/SwitchToggleStencil.png";
  122.     var ButtonStencil = "assets/UI/ButtonStencil.png";
  123.     
  124.     /**
  125.      * Return the Global default font
  126.      * @memberOf gEngine.DefaultResources
  127.      * @returns {String} Default font name
  128.      */
  129.     var getDefaultFont = function () { return kDefaultFont; };
  131.     var _createShaders = function (callBackFunction) {
  132.         gEngine.ResourceMap.setLoadCompleteCallback(null);
  133.         mUnlitShader = new UnlitShader(kSimpleVS, kUnlitFS);
  134.         mUnlitTextureShader = new UnlitTextureShader(kTextureVS, kUnlitTextureFS);
  135.         mUnlitSpriteShader =  new UnlitSpriteShader(kTextureVS, kUnlitTextureFS);
  136.         mConstColorShader = new SimpleShader(kSimpleVS, kSimpleFS);
  137.         mTextureShader = new TextureShader(kTextureVS, kTextureFS);
  138.         mSpriteShader =  new SpriteShader(kTextureVS, kTextureFS);
  139.         mLineShader =  new LineShader(kSimpleVS, kLineFS);
  140.         mLightShader = new LightShader(kTextureVS, kLightFS);
  141.         mIllumShader = new IllumShader(kTextureVS, kIllumFS);
  142.         mShadowReceiverShader = new SpriteShader(kTextureVS, kShadowReceiverFS);
  143.         mShadowCasterShader = new ShadowCasterShader(kTextureVS, kShadowCasterFS);
  144.         mParticleShader = new TextureShader(kTextureVS, kParticleFS);
  145.         callBackFunction();
  146.     };
  148.     /**
  149.      * Return the Unlit Shader
  150.      * @memberOf gEngine.DefaultResources
  151.      * @returns {UnlitShader} Unlit Shader
  152.      */
  153.     var getUnlitShader = function () { return mUnlitShader; };
  154.     
  155.     /**
  156.      * Return the Unlit Texture Shader
  157.      * @memberOf gEngine.DefaultResources
  158.      * @returns {UnlitTextureShader} Unlit Texture Shader
  159.      */
  160.     var getUnlitTextureShader = function () { return mUnlitTextureShader; };
  161.     
  162.     /**
  163.      * Return the Unlit Sprite Shader
  164.      * @memberOf gEngine.DefaultResources
  165.      * @returns {UnlitSpriteShader} Unlit Sprite Shader
  166.      */
  167.     var getUnlitSpriteShader = function () { return mUnlitSpriteShader; };
  169.     /**
  170.      * Return the Constant Color Shader
  171.      * @memberOf gEngine.DefaultResources
  172.      * @returns {SimpleShader} Simple Shader
  173.      */
  174.     var getConstColorShader = function () { return mConstColorShader; };
  175.     
  176.     /**
  177.      * Return the Texture Shader
  178.      * @memberOf gEngine.DefaultResources
  179.      * @returns {TextureShader} Texture Shader
  180.      */
  181.     var getTextureShader = function () { return mTextureShader; };
  182.     
  183.     /**
  184.      * Return the Sprite Shader
  185.      * @memberOf gEngine.DefaultResources
  186.      * @returns {SpriteShader} Sprite Shader
  187.      */
  188.     var getSpriteShader = function () { return mSpriteShader; };
  189.     
  190.     /**
  191.      * Return the Line Shader
  192.      * @memberOf gEngine.DefaultResources
  193.      * @returns {LineShader} Line Shader
  194.      */
  195.     var getLineShader = function () { return mLineShader; };
  196.     
  197.     /**
  198.      * Return the Light Shader
  199.      * @memberOf gEngine.DefaultResources
  200.      * @returns {LightShader} Light Shader
  201.      */
  202.     var getLightShader = function () { return mLightShader; };
  203.     
  204.     /**
  205.      * Return the Illum Shader
  206.      * @memberOf gEngine.DefaultResources
  207.      * @returns {IllumShader} Illum Shader
  208.      */
  209.     var getIllumShader = function () { return mIllumShader; };
  210.     
  211.     /**
  212.      * Return the Shadow Receiver Shader
  213.      * @memberOf gEngine.DefaultResources
  214.      * @returns {SpriteShader} Shadow Receiver Shader
  215.      */
  216.     var getShadowReceiverShader = function () { return mShadowReceiverShader; };
  217.     
  218.     /**
  219.      * Return the Shadow Caster Shader
  220.      * @memberOf gEngine.DefaultResources
  221.      * @returns {ShadowCasterShader} Shadow Caster Shader
  222.      */
  223.     var getShadowCasterShader = function () { return mShadowCasterShader; };
  224.     
  225.     /**
  226.      * Return the Particle Shader
  227.      * @memberOf gEngine.DefaultResources
  228.      * @returns {TextureShader} Particle Shader
  229.      */
  230.     var getParticleShader = function () { return mParticleShader; };
  232.     /**
  233.      * Initilize Default Resources.<p>
  234.      * Calls callBackFunction when finished loading.
  235.      * @memberOf gEngine.DefaultResources
  236.      * @param {Function} callBackFunction to call after loading completes
  237.      * @returns {void}
  238.      */
  239.     var initialize = function (callBackFunction) {
  240.         // unlit shader: UnlitFS
  241.         gEngine.TextFileLoader.loadTextFile(kUnlitFS, gEngine.TextFileLoader.eTextFileType.eTextFile);
  243.         // unlit texture shader: 
  244.         gEngine.TextFileLoader.loadTextFile(kUnlitTextureFS, gEngine.TextFileLoader.eTextFileType.eTextFile);
  245.         
  246.         // constant color shader: SimpleVS, and SimpleFS
  247.         gEngine.TextFileLoader.loadTextFile(kSimpleVS, gEngine.TextFileLoader.eTextFileType.eTextFile);
  248.         gEngine.TextFileLoader.loadTextFile(kSimpleFS, gEngine.TextFileLoader.eTextFileType.eTextFile);
  250.         // texture shader: 
  251.         gEngine.TextFileLoader.loadTextFile(kTextureVS, gEngine.TextFileLoader.eTextFileType.eTextFile);
  252.         gEngine.TextFileLoader.loadTextFile(kTextureFS, gEngine.TextFileLoader.eTextFileType.eTextFile);
  254.         // Line Shader:
  255.         gEngine.TextFileLoader.loadTextFile(kLineFS, gEngine.TextFileLoader.eTextFileType.eTextFile);
  257.         // Light Shader
  258.         gEngine.TextFileLoader.loadTextFile(kLightFS, gEngine.TextFileLoader.eTextFileType.eTextFile);
  260.         // Illumination Shader
  261.         gEngine.TextFileLoader.loadTextFile(kIllumFS, gEngine.TextFileLoader.eTextFileType.eTextFile);
  263.         // Shadow caster and receiver shaders
  264.         gEngine.TextFileLoader.loadTextFile(kShadowReceiverFS, gEngine.TextFileLoader.eTextFileType.eTextFile);
  265.         gEngine.TextFileLoader.loadTextFile(kShadowCasterFS, gEngine.TextFileLoader.eTextFileType.eTextFile);
  267.         // particle shader
  268.         gEngine.TextFileLoader.loadTextFile(kParticleFS, gEngine.TextFileLoader.eTextFileType.eTextFile);
  269.         
  270.         // load default font
  271.         gEngine.Fonts.loadFont(kDefaultFont);
  272.         // load particles
  273.         gEngine.Textures.loadTexture(kParticleTexture);
  274.         gEngine.Textures.loadTexture(fireParticleTexture);
  275.         gEngine.Textures.loadTexture(smokeParticleTexture);
  276.         gEngine.Textures.loadTexture(snowParticleTexture);
  277.         gEngine.Textures.loadTexture(tinyParticleTexture);
  278.         gEngine.Textures.loadTexture(dustParticleTexture);
  279.         gEngine.Textures.loadTexture(dust2ParticleTexture);
  280.         gEngine.Textures.loadTexture(flareParticleTexture);
  281.         gEngine.Textures.loadTexture(shockParticleTexture);
  282.         gEngine.Textures.loadTexture(shock2ParticleTexture);
  283.         gEngine.Textures.loadTexture(targetParticleTexture);
  284.         gEngine.Textures.loadTexture(bubbleParticleTexture);
  285.         gEngine.Textures.loadTexture(sparkleParticleTexture);
  286.         gEngine.Textures.loadTexture(UIRadarButtonTexture);
  287.         gEngine.Textures.loadTexture(UIDropDownArrow);
  288.         gEngine.Textures.loadTexture(BarStencil);
  289.         gEngine.Textures.loadTexture(VBarStencil);
  290.         gEngine.Textures.loadTexture(SliderHandle);
  291.         gEngine.Textures.loadTexture(VSliderHandle);
  292.         gEngine.Textures.loadTexture(SwitchToggleHandle);
  293.         gEngine.Textures.loadTexture(SwitchToggleStencil);
  294.         gEngine.Textures.loadTexture(ButtonStencil);
  296.         gEngine.ResourceMap.setLoadCompleteCallback(function s() {_createShaders(callBackFunction); });
  297.     };
  299.     /**
  300.      * unload all resources
  301.      * @memberOf gEngine.DefaultResources
  302.      * @returns {void}
  303.      */
  304.     var cleanUp = function () {
  305.         mUnlitShader.cleanUp();
  306.         mUnlitTextureShader.cleanUp();
  307.         mUnlitSpriteShader.cleanUp();
  308.         mConstColorShader.cleanUp();
  309.         mTextureShader.cleanUp();
  310.         mSpriteShader.cleanUp();
  311.         mLineShader.cleanUp();
  312.         mLightShader.cleanUp();
  313.         mIllumShader.cleanUp();
  314.         mShadowReceiverShader.cleanUp();
  315.         mShadowCasterShader.cleanUp();
  316.         mParticleShader.cleanUp();
  318.         // unlit shader:
  319.         gEngine.TextFileLoader.unloadTextFile(kUnlitFS);
  321.         // unlit texture shader: 
  322.         gEngine.TextFileLoader.unloadTextFile(kUnlitTextureFS);
  324.         // constant color shader:
  325.         gEngine.TextFileLoader.unloadTextFile(kSimpleVS);
  326.         gEngine.TextFileLoader.unloadTextFile(kSimpleFS);
  328.         // texture shader: 
  329.         gEngine.TextFileLoader.unloadTextFile(kTextureVS);
  330.         gEngine.TextFileLoader.unloadTextFile(kTextureFS);
  332.         // Line Shader:
  333.         gEngine.TextFileLoader.unloadTextFile(kLineFS);
  336.         // Light Shader
  337.         gEngine.TextFileLoader.unloadTextFile(kLightFS);
  339.          // Illumination Shader
  340.         gEngine.TextFileLoader.unloadTextFile(kIllumFS);
  341.         
  342.         // Shadow shaders
  343.         gEngine.TextFileLoader.unloadTextFile(kShadowReceiverFS, gEngine.TextFileLoader.eTextFileType.eTextFile);
  344.         gEngine.TextFileLoader.unloadTextFile(kShadowCasterFS, gEngine.TextFileLoader.eTextFileType.eTextFile);
  346.         // particle shader
  347.         gEngine.TextFileLoader.unloadTextFile(kParticleFS);
  349.         // default font
  350.         gEngine.Fonts.unloadFont(kDefaultFont);
  351.         
  352.         // particles
  353.         gEngine.Textures.unloadTexture(kParticleTexture);
  354.         gEngine.Textures.unloadTexture(fireParticleTexture);
  355.         gEngine.Textures.unloadTexture(smokeParticleTexture);
  356.         gEngine.Textures.unloadTexture(snowParticleTexture);
  357.         gEngine.Textures.unloadTexture(tinyParticleTexture);
  358.         gEngine.Textures.unloadTexture(dustParticleTexture);
  359.         gEngine.Textures.unloadTexture(dust2ParticleTexture);
  360.         gEngine.Textures.unloadTexture(flareParticleTexture);
  361.         gEngine.Textures.unloadTexture(shockParticleTexture);
  362.         gEngine.Textures.unloadTexture(shock2ParticleTexture);
  363.         gEngine.Textures.unloadTexture(targetParticleTexture);
  364.         gEngine.Textures.unloadTexture(bubbleParticleTexture);
  365.         gEngine.Textures.unloadTexture(sparkleParticleTexture);
  366.         gEngine.Textures.unloadTexture(UIRadarButtonTexture);
  367.         gEngine.Textures.unloadTexture(UIDropDownArrow);
  368.         gEngine.Textures.unloadTexture(BarStencil);
  369.         gEngine.Textures.unloadTexture(VBarStencil);
  370.         gEngine.Textures.unloadTexture(SliderHandle);
  371.         gEngine.Textures.unloadTexture(VSliderHandle);
  372.         gEngine.Textures.unloadTexture(SwitchToggleHandle);
  373.         gEngine.Textures.unloadTexture(SwitchToggleStencil);
  374.         gEngine.Textures.unloadTexture(ButtonStencil);
  375.     };
  377.     // Public interface for this object. Anything not in here will
  378.     // not be accessable.
  379.     var mPublic = {
  380.         initialize: initialize,
  381.         getUnlitShader: getUnlitShader,
  382.         getUnlitTextureShader: getUnlitTextureShader,
  383.         getUnlitSpriteShader: getUnlitSpriteShader,
  384.         getConstColorShader: getConstColorShader,
  385.         getTextureShader: getTextureShader,
  386.         getSpriteShader: getSpriteShader,
  387.         getLineShader: getLineShader,
  388.         getLightShader: getLightShader,
  389.         getIllumShader: getIllumShader,
  390.         getShadowReceiverShader: getShadowReceiverShader,
  391.         getShadowCasterShader: getShadowCasterShader,
  392.         getParticleShader: getParticleShader,
  393.         getDefaultFont: getDefaultFont,
  394.         getGlobalAmbientColor: getGlobalAmbientColor,
  395.         setGlobalAmbientColor: setGlobalAmbientColor,
  396.         getGlobalAmbientIntensity: getGlobalAmbientIntensity,
  397.         setGlobalAmbientIntensity: setGlobalAmbientIntensity,
  398.         cleanUp: cleanUp
  399.     };
  400.     return mPublic;
  401. }());