Newer
Older
pixi.js / src / mesh / NineSlicePlane.js
@Robert Krasky Robert Krasky on 4 Aug 2016 9 KB Adding CanvasRender worldAlpha (#2763)
var DEFAULT_BORDER_SIZE= 10;

var Plane = require('./Plane');

/**
 * The NineSlicePlane allows you to stretch a texture using 9-slice scaling. The corners will remain unscaled (useful
 * for buttons with rounded corners for example) and the other areas will be scaled horizontally and or vertically
 *  
 *```js
 * var Plane9 = new PIXI.NineSlicePlane(PIXI.Texture.fromImage('BoxWithRoundedCorners.png'), 15, 15, 15, 15);
 *  ```
 * <pre>
 *      A                          B
 *    +---+----------------------+---+
 *  C | 1 |          2           | 3 |
 *    +---+----------------------+---+
 *    |   |                      |   |
 *    | 4 |          5           | 6 |
 *    |   |                      |   |
 *    +---+----------------------+---+
 *  D | 7 |          8           | 9 |
 *    +---+----------------------+---+

 *  When changing this objects width and/or height:
 *     areas 1 3 7 and 9 will remain unscaled.
 *     areas 2 and 8 will be stretched horizontally
 *     areas 4 and 6 will be stretched vertically
 *     area 5 will be stretched both horizontally and vertically
 * </pre>
 *
 * @class
 * @extends PIXI.mesh.Plane
 * @memberof PIXI.mesh
 * @param {PIXI.Texture} texture - The texture to use on the NineSlicePlane.
 * @param {int} [leftWidth=10] size of the left vertical bar (A)
 * @param {int} [topHeight=10] size of the top horizontal bar (C)
 * @param {int} [rightWidth=10] size of the right vertical bar (B)
 * @param {int} [bottomHeight=10] size of the bottom horizontal bar (D)
 *
 */
function NineSlicePlane(texture, leftWidth, topHeight, rightWidth, bottomHeight)
{
    Plane.call(this, texture, 4, 4);

    var uvs = this.uvs;
    // right and bottom uv's are always 1
    uvs[6] = uvs[14] = uvs[22] = uvs[30] = 1;
    uvs[25] = uvs[27] = uvs[29] = uvs[31] = 1;

    this._origWidth = texture.width;
    this._origHeight = texture.height;
    this._uvw = 1 / this._origWidth;
    this._uvh = 1 / this._origHeight;
    /**
     * The width of the NineSlicePlane, setting this will actually modify the vertices and UV's of this plane
     *
     * @member {number}
     * @memberof PIXI.NineSlicePlane#
     * @override
     */
    this.width = texture.width;
    /**
     * The height of the NineSlicePlane, setting this will actually modify the vertices and UV's of this plane
     *
     * @member {number}
     * @memberof PIXI.NineSlicePlane#
     * @override
     */
    this.height = texture.height;

    uvs[2] = uvs[10] = uvs[18] = uvs[26] = this._uvw * leftWidth;
    uvs[4] = uvs[12] = uvs[20] = uvs[28] = 1 - this._uvw * rightWidth;
    uvs[9] = uvs[11] = uvs[13] = uvs[15] = this._uvh * topHeight;
    uvs[17] = uvs[19] = uvs[21] = uvs[23] = 1 - this._uvh * bottomHeight;

    /**
     * The width of the left column (a)
     *
     * @member {number}
     */
    this.leftWidth = typeof leftWidth !== 'undefined' ? leftWidth : DEFAULT_BORDER_SIZE;
    /**
     * The width of the right column (b)
     *
     * @member {number}
     */
    this.rightWidth = typeof rightWidth !== 'undefined' ? rightWidth : DEFAULT_BORDER_SIZE;
    /**
     * The height of the top row (c)
     *
     * @member {number}
     */
    this.topHeight = typeof topHeight !== 'undefined' ? topHeight : DEFAULT_BORDER_SIZE;
    /**
     * The height of the bottom row (d)
     *
     * @member {number}
     */
    this.bottomHeight = typeof bottomHeight !== 'undefined' ? bottomHeight : DEFAULT_BORDER_SIZE;
}


// constructor
NineSlicePlane.prototype = Object.create( Plane.prototype );
NineSlicePlane.prototype.constructor = NineSlicePlane;
module.exports = NineSlicePlane;

Object.defineProperties(NineSlicePlane.prototype, {
    /**
     * The width of the NineSlicePlane, setting this will actually modify the vertices and UV's of this plane
     *
     * @member {number}
     * @memberof PIXI.NineSlicePlane#
     * @override
     */
    width: {
        get: function ()
        {
            return this._width;
        },
        set: function (value)
        {
            this._width = value;
            this.updateVerticalVertices();
        }
    },

    /**
     * The height of the NineSlicePlane, setting this will actually modify the vertices and UV's of this plane
     *
     * @member {number}
     * @memberof PIXI.NineSlicePlane#
     * @override
     */
    height: {
        get: function ()
        {
            return  this._height;
        },
        set: function (value)
        {
            this._height = value;
            this.updateHorizontalVertices();
        }
    },

    /**
     * The width of the left column
     *
     * @member {number}
     */
    leftWidth: {
        get: function()
        {
            return this._leftWidth;
        },
        set: function (value)
        {
            this._leftWidth = value;
            var uvs = this.uvs;
            var vertices = this.vertices;
            uvs[2] = uvs[10] = uvs[18] = uvs[26] = this._uvw * value;
            vertices[2] = vertices[10] = vertices[18] = vertices[26] = value;
            this.dirty=true;
        }
    },
    /**
     * The width of the right column
     *
     * @member {number}
     */
    rightWidth: {
        get: function()
        {
            return this._rightWidth;
        },
        set: function (value)
        {
            this._rightWidth = value;
            var uvs = this.uvs;
            var vertices = this.vertices;
            uvs[4] = uvs[12] = uvs[20] = uvs[28] = 1 - this._uvw * value;
            vertices[4] = vertices[12] = vertices[20] = vertices[28] = this._width - value;
            this.dirty=true;
        }
    },
    /**
     * The height of the top row
     *
     * @member {number}
     */
    topHeight: {
        get: function()
        {
            return this._topHeight;
        },
        set: function (value)
        {
            this._topHeight = value;
            var uvs = this.uvs;
            var vertices = this.vertices;
            uvs[9] = uvs[11] = uvs[13] = uvs[15] = this._uvh * value;
            vertices[9] = vertices[11] = vertices[13] = vertices[15] = value;
            this.dirty=true;
        }
    },
    /**
     * The height of the bottom row
     *
     * @member {number}
     */
    bottomHeight: {
        get: function()
        {
            return this._bottomHeight;
        },
        set: function (value)
        {
            this._bottomHeight = value;
            var uvs = this.uvs;
            var vertices = this.vertices;
            uvs[17] = uvs[19] = uvs[21] = uvs[23] = 1 - this._uvh * value;
            vertices[17] = vertices[19] = vertices[21] = vertices[23] = this._height - value;
            this.dirty=true;
        }
    }
});

NineSlicePlane.prototype.updateHorizontalVertices = function() {
    var vertices = this.vertices;
    vertices[9] = vertices[11] = vertices[13] = vertices[15] = this._topHeight;
    vertices[17] = vertices[19] = vertices[21] = vertices[23] = this._height - this._bottomHeight;
    vertices[25] = vertices[27] = vertices[29] = vertices[31] = this._height;
};

NineSlicePlane.prototype.updateVerticalVertices = function() {
    var vertices = this.vertices;
    vertices[2] = vertices[10] = vertices[18] = vertices[26] = this._leftWidth;
    vertices[4] = vertices[12] = vertices[20] = vertices[28] = this._width - this._rightWidth;
    vertices[6] = vertices[14] = vertices[22] = vertices[30] = this._width ;
};

/**
 * Renders the object using the Canvas renderer
 *
 * @param renderer {PIXI.CanvasRenderer}
 * @private
 */
NineSlicePlane.prototype._renderCanvas= function (renderer)
{
    var context = renderer.context;
    context.globalAlpha = this.worldAlpha;

    var transform = this.worldTransform;
    var res = renderer.resolution;

    if (renderer.roundPixels)
    {
        context.setTransform(transform.a * res, transform.b * res, transform.c * res, transform.d * res, (transform.tx * res) | 0, (transform.ty * res) | 0);
    }
    else
    {
        context.setTransform(transform.a * res, transform.b * res, transform.c * res, transform.d * res, transform.tx * res, transform.ty * res);
    }
        
    var base = this._texture.baseTexture;
    var textureSource = base.source;
    var w = base.width;
    var h = base.height;
    
    this.drawSegment(context, textureSource, w, h, 0, 1, 10, 11);
    this.drawSegment(context, textureSource, w, h, 2, 3, 12, 13);
    this.drawSegment(context, textureSource, w, h, 4, 5, 14, 15);
    this.drawSegment(context, textureSource, w, h, 8, 9, 18, 19);
    this.drawSegment(context, textureSource, w, h, 10, 11, 20, 21);
    this.drawSegment(context, textureSource, w, h, 12, 13, 22, 23);
    this.drawSegment(context, textureSource, w, h, 16, 17, 26, 27);
    this.drawSegment(context, textureSource, w, h, 18, 19, 28, 29);
    this.drawSegment(context, textureSource, w, h, 20, 21, 30, 31);
};

/**
 * Renders one segment of the plane.
 * to mimic the exact drawing behavior of stretching the image like WebGL does, we need to make sure
 * that the source area is at least 1 pixel in size, otherwise nothing gets drawn when a slice size of 0 is used.
 *
 * @param context
 * @param textureSource
 * @param w	width of the texture
 * @param h height of the texture
 * @param x1 
 * @param y1	
 * @param x2
 * @param y2
 * @private
 */
NineSlicePlane.prototype.drawSegment= function (context, textureSource, w, h, x1, y1, x2, y2)
{
    // otherwise you get weird results when using slices of that are 0 wide or high.
    var uvs = this.uvs;
    var vertices = this.vertices;
    
    var sw = (uvs[x2]-uvs[x1]) * w;
    var sh = (uvs[y2]-uvs[y1]) * h;
    var dw = vertices[x2] - vertices[x1];
    var dh = vertices[y2] - vertices[y1];
    
    // make sure the source is at least 1 pixel wide and high, otherwise nothing will be drawn.
    if (sw<1) {
        sw=1;
    }
    if (sh<1) {
        sh=1;
    }
    // make sure destination is at least 1 pixel wide and high, otherwise you get lines when rendering close to original size.
    if (dw<1) {
        dw=1;
    }
    if (dh<1) {
        dh=1;
    }
    context.drawImage(textureSource, uvs[x1] * w, uvs[y1] * h, sw, sh, vertices[x1], vertices[y1], dw, dh);
};