API Docs for: 2.0.0
Show:

DisplayObject Class

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.

Constructor

DisplayObject

()

Methods

_destroyCachedSprite

() private

Destroys the cached sprite.

_generateCachedSprite

() private

Internal method.

_renderCachedSprite

(
  • renderSession
)
private

Internal method.

Parameters:

  • renderSession Object

    The render session

_renderCanvas

(
  • renderSession
)
private

Renders the object using the Canvas renderer

Parameters:

  • renderSession RenderSession

_renderWebGL

(
  • renderSession
)
private

Renders the object using the WebGL renderer

Parameters:

  • renderSession RenderSession

click

(
  • interactionData
)

A callback that is used when the users clicks on the displayObject with their mouse's left button

Parameters:

generateTexture

(
  • resolution
  • scaleMode
  • renderer
)
Texture

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

Parameters:

  • resolution Number

    The resolution of the texture being generated

  • scaleMode Number

    Should be one of the PIXI.scaleMode consts

  • renderer CanvasRenderer | WebGLRenderer

    The renderer used to generate the texture.

Returns:

Texture:

a texture of the graphics object

getBounds

(
  • matrix
)
Rectangle

Retrieves the bounds of the displayObject as a rectangle object

Parameters:

Returns:

Rectangle:

the rectangular bounding area

getLocalBounds

() Rectangle

Retrieves the local bounds of the displayObject as a rectangle object

Returns:

Rectangle:

the rectangular bounding area

mousedown

(
  • interactionData
)

A callback that is used when the user clicks the mouse's left button down over the sprite

Parameters:

mouseout

(
  • interactionData
)

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

Parameters:

mouseover

(
  • interactionData
)

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

Parameters:

mouseup

(
  • interactionData
)

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

Parameters:

mouseupoutside

(
  • interactionData
)

A callback that is used when the user releases the mouse's left button that was over the displayObject but is no longer over the displayObject for this callback to be fired, the mouse's left button must have been pressed down over the displayObject

Parameters:

rightclick

(
  • interactionData
)

A callback that is used when the users clicks on the displayObject with their mouse's right button

Parameters:

rightdown

(
  • interactionData
)

A callback that is used when the user clicks the mouse's right button down over the sprite

Parameters:

rightup

(
  • interactionData
)

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

Parameters:

rightupoutside

(
  • interactionData
)

A callback that is used when the user releases the mouse's right button that was over the displayObject but is no longer over the displayObject for this callback to be fired, the mouse's right button must have been pressed down over the displayObject

Parameters:

setStageReference

(
  • stage
)

Sets the object's stage reference, the stage this object is connected to

Parameters:

  • stage Stage

    the stage that the object will have as its current stage reference

tap

(
  • interactionData
)

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

Parameters:

toGlobal

(
  • position
)
Point

Calculates the global position of the display object

Parameters:

  • position Point

    The world origin to calculate from

Returns:

Point:

A point object representing the position of this object

toLocal

(
  • position
  • [from]
)
Point

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

Parameters:

  • position Point

    The world origin to calculate from

  • [from] DisplayObject optional

    The DisplayObject to calculate the global position from

Returns:

Point:

A point object representing the position of this object

touchend

(
  • interactionData
)

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

Parameters:

touchendoutside

(
  • interactionData
)

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
)

A callback that is used when the user touches over the displayObject

Parameters:

updateCache

()

Generates and updates the cached sprite for this object.

Properties

_bounds

Rectangle private

The original, cached bounds of the object

_cacheAsBitmap

Boolean private

Cached internal flag.

_cacheIsDirty

Boolean private

Cached internal flag.

_cr

Number private

cached sin rotation and cos rotation

_currentBounds

Rectangle private

The most up-to-date bounds of the object

_currentBounds

Rectangle private

The original, cached mask of the object

_interactive

Boolean private

[read-only] Whether or not the object is interactive, do not toggle directly! use the interactive property

_sr

Number private

cached sin rotation and cos rotation

alpha

Number

The opacity of the object.

buttonMode

Boolean

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

cacheAsBitmap

Boolean

Set if this display object is 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 'null'

defaultCursor

String

This is the cursor that will be used when the mouse is over this object. To enable this the element must have interaction = true and buttonMode = true

filterArea

Rectangle

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

filters

Array An array of filters

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'

hitArea

Rectangle | Circle | Ellipse | Polygon

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

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

Default: false

mask

Graphics

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

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

pivot

Point

The pivot point of the displayObject that it rotates around

position

Point

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

renderable

Boolean

Can this object be rendered

rotation

Number

The rotation of the object in radians.

scale

Point

The scale factor of the object.

stage

Stage

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

visible

Boolean

The visibility of the object.

worldAlpha

Number

[read-only] The multiplied alpha of the displayObject

worldTransform

Matrix private

[read-only] Current transform of the object based on world (parent) factors

worldVisible

Boolean

[read-only] Indicates if the sprite is globally visible.

x

Number

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

y

Number

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