PIXI

Class: DisplayObject

PIXI. DisplayObject

The base class for all objects that are rendered on the screen.
This is an abstract class and should not be used on its own rather it should be extended.

new PIXI.DisplayObject()

core/display/DisplayObject.js, line 21

Extends

  • EventEmitter

Mixes In

Members

alphanumber

The opacity of the object.

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'

filterAreaPIXI.Rectangle

The area the filter is applied to. This is used as more of an optimisation
rather than figuring out the dimensions of the displayObject each frame you can set this rectangle

Also works as an interaction mask

filtersArray.<PIXI.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'

readonlylocalTransformPIXI.Matrix

Current transform of the object based on local factors: position, scale, other stuff

maskPIXI.Graphics PIXI.Sprite

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

TODO
  • For the moment, PIXI.CanvasRenderer doesn't support PIXI.Sprite as mask.

readonlyparentPIXI.Container

The display object container that contains this display object.

pivotPIXI.Point PIXI.ObservablePoint

The pivot point of the displayObject that it rotates around
Assignment by value since pixi-v4.

positionPIXI.Point PIXI.ObservablePoint

The coordinate of the object relative to the local coordinates of the parent.
Assignment by value since pixi-v4.

renderableboolean

Can this object be rendered, if false the object will not be drawn but the updateTransform
methods will still be called.

Only affects recursive calls from parent. You can ask for bounds manually

rotationnumber

The rotation of the object in radians.

scalePIXI.Point PIXI.ObservablePoint

The scale factor of the object.
Assignment by value since pixi-v4.

skewPIXI.ObservablePoint

The skew factor for the object in radians.
Assignment by value since pixi-v4.

transformPIXI.TransformBase

World transform and local transform of this object.
This will become read-only later, please do not assign anything there unless you know what are you doing

visibleboolean

The visibility of the object. If false the object will not be drawn, and
the updateTransform function will not be called.

Only affects recursive calls from parent. You can ask for bounds or call updateTransform manually

readonlyworldAlphanumber

The multiplied alpha of the displayObject

readonlyworldTransformPIXI.Matrix

Current transform of the object based on world (parent) factors

readonlyworldVisibleboolean

Indicates if the object is globally visible.

xnumber

The position of the displayObject on the x axis relative to the local coordinates of the parent.
An alias to position.x

ynumber

The position of the displayObject on the y axis relative to the local coordinates of the parent.
An alias to position.y

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!