new DisplayObjectContainer()
A DisplayObjectContainer represents a collection of display objects. It is the base class of all display objects that act as a container for other objects.
- Source code: pixi/display/DisplayObjectContainer.js (Line 5)
Extends
Public Properties
-
[readonly] children : Array.<DisplayObject>
-
[read-only] The array of children of this container.
Type
- Array.<DisplayObject>
- Source code: pixi/display/DisplayObjectContainer.js (Line 17)
-
height : number
-
The height of the displayObjectContainer, setting this will actually modify the scale to achieve the value set
- Source code: pixi/display/DisplayObjectContainer.js (Line 72)
-
ignoreChildInput : boolean
-
If
ignoreChildInput
isfalse
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.
- Source code: pixi/display/DisplayObjectContainer.js (Line 26)
-
width : number
-
The width of the displayObjectContainer, setting this will actually modify the scale to achieve the value set
- Source code: pixi/display/DisplayObjectContainer.js (Line 43)
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.
- Source code: pixi/display/DisplayObjectContainer.js (Line 102)
-
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.
- Source code: pixi/display/DisplayObjectContainer.js (Line 114)
-
getBounds() → {Rectangle}
-
Retrieves the bounds of the displayObjectContainer as a rectangle. The bounds calculation takes all visible children into consideration.
Returns
Rectangle -The rectangular bounding area
- Source code: pixi/display/DisplayObjectContainer.js (Line 318)
-
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.
- Source code: pixi/display/DisplayObjectContainer.js (Line 205)
-
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
- Source code: pixi/display/DisplayObjectContainer.js (Line 170)
-
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
- Source code: pixi/display/DisplayObjectContainer.js (Line 383)
-
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.
- Source code: pixi/display/DisplayObjectContainer.js (Line 222)
-
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.
- Source code: pixi/display/DisplayObjectContainer.js (Line 237)
-
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.
- Source code: pixi/display/DisplayObjectContainer.js (Line 255)
-
removeStageReference()
-
Removes the current stage reference from the container and all of its children.
- Source code: pixi/display/DisplayObjectContainer.js (Line 428)
-
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
- Source code: pixi/display/DisplayObjectContainer.js (Line 187)
-
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
- Source code: pixi/display/DisplayObjectContainer.js (Line 412)
-
swapChildren(child, child2)
-
Swaps the position of 2 Display Objects within this container.
Parameters
Name Type Description child
DisplayObject -
child2
DisplayObject -
- Source code: pixi/display/DisplayObjectContainer.js (Line 145)