API Docs for: 1.3.0
Show:

DisplayObjectContainer Class

Extends DisplayObject
Defined in: src/pixi/display/DisplayObjectContainer.js:6
Module: PIXI

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.

Constructor

DisplayObjectContainer

()

Defined in src/pixi/display/DisplayObjectContainer.js:6

Methods

addChild

(
  • DisplayObject
)

Defined in src/pixi/display/DisplayObjectContainer.js:42

Adds a child to the container.

Parameters:

addChildAt

(
  • DisplayObject
  • index
)

Defined in src/pixi/display/DisplayObjectContainer.js:139

Adds a child to the container at a specified index. If the index is out of bounds an error will be thrown

Parameters:

click

(
  • interactionData
)

Inherited from DisplayObject: src/pixi/display/DisplayObject.js:109

A callback that is used when the users clicks on the displayObject with their mouse

Parameters:

getChildAt

(
  • index
)

Defined in src/pixi/display/DisplayObjectContainer.js:274

Returns the Child at the specified index

Parameters:

  • index Number

mousedown

(
  • interactionData
)

Inherited from DisplayObject: src/pixi/display/DisplayObject.js:115

A callback that is used when the user clicks the mouse down over the sprite

Parameters:

mouseout

(
  • interactionData
)

Inherited from DisplayObject: src/pixi/display/DisplayObject.js:141

A callback that is used when the users mouse leaves the displayObject

Parameters:

mouseover

(
  • interactionData
)

Inherited from DisplayObject: src/pixi/display/DisplayObject.js:135

A callback that is used when the users mouse rolls over the displayObject

Parameters:

mouseup

(
  • interactionData
)

Inherited from DisplayObject: src/pixi/display/DisplayObject.js:121

A callback that is used when the user releases the mouse that was over the displayObject for this callback to be fired the mouse must have been pressed down over the displayObject

Parameters:

mouseupoutside

(
  • interactionData
)

Inherited from DisplayObject: src/pixi/display/DisplayObject.js:128

A callback that is used when the user releases the mouse that was over the displayObject but is no longer over the displayObject for this callback to be fired, The touch must have started over the displayObject

Parameters:

removeChild

(
  • DisplayObject
)

Defined in src/pixi/display/DisplayObjectContainer.js:291

Removes a child from the container.

Parameters:

setInteractive

(
  • interactive
)

Inherited from DisplayObject: src/pixi/display/DisplayObject.js:193

[Deprecated] Indicates if the sprite will have touch and mouse interactivity. It is false by default Instead of using this function you can now simply set the interactive property to true or false

Parameters:

  • interactive Boolean

swapChildren

(
  • DisplayObject
  • DisplayObject2
)

Defined in src/pixi/display/DisplayObjectContainer.js:227

Swaps the depth of 2 displayObjects

Parameters:

tap

(
  • interactionData
)

Inherited from DisplayObject: src/pixi/display/DisplayObject.js:152

A callback that is used when the users taps on the sprite with their finger basically a touch version of click

Parameters:

touchend

(
  • interactionData
)

Inherited from DisplayObject: src/pixi/display/DisplayObject.js:165

A callback that is used when the user releases a touch over the displayObject

Parameters:

touchendoutside

(
  • interactionData
)

Inherited from DisplayObject: src/pixi/display/DisplayObject.js:171

A callback that is used when the user releases the touch that was over the displayObject for this callback to be fired, The touch must have started over the sprite

Parameters:

touchstart

(
  • interactionData
)

Inherited from DisplayObject: src/pixi/display/DisplayObject.js:159

A callback that is used when the user touch's over the displayObject

Parameters:

Properties

alpha

Number

Inherited from DisplayObject: src/pixi/display/DisplayObject.js:43

The opacity of the object.

buttonMode

Boolean

Inherited from DisplayObject: src/pixi/display/DisplayObject.js:98

This is used to indicate if the displayObject should display a mouse hand cursor on rollover

children

Array

Defined in src/pixi/display/DisplayObjectContainer.js:16

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

hitArea

Rectangle

Inherited from DisplayObject: src/pixi/display/DisplayObject.js:72

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)

interactive

Boolean

Inherited from DisplayObject: src/pixi/display/DisplayObject.js:204

Indicates if the sprite will have touch and mouse interactivity. It is false by default

mask

PIXI.Graphics

Inherited from DisplayObject: src/pixi/display/DisplayObject.js:222

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

parent

DisplayObjectContainer

Inherited from DisplayObject: src/pixi/display/DisplayObject.js:58

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

pivot

Point

Inherited from DisplayObject: src/pixi/display/DisplayObject.js:29

The pivot point of the displayObject that it rotates around

position

Point

Inherited from DisplayObject: src/pixi/display/DisplayObject.js:15

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

rotation

Number

Inherited from DisplayObject: src/pixi/display/DisplayObject.js:36

The rotation of the object in radians.

scale

Point

Inherited from DisplayObject: src/pixi/display/DisplayObject.js:22

The scale factor of the object.

stage

Stage

Inherited from DisplayObject: src/pixi/display/DisplayObject.js:65

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

visible

Boolean

Inherited from DisplayObject: src/pixi/display/DisplayObject.js:50

The visibility of the object.