PixiJS

Class: TemporaryDisplayObject

TemporaryDisplayObject

Extends

Inherited Properties

From class PIXI.DisplayObject

_accessibleActive boolean inherited

TODO
  • Needs docs.

_accessibleDiv boolean inherited

TODO
  • Needs docs.

_bounds PIXI.Bounds inherited

The bounds object, this is used to calculate and store the bounds of the displayObject.

_localBounds PIXI.Bounds inherited

Local bounds object, swapped with _bounds when using getLocalBounds().

accessible boolean inherited

Flag for if the object is accessible. If true AccessibilityManager will overlay a shadow div with attributes set

accessibleChildren boolean inherited

Setting to false will prevent any children inside this container to be accessible. Defaults to true.

Default Value:
  • true

accessibleHint string inherited

Sets the aria-label attribute of the shadow div

accessiblePointerEvents string inherited

Specify the pointer-events the accessible div will use Defaults to auto.

Default Value:
  • 'auto'

accessibleTitle ?string inherited

Sets the title attribute of the shadow div If accessibleTitle AND accessibleHint has not been this will default to 'displayObject [tabIndex]'

accessibleType string inherited

Specify the type of div the accessible layer is. Screen readers treat the element differently depending on this type. Defaults to button.

Default Value:
  • 'button'

alpha number inherited

The opacity of the object.

angle number inherited

The angle of the object in degrees. 'rotation' and 'angle' have the same effect on a display object; rotation is in radians, angle is in degrees.

buttonMode boolean inherited

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 inherited

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 inherited

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 inherited

The area the filter is applied to. This is used as more of an optimization 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> inherited

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 PIXI.IHitArea inherited

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 inherited

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
 });

isMask boolean inherited

Does any other displayObject use this object as a mask?

isSprite boolean inherited

used to fast check if a sprite is.. a sprite!

localTransform PIXI.Matrix inherited

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

mask PIXI.Container | PIXI.MaskData | unknown inherited

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

For sprite mask both alpha and red channel are used. Black mask is the same as transparent mask.

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

 const graphics = new PIXI.Graphics();
 graphics.beginFill(0xFF3300);
 graphics.drawRect(50, 250, 100, 100);
 graphics.endFill();

 const sprite = new PIXI.Sprite(texture);
 sprite.mask = graphics;

name string inherited

The instance name of the object.

parent PIXI.Container inherited

The display object container that contains this display object.

pivot PIXI.ObservablePoint inherited

The center of rotation, scaling, and skewing for this display object in its local space. The position is the projection of pivot in the parent's local space.

By default, the pivot is the origin (0, 0).

Since:
  • PixiJS 4

position PIXI.ObservablePoint inherited

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

Since:
  • PixiJS 4

renderable boolean inherited

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 inherited

The rotation of the object in radians. 'rotation' and 'angle' have the same effect on a display object; rotation is in radians, angle is in degrees.

scale PIXI.ObservablePoint inherited

The scale factors of this object along the local coordinate axes.

The default scale is (1, 1).

Since:
  • PixiJS 4

skew PIXI.ObservablePoint inherited

The skew factor for the object in radians.

Since:
  • PixiJS 4

transform PIXI.Transform inherited

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 inherited

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 inherited

The multiplied alpha of the displayObject.

worldTransform PIXI.Matrix inherited

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

worldVisible boolean inherited

Indicates if the object is globally visible.

x number inherited

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

y number inherited

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

zIndex number inherited

The zIndex of the displayObject.

If a container has the sortableChildren property set to true, children will be automatically sorted by zIndex value; a higher value will mean it will be moved towards the end of the array, and thus rendered on top of other display objects within the same container.

See:
  • PIXI.Container#sortableChildren

_boundsID number protected inherited

Flags the cached bounds as dirty.

_boundsRect PIXI.Bounds protected inherited

Cache of this display-object's bounds-rectangle.

_destroyed boolean protected inherited

