Options
All
  • Public
  • Public/Protected
  • All
Menu

A container represents a collection of 3D objects.

Hierarchy

Index

Constructors

constructor

  • Returns Container3D

Properties

Optional _accessibleActive

_accessibleActive?: boolean

Optional _accessibleDiv

_accessibleDiv?: IAccessibleHTMLElement

_bounds

_bounds: Bounds

Protected _boundsID

_boundsID: number

Protected _boundsRect

_boundsRect: Rectangle

Optional _cacheAsBitmap

_cacheAsBitmap?: boolean

Optional _cacheAsBitmapResolution

_cacheAsBitmapResolution?: number

Optional _cacheData

_cacheData?: CacheData

Protected _destroyed

_destroyed: boolean

Protected _enabledFilters

_enabledFilters: Filter[]

Protected _height

_height: number

_lastSortedIndex

_lastSortedIndex: number

_localBounds

_localBounds: Bounds

Protected _localBoundsRect

_localBoundsRect: Rectangle

_mask

_mask: Container | MaskData

Optional _trackedPointers

_trackedPointers?: {}

Type declaration

  • [x: number]: InteractionTrackingData

Protected _width

_width: number

Protected _zIndex

_zIndex: number

Optional accessible

accessible?: boolean

Optional accessibleChildren

accessibleChildren?: true

Optional accessibleHint

accessibleHint?: string

Optional accessiblePointerEvents

accessiblePointerEvents?: PointerEvents

Optional accessibleTitle

accessibleTitle?: string

Optional accessibleType

accessibleType?: string

alpha

alpha: number

Optional buttonMode

buttonMode?: boolean

Optional cacheAsBitmap

cacheAsBitmap?: boolean

Optional cacheAsBitmapResolution

cacheAsBitmapResolution?: number

Readonly children

children: DisplayObject[]

containerUpdateTransform

containerUpdateTransform: () => void

Type declaration

    • (): void
    • Returns void

Optional cursor

cursor?: string

displayObjectUpdateTransform

displayObjectUpdateTransform: () => void

Type declaration

    • (): void
    • Returns void

filterArea

filterArea: Rectangle

filters

filters: Filter[]

Optional hitArea

hitArea?: IHitArea

Optional interactive

interactive?: boolean

Optional interactiveChildren

interactiveChildren?: boolean

isMask

isMask: boolean

isSprite

isSprite: boolean

Optional name

name?: string

parent

parent: Container

Optional renderId

renderId?: number

renderable

renderable: boolean

sortDirty

sortDirty: boolean

sortableChildren

sortableChildren: boolean

Optional tabIndex

tabIndex?: number

Optional trackedPointers

trackedPointers?: {}

Type declaration

  • [x: number]: InteractionTrackingData

transform

transform: Transform3D = ...

visible

visible: boolean

worldAlpha

worldAlpha: number

Static prefixed

prefixed: string | boolean

Accessors

Protected _tempDisplayObjectParent

  • get _tempDisplayObjectParent(): TemporaryDisplayObject
  • member

    {PIXI.Container}

    Returns TemporaryDisplayObject

angle

  • get angle(): number
  • set angle(value: number): void
  • 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.

    member

    {number}

    Returns number

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

    member

    {number}

    Parameters

    • value: number

    Returns void

height

  • get height(): number
  • set height(value: number): void
  • The height of the Container, setting this will actually modify the scale to achieve the value set

    member

    {number}

    Returns number

  • The height of the Container, setting this will actually modify the scale to achieve the value set

    member

    {number}

    Parameters

    • value: number

    Returns void

localTransform

