topical media & game development

topical media & game development

[] readme course(s) preface I 1 2 II 3 4 III 5 6 7 IV 8 9 10 V 11 12 afterthought(s) appendix reference(s) example(s) resource(s) _

graphic-o3d-samples-o3djs-loader.js / js


  /*
   * Copyright 2009, Google Inc.
   * All rights reserved.
   *
   * Redistribution and use in source and binary forms, with or without
   * modification, are permitted provided that the following conditions are
   * met:
   *
   *     * Redistributions of source code must retain the above copyright
   * notice, this list of conditions and the following disclaimer.
   *     * Redistributions in binary form must reproduce the above
   * copyright notice, this list of conditions and the following disclaimer
   * in the documentation and/or other materials provided with the
   * distribution.
   *     * Neither the name of Google Inc. nor the names of its
   * contributors may be used to endorse or promote products derived from
   * this software without specific prior written permission.
   *
   * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
   * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
   * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
   * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
   * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
   * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
   * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
   * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
   * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
   * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
   * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
   */

@fileoverview This file contains a loader class for helping to load muliple assets in an asynchronous manner.


  
  
  o3djs.provide('o3djs.loader');
  
  o3djs.require('o3djs.io');
  o3djs.require('o3djs.scene');

A Module with a loader class for helping to load muliple assets in an asynchronous manner. @namespace


  
  o3djs.loader = o3djs.loader || {};

A simple Loader class to call some callback when everything has loaded. @constructor
parameter: {!function(): void} onFinished Function to call when final item has loaded.


  
  o3djs.loader.Loader = function(onFinished)  {
    this.count_ = 1;
    this.onFinished_ = onFinished;

The LoadInfo for this loader you can use to track progress. @type {!o3djs.io.LoadInfo}


  
    this.loadInfo = o3djs.io.createLoadInfo();
  };

Creates a Loader for helping to load a bunch of items asychronously. The way you use this is as follows. <pre> var loader = o3djs.loader.createLoader(myFinishedCallback); loader.loadTexture(pack, texture1Url, callbackForTexture); loader.loadTexture(pack, texture2Url, callbackForTexture); loader.loadTexture(pack, texture3Url, callbackForTexture); loader.finish(); </pre> The loader guarantees that myFinishedCallback will be called after all the items have been loaded.
parameter: {!function(): void} onFinished Function to call when final item has loaded.
returns: {!o3djs.loader.Loader} A Loader Object.


  
  o3djs.loader.createLoader = function(onFinished) {
    return new o3djs.loader.Loader(onFinished);
  };

Loads a texture.
parameter: {!o3d.Pack} pack Pack to load texture into.
parameter: {string} url URL of texture to load.
parameter: {!function(o3d.Texture, *): void} opt_onTextureLoaded optional callback when texture is loaded. It will be passed the texture and an exception which is null on success.


  
  o3djs.loader.Loader.prototype.loadTexture = function(pack,
                                                       url,
                                                       opt_onTextureLoaded) {
    var that = this;  // so the function below can see "this".
    ++this.count_;
    var loadInfo = o3djs.io.loadTexture(pack, url, function(texture, exception) {
      if (opt_onTextureLoaded) {
        opt_onTextureLoaded(texture, exception);
      }
      that.countDown_();
    });
    this.loadInfo.addChild(loadInfo);
  };

Loads a 3d scene.
parameter: {!o3d.Client} client An O3D client object.
parameter: {!o3d.Pack} pack Pack to load texture into.
parameter: {!o3d.Transform} parent Transform to parent scene under.
parameter: {string} url URL of scene to load.
parameter: {!function(!o3d.Pack, !o3d.Transform, *): void} opt_onSceneLoaded optional callback when scene is loaded. It will be passed the pack and parent and an exception which is null on success.


  
  o3djs.loader.Loader.prototype.loadScene = function(client,
                                                     pack,
                                                     parent,
                                                     url,
                                                     opt_onSceneLoaded) {
    var that = this;  // so the function below can see "this".
    ++this.count_;
    var loadInfo = o3djs.scene.loadScene(
        client, pack, parent, url, function(pack, parent, exception) {
      if (opt_onSceneLoaded) {
        opt_onSceneLoaded(pack, parent, exception);
      }
      that.countDown_();
    });
    this.loadInfo.addChild(loadInfo);
  };

Loads a text file.
parameter: {string} url URL of scene to load.
parameter: {!function(string, *): void} onTextLoaded Function to call when the file is loaded. It will be passed the contents of the file as a string and an exception which is null on success.


  
  o3djs.loader.Loader.prototype.loadTextFile = function(url, onTextLoaded) {
    var that = this;  // so the function below can see "this".
    ++this.count_;
    var loadInfo = o3djs.io.loadTextFile(url, function(string, exception) {
      onTextLoaded(string, exception);
      that.countDown_();
    });
    this.loadInfo.addChild(loadInfo);
  };

Creates a loader that is tracked by this loader so that when the new loader is finished it will be reported to this loader.
parameter: {!function(): void} onFinished Function to be called when everything loaded with this loader has finished.
returns: {!o3djs.loader.Loader} The new Loader.


  
  o3djs.loader.Loader.prototype.createLoader = function(onFinished) {
    var that = this;
    ++this.count_;
    var loader = o3djs.loader.createLoader(function() {
        onFinished();
        that.countDown_();
    });
    this.loadInfo.addChild(loader.loadInfo);
    return loader;
  };

Counts down the internal count and if it gets to zero calls the callback. @private


  
  o3djs.loader.Loader.prototype.countDown_ = function() {
    --this.count_;
    if (this.count_ === 0) {
      this.onFinished_();
    }
  };

Finishes the loading process. Actually this just calls countDown_ to account for the count starting at 1.


  
  o3djs.loader.Loader.prototype.finish = function() {
    this.countDown_();
  };

[] readme course(s) preface I 1 2 II 3 4 III 5 6 7 IV 8 9 10 V 11 12 afterthought(s) appendix reference(s) example(s) resource(s) _

You may not copy or print any of this material without explicit permission of the author or the publisher. In case of other copyright issues, contact the author.