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
-
alpha : number
-
The opacity of the object.
- Inherited From
- Source code: pixi/display/DisplayObject.js (Line 46)
-
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 code: pixi/display/DisplayObject.js (Line 355)
-
[readonly] children : Array.<DisplayObject>
-
[read-only] The array of children of this container.
Type
- Array.<DisplayObject>
- Source code: pixi/display/DisplayObjectContainer.js (Line 17)
-
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 code: 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 code: 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
- Source code: pixi/display/DisplayObjectContainer.js (Line 72)
-
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 code: pixi/display/DisplayObject.js (Line 62)
-
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)
-
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 code: pixi/display/DisplayObject.js (Line 282)
-
[readonly] parent : PIXI.DisplayObjectContainer
-
[read-only] The display object container that contains this display object.
- Inherited From
- Source code: pixi/display/DisplayObject.js (Line 79)
-
pivot :Point
-
The pivot point of the displayObject that it rotates around
- Inherited From
- Source code: pixi/display/DisplayObject.js (Line 30)
-
position :Point
-
The coordinate of the object relative to the local coordinates of the parent.
- Inherited From
- Source code: pixi/display/DisplayObject.js (Line 14)
-
renderable : boolean
-
Can this object be rendered
- Inherited From
- Source code: pixi/display/DisplayObject.js (Line 71)
-
rotation : number
-
The rotation of the object in radians.
- Inherited From
- Source code: pixi/display/DisplayObject.js (Line 38)
-
scale :Point
-
The scale factor of the object.
- Inherited From
- Source code: 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 code: pixi/display/DisplayObject.js (Line 88)
-
visible : boolean
-
The visibility of the object.
- Inherited From
- Source code: 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
- Source code: pixi/display/DisplayObjectContainer.js (Line 43)
-
[readonly] worldAlpha : number
-
[read-only] The multiplied alpha of the displayObject
- Inherited From
- Source code: 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 code: 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 code: 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 code: pixi/display/DisplayObject.js (Line 126)
-
worldVisible : boolean
-
[read-only] Indicates if the sprite is globally visible.
- Inherited From
- Source code: 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 code: pixi/display/DisplayObject.js (Line 722)
-
y : number
-
The position of the displayObject on the y axis relative to the local coordinates of the parent.
- Inherited From
- Source code: pixi/display/DisplayObject.js (Line 740)
Public 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.
- Source code: pixi/display/DisplayObjectContainer.js (Line 102)
-
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.
- Source code: pixi/display/DisplayObjectContainer.js (Line 114)
-
destroy()
-
Destroy this DisplayObject. Removes all references to transformCallbacks, its parent, the stage, filters, bounds, mask and cached Sprites.
- Inherited From
- Source code: pixi/display/DisplayObject.js (Line 223)
-
generateTexture(resolution, scaleMode, renderer) → {PIXI.RenderTexture}
-
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 code: pixi/display/DisplayObject.js (Line 541)
-
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) → {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.
- 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
PIXI.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 381)
-
preUpdate()
-
Empty, to be overridden by classes that require it.
- Inherited From
- Source code: pixi/display/DisplayObject.js (Line 532)
-
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.
- Source code: pixi/display/DisplayObjectContainer.js (Line 222)
-
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.
- 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 426)
-
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
- 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 410)
-
swapChildren(child, child2)
-
Swaps the position of 2 Display Objects within this container.
Parameters
Name Type Description child
PIXI.DisplayObject -
child2
PIXI.DisplayObject -
- Source code: pixi/display/DisplayObjectContainer.js (Line 145)
-
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 code: pixi/display/DisplayObject.js (Line 575)
-
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 code: pixi/display/DisplayObject.js (Line 589)
-
updateCache()
-
Generates and updates the cached sprite for this object.
- Inherited From
- Source code: pixi/display/DisplayObject.js (Line 565)