Class: DisplayObject

Extends

• EventEmitter

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

filtersArray.<PIXI.AbstractFilter>

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'

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

The pivot point of the displayObject that it rotates around

positionPIXI.Point

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

renderableboolean

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

rotationnumber

The rotation of the object in radians.

scalePIXI.Point

The scale factor of the object.

skewPIXI.Point

The skew factor for the object in radians.

visibleboolean

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

readonlyworldAlphanumber

The multiplied alpha of the displayObject

readonlyworldTransformPIXI.Matrix

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

readonlyworldVisibleboolean

Indicates if the sprite is globally visible.

xnumber

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

ynumber

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

Methods

destroy()

core/display/DisplayObject.js, line 548

Base destroy method for generic display objects

generateTexture(renderer, scaleMode, resolution){PIXI.Texture}

core/display/DisplayObject.js, line 485

Useful function that returns a texture of the display 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.

Name	Type	Description
renderer	PIXI.CanvasRenderer | PIXI.WebGLRenderer	The renderer used to generate the texture.
scaleMode	number	See PIXI.SCALE_MODES for possible values
resolution	number	The resolution of the texture being generated

Returns:

Type	Description
PIXI.Texture	a texture of the display object

getBounds(matrix){PIXI.Rectangle}

core/display/DisplayObject.js, line 381

Retrieves the bounds of the displayObject as a rectangle object

Name	Type	Description
matrix	PIXI.Matrix

Returns:

Type	Description
PIXI.Rectangle	the rectangular bounding area

getLocalBounds(){PIXI.Rectangle}

core/display/DisplayObject.js, line 391

Retrieves the local bounds of the displayObject as a rectangle object

Returns:

Type	Description
PIXI.Rectangle	the rectangular bounding area

setParent(container){Container}

core/display/DisplayObject.js, line 505

Set the parent Container of this DisplayObject

Name	Type	Description
container	Container	The Container to add this DisplayObject to

Returns:

Type	Description
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 530

Convenience function to set the postion, 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

toGlobal(position){PIXI.Point}

core/display/DisplayObject.js, line 402

Calculates the global position of the display object

Name	Type	Description
position	PIXI.Point	The world origin to calculate from

Returns:

Type	Description
PIXI.Point	A point object representing the position of this object

toLocal(position, from, point){PIXI.Point}

core/display/DisplayObject.js, line 430

Calculates the local position of the display object relative to another point

Name	Type	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)

Returns:

Type	Description
PIXI.Point	A point object representing the position of this object