gibbon.js/lib/src/layerManager.js

Actor/Component system for use with pixi.js.

import { Container } from 'pixi.js';
/**
 * Use to keep track of basic game layers.
 * Each layer is a separate PIXI.Container objects on the stage.
 * Possibly change these layers to Actors in the future, but at the moment
 * they're easier to deal with as raw PIXI Containers.
 */
export class LayerManager {
    get background() { return this._background; }
    get foreground() { return this._foreground; }
    get objectLayer() { return this._objectLayer; }
    get uiLayer() { return this._uiLayer; }
    get layerCount() { return this._objectLayer.parent.children.length; }
    _foreground;
    _background;
    _objectLayer;
    _uiLayer;
    _baseLayer;
    /**
     *
     * @param opts - Set initial LayerManager containers.
     * @param opts.baseLayer - Layer to use as the base of all others.
     * Defaults to game.stage.
     * @param opts.layers - Additional layers to create.
     */
    constructor(game, opts) {
        this._baseLayer = opts?.baseLayer ?? game.stage;
        this._objectLayer = opts?.objects ?? this.createLayer('objects');
        if (opts) {
            this._uiLayer = opts.uiLayer;
            this._background = opts.background;
            this._foreground = opts.foreground;
            if (opts.layers) {
                this.initFromData(opts.layers);
            }
        }
        else {
            this._background = this.createLayer('background');
            this._uiLayer = this.createLayer('uiLayer');
        }
    }
    addLayer(container) {
        if (container.parent === null) {
            this._baseLayer.addChild(container);
        }
    }
    /**
     * Add a layer to the stage.
     * @param {string} name - the name of the layer clip.
     * @param {number} index - index where the new clip is placed.
     * @returns {Container} the clip created.
     */
    createLayer(name, index) {
        const clip = new Container();
        clip.name = name;
        if (index === null || index === undefined) {
            this._baseLayer.addChild(clip);
        }
        else
            this._baseLayer.addChildAt(clip, index);
        return clip;
    }
    initFromData(layerData) {
        const base = this._baseLayer;
        for (const data of layerData) {
            const clip = new Container();
            clip.name = data.name || '';
            if (data.depth) {
                base.addChildAt(clip, data.depth);
            }
            else
                base.addChild(clip);
        }
    }
}
//# sourceMappingURL=layerManager.js.map