@theatrejs/theatrejs/sources/core/sprite.js

🎮 A JavaScript 2D Game Engine focused on creating pixel art games.

import {AABB, Vector2} from '../index.js';

/**
 * Creates sprites.
 *
 * @example
 *
 * // minimal
 * const sprite = new Sprite({
 *
 *     $sizeTarget: new Vector2(32, 32),
 *     $texture: texture
 * });
 *
 * @example
 *
 * // full
 * const sprite = new Sprite({
 *
 *     $frameSource: new AABB(new Vector2(0, 0), new Vector2(1, 1)),
 *     $sizeTarget: new Vector2(32, 32),
 *     $texture: texture
 * });
 */
class Sprite {

    /**
     * Stores the frame to use from the texture sources (with values in [0, 1] ranges).
     * @type {AABB}
     * @private
     */
    $frameSource;

    /**
     * Stores the serialized value of frame to use from the texture sources (with values in [0, 1] ranges).
     * @type {string}
     * @private
     */
    $frameSourceSerialized;

    /**
     * Stores the target size.
     * @type {Vector2}
     * @private
     */
    $sizeTarget;

    /**
     * Stores the texture source.
     * @type {string}
     * @private
     */
    $texture;

    /**
     * Gets the frame to use from the texture sources.
     * @type {AABB}
     * @public
     */
    get frameSource() {

        return this.$frameSource;
    }

    /**
     * Gets the serialized value of the frame to use from the texture sources.
     * @type {string}
     * @public
     */
    get frameSourceSerialized() {

        return this.$frameSourceSerialized;
    }

    /**
     * Gets the target size.
     * @type {Vector2}
     * @public
     */
    get sizeTarget() {

        return this.$sizeTarget;
    }

    /**
     * Gets the texture source.
     * @type {string}
     * @public
     */
    get texture() {

        return this.$texture;
    }

    /**
     * Creates a new sprite.
     * @param {object} $parameters The given parameters.
     * @param {AABB} [$parameters.$frameSource] The frame to use from the texture sources (with values in [0, 1] ranges) (if not specified then the full texture is used).
     * @param {Vector2} $parameters.$sizeTarget The target size.
     * @param {string} $parameters.$texture The texture source.
     */
    constructor({$frameSource = new AABB(new Vector2(0, 0), new Vector2(1, 1)), $sizeTarget, $texture}) {

        this.$frameSource = $frameSource.clone();
        this.$sizeTarget = $sizeTarget.clone();
        this.$texture = $texture;

        this.$frameSourceSerialized = JSON.stringify([

            [$frameSource.minimum.x, $frameSource.minimum.y],
            [$frameSource.maximum.x, $frameSource.maximum.y]
        ]);
    }
}

export {

    Sprite
};

export default Sprite;