Strip
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
- Default Value
- PIXI.blendModes.NORMAL;
- Source code: pixi/extras/Strip.js (Line 51)
- Source code: pixi/extras/Strip.js (Line 60)
- Array.<DisplayObject>
- Inherited From
- Source code: pixi/display/DisplayObjectContainer.js (Line 17)
- Source code: pixi/extras/Strip.js (Line 43)
- Inherited From
- Source code: pixi/display/DisplayObjectContainer.js (Line 600)
- Inherited From
- Source code: pixi/display/DisplayObjectContainer.js (Line 26)
- Source code: pixi/extras/Strip.js (Line 20)
- Inherited From
- Source code: pixi/display/DisplayObjectContainer.js (Line 571)
blendMode : number
The blend mode to be applied to the sprite. Set to PIXI.blendModes.NORMAL to remove any blend mode.
canvasPadding : number
Triangles in canvas mode are automatically antialiased, use this value to force triangles to overlap a bit with each other.
[readonly] children : Array.<DisplayObject>
[read-only] The array of children of this container.
Type
dirty : boolean
Whether the strip is dirty or not
height : number
The height of the displayObjectContainer, setting this will actually modify the scale to achieve the value set
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.
texture : PIXI.Texture
The texture of the strip
width : number
The width of the displayObjectContainer, setting this will actually modify the scale to achieve the value set
Public Methods
- Inherited From
- Source code: pixi/display/DisplayObjectContainer.js (Line 42)
- Inherited From
- Source code: pixi/display/DisplayObjectContainer.js (Line 55)
- Inherited From
- Source code: pixi/display/DisplayObjectContainer.js (Line 449)
- Source code: pixi/extras/Strip.js (Line 405)
- Inherited From
- Source code: pixi/display/DisplayObjectContainer.js (Line 153)
- Inherited From
- Source code: pixi/display/DisplayObjectContainer.js (Line 112)
- Inherited From
- Source code: pixi/display/DisplayObjectContainer.js (Line 437)
- Inherited From
- Source code: pixi/display/DisplayObjectContainer.js (Line 171)
- Inherited From
- Source code: pixi/display/DisplayObjectContainer.js (Line 191)
- Inherited From
- Source code: pixi/display/DisplayObjectContainer.js (Line 213)
- Inherited From
- Source code: pixi/display/DisplayObjectContainer.js (Line 132)
- Inherited From
- Source code: pixi/display/DisplayObjectContainer.js (Line 85)
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.
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.
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
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
the framing rectangle
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.
getChildIndex(child) → {Number}
Returns the index position of a child DisplayObject instance
Parameters
Name | Type | Description |
---|---|---|
child | DisplayObject | The DisplayObject instance to identify |
Returns
The index position of the child display object to identify
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
The rectangular bounding area
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.
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.
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. |
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 |
swapChildren(child, child2)
Swaps the position of 2 Display Objects within this container.
Parameters
Name | Type | Description |
---|---|---|
child | DisplayObject | - |
child2 | DisplayObject | - |
© 2016 Richard Davey, Photon Storm Ltd.
Licensed under the MIT License.
http://phaser.io/docs/2.6.2/PIXI.Strip.html