Class: NineSlicePlane

PIXI .mesh. NineSlicePlane

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

let Plane9 = new PIXI.NineSlicePlane(PIXI.Texture.fromImage('BoxWithRoundedCorners.png'), 15, 15, 15, 15);

     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

new PIXI.mesh.NineSlicePlane(texture, leftWidth, topHeight, rightWidth, bottomHeight)

mesh/NineSlicePlane.js, line 38

Name	Type	Default	Description
`texture`	PIXI.Texture		The texture to use on the NineSlicePlane.
`leftWidth`	int	10	optional size of the left vertical bar (A)
`topHeight`	int	10	optional size of the top horizontal bar (C)
`rightWidth`	int	10	optional size of the right vertical bar (B)
`bottomHeight`	int	10	optional size of the bottom horizontal bar (D)

Extends

PIXI.mesh.Plane

Members

bottomHeightnumber

The height of the bottom row

bottomHeight

Sets the height of the bottom row.

cacheAsBitmapboolean

Set this to true if you want this display object to be cached as a bitmap.
This basically takes a snap shot of the display object as it is at that moment. It can
provide a performance benefit for complex static displayObjects.
To remove simply set this property to 'false'

filters

Shallow copies the array to the filters of the object.

height

Sets the height.

leftWidth

Sets the width of the left column.

leftWidthnumber

The width of the left column

mask

Sets the mask.

pivot

Copies the point to the pivot of the object.

position

Copies the point to the position of the object.

rightWidth

Sets the width of the right column.

rightWidthnumber

The width of the right column

rotation

Sets the rotation of the object.

scale

Copies the point to the scale of the object.

skew

Copies the point to the skew of the object.

texture

Sets the texture the mesh uses.

tint

Sets the tint the mesh uses.

topHeight

Sets the height of the top row.

topHeightnumber

The height of the top row

width

Sets the width.

x

Sets the X position of the object.

y

Sets the Y position of the object.

Methods

inherited _calculateBounds() mesh/Mesh.js, line 166

Returns the bounds of the mesh as a rectangle. The bounds calculation takes the worldTransform into account.

inherited _recursivePostUpdateTransform() core/display/DisplayObject.js, line 151

recursively updates transform of all objects from the root to this one
internal function for toLocal()

inherited addChild(child){PIXI.DisplayObject} core/display/Container.js, line 55

Adds a child or multiple children to the container.

Multple items can be added like so: myContainer.addChild(thinkOne, thingTwo, thingThree)

Name	Type	Description
`child`	PIXI.DisplayObject	repeatable The DisplayObject(s) to add to the container

Returns:

Type	Description
PIXI.DisplayObject	The first child that was added.

inherited addChildAt(child, index){PIXI.DisplayObject} core/display/Container.js, line 90

Adds a child to the container at a specified index. If the index is out of bounds an error will be thrown

Name	Type	Description
`child`	PIXI.DisplayObject	The child to add
`index`	number	The index to place the child in

Returns:

Type	Description
PIXI.DisplayObject	The child that was added.

inherited calculateBounds() core/display/Container.js, line 303

Recalculates the bounds of the container.

inherited containsPoint(point){boolean} mesh/Mesh.js, line 178

Tests if a point is inside this mesh. Works only for TRIANGLE_MESH

Name	Type	Description
`point`	PIXI.Point	the point to test

Returns:

Type	Description
boolean	the result of the test

inherited destroy(options) core/display/Container.js, line 508

Removes all internal references and listeners as well as removes children from the display list.
Do not use a Container after calling destroy.

Name Type Description

options

object | boolean

optional

Options parameter. A boolean will act as if all options
have been set to that value

Name	Type	Default	Description
`children`	boolean	false	optional if set to true, all the children will have their destroy method called as well. 'options' will be passed on to those calls.

inherited getBounds(skipUpdate, rect){PIXI.Rectangle} core/display/DisplayObject.js, line 173

Retrieves the bounds of the displayObject as a rectangle object.

Name	Type	Description
`skipUpdate`	boolean	setting to true will stop the transforms of the scene graph from being updated. This means the calculation returned MAY be out of date BUT will give you a nice performance boost
`rect`	PIXI.Rectangle	Optional rectangle to store the result of the bounds calculation

Returns:

Type	Description
PIXI.Rectangle	the rectangular bounding area

inherited getChildAt(index){PIXI.DisplayObject} core/display/Container.js, line 178

Returns the child at the specified index

Name	Type	Description
`index`	number	The index to get the child at

Returns:

Type	Description
PIXI.DisplayObject	The child at the given index, if any.

inherited getChildIndex(child){number} core/display/Container.js, line 140

Returns the index position of a child DisplayObject instance

Name	Type	Description
`child`	PIXI.DisplayObject	The DisplayObject instance to identify