If the object has been destroyed via destroy(). If true, it should not be used.

_enabledFilters Array<PIXI.Filter> protected inherited

Currently enabled filters

_lastSortedIndex number protected inherited

Which index in the children array the display component was before the previous zIndex sort. Used by containers to help sort objects with the same zIndex, by using previous array index as the decider.

_localBoundsRect PIXI.Bounds protected inherited

Cache of this display-object's local-bounds rectangle.

_mask PIXI.Container | PIXI.MaskData | unknown protected inherited

The original, cached mask of the object.

_tempDisplayObjectParent PIXI.Container protected inherited

_zIndex number protected inherited

The zIndex of the displayObject. A higher value will mean it will be rendered on top of other displayObjects within the same container.

Inherited Methods

From class PIXI.DisplayObject

_recursivePostUpdateTransform () void inherited

DisplayObject.ts:460

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

calculateBounds () void abstract inherited

DisplayObject.ts:446

Recalculates the bounds of the display object.

destroy (_options) void inherited

DisplayObject.ts:728

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

Name Type Attributes Description
_options IDestroyOptions | boolean <optional>

disableTempParent (cacheParent) void inherited

DisplayObject.ts:793

Pair method for enableTempParent

Name Type Description
cacheParent PIXI.DisplayObject

Actual parent of element

displayObjectUpdateTransform inherited

DisplayObject.ts:1060

DisplayObject default updateTransform, does not update children of container. Will crash if there's no parent element.

enableTempParent () PIXI.DisplayObject inherited

DisplayObject.ts:773

Used in Renderer, cacheAsBitmap and other places where you call an updateTransform on root

const cacheParent = elem.enableTempParent();
elem.updateTransform();
elem.disableTempParent(cacheParent);
Returns:
Type Description
PIXI.DisplayObject current parent

getBounds (skipUpdate, rect) PIXI.Rectangle inherited

DisplayObject.ts:491

Calculates and returns the (world) bounds of the display object as a Rectangle.

This method is expensive on containers with a large subtree (like the stage). This is because the bounds of a container depend on its children's bounds, which recursively causes all bounds in the subtree to be recalculated. The upside, however, is that calling getBounds once on a container will indeed update the bounds of all children (the whole subtree, in fact). This side effect should be exploited by using displayObject._bounds.getRectangle() when traversing through all the bounds in a scene graph. Otherwise, calling getBounds on each object in a subtree will cause the total cost to increase quadratically as its height increases.

  • The transforms of all objects in a container's subtree and of all ancestors are updated.
  • The world bounds of all display objects in a container's subtree will also be recalculated.

The _bounds object stores the last calculation of the bounds. You can use to entirely skip bounds calculation if needed.

const lastCalculatedBounds = displayObject._bounds.getRectangle(optionalRect);

Do know that usage of getLocalBounds can corrupt the _bounds of children (the whole subtree, actually). This is a known issue that has not been solved. See getLocalBounds for more details.

getBounds should be called with skipUpdate equal to true in a render() call. This is because the transforms are guaranteed to be update-to-date. In fact, recalculating inside a render() call may cause corruption in certain cases.

Name Type Attributes Description
skipUpdate boolean <optional>

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>

Optional rectangle to store the result of the bounds calculation.
Returns:
Type Description
PIXI.Rectangle The minimum axis-aligned rectangle in world space that fits around this object.

getGlobalPosition (point, skipUpdate) PIXI.Point inherited

index.ts:4

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

Name Type Attributes Default Description
point PIXI.Point <optional>
 new PIXI.Point()

The point to write the global value to.
skipUpdate boolean <optional>
 false

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
PIXI.Point The updated point.

getLocalBounds (rect) PIXI.Rectangle inherited

DisplayObject.ts:562

Retrieves the local bounds of the displayObject as a rectangle object.

Name Type Attributes Description
rect PIXI.Rectangle <optional>

