PIXI

Class: Container

PIXI. Container

A Container represents a collection of display objects.
It is the base class of all display objects that act as a container for other objects.

let container = new PIXI.Container();
container.addChild(sprite);

new PIXI.Container()

core/display/Container.js, line 19

Extends

Members

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 of the container by modifying the scale.

mask

Sets the mask.

pivot

Copies the point to the pivot of the object.

position

Copies the point to the position of the object.

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.

width

Sets the width of the container by modifying the scale.

x

Sets the X position of the object.

y

Sets the Y position of the object.

Methods

_calculateBounds()

core/display/Container.js, line 369

Recalculates the bounds of the object. Override this to
calculate the bounds of the specific object (not including children).

inherited _recursivePostUpdateTransform()

core/display/DisplayObject.js, line 152

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

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.

addChildAt(child, index){PIXI.DisplayObject}

core/display/Container.js, line 100

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.

calculateBounds()

core/display/Container.js, line 328

Recalculates the bounds of the container.

destroy(options)

core/display/Container.js, line 529

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 174

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

getChildAt(index){PIXI.DisplayObject}

core/display/Container.js, line 188

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.

getChildIndex(child){number}

core/display/Container.js, line 150

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 215

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

removeChild(child){PIXI.DisplayObject}

core/display/Container.js, line 204

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.

removeChildAt(index){PIXI.DisplayObject}

core/display/Container.js, line 245

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.

removeChildren(beginIndex, endIndex){Array.<DisplayObject>}

core/display/Container.js, line 266

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

renderCanvas(renderer)

core/display/Container.js, line 495

Renders the object using the Canvas renderer

Name Type Description
renderer PIXI.CanvasRenderer

The renderer

renderWebGL(renderer)

core/display/Container.js, line 379

Renders the object using the WebGL renderer

Name Type Description
renderer PIXI.WebGLRenderer

The renderer

setChildIndex(child, index)

core/display/Container.js, line 168

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 341

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 367

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

swapChildren(child, child2)

core/display/Container.js, line 129

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 250

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 285

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