Class: Plane

PIXI .mesh. Plane

The Plane allows you to draw a texture across several points and them manipulate these points

for (let i = 0; i < 20; i++) {
    points.push(new PIXI.Point(i * 50, 0));
};
let Plane = new PIXI.Plane(PIXI.Texture.fromImage("snake.png"), points);

new PIXI.mesh.Plane(texture, verticesX, verticesY)

mesh/Plane.js, line 20

Name	Type	Description
`texture`	PIXI.Texture	The texture to use on the Plane.
`verticesX`	number	The number of vertices in the x-axis
`verticesY`	number	The number of vertices in the y-axis

Extends

PIXI.mesh.Mesh

Members

alphanumber

The opacity of the object.

blendModenumber

The blend mode to be applied to the sprite. Set to PIXI.BLEND_MODES.NORMAL to remove
any blend mode.

Default Value:

PIXI.BLEND_MODES.NORMAL

See:

PIXI.BLEND_MODES

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'

IMPORTANT GOTCHA - make sure that all your textures are preloaded BEFORE setting this property to true
as it will take a snapshot of what is currently there. If the textures have not loaded then they will not appear.

canvasPaddingnumber

Triangles in canvas mode are automatically antialiased, use this value to force triangles
to overlap a bit with each other.

readonlychildrenArray.<PIXI.DisplayObject>

The array of children of this container.

dirtynumber

Version of mesh uvs are dirty or not

drawModenumber

The way the Mesh should be drawn, can be any of the PIXI.mesh.Mesh.DRAW_MODES consts

See:

PIXI.mesh.Mesh.DRAW_MODES

filterAreaPIXI.Rectangle

The area the filter is applied to. This is used as more of an optimisation
rather than figuring out the dimensions of the displayObject each frame you can set this rectangle

Also works as an interaction mask

filtersArray.<PIXI.Filter>

Sets the filters for the displayObject.

IMPORTANT: This is a webGL only feature and will be ignored by the canvas renderer.
To remove filters simply set this property to 'null'

heightnumber

The height of the Container, setting this will actually modify the scale to achieve the value set

indexDirtynumber

Version of mesh indices

readonlylocalTransformPIXI.Matrix

Current transform of the object based on local factors: position, scale, other stuff

maskPIXI.Graphics PIXI.Sprite

Sets a mask for the displayObject. A mask is an object that limits the visibility of an
object to the shape of the mask applied to it. In PIXI a regular mask must be a
PIXI.Graphics or a PIXI.Sprite object. This allows for much faster masking in canvas as it
utilises shape clipping. To remove a mask, set this property to null.

TODO

For the moment, PIXI.CanvasRenderer doesn't support PIXI.Sprite as mask.

readonlyparentPIXI.Container

The display object container that contains this display object.

pivotPIXI.Point PIXI.ObservablePoint

The pivot point of the displayObject that it rotates around
Assignment by value since pixi-v4.

pluginNamestring

Plugin that is responsible for rendering this element.
Allows to customize the rendering process without overriding '_renderWebGL' & '_renderCanvas' methods.

Default Value:

'mesh'

positionPIXI.Point PIXI.ObservablePoint

The coordinate of the object relative to the local coordinates of the parent.
Assignment by value since pixi-v4.

renderableboolean

Can this object be rendered, if false the object will not be drawn but the updateTransform
methods will still be called.

Only affects recursive calls from parent. You can ask for bounds manually

rotationnumber

The rotation of the object in radians.

scalePIXI.Point PIXI.ObservablePoint

The scale factor of the object.
Assignment by value since pixi-v4.

shaderPIXI.Shader

The default shader that is used if a mesh doesn't have a more specific one.

skewPIXI.ObservablePoint

The skew factor for the object in radians.
Assignment by value since pixi-v4.

texturePIXI.Texture

The texture that the mesh uses.

tintnumber

The tint applied to the mesh. This is a hex value. A value of 0xFFFFFF will remove any tint effect.

Default Value:

0xFFFFFF

tintRgbnumber

The tint applied to the mesh. This is a [r,g,b] value. A value of [1,1,1] will remove any
tint effect.

transformPIXI.TransformBase

World transform and local transform of this object.
This will become read-only later, please do not assign anything there unless you know what are you doing

uvsFloat32Array

The Uvs of the Mesh

verticesFloat32Array

An array of vertices

visibleboolean

The visibility of the object. If false the object will not be drawn, and
the updateTransform function will not be called.

Only affects recursive calls from parent. You can ask for bounds or call updateTransform manually

widthnumber

The width of the Container, setting this will actually modify the scale to achieve the value set

readonlyworldAlphanumber

The multiplied alpha of the displayObject

readonlyworldTransformPIXI.Matrix

Current transform of the object based on world (parent) factors

readonlyworldVisibleboolean

Indicates if the object is globally visible.

xnumber

The position of the displayObject on the x axis relative to the local coordinates of the parent.
An alias to position.x

ynumber

The position of the displayObject on the y axis relative to the local coordinates of the parent.
An alias to position.y

Methods

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

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

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

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 one or more children to the container.

Multiple items can be added like so: myContainer.addChild(thingOne, 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 101

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 345

Recalculates the bounds of the container.

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

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 550

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.
`texture`	boolean	false	optional Only used for child Sprites if options.children is set to true Should it destroy the texture of the child sprite
`baseTexture`	boolean	false	optional Only used for child Sprites if options.children is set to true Should it destroy the base texture of the child sprite

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

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 195

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 156

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 224

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

refresh() mesh/Plane.js, line 51

Refreshes

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

Removes one or more children from the container.

Name	Type	Description
`child`	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 253

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 279

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 512

Renders the object using the Canvas renderer

Name	Type	Description
`renderer`	PIXI.CanvasRenderer	The renderer

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

Renders the object using the WebGL renderer

Name	Type	Description
`renderer`	PIXI.WebGLRenderer	The renderer

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

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 350

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 376

Convenience function to set the position, 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 135

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 259

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 294

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

inherited updateTransform() core/display/Container.js, line 321

Updates the transform on all children of this container for rendering