Optional rectangle to store the result of the bounds calculation.
Returns:
Type Description
PIXI.Rectangle The rectangular bounding area.

render (renderer) void abstract inherited

DisplayObject.ts:453

Renders the object using the WebGL renderer.

Name Type Description
renderer PIXI.Renderer

The renderer.

setParent (container) PIXI.Container inherited

DisplayObject.ts:681

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 inherited

DisplayObject.ts:699

Convenience function to set the position, scale, skew and pivot at once.

Name Type Attributes Default Description
x number <optional>
 0

The X position
y number <optional>
 0

The Y position
scaleX number <optional>
 1

The X scale value
scaleY number <optional>
 1

The Y scale value
rotation number <optional>
 0

The rotation
skewX number <optional>
 0

The X skew value
skewY number <optional>
 0

The Y skew value
pivotX number <optional>
 0

The X pivot value
pivotY number <optional>
 0

The Y pivot value
Returns:
Type Description
PIXI.DisplayObject The DisplayObject instance

toGlobal (position, point, skipUpdate) PIXI.Point inherited

DisplayObject.ts:607

Calculates the global position of the display object.

Name Type Attributes Default Description
position PIXI.IPointData

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

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 inherited

DisplayObject.ts:641

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

Name Type Attributes Default Description
position PIXI.IPointData

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

Should we skip the update transform
Returns:
Type Description
PIXI.Point A point object representing the position of this object

updateTransform () void inherited

DisplayObject.ts:477

Updates the object transform for rendering.

TODO - Optimization pass!

Inherited Events

From class PIXI.DisplayObject

click inherited

InteractionManager.ts:557

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

Interaction event

mousedown inherited

InteractionManager.ts:525

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

Interaction event

mousemove inherited

InteractionManager.ts:593

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

Interaction event

mouseout inherited

InteractionManager.ts:609

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

Interaction event

mouseover inherited

InteractionManager.ts:601

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

Interaction event

mouseup inherited

InteractionManager.ts:541

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

Interaction event

mouseupoutside inherited

InteractionManager.ts:573

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

Interaction event

pointercancel inherited

InteractionManager.ts:633

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

Interaction event

pointerdown inherited

InteractionManager.ts:617

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

Interaction event

pointermove inherited

InteractionManager.ts:658

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

Interaction event

pointerout inherited

InteractionManager.ts:674

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

Interaction event

pointerover inherited

InteractionManager.ts:666

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

Interaction event

pointertap inherited

InteractionManager.ts:641

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

Interaction event

pointerup inherited

InteractionManager.ts:625

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

Interaction event

pointerupoutside inherited

InteractionManager.ts:649

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

Interaction event

removedFrom inherited

Container.ts:115

Fired when a DisplayObject is removed from this Container.

Name Type Description
child PIXI.DisplayObject

The child removed from the Container.
container PIXI.Container

The container that removed removed the child.
index number

The former children's index of the removed child

rightclick inherited

InteractionManager.ts:565

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

Interaction event

rightdown inherited

InteractionManager.ts:533

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

Interaction event

rightup inherited

InteractionManager.ts:549

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

Interaction event

rightupoutside inherited

InteractionManager.ts:583

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

Interaction event

tap inherited

InteractionManager.ts:706

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

Interaction event

touchcancel inherited

InteractionManager.ts:698

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

Interaction event

touchend inherited

InteractionManager.ts:690

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

Interaction event

touchendoutside inherited

InteractionManager.ts:714

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

Interaction event

touchmove inherited

InteractionManager.ts:723

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

Interaction event

touchstart inherited

InteractionManager.ts:682

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

Interaction event

added inherited

DisplayObject.ts:430

Fired when this DisplayObject is added to a Container.

Name Type Description
container PIXI.Container

The container added to.

removed inherited

DisplayObject.ts:438

Fired when this DisplayObject is removed from a Container.

Name Type Description
container PIXI.Container

The container removed from.