Optional_Optional_Protected_Flags the cached bounds as dirty.
Protected_Cache of this display-object's bounds-rectangle.
Protected_If the object has been destroyed via destroy(). If true, it should not be used.
Protected_Currently enabled filters.
Protected_Protected_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.
Local bounds object, swapped with _bounds when
using getLocalBounds().
Protected_Cache of this display-object's local-bounds rectangle.
Protected_The original, cached mask of the object.
Protected_Protected_The zIndex of the displayObject. A higher value will mean it will be rendered on top of other displayObjects within the same container.
Optionalaccessible
OptionalaccessibleOptionalaccessibleOptionalaccessibleOptionalaccessibleOptionalaccessibleThe opacity of the object.
Optionalanimation
Pointer to currently visible animation.
Readonlychildren
The array of children of this container.
Readonlycomplete$
When animation completes, it emits this subject.
Should this object be rendered if the bounds of this object are out of frame?
Culling has no effect on whether updateTransform is called.
If set, this shape is used for culling instead of the bounds of this object. It can improve the culling performance of objects with many children. The culling area is defined in local space.
The cursor preferred when the mouse pointer is hovering over.
Readonlydestroy$
When Lifecycle Object is destroyed, it emits and closes this subject. Along with destroying his children, which in turn behave the same.
The mode of interaction for this object
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.
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'.
Parent GameObject is assigned at creation.
The hit-area specifies the area for which pointer events should be captured by this event target.
Whether this event target should fire UI events.
Whether this event target has any children that need UI events. This can be used optimize event propagation.
Returns true if the DisplayObject has interactive 'static' or 'dynamic'
Does any other displayObject use this object as a mask?
Used to fast check if a sprite is.. a sprite!
Each Lifecycle Object has label for pixi debugging.
Handler for 'click' event
Handler for 'globalmousemove' event
Handler for 'globalpointermove' event
Handler for 'globaltouchmove' event
Handler for 'mousedown' event
Handler for 'mouseenter' event
Handler for 'mouseleave' event
Handler for 'mousemove' event
Handler for 'mouseout' event
Handler for 'mouseover' event
Handler for 'mouseup' event
Handler for 'mouseupoutside' event
Handler for 'pointercancel' event
Handler for 'pointerdown' event
Handler for 'pointerenter' event
Handler for 'pointerleave' event
Handler for 'pointermove' event
Handler for 'pointerout' event
Handler for 'pointerover' event
Handler for 'pointertap' event
Handler for 'pointerup' event
Handler for 'pointerupoutside' event
Handler for 'rightclick' event
Handler for 'rightdown' event
Handler for 'rightup' event
Handler for 'rightupoutside' event
Handler for 'tap' event
Handler for 'touchcancel' event
Handler for 'touchend' event
Handler for 'touchendoutside' event
Handler for 'touchmove' event
Handler for 'touchstart' event
Handler for 'wheel' event
The display object container that contains this display object.
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.
Optionalrender
If set to true, the container will sort its children by
zIndex value when
updateTransform() is called, or manually if
sortChildren() is called.
This actually changes the order of elements in the array, so should be treated as a basic solution that is not performant compared to other solutions, such as PixiJS Layers
Also be aware of that this may not work nicely with the
addChildAt() function, as the
zIndex sorting may cause the child to
automatically sorted to another position.
Should children be sorted by zIndex at the next updateTransform call.
Will get automatically set to true if a new child is added, or if a child's zIndex changes.
Readonlysprite
Animator has sprite container for animations.
ReadonlystateInner State Machine Object.
List of possible animations.
OptionaltabWorld 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.
Readonlyupdate$
When Lifecycle Object is updated, it emits this subject. Along with updating his children, which in turn behave the same.
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.
ReadonlyworldThe multiplied alpha of the displayObject.
Staticdefault
Sets the default value for the container property
sortableChildren. If set to true, the container
will sort its children by zIndex value when
updateTransform() is called, or manually if
sortChildren() is called.
This actually changes the order of elements in the array, so should be treated as a basic solution that is not performant compared to other solutions, such as PixiJS Layers.
Also be aware of that this may not work nicely with the
addChildAt() function, as the
zIndex sorting may cause the child to
automatically sorted to another position.
Staticprefixed
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.
Readonly flag for destroyed display objects.
The height of the Container, setting this will actually modify the scale to achieve the value set.
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 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. Furthermore, a mask of an object must be in
the subtree of its parent. Otherwise,
getLocalBounds may calculate incorrect
bounds, which makes the container's width and height
wrong. 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.
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.
Reference to inner animation scale.
Reference to inner State Machine's state.
Reference to inner State Machine's state$ Subject.
The width of the Container, setting this will actually modify the scale to achieve the value set.
Current transform of the object based on world (parent) factors.
Indicates if the object is globally visible.
The position of the displayObject on the x axis relative to the local coordinates of the parent. An alias to position.x
The position of the displayObject on the y axis relative to the local coordinates of the parent. An alias to position.y
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.
Optionaloptions:
boolean
|
IDestroyOptions
Protected_Protected
Recalculates the content bounds of this object. This should be overriden to calculate the bounds of this specific object (not including children).
Protected_Recursively updates transform of all objects from the root to this one internal function for toLocal()
Protected_To be overridden by the subclasses.
The renderer
Protected_Protected
Renders this object and its children with culling.
The renderer
Adds a child to the container at a specified index. If the index is out of bounds an error will be thrown. If the child is already in this container, it will be moved to the specified index.
The child to add.
The absolute index where the child will be positioned at the end of the operation.
The child that was added.
The
addEventListener() method
of the EventTarget interface sets up a function that
will be called whenever the specified event is delivered
to the target.
The
addEventListener() method
of the EventTarget interface sets up a function that
will be called whenever the specified event is delivered
to the target.
Optionaloptions:
AddListenerOptions
Recalculates the bounds of the container.
This implementation will automatically fit the children's bounds into the calculation. Each child's bounds is limited to its mask's bounds or filterArea, if any is applied.
Removes all internal references and listeners as well as
removes children from the display list. Do not use a
Container after calling destroy.
Optionaloptions:
boolean
|
IDestroyOptions
Options parameter. A boolean will act as if all options have been set to that value
if set to true, all the children will have their destroy method called as well. 'options' will be passed on to those calls.
Only used for child Sprites if options.children is set to true Should it destroy the texture of the child sprite
Only used for child Sprites if options.children is set to true Should it destroy the base texture of the child sprite
Pair method for enableTempParent
Actual parent of element
The dispatchEvent() method
of the EventTarget sends an Event to the object,
(synchronously) invoking the affected event listeners in
the appropriate order.
Used in Renderer, cacheAsBitmap and other places where
you call an updateTransform on root.
const cacheParent = elem.enableTempParent();
elem.updateTransform();
elem.disableTempParent(cacheParent);
Return an array listing the events for which the emitter has registered listeners.
Calculates and returns the (world) bounds of the display object as a [Rectangle]PIXI.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]PIXI.DisplayObject#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.
OptionalskipUpdate:
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.
Optionalrect:
Rectangle
Optional rectangle to store the result of the bounds calculation.
Returns the child at the specified index
The index to get the child at
Returns the index position of a child DisplayObject instance
The DisplayObject instance to identify
ProtectedgetProtectedgetOptionalpoint:
Point
OptionalskipUpdate:
boolean
Retrieves the local bounds of the displayObject as a rectangle object.
Calling getLocalBounds may invalidate the
_bounds of the whole subtree below. If
using it inside a render() call, it is advised to call
getBounds() immediately after to
recalculate the world bounds of the subtree.
Optionalrect:
Rectangle
Optional rectangle to store the result of the bounds calculation.
OptionalskipChildrenUpdate:
boolean
Setting to true will stop
re-calculation of children transforms, it was
default behaviour of pixi 4.0-5.2 and caused many
problems to users.
Return the number of listeners listening to a given event.
Return the listeners registered for a given event.
ProtectedonOverridable method that can be used by Container subclasses whenever the children array is modified.
Optional_length:
number
Remove all listeners, or those of the specified event.
Optionalevent:
keyof
DisplayObjectEvents
Removes a child from the specified index position.
The index to get the child from
The child that was removed.
Removes all children from this container that are within the begin and end indexes.
OptionalbeginIndex:
number
The beginning position.
OptionalendIndex:
number
The ending position. Default value is size of the container.
The
removeEventListener()
method of the EventTarget interface removes an event
listener previously registered with
EventTarget.addEventListener() from the target.
The
removeEventListener()
method of the EventTarget interface removes an event
listener previously registered with
EventTarget.addEventListener() from the target.
Optionaloptions:
RemoveListenerOptions
Remove the DisplayObject from its parent Container. If the DisplayObject has no parent, do nothing.
Remove the listeners of a given event.
Renders the object using the WebGL renderer.
The [_render]PIXI.Container#_render method is be
overriden for rendering the contents of the container
itself. This render method will invoke it,
and also invoke the render methods of all
children afterward.
If renderable or visible is
false or if worldAlpha is not positive or
if cullable is true and the bounds of this
object are out of frame, this implementation will
entirely skip rendering. See PIXI.DisplayObject for
choosing between renderable or
visible. Generally, setting alpha to zero
is not recommended for purely skipping rendering.
When your scene becomes large (especially when it is larger than can be viewed in a single screen), it is advised to employ culling to automatically skip rendering objects outside of the current screen. See [cullable]PIXI.DisplayObject#cullable and [cullArea]PIXI.DisplayObject#cullArea. Other culling methods might be better suited for a large number static objects; see [@pixi-essentials/cull]https://www.npmjs.com/package/@pixi-essentials/cull and [pixi-cull]https://www.npmjs.com/package/pixi-cull.
The [renderAdvanced]PIXI.Container#renderAdvanced method is internally used when when masking or filtering is applied on a container. This does, however, break batching and can affect performance when masking and filtering is applied extensively throughout the scene graph.
The renderer
ProtectedrenderRender the object using the WebGL renderer and advanced features.
The renderer
Changes the position of an existing child in the display object container
The child DisplayObject instance for which you want to change the index number
The resulting index number for the child display object
Set the parent Container of this DisplayObject.
The Container to add this DisplayObject to.
Convenience function to set the position, scale, skew and pivot at once.
Optionalx:
number
The X position
Optionaly:
number
The Y position
OptionalscaleX:
number
The X scale value
OptionalscaleY:
number
The Y scale value
Optionalrotation:
number
The rotation
OptionalskewX:
number
The X skew value
OptionalskewY:
number
The Y skew value
OptionalpivotX:
number
The X pivot value
OptionalpivotY:
number
The Y pivot value
Sorts children by zIndex. Previous order is maintained for 2 children with the same zIndex.
Swaps the position of 2 Display Objects within this container.
First display object to swap
Second display object to swap
Calculates the global position of the display object.
The world origin to calculate from.
Optionalpoint:
P
A Point object in which to store the value, optional (otherwise will create a new Point).
OptionalskipUpdate:
boolean
Should we skip the update transform.
Calculates the local position of the display object relative to another point.
The world origin to calculate from.
Optionalfrom:
DisplayObject
The DisplayObject to calculate the global position from.
Optionalpoint:
P
A Point object in which to store the value, optional (otherwise will create a new Point).
OptionalskipUpdate:
boolean
Should we skip the update transform
= 1.0 for 60FPS
Updates the transform on all children of this container for rendering.
Staticmixin
Mixes all enumerable properties and methods from a source object to DisplayObject.
The source of properties and methods to mix in.
The bounds object, this is used to calculate and store the bounds of the displayObject.