@woosh/meep-engine/src/engine/ecs/gui/hud/HeadsUpDisplay.js

Pure JavaScript game engine. Fully featured and production ready.

import { combine_hash } from "../../../../core/collection/array/combine_hash.js";
import Vector3 from '../../../../core/geom/Vector3.js';
import { HeadsUpDisplayFlag } from "./HeadsUpDisplayFlag.js";

class HeadsUpDisplay {

    /**
     *
     * @type {Vector3}
     */
    worldOffset = new Vector3();

    /**
     *
     * @type {number}
     */
    flags = HeadsUpDisplayFlag.TransformWorldOffset;


    /**
     *
     * @param {number|HeadsUpDisplayFlag} flag
     * @returns {void}
     */
    setFlag(flag) {
        this.flags |= flag;
    }

    /**
     *
     * @param {number|HeadsUpDisplayFlag} flag
     * @returns {void}
     */
    clearFlag(flag) {
        this.flags &= ~flag;
    }

    /**
     *
     * @param {number|HeadsUpDisplayFlag} flag
     * @param {boolean} value
     */
    writeFlag(flag, value) {
        if (value) {
            this.setFlag(flag);
        } else {
            this.clearFlag(flag);
        }
    }

    /**
     *
     * @param {number|HeadsUpDisplayFlag} flag
     * @returns {boolean}
     */
    getFlag(flag) {
        return (this.flags & flag) === flag;
    }

    /**
     *
     * @param {HeadsUpDisplay} other
     * @returns {boolean}
     */
    equals(other) {
        return this.flags === other.flags
            && this.worldOffset.equals(other.worldOffset)
            ;
    }

    /**
     *
     * @return {number}
     */
    hash() {
        return combine_hash(
            this.flags,
            this.worldOffset.hash()
        );
    }

    toJSON() {
        return {
            worldOffset: this.worldOffset.toJSON(),
            transformWorldOffset: this.getFlag(HeadsUpDisplayFlag.TransformWorldOffset),
            transformPerspectiveRotation: this.getFlag(HeadsUpDisplayFlag.PerspectiveRotation)
        };
    }

    fromJSON({ worldOffset = Vector3.zero, transformWorldOffset = true, perspectiveRotation = false }) {
        this.worldOffset.fromJSON(worldOffset);
        this.writeFlag(HeadsUpDisplayFlag.TransformWorldOffset, transformWorldOffset);
        this.writeFlag(HeadsUpDisplayFlag.PerspectiveRotation, perspectiveRotation);
    }

    static fromJSON(j) {
        const r = new HeadsUpDisplay();

        r.fromJSON(j);

        return r;
    }
}

HeadsUpDisplay.typeName = "HeadsUpDisplay";
HeadsUpDisplay.serializable = true;

export default HeadsUpDisplay;