PIXI. Strip

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 - pixi/extras/Strip.js, line 5

Extends

Members

alpha :Number

The opacity of the object.

Inherited From:
Source - pixi/display/DisplayObject.js, line 46

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 - pixi/extras/Strip.js, line 51

cacheAsBitmap :Boolean

Set if this display object is 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 'null'

Inherited From:
Source - pixi/display/DisplayObject.js, line 355

canvasPadding :Number

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

Source - pixi/extras/Strip.js, line 60

<readonly> children :Array.<DisplayObject>

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

Type:
Inherited From:
Source - pixi/display/DisplayObjectContainer.js, line 17

dirty :Boolean

Whether the strip is dirty or not

Source - pixi/extras/Strip.js, line 43

filterArea :Rectangle

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

Inherited From:
Source - pixi/display/DisplayObject.js, line 164

filters :Array.<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'.

You cannot have a filter and a multiply blend mode active at the same time. Setting a filter will reset this objects blend mode to NORMAL.

Type:
  • Array.<Filter>
Inherited From:
Source - pixi/display/DisplayObject.js, line 307

height :Number

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

Inherited From:
Source - pixi/display/DisplayObjectContainer.js, line 61

hitArea :Rectangle|Circle|Ellipse|Polygon

This is the defined area that will pick up mouse / touch events. It is null by default. Setting it is a neat way of optimising the hitTest function that the interactionManager will use (as it will not need to hit test all the children)

Type:
  • Rectangle | Circle | Ellipse | Polygon
Inherited From:
Source - pixi/display/DisplayObject.js, line 62

mask :PIXI.Graphics

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 object. This allows for much faster masking in canvas as it utilises shape clipping. To remove a mask, set this property to null.

Inherited From:
Source - pixi/display/DisplayObject.js, line 282

<readonly> parent :PIXI.DisplayObjectContainer

[read-only] The display object container that contains this display object.

Inherited From:
Source - pixi/display/DisplayObject.js, line 79

pivot :Point

The pivot point of the displayObject that it rotates around

Inherited From:
Source - pixi/display/DisplayObject.js, line 30

position :Point

The coordinate of the object relative to the local coordinates of the parent.

Inherited From:
Source - pixi/display/DisplayObject.js, line 14

renderable :Boolean

Can this object be rendered

Inherited From:
Source - pixi/display/DisplayObject.js, line 71

rotation :Number

The rotation of the object in radians.

Inherited From:
Source - pixi/display/DisplayObject.js, line 38

scale :Point

The scale factor of the object.

Inherited From:
Source - pixi/display/DisplayObject.js, line 22

<readonly> stage :Stage

[read-only] The stage the display object is connected to, or undefined if it is not connected to the stage.

Inherited From:
Source - pixi/display/DisplayObject.js, line 88

texture :PIXI.Texture

The texture of the strip

Source - pixi/extras/Strip.js, line 20

visible :Boolean

The visibility of the object.

Inherited From:
Source - pixi/display/DisplayObject.js, line 54

width :Number

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

Inherited From:
Source - pixi/display/DisplayObjectContainer.js, line 32

<readonly> worldAlpha :Number

[read-only] The multiplied alpha of the displayObject

Inherited From:
Source - pixi/display/DisplayObject.js, line 97

<readonly> worldPosition :Point

The position of the Display Object based on the world transform. This value is updated at the end of updateTransform and takes all parent transforms into account.

Inherited From:
Source - pixi/display/DisplayObject.js, line 116

<readonly> worldRotation :Number

The rotation of the Display Object, in radians, based on the world transform. This value is updated at the end of updateTransform and takes all parent transforms into account.

Inherited From:
Source - pixi/display/DisplayObject.js, line 136

<readonly> worldScale :Point

The scale of the Display Object based on the world transform. This value is updated at the end of updateTransform and takes all parent transforms into account.

Inherited From:
Source - pixi/display/DisplayObject.js, line 126

worldVisible :Boolean

[read-only] Indicates if the sprite is globally visible.

Inherited From:
Source - pixi/display/DisplayObject.js, line 258

x :Number

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

Inherited From:
Source - pixi/display/DisplayObject.js, line 723

y :Number

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

Inherited From:
Source - pixi/display/DisplayObject.js, line 741

Methods

addChild(child) → {PIXI.DisplayObject}

Adds a child to the container.

