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 ()

Extends

  • EventEmitter

Members

alpha number

The opacity of the object.

buttonMode boolean

If enabled, the mouse cursor use the pointer behavior when hovered over the displayObject if it is interactive Setting this changes the 'cursor' property to 'pointer'.

Example
const sprite = new PIXI.Sprite(texture);
sprite.interactive = true;
sprite.buttonMode = true;

cacheAsBitmap boolean

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'

IMPORTANT GOTCHA - make sure that all your textures are preloaded BEFORE setting this property to true as it will take a snapshot of what is currently there. If the textures have not loaded then they will not appear.

cursor string

This defines what cursor mode is used when the mouse cursor is hovered over the displayObject.

See:
Example
const sprite = new PIXI.Sprite(texture);
sprite.interactive = true;
sprite.cursor = 'wait';

filterArea PIXI.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

filters Array.<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'

Interaction shape. Children will be hit first, then this shape will be checked. Setting this will cause this shape to be checked in hit tests rather than the displayObject's bounds.

Example
const sprite = new PIXI.Sprite(texture);
sprite.interactive = true;
sprite.hitArea = new PIXI.Rectangle(0, 0, 100, 100);

interactive boolean

Enable interaction events for the DisplayObject. Touch, pointer and mouse events will not be emitted unless interactive is set to true.

Example
const sprite = new PIXI.Sprite(texture);
sprite.interactive = true;
sprite.on('tap', (event) => {
   //handle event
});

localTransform PIXI.Matrix readonly

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

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.

name string

The instance name of the object.

parent PIXI.Container readonly

The display object container that contains this display object.

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

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

renderable boolean

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

rotation number

The rotation of the object in radians.

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

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

transform PIXI.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

visible boolean

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

worldAlpha number readonly

The multiplied alpha of the displayObject

worldTransform PIXI.Matrix readonly

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

worldVisible boolean readonly

Indicates if the object is globally visible.

x number

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

y number

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

Methods

_recursivePostUpdateTransform ()

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

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

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

getGlobalPosition (point, skipUpdate)Point

Returns the global position of the displayObject. Does not depend on object scale, rotation and pivot.

Name Type Description
point Point

the point to write the global value to. If null a new point will be returned

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

Returns:
Type Description
Point The updated point

getLocalBounds (rect)PIXI.Rectangle

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)

Renders the object using the Canvas renderer

Name Type Description
renderer PIXI.CanvasRenderer

The renderer

renderWebGL (renderer)

Renders the object using the WebGL renderer

Name Type Description
renderer PIXI.WebGLRenderer

The renderer

setParent (container)PIXI.Container

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

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

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

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 ()

Updates the object transform for rendering

TODO - Optimization pass!

Events

Fired when this DisplayObject is added to a Container.

Name Type Description
container PIXI.Container

The container added to.

Fired when a pointer device button (usually a mouse left-button) is pressed and released on the display object. DisplayObject's interactive property must be set to true to fire event.

Name Type Description
event PIXI.interaction.InteractionEvent

Interaction event

Fired when a pointer device button (usually a mouse left-button) is pressed on the display. object. DisplayObject's interactive property must be set to true to fire event.

Name Type Description
event PIXI.interaction.InteractionEvent

Interaction event

Fired when a pointer device (usually a mouse) is moved while over the display object. DisplayObject's interactive property must be set to true to fire event.

Name Type Description
event PIXI.interaction.InteractionEvent

Interaction event

Fired when a pointer device (usually a mouse) is moved off the display object. DisplayObject's interactive property must be set to true to fire event.

Name Type Description
event PIXI.interaction.InteractionEvent

Interaction event

Fired when a pointer device (usually a mouse) is moved onto the display object. DisplayObject's interactive property must be set to true to fire event.

Name Type Description
event PIXI.interaction.InteractionEvent

Interaction event

Fired when a pointer device button (usually a mouse left-button) is released over the display object. DisplayObject's interactive property must be set to true to fire event.

