Class: DisplayObject

Extends

• EventEmitter

Mixes In

• PIXI.interaction.interactiveTarget

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.

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.

x

Sets the X position of the object.

y

Sets the Y position of the object.

Methods

_recursivePostUpdateTransform()

core/display/DisplayObject.js, line 152

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

destroy()

core/display/DisplayObject.js, line 389

Base destroy method for generic display objects. This will automatically
remove the display object from its parent Container as well as remove
all current event listeners and internal references. Do not use a DisplayObject
after calling destroy.

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

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

renderCanvas(renderer)

core/display/DisplayObject.js, line 330

Renders the object using the Canvas renderer

Name	Type	Description
renderer	PIXI.CanvasRenderer	The renderer

renderWebGL(renderer)

core/display/DisplayObject.js, line 320

Renders the object using the WebGL renderer

Name	Type	Description
renderer	PIXI.WebGLRenderer	The renderer

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

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

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

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

updateTransform()

core/display/DisplayObject.js, line 139

Updates the object transform for rendering

TODO - Optimization pass!