Class: PIXI.Strip

Constructor

new Strip(texture, width, height)

Parameters
Name Type Description
texture PIXI.Texture

The texture to use

width Number

the width

height Number

the height

Source code: pixi/extras/Strip.js (Line 5)

Extends

Public Properties

blendMode : number

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

Default Value
  • PIXI.blendModes.NORMAL;
Source code: pixi/extras/Strip.js (Line 51)

canvasPadding : number

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

Source code: pixi/extras/Strip.js (Line 60)

[readonly] children : Array.<DisplayObject>

[read-only] The array of children of this container.

Type
Inherited From
Source code: pixi/display/DisplayObjectContainer.js (Line 17)

dirty : boolean

Whether the strip is dirty or not

Source code: pixi/extras/Strip.js (Line 43)

height : number

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

Inherited From
Source code: pixi/display/DisplayObjectContainer.js (Line 600)

ignoreChildInput : boolean

If ignoreChildInput is false it will allow this objects children to be considered as valid for Input events.

If this property is true then the children will not be considered as valid for Input events.

Note that this property isn't recursive: only immediate children are influenced, it doesn't scan further down.

Inherited From
Source code: pixi/display/DisplayObjectContainer.js (Line 26)

texture : PIXI.Texture

The texture of the strip

Source code: pixi/extras/Strip.js (Line 20)

width : number

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

Inherited From
Source code: pixi/display/DisplayObjectContainer.js (Line 571)

Public Methods

addChild(child) → {DisplayObject}

Adds a child to the container.

Parameters
Name Type Description
child DisplayObject

The DisplayObject to add to the container

Returns

The child that was added.

Inherited From
Source code: pixi/display/DisplayObjectContainer.js (Line 42)

addChildAt(child, index) → {DisplayObject}

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

Parameters
Name Type Description
child DisplayObject

The child to add

index Number

The index to place the child in

Returns

The child that was added.

Inherited From
Source code: pixi/display/DisplayObjectContainer.js (Line 55)

contains(child) → {Boolean}

Determines whether the specified display object is a child of the DisplayObjectContainer instance or the instance itself.

Parameters
Name Type Description
child DisplayObject

-

Returns
Boolean -
Inherited From
Source code: pixi/display/DisplayObjectContainer.js (Line 449)

getBounds(matrix) → {Rectangle}

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

Parameters
Name Type Description
matrix Matrix

the transformation matrix of the sprite

Returns
Rectangle -

the framing rectangle

Source code: pixi/extras/Strip.js (Line 405)

getChildAt(index) → {DisplayObject}

Returns the child at the specified index

Parameters
Name Type Description
index Number

The index to get the child from

Returns

The child at the given index, if any.

Inherited From
Source code: pixi/display/DisplayObjectContainer.js (Line 153)

getChildIndex(child) → {Number}

Returns the index position of a child DisplayObject instance

Parameters
Name Type Description
child DisplayObject

The DisplayObject instance to identify

Returns
Number -

The index position of the child display object to identify

Inherited From
Source code: pixi/display/DisplayObjectContainer.js (Line 112)

getLocalBounds() → {Rectangle}

Retrieves the non-global local bounds of the displayObjectContainer as a rectangle without any transformations. The calculation takes all visible children into consideration.

Returns
Rectangle -

The rectangular bounding area

Inherited From
Source code: pixi/display/DisplayObjectContainer.js (Line 437)

removeChild(child) → {DisplayObject}

Removes a child from the container.

Parameters
Name Type Description
child DisplayObject

The DisplayObject to remove

Returns

The child that was removed.

Inherited From
Source code: pixi/display/DisplayObjectContainer.js (Line 171)

removeChildAt(index) → {DisplayObject}

Removes a child from the specified index position.

Parameters
Name Type Description
index Number

The index to get the child from

Returns

The child that was removed.

Inherited From
Source code: pixi/display/DisplayObjectContainer.js (Line 191)

removeChildren(beginIndex, endIndex)

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

Parameters
Name Type Description
beginIndex Number

The beginning position. Default value is 0.

endIndex Number

The ending position. Default value is size of the container.

Inherited From
Source code: pixi/display/DisplayObjectContainer.js (Line 213)

setChildIndex(child, index)

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

Parameters
Name Type Description
child 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 From
Source code: pixi/display/DisplayObjectContainer.js (Line 132)

swapChildren(child, child2)

Swaps the position of 2 Display Objects within this container.

Parameters
Name Type Description
child DisplayObject

-

child2 DisplayObject

-

Inherited From
Source code: pixi/display/DisplayObjectContainer.js (Line 85)

© 2016 Richard Davey, Photon Storm Ltd.
Licensed under the MIT License.
http://phaser.io/docs/2.6.2/PIXI.Strip.html