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 - pixi/display/DisplayObjectContainer.js, line 5
Extends
Members
-
<readonly> children :Array.<DisplayObject>
-
[read-only] The array of children of this container.
Type:
- Array.<DisplayObject>
-
height :Number
-
The height of the displayObjectContainer, setting this will actually modify the scale to achieve the value set
-
ignoreChildInput :Boolean
-
If
ignoreChildInputisfalseit will allow this objects children to be considered as valid for Input events.If this property is
truethen 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.
-
width :Number
-
The width of the displayObjectContainer, setting this will actually modify the scale to achieve the value set
Methods
-
addChild(child) → {DisplayObject}
-
Adds a child to the container.
Parameters:
Name Type Description childDisplayObject 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 childDisplayObject The child to add
indexNumber The index to place the child in
Returns:
The child that was added.
-
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
-
getChildAt(index) → {DisplayObject}
-
Returns the child at the specified index
Parameters:
Name Type Description indexNumber 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 childDisplayObject The DisplayObject instance to identify
Returns:
Number -The index position of the child display object to identify
-
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
-
removeChild(child) → {DisplayObject}
-
Removes a child from the container.
Parameters:
Name Type Description childDisplayObject 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 indexNumber 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 beginIndexNumber The beginning position. Default value is 0.
endIndexNumber The ending position. Default value is size of the container.
-
removeStageReference()
-
Removes the current stage reference from the container and all of its children.
-
setChildIndex(child, index)
-
Changes the position of an existing child in the display object container
Parameters:
Name Type Description childDisplayObject The child DisplayObject instance for which you want to change the index number
indexNumber The resulting index number for the child display object
-
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 stageStage the stage that the container will have as its current stage reference
-
swapChildren(child, child2)
-
Swaps the position of 2 Display Objects within this container.
Parameters:
Name Type Description childDisplayObject -
child2DisplayObject -