Returns:

Type	Description
number	The index position of the child display object to identify

inherited getLocalBounds(rect){PIXI.Rectangle} core/display/DisplayObject.js, line 214

Retrieves the local bounds of the displayObject as a rectangle object

Name	Type	Description
`rect`	PIXI.Rectangle	optional Optional rectangle to store the result of the bounds calculation

Returns:

Type	Description
PIXI.Rectangle	the rectangular bounding area

inherited refresh() mesh/Plane.js, line 51

Refreshes

inherited removeChild(childs){PIXI.DisplayObject} core/display/Container.js, line 194

Removes a child from the container.

Name	Type	Description
`childs`	PIXI.DisplayObject	repeatable The DisplayObject(s) to remove

Returns:

Type	Description
PIXI.DisplayObject	The first child that was removed.

inherited removeChildAt(index){PIXI.DisplayObject} core/display/Container.js, line 220

Removes a child from the specified index position.

Name	Type	Description
`index`	number	The index to get the child from

Returns:

Type	Description
PIXI.DisplayObject	The child that was removed.

inherited removeChildren(beginIndex, endIndex){Array.<DisplayObject>} core/display/Container.js, line 241

Removes all children from this container that are within the begin and end indexes.

Name	Type	Default	Description
`beginIndex`	number	0	optional The beginning position.
`endIndex`	number	this.children.length	optional The ending position. Default value is size of the container.

Returns:

Type	Description
Array.<DisplayObject>	List of removed children

inherited renderCanvas(renderer) core/display/Container.js, line 474

Renders the object using the Canvas renderer

Name	Type	Description
`renderer`	PIXI.CanvasRenderer	The renderer

inherited renderWebGL(renderer) core/display/Container.js, line 354

Renders the object using the WebGL renderer

Name	Type	Description
`renderer`	PIXI.WebGLRenderer	The renderer

inherited setChildIndex(child, index) core/display/Container.js, line 158

Changes the position of an existing child in the display object container

Name	Type	Description
`child`	PIXI.DisplayObject	The child DisplayObject instance for which you want to change the index number
`index`	number	The resulting index number for the child display object

inherited setParent(container){PIXI.Container} core/display/DisplayObject.js, line 340

Set the parent Container of this DisplayObject

Name	Type	Description
`container`	PIXI.Container	The Container to add this DisplayObject to

Returns:

Type	Description
PIXI.Container	The Container that this DisplayObject was added to

inherited setTransform(x, y, scaleX, scaleY, rotation, skewX, skewY, pivotX, pivotY){PIXI.DisplayObject} core/display/DisplayObject.js, line 366

Convenience function to set the postion, scale, skew and pivot at once.

Name	Type	Default	Description
`x`	number	0	optional The X position
`y`	number	0	optional The Y position
`scaleX`	number	1	optional The X scale value
`scaleY`	number	1	optional The Y scale value
`rotation`	number	0	optional The rotation
`skewX`	number	0	optional The X skew value
`skewY`	number	0	optional The Y skew value
`pivotX`	number	0	optional The X pivot value
`pivotY`	number	0	optional The Y pivot value

Returns:

Type	Description
PIXI.DisplayObject	The DisplayObject instance

inherited swapChildren(child, child2) core/display/Container.js, line 119

Swaps the position of 2 Display Objects within this container.

Name	Type	Description
`child`	PIXI.DisplayObject	First display object to swap
`child2`	PIXI.DisplayObject	Second display object to swap

inherited toGlobal(position, point, skipUpdate){PIXI.Point} core/display/DisplayObject.js, line 249

Calculates the global position of the display object

Name	Type	Default	Description
`position`	PIXI.Point		The world origin to calculate from
`point`	PIXI.Point		optional A Point object in which to store the value, optional (otherwise will create a new Point)
`skipUpdate`	boolean	false	optional Should we skip the update transform.

Returns:

Type	Description
PIXI.Point	A point object representing the position of this object

inherited toLocal(position, from, point, skipUpdate){PIXI.Point} core/display/DisplayObject.js, line 284

Calculates the local position of the display object relative to another point

Name	Type	Default	Description
`position`	PIXI.Point		The world origin to calculate from
`from`	PIXI.DisplayObject		optional The DisplayObject to calculate the global position from
`point`	PIXI.Point		optional A Point object in which to store the value, optional (otherwise will create a new Point)
`skipUpdate`	boolean	false	optional Should we skip the update transform

Returns:

Type	Description
PIXI.Point	A point object representing the position of this object

updateHorizontalVertices() mesh/NineSlicePlane.js, line 118

Updates the horizontal vertices.

updateVerticalVertices() mesh/NineSlicePlane.js, line 131

Updates the vertical vertices.