mdx-m3-viewer/src/viewer/promiseresource.ts

A browser WebGL model viewer. Mainly focused on models of the games Warcraft 3 and Starcraft 2.

import { Resource } from './resource';

/**
 * This object is used to promise about future resource loads, in case they are not yet known.
 * It is needed to stop the viewer from preemtively calling whenAllLoaded.
 *
 * An example of this is MDX event objects.
 * First the SLK their data is contained in needs to be loaded, and only then can the actual objects be loaded.
 * Once the SLK loads, the viewer thinks it finished loading and calls whenAllLoaded, before starting to load the objects.
 * Adding a promise in this case acts as a barrier, which is removed by resolving the promise after the objects start loading.
 *
 * Note that you can create a promise resource with viewer.promise(), which returns an already active promise.
 */
export default class PromiseResource extends Resource {
  /**
   * Does nothing.
   */
  load() {

  }

  /**
   * Immitates a promise.
   */
  promise() {
    this.emit('loadstart', this);
  }

  /**
   * Immitates promise resolution.
   */
  resolve() {
    this.emit('loadend', this);
  }
}