API Docs for: 2.2.1
Show:

DisplayObject Class

Defined in: pixi/display/CoreDisplayObject.hx:14

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

()

Defined in pixi/display/CoreDisplayObject.hx:14

Methods

click

(
  • interactionData
)

Defined in pixi/display/CoreDisplayObject.hx:279

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

Parameters:

generateTexture

(
  • resolution
  • scaleMode
  • [renderer]
)
Texture

Defined in pixi/display/CoreDisplayObject.hx:23

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 Float

    The resolution of the texture being generated

  • scaleMode Int

    Should be one of the PIXI.scaleMode consts

  • [renderer] CanvasRenderer | WebGLRenderer optional

    The renderer used to generate the texture.

Returns:

Texture:

a texture of the graphics object

getBounds

(
  • [matrix]
)
Rectangle

Defined in pixi/display/CoreDisplayObject.hx:36

Retrieves the bounds of the displayObject as a rectangle object

Parameters:

Returns:

Rectangle:

the rectangular bounding area

getLocalBounds

() Rectangle

Defined in pixi/display/CoreDisplayObject.hx:45

Retrieves the local bounds of the displayObject as a rectangle object

Returns:

Rectangle:

the rectangular bounding area

mousedown

(
  • interactionData
)

Defined in pixi/display/CoreDisplayObject.hx:286

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

Parameters:

mousemove

(
  • interactionData
)

Defined in pixi/display/CoreDisplayObject.hx:301

Is called when mouse is moved across the renderer element

Parameters:

mouseout

(
  • interactionData
)

Defined in pixi/display/CoreDisplayObject.hx:272

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

Parameters:

mouseover

(
  • interactionData
)

Defined in pixi/display/CoreDisplayObject.hx:265

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

Parameters:

mouseup

(
  • interactionData
)

Defined in pixi/display/CoreDisplayObject.hx:293

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
)

Defined in pixi/display/CoreDisplayObject.hx:308

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
)

Defined in pixi/display/CoreDisplayObject.hx:316

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

Parameters:

rightdown

(
  • interactionData
)

Defined in pixi/display/CoreDisplayObject.hx:323

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

Parameters:

rightup

(
  • interactionData
)

Defined in pixi/display/CoreDisplayObject.hx:330

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
)

Defined in pixi/display/CoreDisplayObject.hx:338

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
)

Defined in pixi/display/CoreDisplayObject.hx:53

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
)

Defined in pixi/display/CoreDisplayObject.hx:346

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

Defined in pixi/display/CoreDisplayObject.hx:61

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
  • [frm]
)
Point

Defined in pixi/display/CoreDisplayObject.hx:70

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

Parameters:

  • position Point

    The world origin to calculate from

  • [frm] DisplayObject optional

    The DisplayObject to calculate the global position from

Returns:

Point:

A point object representing the position of this object

touchend

(
  • interactionData
)

Defined in pixi/display/CoreDisplayObject.hx:361

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

Parameters:

touchendoutside

(
  • interactionData
)

Defined in pixi/display/CoreDisplayObject.hx:368

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:

touchmove

(
  • interactionData
)

Defined in pixi/display/CoreDisplayObject.hx:376

Is called when a touch is moved across the renderer element

Parameters:

touchstart

(
  • interactionData
)

Defined in pixi/display/CoreDisplayObject.hx:354

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

Parameters:

updateCache

()

Defined in pixi/display/CoreDisplayObject.hx:80

Generates and updates the cached sprite for this object.

Properties

alpha

Float

Defined in pixi/display/CoreDisplayObject.hx:87

The opacity of the object.

buttonMode

Bool

Defined in pixi/display/CoreDisplayObject.hx:95

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

cacheAsBitmap

Bool

Defined in pixi/display/CoreDisplayObject.hx:103

Set weather or not a the display objects 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 filters simply set this property to 'null'

defaultCursor

String

Defined in pixi/display/CoreDisplayObject.hx:112

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

Defined in pixi/display/CoreDisplayObject.hx:120

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

Defined in pixi/display/CoreDisplayObject.hx:129

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

Defined in pixi/display/CoreDisplayObject.hx:138

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

Bool

Defined in pixi/display/CoreDisplayObject.hx:147

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

Default: false

mask

Graphics

Defined in pixi/display/CoreDisplayObject.hx:156

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

Defined in pixi/display/CoreDisplayObject.hx:166

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

pivot

Point

Defined in pixi/display/CoreDisplayObject.hx:175

The pivot point of the displayObject that it rotates around

position

Point

Defined in pixi/display/CoreDisplayObject.hx:183

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

renderable

Bool

Defined in pixi/display/CoreDisplayObject.hx:191

Can this object be rendered

rotation

Float

Defined in pixi/display/CoreDisplayObject.hx:199

The rotation of the object in radians.

scale

Point

Defined in pixi/display/CoreDisplayObject.hx:207

The scale factor of the object.

stage

Stage

Defined in pixi/display/CoreDisplayObject.hx:215

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

visible

Bool

Defined in pixi/display/CoreDisplayObject.hx:224

The visibility of the object.

worldAlpha

Float

Defined in pixi/display/CoreDisplayObject.hx:232

[read-only] The multiplied alpha of the displayObject

worldVisible

Bool

Defined in pixi/display/CoreDisplayObject.hx:241

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

x

Float

Defined in pixi/display/CoreDisplayObject.hx:249

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

y

Float

Defined in pixi/display/CoreDisplayObject.hx:257

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