gibbon.js/lib/src/group.js

Actor/Component system for use with pixi.js.

import { contains } from './utils/array-utils';
/**
 * If a clip is supplied to the Group, it will act as the parent
 * of all GameObject clips added to the group.
 */
export default class Group {
    get gameObject() {
        return this._gameObject;
    }
    /**
      * @property clip - clip associated with group, if any.
      * Objects added to the group are added to clip's child clips.
      */
    clip;
    /**
     * @property {string} name
     */
    name;
    /**
     * @property {boolean} paused
     */
    get paused() { return this._paused; }
    subgroups;
    objects;
    game;
    get engine() { return this.game.engine; }
    /**
     * GameObject to hold group components.
     */
    _gameObject;
    _paused = false;
    /**
     *
     * @param {Game} game
     * @param {DisplayObject} [clip=null]
     * @param {boolean} [paused=false]
     */
    constructor(game, clip = undefined, paused = false, createGroupObject = false) {
        this._paused = paused;
        this.clip = clip;
        this.game = game;
        this.objects = [];
        this.subgroups = [];
        if (createGroupObject) {
            this.makeGroupObject();
        }
    }
    /**
      * Ensure the group has its own group GameObject.
      */
    makeGroupObject() {
        this._gameObject = this.engine.Instantiate(this.clip);
        return this._gameObject;
    }
    pause() {
        if (this._paused)
            return;
        this._paused = true;
        for (let obj of this.objects) {
            if (('pause' in obj) && typeof obj.pause === 'function') {
                obj.pause();
            }
            obj.active = false;
        }
        for (let g of this.subgroups) {
            g.pause();
        }
    }
    unpause() {
        if (this._paused === false)
            return;
        for (let obj of this.objects) {
            if (obj.unpause)
                obj.unpause();
            obj.active = true;
        }
        for (let g of this.subgroups) {
            g.unpause();
        }
        this._paused = false;
    }
    /**
     * Show all the objects in the group and subgroups.
     */
    show() {
        if (this.clip) {
            this.clip.visible = false;
        }
        for (let i = this.subgroups.length - 1; i >= 0; i--) {
            this.subgroups[i].show();
        }
    }
    hide() {
        if (this.clip) {
            this.clip.visible = true;
        }
        for (let i = this.subgroups.length - 1; i >= 0; i--) {
            this.subgroups[i].hide();
        }
    }
    findGroup(gname) {
        for (let i = this.subgroups.length - 1; i >= 0; i--) {
            if (this.subgroups[i].name == gname)
                return this.subgroups[i];
        }
        return undefined;
    }
    /**
     *
     * @param {Group} g
     */
    addGroup(g) {
        if (!contains(this.subgroups, g)) {
            this.subgroups.push(g);
        }
    }
    /**
     *
     * @param {Group} g
     */
    removeGroup(g) {
        for (var i = this.subgroups.length - 1; i >= 0; i--) {
            if (this.subgroups[i] == g) {
                this.subgroups.splice(i, 1);
                return;
            }
        }
    }
    /**
     * Remove GameObject from group, but not Engine.
     * @param {GameObject} obj
     */
    remove(obj, removeClip = true) {
        let ind = this.objects.indexOf(obj);
        if (ind < 0)
            return;
        this.objects.splice(ind, 1);
        obj.off('destroy', this.remove, this);
        if (this.clip && obj.clip && removeClip) {
            this.clip.removeChild(obj.clip);
        }
        obj.group = null;
    }
    /**
     *
     * @param {GameObject} obj
     * @returns {GameObject} the object.
     */
    add(obj) {
        if (this.clip && obj.clip && (obj.clip != this.clip)) {
            this.clip.addChild(obj.clip);
        }
        obj.group = this;
        obj.on('destroy', this.remove, this);
        this.objects.push(obj);
        this.engine.add(obj);
        return obj;
    }
    destroy() {
        this._paused = true;
        for (let i = this.subgroups.length - 1; i >= 0; i--) {
            this.subgroups[i].destroy();
        }
        for (let i = this.objects.length - 1; i >= 0; i--) {
            this.objects[i].off('destroy', this.remove, this);
            this.objects[i].destroy();
        }
    }
}
//# sourceMappingURL=group.js.map