Parameters:
Name Type Description
child PIXI.DisplayObject

The DisplayObject to add to the container

Returns:

The child that was added.

Inherited From:
Source - pixi/display/DisplayObjectContainer.js, line 91

addChildAt(child, index) → {PIXI.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 PIXI.DisplayObject

The child to add

index Number

The index to place the child in

Returns:

The child that was added.

Inherited From:
Source - pixi/display/DisplayObjectContainer.js, line 103

destroy()

Destroy this DisplayObject. Removes all references to transformCallbacks, its parent, the stage, filters, bounds, mask and cached Sprites.

Inherited From:
Source - pixi/display/DisplayObject.js, line 223

generateTexture(resolution, scaleMode, renderer) → {PIXI.Texture}

Useful function that returns a texture of the displayObject object that can then be used to create sprites This can be quite useful if your displayObject is static / complicated and needs to be reused multiple times.

Parameters:
Name Type Description
resolution Number

The resolution of the texture being generated

scaleMode Number

See {{#crossLink "PIXI/scaleModes:property"}}PIXI.scaleModes{{/crossLink}} for possible values

renderer PIXI.CanvasRenderer | PIXI.WebGLRenderer

The renderer used to generate the texture.

Returns:

a texture of the graphics object

Inherited From:
Source - pixi/display/DisplayObject.js, line 542

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 - pixi/extras/Strip.js, line 402

getChildAt(index) → {PIXI.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 - pixi/display/DisplayObjectContainer.js, line 194

getChildIndex(child) → {Number}

Returns the index position of a child DisplayObject instance

Parameters:
Name Type Description
child PIXI.DisplayObject

The DisplayObject instance to identify

Returns:
Number -

The index position of the child display object to identify

Inherited From:
Source - pixi/display/DisplayObjectContainer.js, line 159

getLocalBounds() → {Rectangle}

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

Returns:
Rectangle -

The rectangular bounding area

Inherited From:
Source - pixi/display/DisplayObjectContainer.js, line 367

preUpdate()

Empty, to be overridden by classes that require it.

Inherited From:
Source - pixi/display/DisplayObject.js, line 533

removeChild(child) → {PIXI.DisplayObject}

Removes a child from the container.

Parameters:
Name Type Description
child PIXI.DisplayObject

The DisplayObject to remove

Returns:

The child that was removed.

Inherited From:
Source - pixi/display/DisplayObjectContainer.js, line 211

removeChildAt(index) → {PIXI.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 - pixi/display/DisplayObjectContainer.js, line 226

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 - pixi/display/DisplayObjectContainer.js, line 244

removeStageReference()

Removes the current stage reference from the container and all of its children.

Inherited From:
Source - pixi/display/DisplayObjectContainer.js, line 407

setChildIndex(child, index)

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

Parameters:
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 From:
Source - pixi/display/DisplayObjectContainer.js, line 176

setStageReference(stage)

Sets the containers Stage reference. This is the Stage that this object, and all of its children, is connected to.

Parameters:
Name Type Description
stage Stage

the stage that the container will have as its current stage reference

Inherited From:
Source - pixi/display/DisplayObjectContainer.js, line 391

swapChildren(child, child2)

Swaps the position of 2 Display Objects within this container.

Parameters:
Name Type Description
child PIXI.DisplayObject

-

child2 PIXI.DisplayObject

-

Inherited From:
Source - pixi/display/DisplayObjectContainer.js, line 134

toGlobal(position) → {Point}

Calculates the global position of the display object

Parameters:
Name Type Description
position Point

The world origin to calculate from

Returns:
Point -

A point object representing the position of this object

Inherited From:
Source - pixi/display/DisplayObject.js, line 576

toLocal(position, from) → {Point}

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

Parameters:
Name Type Argument Description
position Point

The world origin to calculate from

from PIXI.DisplayObject <optional>

The DisplayObject to calculate the global position from

Returns:
Point -

A point object representing the position of this object

Inherited From:
Source - pixi/display/DisplayObject.js, line 590

updateCache()

Generates and updates the cached sprite for this object.

Inherited From:
Source - pixi/display/DisplayObject.js, line 566
Phaser Copyright © 2012-2015 Photon Storm Ltd.
Documentation generated by JSDoc 3.3.2 on Thu Feb 18 2016 14:41:10 GMT+0000 (GMT Standard Time) using the DocStrap template.