mask

  • get mask(): null | Container | MaskData
  • set mask(value: null | Container | MaskData): void
  • 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 {@link PIXI.Graphics} or a {@link 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.

    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;

    todo

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

    member

    {PIXI.Container|PIXI.MaskData|null}

    Returns null | Container | MaskData

  • 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 {@link PIXI.Graphics} or a {@link 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.

    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;

    todo

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

    member

    {PIXI.Container|PIXI.MaskData|null}

    Parameters

    • value: null | Container | MaskData

    Returns void

pivot

  • get pivot(): ObservablePoint<any>
  • set pivot(value: ObservablePoint<any>): void
  • 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

    member

    {PIXI.ObservablePoint}

    Returns ObservablePoint<any>

  • 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

    member

    {PIXI.ObservablePoint}

    Parameters

    • value: ObservablePoint<any>

    Returns void

position

rotation

  • get rotation(): number
  • set rotation(value: number): void
  • 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.

    member

    {number}

    Returns number

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

    member

    {number}

    Parameters

    • value: number

    Returns void

rotationQuaternion

scale

skew

  • get skew(): ObservablePoint<any>
  • set skew(value: ObservablePoint<any>): void
  • The skew factor for the object in radians.

    since

    PixiJS 4

    member

    {PIXI.ObservablePoint}

    Returns ObservablePoint<any>

  • The skew factor for the object in radians.

    since

    PixiJS 4

    member

    {PIXI.ObservablePoint}

    Parameters

    • value: ObservablePoint<any>

    Returns void

width

  • get width(): number
  • set width(value: number): void
  • The width of the Container, setting this will actually modify the scale to achieve the value set

    member

    {number}

    Returns number

  • The width of the Container, setting this will actually modify the scale to achieve the value set

    member

    {number}

    Parameters

    • value: number

    Returns void

worldTransform

worldVisible

  • get worldVisible(): boolean
  • Indicates if the object is globally visible.

    member

    {boolean}

    readonly

    Returns boolean

x

  • get x(): number
  • set x(value: number): void
  • The position of the displayObject on the x axis relative to the local coordinates of the parent. An alias to position.x

    member

    {number}

    Returns number

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

    member

    {number}

    Parameters

    • value: number

    Returns void

y

  • get y(): number
  • set y(value: number): void
  • The position of the displayObject on the y axis relative to the local coordinates of the parent. An alias to position.y

    member

    {number}

    Returns number

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

    member

    {number}

    Parameters

    • value: number

    Returns void

z

  • get z(): number
  • set z(value: number): void
  • The position of the object on the z axis relative to the local coordinates of the parent.

    Returns number

  • The position of the object on the z axis relative to the local coordinates of the parent.

    Parameters

    • value: number

    Returns void

zIndex

  • get zIndex(): number
  • set zIndex(value: number): void
  • 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.

    member

    {number}

    see

    PIXI.Container#sortableChildren

    Returns number

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

    member

    {number}

    see

    PIXI.Container#sortableChildren

    Parameters

    • value: number

    Returns void

Methods

Optional _cacheAsBitmapDestroy

  • _cacheAsBitmapDestroy(options?: boolean | IDestroyOptions): void
  • Parameters

    • Optional options: boolean | IDestroyOptions

    Returns void

Protected _calculateBounds

  • _calculateBounds(): void
  • Recalculates the content bounds of this object. This should be overriden to calculate the bounds of this specific object (not including children).

    Returns void

Optional _calculateCachedBounds

  • _calculateCachedBounds(): void
  • Returns void

Optional _destroyCachedDisplayObject

  • _destroyCachedDisplayObject(): void
  • Returns void

Optional _getCachedLocalBounds

  • _getCachedLocalBounds(): Rectangle
  • Returns Rectangle

Optional _initCachedDisplayObject

  • _initCachedDisplayObject(renderer: Renderer): void
  • Parameters

    • renderer: Renderer

    Returns void

Optional _initCachedDisplayObjectCanvas

  • _initCachedDisplayObjectCanvas(renderer: CanvasRenderer): void
  • Parameters

    • renderer: CanvasRenderer

    Returns void

Protected _recursivePostUpdateTransform

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

    Returns void

Protected _render

  • _render(_renderer: Renderer): void
  • To be overridden by the subclasses.

    Parameters

    • _renderer: Renderer

    Returns void

Optional _renderCached

  • _renderCached(renderer: Renderer): void
  • Parameters

    • renderer: Renderer

    Returns void

Optional _renderCachedCanvas

  • _renderCachedCanvas(renderer: CanvasRenderer): void
  • Parameters

    • renderer: CanvasRenderer

    Returns void

addChild

  • addChild<T>(...children: T): T[0]
  • Adds one or more children to the container.

    Multiple items can be added like so: myContainer.addChild(thingOne, thingTwo, thingThree)

    Type parameters

    • T: DisplayObject[]

    Parameters

    • Rest ...children: T

      The DisplayObject(s) to add to the container

    Returns T[0]

    The first child that was added.

addChildAt

  • addChildAt<T>(child: T, index: number): T
  • Adds a child to the container at a specified index. If the index is out of bounds an error will be thrown

    Type parameters

    • T: DisplayObject<T>

    Parameters

    • child: T

      The child to add

    • index: number

      The index to place the child in

    Returns T

    The child that was added.

addListener

  • addListener(event: string | symbol, fn: ListenerFn, context?: any): Container3D
  • Parameters

    • event: string | symbol
    • fn: ListenerFn
    • Optional context: any

    Returns Container3D

calculateBounds

  • calculateBounds(): void
  • 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.

    Returns void

destroy

  • destroy(options?: boolean | IDestroyOptions): void
  • Removes all internal references and listeners as well as removes children from the display list. Do not use a Container after calling destroy.

    Parameters

    • Optional options: boolean | IDestroyOptions

    Returns void

disableTempParent

  • disableTempParent(cacheParent: DisplayObject): void
  • Pair method for enableTempParent

    Parameters

    • cacheParent: DisplayObject

      Actual parent of element

    Returns void

emit

  • emit(event: string | symbol, ...args: any[]): boolean
  • Calls each of the listeners registered for a given event.

    Parameters

    • event: string | symbol
    • Rest ...args: any[]

    Returns boolean

enableTempParent

  • enableTempParent(): DisplayObject
  • Used in Renderer, cacheAsBitmap and other places where you call an updateTransform on root

    const cacheParent = elem.enableTempParent();
    elem.updateTransform();
    elem.disableTempParent(cacheParent);

    Returns DisplayObject

    current parent

eventNames

  • eventNames(): (string | symbol)[]
  • Return an array listing the events for which the emitter has registered listeners.

    Returns (string | symbol)[]

getBounds

  • getBounds(skipUpdate?: boolean, rect?: Rectangle): Rectangle
  • Calculates and returns the (world) bounds of the display object as a [Rectangle]{@link 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]{@link 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.

    Parameters

    • Optional skipUpdate: boolean
    • Optional rect: Rectangle

    Returns Rectangle

    The minimum axis-aligned rectangle in world space that fits around this object.

getChildAt

  • getChildAt(index: number): DisplayObject
  • Returns the child at the specified index

    Parameters

    • index: number

      The index to get the child at

    Returns DisplayObject

    The child at the given index, if any.

Optional getChildByName

  • getChildByName(name: string, isRecursive?: boolean): DisplayObject
  • Parameters

    • name: string
    • Optional isRecursive: boolean

    Returns DisplayObject

getChildIndex

  • getChildIndex(child: DisplayObject): number
  • Returns the index position of a child DisplayObject instance

    Parameters

    • child: DisplayObject

      The DisplayObject instance to identify

    Returns number

    The index position of the child display object to identify

Optional getGlobalPosition

  • getGlobalPosition(point?: Point, skipUpdate?: boolean): Point
  • Parameters

    • Optional point: Point
    • Optional skipUpdate: boolean

    Returns Point

getLocalBounds

  • getLocalBounds(rect?: Rectangle, skipChildrenUpdate?: boolean): Rectangle
  • 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.

    Parameters

    • Optional rect: Rectangle
    • Optional skipChildrenUpdate: boolean

    Returns Rectangle

    The rectangular bounding area.

listenerCount

  • listenerCount(event: string | symbol): number
  • Return the number of listeners listening to a given event.

    Parameters

    • event: string | symbol

    Returns number

listeners

  • listeners(event: string | symbol): ListenerFn[]
  • Return the listeners registered for a given event.

    Parameters

    • event: string | symbol

    Returns ListenerFn[]

off

  • off(event: string | symbol, fn?: ListenerFn, context?: any, once?: boolean): Container3D
  • Parameters

    • event: string | symbol
    • Optional fn: ListenerFn
    • Optional context: any
    • Optional once: boolean

    Returns Container3D

on

  • on(event: string | symbol, fn: ListenerFn, context?: any): Container3D
  • Add a listener for a given event.

    Parameters

    • event: string | symbol
    • fn: ListenerFn
    • Optional context: any

    Returns Container3D

Protected onChildrenChange

  • onChildrenChange(_length?: number): void
  • Overridable method that can be used by Container subclasses whenever the children array is modified

    Parameters

    • Optional _length: number

    Returns void

once

  • once(event: string | symbol, fn: ListenerFn, context?: any): Container3D
  • Add a one-time listener for a given event.

    Parameters

    • event: string | symbol
    • fn: ListenerFn
    • Optional context: any

    Returns Container3D

removeAllListeners

  • removeAllListeners(event?: string | symbol): Container3D
  • Remove all listeners, or those of the specified event.

    Parameters

    • Optional event: string | symbol

    Returns Container3D

removeChild

  • removeChild<T>(...children: T): T[0]
  • Removes one or more children from the container.

    Type parameters

    • T: DisplayObject[]

    Parameters

    • Rest ...children: T

      The DisplayObject(s) to remove

    Returns T[0]

    The first child that was removed.

removeChildAt

  • removeChildAt(index: number): DisplayObject
  • Removes a child from the specified index position.

    Parameters

    • index: number

      The index to get the child from

    Returns DisplayObject

    The child that was removed.

removeChildren

  • removeChildren(beginIndex?: number, endIndex?: number): DisplayObject[]
  • Removes all children from this container that are within the begin and end indexes.

    Parameters

    • Optional beginIndex: number
    • Optional endIndex: number

    Returns DisplayObject[]

    List of removed children

removeListener

  • removeListener(event: string | symbol, fn?: ListenerFn, context?: any, once?: boolean): Container3D
  • Remove the listeners of a given event.

    Parameters

    • event: string | symbol
    • Optional fn: ListenerFn
    • Optional context: any
    • Optional once: boolean

    Returns Container3D

render

  • render(renderer: Renderer): void
  • Renders the object using the WebGL renderer.

    The [_render]{@link 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, this implementation will entirely skip rendering. See {@link 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. The @pixi-essentials/cull and pixi-cull packages do this out of the box.

    The [renderAdvanced]{@link 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.

    Parameters

    • renderer: Renderer

      The renderer

    Returns void

Protected renderAdvanced

  • renderAdvanced(renderer: Renderer): void
  • Render the object using the WebGL renderer and advanced features.

    Parameters

    • renderer: Renderer

      The renderer

    Returns void

Optional renderCanvas

  • renderCanvas(renderer: CanvasRenderer): void
  • Parameters

    • renderer: CanvasRenderer

    Returns void

setChildIndex

  • setChildIndex(child: DisplayObject, index: number): void
  • Changes the position of an existing child in the display object container

    Parameters

    • child: DisplayObject

      The child DisplayObject instance for which you want to change the index number

    • index: number

      The resulting index number for the child display object

    Returns void

setParent

  • setParent(container: Container): Container
  • Set the parent Container of this DisplayObject.

    Parameters

    • container: Container

      The Container to add this DisplayObject to.

    Returns Container

    The Container that this DisplayObject was added to.

setTransform

  • setTransform(x?: number, y?: number, scaleX?: number, scaleY?: number, rotation?: number, skewX?: number, skewY?: number, pivotX?: number, pivotY?: number): Container3D
  • Convenience function to set the position, scale, skew and pivot at once.

    Parameters

    • Optional x: number
    • Optional y: number
    • Optional scaleX: number
    • Optional scaleY: number
    • Optional rotation: number
    • Optional skewX: number
    • Optional skewY: number
    • Optional pivotX: number
    • Optional pivotY: number

    Returns Container3D

    The DisplayObject instance

sortChildren

  • sortChildren(): void
  • Sorts children by zIndex. Previous order is maintained for 2 children with the same zIndex.

    Returns void

swapChildren

  • swapChildren(child: DisplayObject, child2: DisplayObject): void
  • Swaps the position of 2 Display Objects within this container.

    Parameters

    • child: DisplayObject

      First display object to swap

    • child2: DisplayObject

      Second display object to swap

    Returns void

toGlobal

  • toGlobal<P>(position: IPointData, point?: P, skipUpdate?: boolean): P
  • Calculates the global position of the display object.

    Type parameters

    • P: IPointData = Point

    Parameters

    • position: IPointData

      The world origin to calculate from.

    • Optional point: P
    • Optional skipUpdate: boolean

    Returns P

    A point object representing the position of this object.

toLocal

  • toLocal<P>(position: IPointData, from?: DisplayObject, point?: P, skipUpdate?: boolean): P
  • Calculates the local position of the display object relative to another point.

    Type parameters

    • P: IPointData = Point

    Parameters

    • position: IPointData

      The world origin to calculate from.

    • Optional from: DisplayObject
    • Optional point: P
    • Optional skipUpdate: boolean

    Returns P

    A point object representing the position of this object

updateTransform

  • updateTransform(): void
  • Updates the transform on all children of this container for rendering

    Returns void

Static mixin

  • mixin(source: Dict<any>): void
  • Mixes all enumerable properties and methods from a source object to DisplayObject.

    Parameters

    • source: Dict<any>

      The source of properties and methods to mix in.

    Returns void

Generated using TypeDoc