Name Type Description
event PIXI.interaction.InteractionEvent

Interaction event

mouseupoutside

Fired when a pointer device button (usually a mouse left-button) is released outside the display object that initially registered a mousedown. DisplayObject's interactive property must be set to true to fire event.

Name Type Description
event PIXI.interaction.InteractionEvent

Interaction event

Fired when the operating system cancels a pointer event. DisplayObject's interactive property must be set to true to fire event.

Name Type Description
event PIXI.interaction.InteractionEvent

Interaction event

Fired when a pointer device button is pressed on the display object. DisplayObject's interactive property must be set to true to fire event.

Name Type Description
event PIXI.interaction.InteractionEvent

Interaction event

Fired when a pointer device is moved while over the display object. DisplayObject's interactive property must be set to true to fire event.

Name Type Description
event PIXI.interaction.InteractionEvent

Interaction event

Fired when a pointer device is moved off the display object. DisplayObject's interactive property must be set to true to fire event.

Name Type Description
event PIXI.interaction.InteractionEvent

Interaction event

Fired when a pointer device is moved onto the display object. DisplayObject's interactive property must be set to true to fire event.

Name Type Description
event PIXI.interaction.InteractionEvent

Interaction event

Fired when a pointer device button is pressed and released on the display object. DisplayObject's interactive property must be set to true to fire event.

Name Type Description
event PIXI.interaction.InteractionEvent

Interaction event

Fired when a pointer device button is released over the display object. DisplayObject's interactive property must be set to true to fire event.

Name Type Description
event PIXI.interaction.InteractionEvent

Interaction event

pointerupoutside

Fired when a pointer device button is released outside the display object that initially registered a pointerdown. DisplayObject's interactive property must be set to true to fire event.

Name Type Description
event PIXI.interaction.InteractionEvent

Interaction event

Fired when this DisplayObject is removed from a Container.

Name Type Description
container PIXI.Container

The container removed from.

Fired when a pointer device secondary button (usually a mouse right-button) is pressed and released on the display object. DisplayObject's interactive property must be set to true to fire event.

Name Type Description
event PIXI.interaction.InteractionEvent

Interaction event

Fired when a pointer device secondary button (usually a mouse right-button) is pressed on the display object. DisplayObject's interactive property must be set to true to fire event.

Name Type Description
event PIXI.interaction.InteractionEvent

Interaction event

Fired when a pointer device secondary button (usually a mouse right-button) is released over the display object. DisplayObject's interactive property must be set to true to fire event.

Name Type Description
event PIXI.interaction.InteractionEvent

Interaction event

rightupoutside

Fired when a pointer device secondary button (usually a mouse right-button) is released outside the display object that initially registered a rightdown. DisplayObject's interactive property must be set to true to fire event.

Name Type Description
event PIXI.interaction.InteractionEvent

Interaction event

Fired when a touch point is placed and removed from the display object. DisplayObject's interactive property must be set to true to fire event.

Name Type Description
event PIXI.interaction.InteractionEvent

Interaction event

Fired when the operating system cancels a touch. DisplayObject's interactive property must be set to true to fire event.

Name Type Description
event PIXI.interaction.InteractionEvent

Interaction event

Fired when a touch point is removed from the display object. DisplayObject's interactive property must be set to true to fire event.

Name Type Description
event PIXI.interaction.InteractionEvent

Interaction event

touchendoutside

Fired when a touch point is removed outside of the display object that initially registered a touchstart. DisplayObject's interactive property must be set to true to fire event.

Name Type Description
event PIXI.interaction.InteractionEvent

Interaction event

Fired when a touch point is moved along the display object. DisplayObject's interactive property must be set to true to fire event.

Name Type Description
event PIXI.interaction.InteractionEvent

Interaction event

Fired when a touch point is placed on the display object. DisplayObject's interactive property must be set to true to fire event.

Name Type Description
event PIXI.interaction.InteractionEvent

Interaction event