The bounds object, this is used to calculate and store the bounds of the displayObject.
+
Protected _boundsID
_boundsID:number
+
Flags the cached bounds as dirty.
+
Protected _boundsRect
_boundsRect:Rectangle
+
Cache of this display-object's bounds-rectangle.
+
Protected _destroyed
_destroyed:boolean
+
If the object has been destroyed via destroy(). If true, it should not be used.
+
Protected _enabledFilters
_enabledFilters:Filter[]
+
Currently enabled filters.
+
Protected _height
_height:number
Protected _lastSortedIndex
_lastSortedIndex:number
+
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.
+
_localBounds
_localBounds:Bounds
+
Local bounds object, swapped with _bounds when using getLocalBounds().
+
Protected _localBoundsRect
_localBoundsRect:Rectangle
+
Cache of this display-object's local-bounds rectangle.
+
Protected _mask
_mask:Container<DisplayObject> | MaskData
+
The original, cached mask of the object.
+
_trackedPointers
_trackedPointers:{}
Type declaration
[x: number]: InteractionTrackingData
Protected _width
_width:number
Protected _zIndex
_zIndex:number
+
The zIndex of the displayObject.
+A higher value will mean it will be rendered on top of other displayObjects within the same container.
+
alpha
alpha:number
+
The opacity of the object.
+
buttonMode
buttonMode:boolean
Readonly children
children:DisplayObject[]
+
The array of children of this container.
+
readonly
containerUpdateTransform
containerUpdateTransform:() => void
Type declaration
(): void
Returns void
cullArea
cullArea:Rectangle
+
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.
+
cullable
cullable:boolean
+
Should this object be rendered if the bounds of this object are out of frame?
+
Culling has no effect on whether updateTransform is called.
+
cursor
cursor:string
displayObjectUpdateTransform
displayObjectUpdateTransform:() => void
Type declaration
(): void
Returns void
filterArea
filterArea:Rectangle
+
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
filters:null | Filter[]
+
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
hitArea:null | IHitArea
interactive
interactive:boolean
interactiveChildren
interactiveChildren:boolean
isMask
isMask:boolean
+
Does any other displayObject use this object as a mask?
+
isSprite
isSprite:boolean
+
Used to fast check if a sprite is.. a sprite!
+
name
name:string
parent
parent:Container<DisplayObject>
renderable
renderable:boolean
+
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.
+
renderer
renderer:Renderer
sortDirty
sortDirty:boolean
+
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.
+
sortableChildren
sortableChildren:boolean
+
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 @link https://github.com/pixijs/pixi-display
+
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.
get mask(): null | Container<DisplayObject> | MaskData
set mask(value: null | Container<DisplayObject> | 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.
+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.
example
const graphics = new PIXI.Graphics();
graphics.beginFill(0xFF3300);
@@ -49,12 +116,13 @@
const sprite = new PIXI.Sprite(texture);
sprite.mask = graphics;
todo
At the moment, PIXI.CanvasRenderer doesn't support PIXI.Sprite as mask.
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.
+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.
example
const graphics = new PIXI.Graphics();
graphics.beginFill(0xFF3300);
@@ -63,153 +131,146 @@
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
near
get near(): number
set near(value: number): void
+
Parameters
value: null | Container<DisplayObject> | MaskData
Returns void
near
get near(): number
set near(value: number): void
The near clipping plane distance, 0.1 is the default value.
-
Returns number
+
Returns number
The near clipping plane distance, 0.1 is the default value.
-
Parameters
value: number
Returns void
obliqueness
get obliqueness(): IPointData
set obliqueness(value: IPointData): void
+
Parameters
value: number
Returns void
obliqueness
get obliqueness(): IPointData
set obliqueness(value: IPointData): void
Used for making the frustum oblique, which means that one side is at a
smaller angle to the centre line than the opposite side. Only works with
perspective projection.
-
Returns IPointData
+
Returns IPointData
Used for making the frustum oblique, which means that one side is at a
smaller angle to the centre line than the opposite side. Only works with
perspective projection.
-
Parameters
value: IPointData
Returns void
orthographic
get orthographic(): boolean
set orthographic(value: boolean): void
+
Parameters
value: IPointData
Returns void
orthographic
get orthographic(): boolean
set orthographic(value: boolean): void
Camera will render objects uniformly, with no sense of perspective.
-
Returns boolean
+
Returns boolean
Camera will render objects uniformly, with no sense of perspective.
-
Parameters
value: boolean
Returns void
orthographicSize
get orthographicSize(): number
set orthographicSize(value: number): void
+
Parameters
value: boolean
Returns void
orthographicSize
get orthographicSize(): number
set orthographicSize(value: number): void
The camera's half-size when in orthographic mode. The visible area from
center of the screen to the top.
-
Returns number
+
Returns number
The camera's half-size when in orthographic mode. The visible area from
center of the screen to the top.
-
Parameters
value: number
Returns void
pivot
get pivot(): ObservablePoint<any>
set pivot(value: ObservablePoint<any>): void
+
Parameters
value: number
Returns void
pivot
get pivot(): ObservablePoint<any>
set pivot(value: IPointData): 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>
+
since
4.0.0
+
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.
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
+
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
+
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
+
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
+
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
+
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
+
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
+
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
Protected _calculateBounds
_calculateBounds(): void
+
see
PIXI.Container#sortableChildren
+
Parameters
value: number
Returns void
Methods
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
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
+
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
addChild
addChild<T>(...children: T): T[0]
+
Parameters
_renderer: Renderer
+
The renderer
+
Returns void
Protected _renderWithCulling
_renderWithCulling(renderer: Renderer): void
+
Renders this object and its children with culling.
+
Parameters
renderer: Renderer
+
The renderer
+
Returns void
addChild
addChild<U>(...children: U): U[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
+
Type parameters
U: DisplayObject[]
Parameters
Rest...children: U
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
+
Returns U[0]
+
The first child that was added.
+
+
addChildAt
addChildAt<U>(child: U, index: number): U
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
+
Type parameters
U: DisplayObject<U>
Parameters
child: U
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): Camera
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.
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
@@ -218,13 +279,11 @@
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 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.
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
@@ -232,71 +291,100 @@
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
+
Parameters
Optional skipUpdate: 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.
+
Optional rect: Rectangle
+
Optional rectangle to store the result of the bounds calculation.
+
Returns Rectangle
+
The minimum axis-aligned rectangle in world space that fits around this object.
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.
+
Parameters
Optional rect: Rectangle
+
Optional rectangle to store the result of the bounds calculation.
+
Optional skipChildrenUpdate: 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.
+
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.
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,
+
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 {@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
+advised to employ culling to automatically skip rendering objects outside of the current screen.
+See [cullable]{@link PIXI.DisplayObject#cullable} and [cullArea]{@link PIXI.DisplayObject#cullArea}.
+Other culling methods might be better suited for a large number static objects; see
@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
+
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
screenToRay
screenToRay(x: number, y: number, viewSize?: { height: number; width: number }): undefined | Ray
+
Returns void
screenToRay
screenToRay(x: number, y: number, viewSize?: { height: number; width: number }): undefined | Ray
Converts screen coordinates to a ray.
Parameters
x: number
Screen x coordinate.
@@ -304,7 +392,7 @@
Screen y coordinate.
viewSize: { height: number; width: number } = ...
The size of the view when not rendering to the entire screen.
The bounds object, this is used to calculate and store the bounds of the displayObject.
+
Protected _boundsID
_boundsID:number
+
Flags the cached bounds as dirty.
+
Protected _boundsRect
_boundsRect:Rectangle
+
Cache of this display-object's bounds-rectangle.
+
Protected _destroyed
_destroyed:boolean
+
If the object has been destroyed via destroy(). If true, it should not be used.
+
Protected _enabledFilters
_enabledFilters:Filter[]
+
Currently enabled filters.
+
Protected _height
_height:number
Protected _lastSortedIndex
_lastSortedIndex:number
+
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.
+
_localBounds
_localBounds:Bounds
+
Local bounds object, swapped with _bounds when using getLocalBounds().
+
Protected _localBoundsRect
_localBoundsRect:Rectangle
+
Cache of this display-object's local-bounds rectangle.
+
Protected _mask
_mask:Container<DisplayObject> | MaskData
+
The original, cached mask of the object.
+
_trackedPointers
_trackedPointers:{}
Type declaration
[x: number]: InteractionTrackingData
Protected _width
_width:number
Protected _zIndex
_zIndex:number
+
The zIndex of the displayObject.
+A higher value will mean it will be rendered on top of other displayObjects within the same container.
+
alpha
alpha:number
+
The opacity of the object.
+
buttonMode
buttonMode:boolean
Readonly children
children:DisplayObject[]
+
The array of children of this container.
+
readonly
containerUpdateTransform
containerUpdateTransform:() => void
Type declaration
(): void
Returns void
cullArea
cullArea:Rectangle
+
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.
+
cullable
cullable:boolean
+
Should this object be rendered if the bounds of this object are out of frame?
+
Culling has no effect on whether updateTransform is called.
+
cursor
cursor:string
displayObjectUpdateTransform
displayObjectUpdateTransform:() => void
Type declaration
(): void
Returns void
filterArea
filterArea:Rectangle
+
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
filters:null | Filter[]
+
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
hitArea:null | IHitArea
interactive
interactive:boolean
interactiveChildren
interactiveChildren:boolean
isMask
isMask:boolean
+
Does any other displayObject use this object as a mask?
+
isSprite
isSprite:boolean
+
Used to fast check if a sprite is.. a sprite!
+
name
name:string
parent
parent:Container<DisplayObject>
renderable
renderable:boolean
+
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.
+
sortDirty
sortDirty:boolean
+
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.
+
sortableChildren
sortableChildren:boolean
+
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 @link https://github.com/pixijs/pixi-display
+
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.
get mask(): null | Container<DisplayObject> | MaskData
set mask(value: null | Container<DisplayObject> | 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.
+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.
example
const graphics = new PIXI.Graphics();
graphics.beginFill(0xFF3300);
@@ -28,12 +95,13 @@
const sprite = new PIXI.Sprite(texture);
sprite.mask = graphics;
todo
At the moment, PIXI.CanvasRenderer doesn't support PIXI.Sprite as mask.
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.
+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.
example
const graphics = new PIXI.Graphics();
graphics.beginFill(0xFF3300);
@@ -42,125 +110,121 @@
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
+
Parameters
value: null | Container<DisplayObject> | MaskData
Returns void
pivot
get pivot(): ObservablePoint<any>
set pivot(value: IPointData): 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>
+
since
4.0.0
+
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.
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
+
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
+
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
+
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
+
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
+
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
+
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
+
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
Protected _calculateBounds
_calculateBounds(): void
+
see
PIXI.Container#sortableChildren
+
Parameters
value: number
Returns void
Methods
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
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
+
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
addChild
addChild<T>(...children: T): T[0]
+
Parameters
_renderer: Renderer
+
The renderer
+
Returns void
Protected _renderWithCulling
_renderWithCulling(renderer: Renderer): void
+
Renders this object and its children with culling.
+
Parameters
renderer: Renderer
+
The renderer
+
Returns void
addChild
addChild<U>(...children: U): U[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
+
Type parameters
U: DisplayObject[]
Parameters
Rest...children: U
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
+
Returns U[0]
+
The first child that was added.
+
+
addChildAt
addChildAt<U>(child: U, index: number): U
Adds a child to the container at a specified index. If the index is out of bounds an error will be thrown
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.
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
@@ -169,13 +233,11 @@
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 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.
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
@@ -183,106 +245,173 @@
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
+
Parameters
Optional skipUpdate: 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.
+
Optional rect: Rectangle
+
Optional rectangle to store the result of the bounds calculation.
+
Returns Rectangle
+
The minimum axis-aligned rectangle in world space that fits around this object.
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.
+
Parameters
Optional rect: Rectangle
+
Optional rectangle to store the result of the bounds calculation.
+
Optional skipChildrenUpdate: 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.
+
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.
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,
+
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 {@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
+advised to employ culling to automatically skip rendering objects outside of the current screen.
+See [cullable]{@link PIXI.DisplayObject#cullable} and [cullArea]{@link PIXI.DisplayObject#cullArea}.
+Other culling methods might be better suited for a large number static objects; see
@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
+
Returns void
Protected renderAdvanced
renderAdvanced(renderer: Renderer): void
Render the object using the WebGL renderer and advanced features.
Destroys this base texture.
The method stops if resource doesn't want this texture to be destroyed.
Removes texture from all caches.
-
Returns void
dispose
dispose(): void
+
Returns void
dispose
dispose(): void
Frees the texture from WebGL memory without destroying this texture object.
This means you can still use the texture later which will upload it to GPU
memory again.
@@ -41,62 +122,87 @@
Remove all listeners, or those of the specified event.
Helper function that creates a base texture based on the source you provide.
The source can be - image url, image element, canvas element. If the
source is an image url or an image element and not in the base texture
cache, it will be created and loaded.
true if resource is created by BaseTexture
+useful for doing cleanup with BaseTexture destroy
+and not cleaning up resources that were created
+externally.
Collection of components used for image-based lighting (IBL), a
rendering technique which involves capturing an omnidirectional representation
of real-world light information as an image.
The bounds object, this is used to calculate and store the bounds of the displayObject.
+
Protected _boundsID
_boundsID:number
+
Flags the cached bounds as dirty.
+
Protected _boundsRect
_boundsRect:Rectangle
+
Cache of this display-object's bounds-rectangle.
+
Protected _destroyed
_destroyed:boolean
+
If the object has been destroyed via destroy(). If true, it should not be used.
+
Protected _enabledFilters
_enabledFilters:Filter[]
+
Currently enabled filters.
+
Protected _height
_height:number
Protected _lastSortedIndex
_lastSortedIndex:number
+
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.
+
_localBounds
_localBounds:Bounds
+
Local bounds object, swapped with _bounds when using getLocalBounds().
+
Protected _localBoundsRect
_localBoundsRect:Rectangle
+
Cache of this display-object's local-bounds rectangle.
+
Protected _mask
_mask:Container<DisplayObject> | MaskData
+
The original, cached mask of the object.
+
_trackedPointers
_trackedPointers:{}
Type declaration
[x: number]: InteractionTrackingData
Protected _width
_width:number
Protected _zIndex
_zIndex:number
+
The zIndex of the displayObject.
+A higher value will mean it will be rendered on top of other displayObjects within the same container.
+
alpha
alpha:number
+
The opacity of the object.
+
buttonMode
buttonMode:boolean
Readonly children
children:DisplayObject[]
+
The array of children of this container.
+
readonly
containerUpdateTransform
containerUpdateTransform:() => void
Type declaration
(): void
Returns void
cullArea
cullArea:Rectangle
+
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.
+
cullable
cullable:boolean
+
Should this object be rendered if the bounds of this object are out of frame?
+
Culling has no effect on whether updateTransform is called.
+
cursor
cursor:string
displayObjectUpdateTransform
displayObjectUpdateTransform:() => void
Type declaration
(): void
Returns void
filterArea
filterArea:Rectangle
+
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
filters:null | Filter[]
+
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
hitArea:null | IHitArea
interactive
interactive:boolean
interactiveChildren
interactiveChildren:boolean
isMask
isMask:boolean
+
Does any other displayObject use this object as a mask?
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.
+
sortDirty
sortDirty:boolean
+
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.
+
sortableChildren
sortableChildren:boolean
+
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 @link https://github.com/pixijs/pixi-display
+
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.
get mask(): null | Container<DisplayObject> | MaskData
set mask(value: null | Container<DisplayObject> | 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.
+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.
example
const graphics = new PIXI.Graphics();
graphics.beginFill(0xFF3300);
@@ -26,12 +93,13 @@
const sprite = new PIXI.Sprite(texture);
sprite.mask = graphics;
todo
At the moment, PIXI.CanvasRenderer doesn't support PIXI.Sprite as mask.
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.
+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.
example
const graphics = new PIXI.Graphics();
graphics.beginFill(0xFF3300);
@@ -40,125 +108,118 @@
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
+
Parameters
value: null | Container<DisplayObject> | MaskData
Returns void
pivot
get pivot(): ObservablePoint<any>
set pivot(value: IPointData): 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>
+
since
4.0.0
+
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.
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
+
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
+
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
+
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
+
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
+
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
+
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
+
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
Protected _calculateBounds
_calculateBounds(): void
+
see
PIXI.Container#sortableChildren
+
Parameters
value: number
Returns void
Methods
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
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
+
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
addChild
addChild<T>(...children: T): T[0]
+
Parameters
_renderer: Renderer
+
The renderer
+
Returns void
Protected _renderWithCulling
_renderWithCulling(renderer: Renderer): void
+
Renders this object and its children with culling.
+
Parameters
renderer: Renderer
+
The renderer
+
Returns void
addChild
addChild<U>(...children: U): U[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
+
Type parameters
U: DisplayObject[]
Parameters
Rest...children: U
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
+
Returns U[0]
+
The first child that was added.
+
+
addChildAt
addChildAt<U>(child: U, index: number): U
Adds a child to the container at a specified index. If the index is out of bounds an error will be thrown
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.
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
@@ -167,13 +228,11 @@
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 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.
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
@@ -181,106 +240,173 @@
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
+
Parameters
Optional skipUpdate: 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.
+
Optional rect: Rectangle
+
Optional rectangle to store the result of the bounds calculation.
+
Returns Rectangle
+
The minimum axis-aligned rectangle in world space that fits around this object.
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.
+
Parameters
Optional rect: Rectangle
+
Optional rectangle to store the result of the bounds calculation.
+
Optional skipChildrenUpdate: 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.
+
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.
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,
+
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 {@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
+advised to employ culling to automatically skip rendering objects outside of the current screen.
+See [cullable]{@link PIXI.DisplayObject#cullable} and [cullArea]{@link PIXI.DisplayObject#cullArea}.
+Other culling methods might be better suited for a large number static objects; see
@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
+
Returns void
Protected renderAdvanced
renderAdvanced(renderer: Renderer): void
Render the object using the WebGL renderer and advanced features.
The bounds object, this is used to calculate and store the bounds of the displayObject.
+
Protected _boundsID
_boundsID:number
+
Flags the cached bounds as dirty.
+
Protected _boundsRect
_boundsRect:Rectangle
+
Cache of this display-object's bounds-rectangle.
+
Protected _destroyed
_destroyed:boolean
+
If the object has been destroyed via destroy(). If true, it should not be used.
+
Protected _enabledFilters
_enabledFilters:Filter[]
+
Currently enabled filters.
+
Protected _height
_height:number
Protected _lastSortedIndex
_lastSortedIndex:number
+
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.
+
_localBounds
_localBounds:Bounds
+
Local bounds object, swapped with _bounds when using getLocalBounds().
+
Protected _localBoundsRect
_localBoundsRect:Rectangle
+
Cache of this display-object's local-bounds rectangle.
+
Protected _mask
_mask:Container<DisplayObject> | MaskData
+
The original, cached mask of the object.
+
_trackedPointers
_trackedPointers:{}
Type declaration
[x: number]: InteractionTrackingData
Protected _width
_width:number
Protected _zIndex
_zIndex:number
+
The zIndex of the displayObject.
+A higher value will mean it will be rendered on top of other displayObjects within the same container.
+
alpha
alpha:number
+
The opacity of the object.
+
buttonMode
buttonMode:boolean
Readonly children
children:DisplayObject[]
+
The array of children of this container.
+
readonly
containerUpdateTransform
containerUpdateTransform:() => void
Type declaration
(): void
Returns void
cullArea
cullArea:Rectangle
+
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.
+
cullable
cullable:boolean
+
Should this object be rendered if the bounds of this object are out of frame?
+
Culling has no effect on whether updateTransform is called.
+
cursor
cursor:string
displayObjectUpdateTransform
displayObjectUpdateTransform:() => void
Type declaration
(): void
Returns void
filterArea
filterArea:Rectangle
+
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
filters:null | Filter[]
+
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
hitArea:null | IHitArea
interactive
interactive:boolean
interactiveChildren
interactiveChildren:boolean
isMask
isMask:boolean
+
Does any other displayObject use this object as a mask?
get _tempDisplayObjectParent(): TemporaryDisplayObject
member
{PIXI.Container}
-
Returns TemporaryDisplayObject
angle
get angle(): number
set angle(value: number): void
+
name
name:string
parent
parent:Container<DisplayObject>
renderable
renderable:boolean
+
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.
+
sortDirty
sortDirty:boolean
+
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.
+
sortableChildren
sortableChildren:boolean
+
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 @link https://github.com/pixijs/pixi-display
+
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.
get mask(): null | Container<DisplayObject> | MaskData
set mask(value: null | Container<DisplayObject> | 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.
+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.
example
const graphics = new PIXI.Graphics();
graphics.beginFill(0xFF3300);
@@ -34,12 +101,13 @@
const sprite = new PIXI.Sprite(texture);
sprite.mask = graphics;
todo
At the moment, PIXI.CanvasRenderer doesn't support PIXI.Sprite as mask.
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.
+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.
example
const graphics = new PIXI.Graphics();
graphics.beginFill(0xFF3300);
@@ -48,125 +116,121 @@
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
+
Parameters
value: null | Container<DisplayObject> | MaskData
Returns void
pivot
get pivot(): ObservablePoint<any>
set pivot(value: IPointData): 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>
+
since
4.0.0
+
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.
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
+
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
+
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
+
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
+
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
+
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
+
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
+
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
Protected _calculateBounds
_calculateBounds(): void
+
see
PIXI.Container#sortableChildren
+
Parameters
value: number
Returns void
Methods
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
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
+
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
addChild
addChild<T>(...children: T): T[0]
+
Parameters
_renderer: Renderer
+
The renderer
+
Returns void
Protected _renderWithCulling
_renderWithCulling(renderer: Renderer): void
+
Renders this object and its children with culling.
+
Parameters
renderer: Renderer
+
The renderer
+
Returns void
addChild
addChild<U>(...children: U): U[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
+
Type parameters
U: DisplayObject[]
Parameters
Rest...children: U
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
+
Returns U[0]
+
The first child that was added.
+
+
addChildAt
addChildAt<U>(child: U, index: number): U
Adds a child to the container at a specified index. If the index is out of bounds an error will be thrown
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.
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
@@ -175,13 +239,11 @@
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 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.
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
@@ -189,106 +251,173 @@
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
+
Parameters
Optional skipUpdate: 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.
+
Optional rect: Rectangle
+
Optional rectangle to store the result of the bounds calculation.
+
Returns Rectangle
+
The minimum axis-aligned rectangle in world space that fits around this object.
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.
+
Parameters
Optional rect: Rectangle
+
Optional rectangle to store the result of the bounds calculation.
+
Optional skipChildrenUpdate: 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.
+
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.
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,
+
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 {@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
+advised to employ culling to automatically skip rendering objects outside of the current screen.
+See [cullable]{@link PIXI.DisplayObject#cullable} and [cullArea]{@link PIXI.DisplayObject#cullArea}.
+Other culling methods might be better suited for a large number static objects; see
@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
+
Returns void
Protected renderAdvanced
renderAdvanced(renderer: Renderer): void
Render the object using the WebGL renderer and advanced features.
The bounds object, this is used to calculate and store the bounds of the displayObject.
+
Protected _boundsID
_boundsID:number
+
Flags the cached bounds as dirty.
+
Protected _boundsRect
_boundsRect:Rectangle
+
Cache of this display-object's bounds-rectangle.
+
Protected _destroyed
_destroyed:boolean
+
If the object has been destroyed via destroy(). If true, it should not be used.
+
Protected _enabledFilters
_enabledFilters:Filter[]
+
Currently enabled filters.
+
Protected _height
_height:number
Protected _lastSortedIndex
_lastSortedIndex:number
+
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.
+
_localBounds
_localBounds:Bounds
+
Local bounds object, swapped with _bounds when using getLocalBounds().
+
Protected _localBoundsRect
_localBoundsRect:Rectangle
+
Cache of this display-object's local-bounds rectangle.
+
Protected _mask
_mask:Container<DisplayObject> | MaskData
+
The original, cached mask of the object.
+
_trackedPointers
_trackedPointers:{}
Type declaration
[x: number]: InteractionTrackingData
Protected _width
_width:number
Protected _zIndex
_zIndex:number
+
The zIndex of the displayObject.
+A higher value will mean it will be rendered on top of other displayObjects within the same container.
+
alpha
alpha:number
+
The opacity of the object.
+
buttonMode
buttonMode:boolean
Readonly children
children:DisplayObject[]
+
The array of children of this container.
+
readonly
containerUpdateTransform
containerUpdateTransform:() => void
Type declaration
(): void
Returns void
cullArea
cullArea:Rectangle
+
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.
+
cullable
cullable:boolean
+
Should this object be rendered if the bounds of this object are out of frame?
+
Culling has no effect on whether updateTransform is called.
+
cursor
cursor:string
displayObjectUpdateTransform
displayObjectUpdateTransform:() => void
Type declaration
(): void
Returns void
filterArea
filterArea:Rectangle
+
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
filters:null | Filter[]
+
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
hitArea:null | IHitArea
interactive
interactive:boolean
interactiveChildren
interactiveChildren:boolean
Readonly inverseBindMatrix
inverseBindMatrix:Float32Array
isMask
isMask:boolean
+
Does any other displayObject use this object as a mask?
+
isSprite
isSprite:boolean
+
Used to fast check if a sprite is.. a sprite!
+
name
name:string
parent
parent:Container<DisplayObject>
renderable
renderable:boolean
+
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.
+
sortDirty
sortDirty:boolean
+
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.
+
sortableChildren
sortableChildren:boolean
+
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 @link https://github.com/pixijs/pixi-display
+
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.
get mask(): null | Container<DisplayObject> | MaskData
set mask(value: null | Container<DisplayObject> | 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.
+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.
example
const graphics = new PIXI.Graphics();
graphics.beginFill(0xFF3300);
@@ -32,12 +99,13 @@
const sprite = new PIXI.Sprite(texture);
sprite.mask = graphics;
todo
At the moment, PIXI.CanvasRenderer doesn't support PIXI.Sprite as mask.
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.
+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.
example
const graphics = new PIXI.Graphics();
graphics.beginFill(0xFF3300);
@@ -46,125 +114,121 @@
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
+
Parameters
value: null | Container<DisplayObject> | MaskData
Returns void
pivot
get pivot(): ObservablePoint<any>
set pivot(value: IPointData): 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>
+
since
4.0.0
+
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.
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
+
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
+
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
+
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
+
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
+
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
+
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
+
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
Protected _calculateBounds
_calculateBounds(): void
+
see
PIXI.Container#sortableChildren
+
Parameters
value: number
Returns void
Methods
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
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
+
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
addChild
addChild<T>(...children: T): T[0]
+
Parameters
_renderer: Renderer
+
The renderer
+
Returns void
Protected _renderWithCulling
_renderWithCulling(renderer: Renderer): void
+
Renders this object and its children with culling.
+
Parameters
renderer: Renderer
+
The renderer
+
Returns void
addChild
addChild<U>(...children: U): U[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
+
Type parameters
U: DisplayObject[]
Parameters
Rest...children: U
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
+
Returns U[0]
+
The first child that was added.
+
+
addChildAt
addChildAt<U>(child: U, index: number): U
Adds a child to the container at a specified index. If the index is out of bounds an error will be thrown
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.
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
@@ -173,13 +237,11 @@
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 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.
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
@@ -187,106 +249,173 @@
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
+
Parameters
Optional skipUpdate: 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.
+
Optional rect: Rectangle
+
Optional rectangle to store the result of the bounds calculation.
+
Returns Rectangle
+
The minimum axis-aligned rectangle in world space that fits around this object.
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.
+
Parameters
Optional rect: Rectangle
+
Optional rectangle to store the result of the bounds calculation.
+
Optional skipChildrenUpdate: 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.
+
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.
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,
+
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 {@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
+advised to employ culling to automatically skip rendering objects outside of the current screen.
+See [cullable]{@link PIXI.DisplayObject#cullable} and [cullArea]{@link PIXI.DisplayObject#cullArea}.
+Other culling methods might be better suited for a large number static objects; see
@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
+
Returns void
Protected renderAdvanced
renderAdvanced(renderer: Renderer): void
Render the object using the WebGL renderer and advanced features.
The bounds object, this is used to calculate and store the bounds of the displayObject.
+
Protected _boundsID
_boundsID:number
+
Flags the cached bounds as dirty.
+
Protected _boundsRect
_boundsRect:Rectangle
+
Cache of this display-object's bounds-rectangle.
+
Protected _destroyed
_destroyed:boolean
+
If the object has been destroyed via destroy(). If true, it should not be used.
+
Protected _enabledFilters
_enabledFilters:Filter[]
+
Currently enabled filters.
+
Protected _height
_height:number
Protected _lastSortedIndex
_lastSortedIndex:number
+
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.
+
_localBounds
_localBounds:Bounds
+
Local bounds object, swapped with _bounds when using getLocalBounds().
+
Protected _localBoundsRect
_localBoundsRect:Rectangle
+
Cache of this display-object's local-bounds rectangle.
+
Protected _mask
_mask:Container<DisplayObject> | MaskData
+
The original, cached mask of the object.
+
_trackedPointers
_trackedPointers:{}
Type declaration
[x: number]: InteractionTrackingData
Protected _width
_width:number
Protected _zIndex
_zIndex:number
+
The zIndex of the displayObject.
+A higher value will mean it will be rendered on top of other displayObjects within the same container.
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.
+
cullable
cullable:boolean
+
Should this object be rendered if the bounds of this object are out of frame?
+
Culling has no effect on whether updateTransform is called.
+
cursor
cursor:string
displayObjectUpdateTransform
displayObjectUpdateTransform:() => void
Type declaration
(): void
Returns void
filterArea
filterArea:Rectangle
+
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
filters:null | Filter[]
+
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
hitArea:null | IHitArea
innerConeAngle
innerConeAngle:number = 0
The inner cone angle specified in degrees.
-
intensity
intensity:number = 10
+
intensity
intensity:number = 10
The intensity of the light.
-
Optional interactive
interactive?:boolean
Optional interactiveChildren
interactiveChildren?:boolean
isMask
isMask:boolean
isSprite
isSprite:boolean
Optional name
name?:string
outerConeAngle
outerConeAngle:number = 45
+
interactive
interactive:boolean
interactiveChildren
interactiveChildren:boolean
isMask
isMask:boolean
+
Does any other displayObject use this object as a mask?
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.
+
sortDirty
sortDirty:boolean
+
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.
+
sortableChildren
sortableChildren:boolean
+
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 @link https://github.com/pixijs/pixi-display
+
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.
get mask(): null | Container<DisplayObject> | MaskData
set mask(value: null | Container<DisplayObject> | 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.
+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.
example
const graphics = new PIXI.Graphics();
graphics.beginFill(0xFF3300);
@@ -38,12 +105,13 @@
const sprite = new PIXI.Sprite(texture);
sprite.mask = graphics;
todo
At the moment, PIXI.CanvasRenderer doesn't support PIXI.Sprite as mask.
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.
+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.
example
const graphics = new PIXI.Graphics();
graphics.beginFill(0xFF3300);
@@ -52,125 +120,121 @@
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
+
Parameters
value: null | Container<DisplayObject> | MaskData
Returns void
pivot
get pivot(): ObservablePoint<any>
set pivot(value: IPointData): 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>
+
since
4.0.0
+
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.
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
+
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
+
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
+
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
+
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
+
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
+
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
+
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
Protected _calculateBounds
_calculateBounds(): void
+
see
PIXI.Container#sortableChildren
+
Parameters
value: number
Returns void
Methods
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
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
+
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
addChild
addChild<T>(...children: T): T[0]
+
Parameters
_renderer: Renderer
+
The renderer
+
Returns void
Protected _renderWithCulling
_renderWithCulling(renderer: Renderer): void
+
Renders this object and its children with culling.
+
Parameters
renderer: Renderer
+
The renderer
+
Returns void
addChild
addChild<U>(...children: U): U[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
+
Type parameters
U: DisplayObject[]
Parameters
Rest...children: U
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
+
Returns U[0]
+
The first child that was added.
+
+
addChildAt
addChildAt<U>(child: U, index: number): U
Adds a child to the container at a specified index. If the index is out of bounds an error will be thrown
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.
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
@@ -179,13 +243,11 @@
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 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.
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
@@ -193,106 +255,173 @@
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
+
Parameters
Optional skipUpdate: 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.
+
Optional rect: Rectangle
+
Optional rectangle to store the result of the bounds calculation.
+
Returns Rectangle
+
The minimum axis-aligned rectangle in world space that fits around this object.
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.
+
Parameters
Optional rect: Rectangle
+
Optional rectangle to store the result of the bounds calculation.
+
Optional skipChildrenUpdate: 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.
+
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.
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,
+
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 {@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
+advised to employ culling to automatically skip rendering objects outside of the current screen.
+See [cullable]{@link PIXI.DisplayObject#cullable} and [cullArea]{@link PIXI.DisplayObject#cullArea}.
+Other culling methods might be better suited for a large number static objects; see
@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
+
Returns void
Protected renderAdvanced
renderAdvanced(renderer: Renderer): void
Render the object using the WebGL renderer and advanced features.
Value indicating if writing into the depth buffer is enabled or disabled.
Depth mask feature is only available in PixiJS 6.0+ and won't have any
effects in previous versions.
-
Returns boolean
+
Returns boolean
Value indicating if writing into the depth buffer is enabled or disabled.
Depth mask feature is only available in PixiJS 6.0+ and won't have any
effects in previous versions.
-
Parameters
value: boolean
Returns void
doubleSided
get doubleSided(): boolean
set doubleSided(value: boolean): void
+
Parameters
value: boolean
Returns void
doubleSided
get doubleSided(): boolean
set doubleSided(value: boolean): void
Value indicating if the material is double sided. When set to true, the
culling state will be set to false.
-
Returns boolean
+
Returns boolean
Value indicating if the material is double sided. When set to true, the
culling state will be set to false.
-
Parameters
value: boolean
Returns void
isInstancingSupported
get isInstancingSupported(): boolean
+
Parameters
value: boolean
Returns void
isInstancingSupported
get isInstancingSupported(): boolean
Returns a value indicating if this material supports instancing.
Get a new position with the current transformation applied.
Can be used to go from a child's coordinate space to the world coordinate space. (e.g. rendering)
Type parameters
P: IPointData = Point
Parameters
pos: IPointData
The origin
Optional newPos: P
Returns P
The new point, transformed through this matrix
-
applyInverse
applyInverse<P>(pos: IPointData, newPos?: P): P
+
applyInverse
applyInverse<P>(pos: IPointData, newPos?: P): P
Get a new position with the inverse of the current transformation applied.
Can be used to go from the world coordinate space to a child's coordinate space. (e.g. input)
Type parameters
P: IPointData = Point
Parameters
pos: IPointData
The origin
Optional newPos: P
Returns P
The new point, inverse-transformed through this matrix
-
clone
clone(): Matrix
+
clone
clone(): Matrix
Creates a new Matrix object with the same values as this one.
Returns Matrix
A copy of this matrix. Good for chaining method calls.
The bounds object, this is used to calculate and store the bounds of the displayObject.
+
Protected _boundsID
_boundsID:number
+
Flags the cached bounds as dirty.
+
Protected _boundsRect
_boundsRect:Rectangle
+
Cache of this display-object's bounds-rectangle.
+
Protected _destroyed
_destroyed:boolean
+
If the object has been destroyed via destroy(). If true, it should not be used.
+
Protected _enabledFilters
_enabledFilters:Filter[]
+
Currently enabled filters.
+
Protected _height
_height:number
Protected _lastSortedIndex
_lastSortedIndex:number
+
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.
+
_localBounds
_localBounds:Bounds
+
Local bounds object, swapped with _bounds when using getLocalBounds().
+
Protected _localBoundsRect
_localBoundsRect:Rectangle
+
Cache of this display-object's local-bounds rectangle.
+
Protected _mask
_mask:Container<DisplayObject> | MaskData
+
The original, cached mask of the object.
+
_trackedPointers
_trackedPointers:{}
Type declaration
[x: number]: InteractionTrackingData
Protected _width
_width:number
Protected _zIndex
_zIndex:number
+
The zIndex of the displayObject.
+A higher value will mean it will be rendered on top of other displayObjects within the same container.
+
alpha
alpha:number
+
The opacity of the object.
+
buttonMode
buttonMode:boolean
Readonly children
children:DisplayObject[]
+
The array of children of this container.
+
readonly
containerUpdateTransform
containerUpdateTransform:() => void
Type declaration
(): void
Returns void
cullArea
cullArea:Rectangle
+
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.
+
cullable
cullable:boolean
+
Should this object be rendered if the bounds of this object are out of frame?
+
Culling has no effect on whether updateTransform is called.
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
filters:null | Filter[]
+
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'.
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.
+
sortableChildren
sortableChildren:boolean
+
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 @link https://github.com/pixijs/pixi-display
+
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.
+
see
PIXI.settings.SORTABLE_CHILDREN
+
Optional targetWeights
targetWeights?:number[]
Array of weights used for morphing between geometry targets.
get mask(): null | Container<DisplayObject> | MaskData
set mask(value: null | Container<DisplayObject> | 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.
+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.
example
const graphics = new PIXI.Graphics();
graphics.beginFill(0xFF3300);
@@ -46,12 +113,13 @@
const sprite = new PIXI.Sprite(texture);
sprite.mask = graphics;
todo
At the moment, PIXI.CanvasRenderer doesn't support PIXI.Sprite as mask.
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.
+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.
example
const graphics = new PIXI.Graphics();
graphics.beginFill(0xFF3300);
@@ -60,136 +128,127 @@
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
+
Parameters
value: null | Container<DisplayObject> | MaskData
Returns void
pivot
get pivot(): ObservablePoint<any>
set pivot(value: IPointData): 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>
+
since
4.0.0
+
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.
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
+
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
+
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
+
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
+
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
+
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
+
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
+
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
Protected _calculateBounds
_calculateBounds(): void
+
see
PIXI.Container#sortableChildren
+
Parameters
value: number
Returns void
Methods
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
Protected _recursivePostUpdateTransform
_recursivePostUpdateTransform(): void
-
Recursively updates transform of all objects from the root to this one
-internal function for toLocal()
-
Returns void
_render
_render(renderer: Renderer): void
+
Returns void
Protected _recursivePostUpdateTransform
_recursivePostUpdateTransform(): void
+
Recursively updates transform of all objects from the root to this one internal function for toLocal()
+
Returns void
_render
_render(renderer: Renderer): void
To be overridden by the subclasses.
-
Parameters
renderer: Renderer
Returns void
addChild
addChild<T>(...children: T): T[0]
+
Parameters
renderer: Renderer
Returns void
Protected _renderWithCulling
_renderWithCulling(renderer: Renderer): void
+
Renders this object and its children with culling.
+
Parameters
renderer: Renderer
+
The renderer
+
Returns void
addChild
addChild<U>(...children: U): U[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
+
Type parameters
U: DisplayObject[]
Parameters
Rest...children: U
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
+
Returns U[0]
+
The first child that was added.
+
+
addChildAt
addChildAt<U>(child: U, index: number): U
Adds a child to the container at a specified index. If the index is out of bounds an error will be thrown
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.
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
@@ -198,13 +257,11 @@
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 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.
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
@@ -212,23 +269,42 @@
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
+
Parameters
Optional skipUpdate: 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.
+
Optional rect: Rectangle
+
Optional rectangle to store the result of the bounds calculation.
+
Returns Rectangle
+
The minimum axis-aligned rectangle in world space that fits around this object.
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.
-
isRenderPassEnabled
isRenderPassEnabled(name: string): boolean
+
Parameters
Optional rect: Rectangle
+
Optional rectangle to store the result of the bounds calculation.
+
Optional skipChildrenUpdate: 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.
+
Returns Rectangle
+
The rectangular bounding area.
+
+
isRenderPassEnabled
isRenderPassEnabled(name: string): boolean
Returns a value indicating if the specified render pass is enabled.
Parameters
name: string
The name of the render pass to check.
@@ -238,106 +314,154 @@
Return the listeners registered for a given event.
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,
+
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 {@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
+advised to employ culling to automatically skip rendering objects outside of the current screen.
+See [cullable]{@link PIXI.DisplayObject#cullable} and [cullArea]{@link PIXI.DisplayObject#cullArea}.
+Other culling methods might be better suited for a large number static objects; see
@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
+
Returns void
Protected renderAdvanced
renderAdvanced(renderer: Renderer): void
Render the object using the WebGL renderer and advanced features.
The name of the mesh shader. Used for figuring out if geometry attributes is compatible with the shader. This needs to be set to something different than default value when custom attributes is used.
-
Returns string
uniforms
get uniforms(): Dict<any>
-
Shader uniform values, shortcut for uniformGroup.uniforms
The bounds object, this is used to calculate and store the bounds of the displayObject.
+
Protected _boundsID
_boundsID:number
+
Flags the cached bounds as dirty.
+
Protected _boundsRect
_boundsRect:Rectangle
+
Cache of this display-object's bounds-rectangle.
+
Protected _destroyed
_destroyed:boolean
+
If the object has been destroyed via destroy(). If true, it should not be used.
+
Protected _enabledFilters
_enabledFilters:Filter[]
+
Currently enabled filters.
+
Protected _height
_height:number
Protected _lastSortedIndex
_lastSortedIndex:number
+
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.
+
_localBounds
_localBounds:Bounds
+
Local bounds object, swapped with _bounds when using getLocalBounds().
+
Protected _localBoundsRect
_localBoundsRect:Rectangle
+
Cache of this display-object's local-bounds rectangle.
+
Protected _mask
_mask:Container<DisplayObject> | MaskData
+
The original, cached mask of the object.
+
_trackedPointers
_trackedPointers:{}
Type declaration
[x: number]: InteractionTrackingData
Protected _width
_width:number
Protected _zIndex
_zIndex:number
+
The zIndex of the displayObject.
+A higher value will mean it will be rendered on top of other displayObjects within the same container.
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.
+
cullable
cullable:boolean
+
Should this object be rendered if the bounds of this object are out of frame?
+
Culling has no effect on whether updateTransform is called.
+
cursor
cursor:string
displayObjectUpdateTransform
displayObjectUpdateTransform:() => void
Type declaration
(): void
Returns void
filterArea
filterArea:Rectangle
+
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
filters:null | Filter[]
+
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
hitArea:null | IHitArea
interactive
interactive:boolean
interactiveChildren
interactiveChildren:boolean
isMask
isMask:boolean
+
Does any other displayObject use this object as a mask?
get _tempDisplayObjectParent(): TemporaryDisplayObject
member
{PIXI.Container}
-
Returns TemporaryDisplayObject
angle
get angle(): number
set angle(value: number): void
+
name
name:string
parent
parent:Container<DisplayObject>
renderable
renderable:boolean
+
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.
+
sortDirty
sortDirty:boolean
+
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.
+
sortableChildren
sortableChildren:boolean
+
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 @link https://github.com/pixijs/pixi-display
+
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.
get mask(): null | Container<DisplayObject> | MaskData
set mask(value: null | Container<DisplayObject> | 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.
+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.
example
const graphics = new PIXI.Graphics();
graphics.beginFill(0xFF3300);
@@ -33,12 +100,13 @@
const sprite = new PIXI.Sprite(texture);
sprite.mask = graphics;
todo
At the moment, PIXI.CanvasRenderer doesn't support PIXI.Sprite as mask.
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.
+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.
example
const graphics = new PIXI.Graphics();
graphics.beginFill(0xFF3300);
@@ -47,130 +115,126 @@
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
+
Parameters
value: null | Container<DisplayObject> | MaskData
Returns void
pivot
get pivot(): ObservablePoint<any>
set pivot(value: IPointData): 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>
+
since
4.0.0
+
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.
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
+
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
+
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
+
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
+
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
+
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
+
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
+
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
Protected _calculateBounds
_calculateBounds(): void
+
see
PIXI.Container#sortableChildren
+
Parameters
value: number
Returns void
Methods
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
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
+
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
addChild
addChild<T>(...children: T): T[0]
+
Parameters
_renderer: Renderer
+
The renderer
+
Returns void
Protected _renderWithCulling
_renderWithCulling(renderer: Renderer): void
+
Renders this object and its children with culling.
+
Parameters
renderer: Renderer
+
The renderer
+
Returns void
addChild
addChild<U>(...children: U): U[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
+
Type parameters
U: DisplayObject[]
Parameters
Rest...children: U
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
+
Returns U[0]
+
The first child that was added.
+
+
addChildAt
addChildAt<U>(child: U, index: number): U
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
+
Type parameters
U: DisplayObject<U>
Parameters
child: U
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): Model
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.
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
@@ -179,13 +243,11 @@
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 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.
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
@@ -193,112 +255,179 @@
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
+
Parameters
Optional skipUpdate: 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.
+
Optional rect: Rectangle
+
Optional rectangle to store the result of the bounds calculation.
+
Returns Rectangle
+
The minimum axis-aligned rectangle in world space that fits around this object.
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.
+
Parameters
Optional rect: Rectangle
+
Optional rectangle to store the result of the bounds calculation.
+
Optional skipChildrenUpdate: 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.
+
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.
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,
+
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 {@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
+advised to employ culling to automatically skip rendering objects outside of the current screen.
+See [cullable]{@link PIXI.DisplayObject#cullable} and [cullArea]{@link PIXI.DisplayObject#cullArea}.
+Other culling methods might be better suited for a large number static objects; see
@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
+
Returns void
Protected renderAdvanced
renderAdvanced(renderer: Renderer): void
Render the object using the WebGL renderer and advanced features.
Manages the picking hit areas by keeping track on which hit areas needs to
be checked for interaction. Renders the hit area meshes to a texture which
is then used to map a mesh to a x/y coordinate. The picking manager is
registered as a renderer plugin.
The anchor point defines the normalized coordinates
+in the texture that map to the position of this
+sprite.
+
By default, this is (0,0) (or texture.defaultAnchor
+if you have modified that), which means the position
+(x,y) of this Sprite will be the top-left corner.
+
Note: Updating texture.defaultAnchor after
+constructing a Sprite does not update its anchor.
The bounds object, this is used to calculate and store the bounds of the displayObject.
+
Protected _boundsID
_boundsID:number
+
Flags the cached bounds as dirty.
+
Protected _boundsRect
_boundsRect:Rectangle
+
Cache of this display-object's bounds-rectangle.
+
Protected _cachedTint
_cachedTint:number
+
Cached tint value so we can tell when the tint is changed.
+Value is used for 2d CanvasRenderer.
+
default
0xFFFFFF
+
Protected _destroyed
_destroyed:boolean
+
If the object has been destroyed via destroy(). If true, it should not be used.
+
Protected _enabledFilters
_enabledFilters:Filter[]
+
Currently enabled filters.
+
Protected _height
_height:number
+
The height of the sprite (this is initially set by the texture)
+
Protected _lastSortedIndex
_lastSortedIndex:number
+
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.
+
_localBounds
_localBounds:Bounds
+
Local bounds object, swapped with _bounds when using getLocalBounds().
+
Protected _localBoundsRect
_localBoundsRect:Rectangle
+
Cache of this display-object's local-bounds rectangle.
+
Protected _mask
_mask:Container<DisplayObject> | MaskData
+
The original, cached mask of the object.
+
_textureID
_textureID:number
Protected _textureTrimmedID
_textureTrimmedID:number
_trackedPointers
_trackedPointers:{}
Type declaration
[x: number]: InteractionTrackingData
Protected _width
_width:number
+
The width of the sprite (this is initially set by the texture).
+
Protected _zIndex
_zIndex:number
+
The zIndex of the displayObject.
+A higher value will mean it will be rendered on top of other displayObjects within the same container.
+
alpha
alpha:number
+
The opacity of the object.
+
blendMode
blendMode:BLEND_MODES
+
The blend mode to be applied to the sprite. Apply a value of PIXI.BLEND_MODES.NORMAL to reset the blend mode.
+
default
PIXI.BLEND_MODES.NORMAL
+
buttonMode
buttonMode:boolean
Readonly children
children:DisplayObject[]
+
The array of children of this container.
+
readonly
containerUpdateTransform
containerUpdateTransform:() => void
Type declaration
(): void
Returns void
cullArea
cullArea:Rectangle
+
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.
+
cullable
cullable:boolean
+
Should this object be rendered if the bounds of this object are out of frame?
+
Culling has no effect on whether updateTransform is called.
+
cursor
cursor:string
displayObjectUpdateTransform
displayObjectUpdateTransform:() => void
Type declaration
(): void
Returns void
filterArea
filterArea:Rectangle
+
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
filters:null | Filter[]
+
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
hitArea:null | IHitArea
indices
indices:Uint16Array
interactive
interactive:boolean
interactiveChildren
interactiveChildren:boolean
isMask
isMask:boolean
+
Does any other displayObject use this object as a mask?
+
isSprite
isSprite:boolean
+
Used to fast check if a sprite is.. a sprite!
+
name
name:string
parent
parent:Container<DisplayObject>
pluginName
pluginName:string
+
Plugin that is responsible for rendering this element.
+Allows to customize the rendering process without overriding '_render' & '_renderCanvas' methods.
+
default
'batch'
+
renderable
renderable:boolean
+
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.
+
renderer
renderer:Renderer
sortDirty
sortDirty:boolean
+
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.
+
sortableChildren
sortableChildren:boolean
+
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 @link https://github.com/pixijs/pixi-display
+
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.
+
see
PIXI.settings.SORTABLE_CHILDREN
+
trackedPointers
trackedPointers:{}
Type declaration
[x: number]: InteractionTrackingData
transform
transform:Transform
+
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.
+
Protected uvs
uvs:Float32Array
+
This is used to store the uvs data of the sprite, assigned at the same time
+as the vertexData in calculateVertices().
+
member
{Float32Array}
+
Protected vertexData
vertexData:Float32Array
+
This is used to store the vertex data of the sprite (basically a quad).
+
member
{Float32Array}
+
visible
visible:boolean
+
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
worldAlpha:number
+
The multiplied alpha of the displayObject.
+
readonly
Static prefixed
prefixed:string | boolean
Accessors
Protected _tempDisplayObjectParent
get _tempDisplayObjectParent(): TemporaryDisplayObject
member
{PIXI.Container}
+
Returns TemporaryDisplayObject
anchor
get anchor(): ObservablePoint<any>
set anchor(value: ObservablePoint<any>): void
The anchor sets the origin point of the sprite. The default value is taken from the {@link PIXI.Texture|Texture}
and passed to the constructor.
The default is (0,0), this means the sprite's origin is the top left.
@@ -18,8 +121,7 @@
If you pass only single parameter, it will set both x and y to the same value as shown in the example below.
example
const sprite = new PIXI.Sprite(texture);
sprite.anchor.set(0.5); // This will set the origin to center. (0.5) is same as (0.5, 0.5).
-
member
{PIXI.ObservablePoint}
-
Returns ObservablePoint<any>
+
Returns ObservablePoint<any>
The anchor sets the origin point of the sprite. The default value is taken from the {@link PIXI.Texture|Texture}
and passed to the constructor.
The default is (0,0), this means the sprite's origin is the top left.
@@ -28,31 +130,29 @@
If you pass only single parameter, it will set both x and y to the same value as shown in the example below.
example
const sprite = new PIXI.Sprite(texture);
sprite.anchor.set(0.5); // This will set the origin to center. (0.5) is same as (0.5, 0.5).
-
member
{PIXI.ObservablePoint}
-
Parameters
value: ObservablePoint<any>
Returns void
angle
get angle(): number
set angle(value: number): void
+
Parameters
value: ObservablePoint<any>
Returns void
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
+
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
depthTexture
get depthTexture(): undefined | BaseTexture<Resource, IAutoDetectOptions>
+
Parameters
value: number
Returns void
depthTexture
get depthTexture(): undefined | BaseTexture<Resource, IAutoDetectOptions>
The height of the sprite, setting this will actually modify the scale to achieve the value set.
+
Returns number
+
The height of the sprite, setting this will actually modify the scale to achieve the value set.
+
Parameters
value: number
Returns void
localTransform
get localTransform(): Matrix
Current transform of the object based on local factors: position, scale, other stuff.
-
member
{PIXI.Matrix}
-
readonly
Returns Matrix
mask
get mask(): null | Container | MaskData
set mask(value: null | Container | MaskData): void
+
readonly
Returns Matrix
mask
get mask(): null | Container<DisplayObject> | MaskData
set mask(value: null | Container<DisplayObject> | 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.
+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.
example
const graphics = new PIXI.Graphics();
graphics.beginFill(0xFF3300);
@@ -61,12 +161,13 @@
const sprite = new PIXI.Sprite(texture);
sprite.mask = graphics;
todo
At the moment, PIXI.CanvasRenderer doesn't support PIXI.Sprite as mask.
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.
+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.
example
const graphics = new PIXI.Graphics();
graphics.beginFill(0xFF3300);
@@ -75,180 +176,160 @@
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
+
Parameters
value: null | Container<DisplayObject> | MaskData
Returns void
pivot
get pivot(): ObservablePoint<any>
set pivot(value: IPointData): 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>
+
since
4.0.0
+
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
get position(): ObservablePoint<any>
set position(value: ObservablePoint<any>): void
+
since
4.0.0
+
Parameters
value: IPointData
Returns void
position
get position(): ObservablePoint<any>
set position(value: IPointData): void
The coordinate of the object relative to the local coordinates of the parent.
-
since
PixiJS 4
-
member
{PIXI.ObservablePoint}
-
Returns ObservablePoint<any>
+
since
4.0.0
+
Returns ObservablePoint<any>
The coordinate of the object relative to the local coordinates of the parent.
-
since
PixiJS 4
-
member
{PIXI.ObservablePoint}
-
Parameters
value: ObservablePoint<any>
Returns void
renderTexture
get renderTexture(): RenderTexture
+
since
4.0.0
+
Parameters
value: IPointData
Returns void
renderTexture
get renderTexture(): RenderTexture
The render texture.
-
Returns RenderTexture
rotation
get rotation(): number
set rotation(value: number): void
+
Returns RenderTexture
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
+
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
roundPixels
get roundPixels(): boolean
set roundPixels(value: boolean): void
-
If true PixiJS will Math.floor() x/y values when rendering, stopping pixel interpolation.
-Advantages can include sharper image quality (like text) and faster rendering on canvas.
-The main disadvantage is movement of objects may appear less smooth.
-To set the global default, change {@link PIXI.settings.ROUND_PIXELS}
-
member
{boolean}
-
default
false
-
Returns boolean
-
If true PixiJS will Math.floor() x/y values when rendering, stopping pixel interpolation.
-Advantages can include sharper image quality (like text) and faster rendering on canvas.
-The main disadvantage is movement of objects may appear less smooth.
-To set the global default, change {@link PIXI.settings.ROUND_PIXELS}
-
member
{boolean}
-
default
false
-
Parameters
value: boolean
Returns void
scale
get scale(): ObservablePoint<any>
set scale(value: ObservablePoint<any>): void
+
Parameters
value: number
Returns void
roundPixels
get roundPixels(): boolean
set roundPixels(value: boolean): void
+
If true PixiJS will Math.floor() x/y values when rendering, stopping pixel interpolation.
+
Advantages can include sharper image quality (like text) and faster rendering on canvas.
+The main disadvantage is movement of objects may appear less smooth.
+
To set the global default, change {@link PIXI.settings.ROUND_PIXELS}.
+
default
false
+
Returns boolean
+
If true PixiJS will Math.floor() x/y values when rendering, stopping pixel interpolation.
+
Advantages can include sharper image quality (like text) and faster rendering on canvas.
+The main disadvantage is movement of objects may appear less smooth.
+
To set the global default, change {@link PIXI.settings.ROUND_PIXELS}.
+
default
false
+
Parameters
value: boolean
Returns void
scale
get scale(): ObservablePoint<any>
set scale(value: IPointData): void
The scale factors of this object along the local coordinate axes.
The default scale is (1, 1).
-
since
PixiJS 4
-
member
{PIXI.ObservablePoint}
-
Returns ObservablePoint<any>
+
since
4.0.0
+
Returns ObservablePoint<any>
The scale factors of this object along the local coordinate axes.
The default scale is (1, 1).
-
since
PixiJS 4
-
member
{PIXI.ObservablePoint}
-
Parameters
value: ObservablePoint<any>
Returns void
skew
get skew(): ObservablePoint<any>
set skew(value: ObservablePoint<any>): void
+
since
4.0.0
+
Parameters
value: IPointData
Returns void
skew
get skew(): ObservablePoint<any>
set skew(value: IPointData): void
The skew factor for the object in radians.
-
since
PixiJS 4
-
member
{PIXI.ObservablePoint}
-
Returns ObservablePoint<any>
+
since
4.0.0
+
Returns ObservablePoint<any>
The skew factor for the object in radians.
-
since
PixiJS 4
-
member
{PIXI.ObservablePoint}
-
Parameters
value: ObservablePoint<any>
Returns void
texture
get texture(): Texture<Resource>
set texture(value: Texture<Resource>): void
-
The texture that the sprite is using
-
member
{PIXI.Texture}
-
Returns Texture<Resource>
-
The texture that the sprite is using
-
member
{PIXI.Texture}
-
Parameters
value: Texture<Resource>
Returns void
tint
get tint(): number
set tint(value: number): void
-
The tint applied to the sprite. This is a hex value.
-A value of 0xFFFFFF will remove any tint effect.
-
member
{number}
-
default
0xFFFFFF
-
Returns number
-
The tint applied to the sprite. This is a hex value.
-A value of 0xFFFFFF will remove any tint effect.
-
member
{number}
-
default
0xFFFFFF
-
Parameters
value: number
Returns void
width
get width(): number
set width(value: number): void
-
The width of the sprite, setting this will actually modify the scale to achieve the value set
-
member
{number}
-
Returns number
-
The width of the sprite, setting this will actually modify the scale to achieve the value set
-
member
{number}
-
Parameters
value: number
Returns void
worldTransform
get worldTransform(): Matrix
+
since
4.0.0
+
Parameters
value: IPointData
Returns void
texture
get texture(): Texture<Resource>
set texture(value: Texture<Resource>): void
+
The texture that the sprite is using.
+
Returns Texture<Resource>
+
The texture that the sprite is using.
+
Parameters
value: Texture<Resource>
Returns void
tint
get tint(): number
set tint(value: number): void
+
The tint applied to the sprite. This is a hex value.
+
A value of 0xFFFFFF will remove any tint effect.
+
default
0xFFFFFF
+
Returns number
+
The tint applied to the sprite. This is a hex value.
+
A value of 0xFFFFFF will remove any tint effect.
+
default
0xFFFFFF
+
Parameters
value: number
Returns void
width
get width(): number
set width(value: number): void
+
The width of the sprite, setting this will actually modify the scale to achieve the value set.
+
Returns number
+
The width of the sprite, setting this will actually modify the scale to achieve the value set.
+
Parameters
value: number
Returns void
worldTransform
get worldTransform(): Matrix
Current transform of the object based on world (parent) factors.
-
member
{PIXI.Matrix}
-
readonly
Returns Matrix
worldVisible
get worldVisible(): boolean
+
readonly
Returns Matrix
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
+
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
+
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
+
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
+
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
zIndex
get zIndex(): number
set zIndex(value: number): void
+
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
+
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
Protected _calculateBounds
_calculateBounds(): void
+
see
PIXI.Container#sortableChildren
+
Parameters
value: number
Returns void
Methods
Protected _calculateBounds
_calculateBounds(): void
Updates the bounds of the sprite.
-
Returns void
Protected _onTextureUpdate
_onTextureUpdate(): void
-
When the texture is updated, this event will fire to update the scale and frame
-
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
+
Returns void
Protected _onTextureUpdate
_onTextureUpdate(): void
+
When the texture is updated, this event will fire to update the scale and frame.
+
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
Renders the object using the WebGL renderer
Parameters
renderer: Renderer
The webgl renderer to use.
-
Returns void
addChild
addChild<T>(...children: T): T[0]
+
Returns void
Protected _renderWithCulling
_renderWithCulling(renderer: Renderer): void
+
Renders this object and its children with culling.
+
Parameters
renderer: Renderer
+
The renderer
+
Returns void
addChild
addChild<U>(...children: U): U[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
+
Type parameters
U: DisplayObject[]
Parameters
Rest...children: U
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
+
Returns U[0]
+
The first child that was added.
+
+
addChildAt
addChildAt<U>(child: U, index: number): U
Adds a child to the container at a specified index. If the index is out of bounds an error will be thrown
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
calculateTrimmedVertices
calculateTrimmedVertices(): void
-
calculates worldTransform * vertices for a non texture with a trim. store it in vertexTrimmedData
-This is used to ensure that the true width and height of a trimmed texture is respected
-
Returns void
calculateVertices
calculateVertices(): void
-
calculates worldTransform * vertices, store it in vertexData
-
Returns void
containsPoint
containsPoint(point: IPointData): boolean
+
Returns void
calculateTrimmedVertices
calculateTrimmedVertices(): void
+
Calculates worldTransform * vertices for a non texture with a trim. store it in vertexTrimmedData.
+
This is used to ensure that the true width and height of a trimmed texture is respected.
+
Returns void
calculateVertices
calculateVertices(): void
+
Calculates worldTransform * vertices, store it in vertexData.
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
@@ -257,13 +338,11 @@
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 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.
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
@@ -271,118 +350,180 @@
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
+
Parameters
Optional skipUpdate: 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.
+
Optional rect: Rectangle
+
Optional rectangle to store the result of the bounds calculation.
+
Returns Rectangle
+
The minimum axis-aligned rectangle in world space that fits around this object.
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,
+
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 {@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
+advised to employ culling to automatically skip rendering objects outside of the current screen.
+See [cullable]{@link PIXI.DisplayObject#cullable} and [cullArea]{@link PIXI.DisplayObject#cullArea}.
+Other culling methods might be better suited for a large number static objects; see
@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
+
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
renderObject
renderObject(object: DisplayObject): void
+
Returns void
renderObject
renderObject(object: DisplayObject): void
Updates the sprite's texture by rendering the specified object to it.
Helper function that creates a new sprite based on the source you provide.
The source can be - frame id, image url, video url, canvas element, video element, base texture
-
static
Parameters
source: SpriteSource
+
Parameters
source: SpriteSource
Source to create texture from
Optional options: IBaseTextureOptions<any>
Returns Sprite
The newly created sprite
-
Static mixin
mixin(source: Dict<any>): void
+
Static mixin
mixin(source: Dict<any>): void
Mixes all enumerable properties and methods from a source object to DisplayObject.
The camera to follow when using directional lights.
-
followCamera
followCamera:boolean = true
+
followCamera
followCamera:boolean = true
Value indicating if the shadow should follow the specified camera. If the
camera is not set, the main camera will be used as default. Only available
when using directional lights.
- Preparing search index...
- The search index is not available
Pixi3D - v1.6.0Class AABB
Axis-aligned bounding box.
-Hierarchy
Index
Constructors
Accessors
Methods
Constructors
constructor
Returns AABB
Accessors
center
Hierarchy
Index
Constructors
Accessors
Methods
Constructors
constructor
Returns AABB
Accessors
center
The center of the bounding box.
-Returns ObservablePoint3D
extents
Returns ObservablePoint3D
extents
The extents of the bounding box.
-Returns ObservablePoint3D
max
Returns ObservablePoint3D
max
The maximal point of the bounding box.
-Returns ObservablePoint3D
Returns ObservablePoint3D
The maximal point of the bounding box.
-Parameters
value: ObservablePoint3D
Returns void
min
Parameters
value: ObservablePoint3D
Returns void
min
The minimal point of the bounding box.
-Returns ObservablePoint3D
Returns ObservablePoint3D
The minimal point of the bounding box.
-Parameters
value: ObservablePoint3D
Returns void
size
Parameters
value: ObservablePoint3D
Returns void
size
The size of the bounding box.
-Returns ObservablePoint3D
Methods
encapsulate
Returns ObservablePoint3D
Methods
encapsulate
Grows the bounding box to include the point.
Parameters
point: { x: number; y: number; z: number }
The point to include.
-x: number
y: number
z: number
Returns void
Static from
x: number
y: number
z: number
Returns void
Static from
Creates a new bounding box from the specified source.
Parameters
source: { max: Float32Array; min: Float32Array }
The source to create the bounding box from.
diff --git a/docs/classes/Animation.html b/docs/classes/Animation.html index dfcd4ef8..fe3bb38e 100644 --- a/docs/classes/Animation.html +++ b/docs/classes/Animation.html @@ -1,16 +1,16 @@ -- Preparing search index...
- The search index is not available
Pixi3D - v1.5.1Class Animation
- Preparing search index...
- The search index is not available
Pixi3D - v1.6.0Class Animation
Represents an animation.
-Hierarchy
Index
Constructors
Properties
Methods
Constructors
constructor
Hierarchy
Index
Constructors
Properties
Methods
Constructors
constructor
Creates a new animation with the specified name.
Parameters
Optional name: string
Name for the animation.
-Returns Animation
Properties
Readonly Abstract duration
Returns Animation
Properties
Readonly Abstract duration
The duration (in seconds) of this animation.
-loop
loop
A value indicating if the animation is looping.
-Optional name
Abstract position
Optional name
Abstract position
The current position (in seconds) of this animation.
-speed
speed
The speed that the animation will play at.
Static prefixed
Methods
add
Parameters
event: string | symbol
fn: ListenerFn
Optional context: any
Returns Animation
emit
Calls each of the listeners registered for a given event.
@@ -25,7 +25,7 @@Add a listener for a given event.
Parameters
event: string | symbol
fn: ListenerFn
Optional context: any
Returns Animation
once
Add a one-time listener for a given event.
-Parameters
event: string | symbol
fn: ListenerFn
Optional context: any
Returns Animation
play
Parameters
event: string | symbol
fn: ListenerFn
Optional context: any
Returns Animation
play
Starts playing the animation using the specified ticker.
Parameters
ticker: Ticker = Ticker.shared
The ticker to use for updating the animation. If a ticker @@ -34,9 +34,9 @@
Remove all listeners, or those of the specified event.
Parameters
Optional event: string | symbol
Returns Animation
remove
Remove the listeners of a given event.
-Parameters
event: string | symbol
Optional fn: ListenerFn
Optional context: any
Optional once: boolean
Returns Animation
stop
Parameters
event: string | symbol
Optional fn: ListenerFn
Optional context: any
Optional once: boolean
Returns Animation
stop
Stops playing the animation.
-Returns void
update
Returns void
update
Updates the animation by the specified delta time.
Parameters
delta: number
The time in seconds since last frame.
diff --git a/docs/classes/Camera.html b/docs/classes/Camera.html index 6789f6be..fc73f72f 100644 --- a/docs/classes/Camera.html +++ b/docs/classes/Camera.html @@ -1,46 +1,113 @@ -- Preparing search index...
- The search index is not available
Pixi3D - v1.5.1Class Camera
- Preparing search index...
- The search index is not available
Pixi3D - v1.6.0Class Camera
Camera is a device from which the world is viewed.
-Hierarchy
Implements
Index
Constructors
Properties
Accessors
Methods
Constructors
constructor
Hierarchy
Implements
Index
Constructors
Properties
Accessors
Methods
Constructors
constructor
Creates a new camera using the specified renderer. By default the camera looks towards negative z and is positioned at z = 5.
Parameters
renderer: Renderer
Renderer to use.
-Returns Camera
Properties
_bounds
Protected _boundsID
Protected _bounds
Protected _destroyed
Protected _enabled
Protected _height
_last
_local
Protected _local
_mask
Optional _tracked
Type declaration
[x: number]: InteractionTrackingData
Protected _width
Protected _z
alpha
Optional button
Readonly children
container
Type declaration
Returns void
Optional cursor
display
Type declaration
Returns void
filter
filters
Optional hit
Optional interactive
Optional interactive
is
is
Optional name
parent
renderable
renderer
sort
sortable
Optional tracked
Type declaration
[x: number]: InteractionTrackingData
transform
visible
world
Static main
Returns Camera
Properties
_bounds
The bounds object, this is used to calculate and store the bounds of the displayObject.
+Protected _boundsID
Flags the cached bounds as dirty.
+Protected _bounds
Cache of this display-object's bounds-rectangle.
+Protected _destroyed
If the object has been destroyed via destroy(). If true, it should not be used.
+Protected _enabled
Currently enabled filters.
+Protected _height
Protected _last
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
Local bounds object, swapped with
+_boundswhen usinggetLocalBounds().Protected _local
Cache of this display-object's local-bounds rectangle.
+Protected _mask
The original, cached mask of the object.
+_tracked
Type declaration
[x: number]: InteractionTrackingData
Protected _width
Protected _z
The zIndex of the displayObject. +A higher value will mean it will be rendered on top of other displayObjects within the same container.
+alpha
The opacity of the object.
+button
Readonly children
The array of children of this container.
+container
Type declaration
Returns void
cull
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.
+cullable
Should this object be rendered if the bounds of this object are out of frame?
+Culling has no effect on whether updateTransform is called.
+cursor
display
Type declaration
Returns void
filter
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
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'.hit
interactive
interactive
is
Does any other displayObject use this object as a mask?
+is
Used to fast check if a sprite is.. a sprite!
+name
parent
renderable
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.
+renderer
sort
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.
+sortable
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 @link https://github.com/pixijs/pixi-display
+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.
+PIXI.settings.SORTABLE_CHILDREN
+tracked
Type declaration
[x: number]: InteractionTrackingData
transform
visible
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.
+world
The multiplied alpha of the displayObject.
+Static main
Main camera which is used by default.
-Static prefixed
Accessors
Protected _temp
{PIXI.Container}
-Returns TemporaryDisplayObject
angle
Static prefixed
Accessors
Protected _temp
{PIXI.Container}
+Returns TemporaryDisplayObject
angle
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.
-{number}
-Returns 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.
-{number}
-Parameters
value: number
Returns void
aspect
Parameters
value: number
Returns void
aspect
The aspect ratio (width divided by height). If not set, the aspect ratio of the renderer will be used by default.
-Returns undefined | number
Returns undefined | number
The aspect ratio (width divided by height). If not set, the aspect ratio of the renderer will be used by default.
-Parameters
value: undefined | number
Returns void
far
Parameters
value: undefined | number
Returns void
destroyed
Readonly flag for destroyed display objects.
+Returns boolean
far
The far clipping plane distance, 1000 is the default value.
-Returns number
Returns number
The far clipping plane distance, 1000 is the default value.
-Parameters
value: number
Returns void
field
Parameters
value: number
Returns void
field
The vertical field of view in degrees, 60 is the default value.
-Returns number
Returns number
The vertical field of view in degrees, 60 is the default value.
-Parameters
value: number
Returns void
height
The height of the Container, setting this will actually modify the scale to achieve the value set
-{number}
-Returns number
The height of the Container, setting this will actually modify the scale to achieve the value set
-{number}
-Parameters
value: number
Returns void
local
Returns Matrix4
mask
Parameters
value: number
Returns void
height
The height of the Container, setting this will actually modify the scale to achieve the value set.
+Returns number
The height of the Container, setting this will actually modify the scale to achieve the value set.
+Parameters
value: number
Returns void
local
Returns Matrix4
mask
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
+utilities shape clipping. Furthermore, a mask of an object must be in the subtree of its parent. +Otherwise,null.getLocalBoundsmay calculate incorrect bounds, which makes the container's width and height wrong. +To remove a mask, set this property tonull.For sprite mask both alpha and red channel are used. Black mask is the same as transparent mask.
const graphics = new PIXI.Graphics(); graphics.beginFill(0xFF3300); @@ -49,12 +116,13 @@
const sprite = new PIXI.Sprite(texture); sprite.mask = graphics;
At the moment, PIXI.CanvasRenderer doesn't support PIXI.Sprite as mask.
-{PIXI.Container|PIXI.MaskData|null}
-Returns null | Container | MaskData
Returns null | Container<DisplayObject> | 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
+utilities shape clipping. Furthermore, a mask of an object must be in the subtree of its parent. +Otherwise,null.getLocalBoundsmay calculate incorrect bounds, which makes the container's width and height wrong. +To remove a mask, set this property tonull.For sprite mask both alpha and red channel are used. Black mask is the same as transparent mask.
const graphics = new PIXI.Graphics(); graphics.beginFill(0xFF3300); @@ -63,153 +131,146 @@
const sprite = new PIXI.Sprite(texture); sprite.mask = graphics;
At the moment, PIXI.CanvasRenderer doesn't support PIXI.Sprite as mask.
-{PIXI.Container|PIXI.MaskData|null}
-Parameters
value: null | Container | MaskData
Returns void
near
Parameters
value: null | Container<DisplayObject> | MaskData
Returns void
near
The near clipping plane distance, 0.1 is the default value.
-Returns number
Returns number
The near clipping plane distance, 0.1 is the default value.
-Parameters
value: number
Returns void
obliqueness
Parameters
value: number
Returns void
obliqueness
Used for making the frustum oblique, which means that one side is at a smaller angle to the centre line than the opposite side. Only works with perspective projection.
-Returns IPointData
Returns IPointData
Used for making the frustum oblique, which means that one side is at a smaller angle to the centre line than the opposite side. Only works with perspective projection.
-Parameters
value: IPointData
Returns void
orthographic
Parameters
value: IPointData
Returns void
orthographic
Camera will render objects uniformly, with no sense of perspective.
-Returns boolean
Returns boolean
Camera will render objects uniformly, with no sense of perspective.
-Parameters
value: boolean
Returns void
orthographic
Parameters
value: boolean
Returns void
orthographic
The camera's half-size when in orthographic mode. The visible area from center of the screen to the top.
-Returns number
Returns number
The camera's half-size when in orthographic mode. The visible area from center of the screen to the top.
-Parameters
value: number
Returns void
pivot
Parameters
value: number
Returns void
pivot
The center of rotation, scaling, and skewing for this display object in its local space. The
positionis the projection ofpivotin the parent's local space.By default, the pivot is the origin (0, 0).
-PixiJS 4
-{PIXI.ObservablePoint}
-Returns ObservablePoint<any>
4.0.0
+Returns ObservablePoint<any>
The center of rotation, scaling, and skewing for this display object in its local space. The
positionis the projection ofpivotin the parent's local space.By default, the pivot is the origin (0, 0).
-PixiJS 4
-{PIXI.ObservablePoint}
-Parameters
value: ObservablePoint<any>
Returns void
position
Returns ObservablePoint3D
Parameters
value: ObservablePoint3D
Returns void
projection
4.0.0
+Parameters
value: IPointData
Returns void
position
Returns ObservablePoint3D
Parameters
value: ObservablePoint3D
Returns void
projection
Returns the projection matrix.
-Returns Float32Array
rotation
Returns Float32Array
rotation
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.
-{number}
-Returns 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.
-{number}
-Parameters
value: number
Returns void
rotation
Parameters
value: number
Returns void
rotation
The quaternion rotation of the object.
-Returns ObservableQuaternion
Parameters
value: ObservableQuaternion
Returns void
scale
Returns ObservablePoint3D
Parameters
value: ObservablePoint3D
Returns void
skew
Returns ObservableQuaternion
Parameters
value: ObservableQuaternion
Returns void
scale
Returns ObservablePoint3D
Parameters
value: ObservablePoint3D
Returns void
skew
The skew factor for the object in radians.
-PixiJS 4
-{PIXI.ObservablePoint}
-Returns ObservablePoint<any>
4.0.0
+Returns ObservablePoint<any>
The skew factor for the object in radians.
-PixiJS 4
-{PIXI.ObservablePoint}
-Parameters
value: ObservablePoint<any>
Returns void
transform
Returns number
view
4.0.0
+Parameters
value: IPointData
Returns void
transform
Returns number
view
Returns the view matrix.
-Returns Float32Array
view
Returns Float32Array
view
Returns the view projection matrix.
-Returns Float32Array
width
The width of the Container, setting this will actually modify the scale to achieve the value set
-{number}
-Returns number
The width of the Container, setting this will actually modify the scale to achieve the value set
-{number}
-Parameters
value: number
Returns void
world
Returns Matrix4
world
Returns Float32Array
width
The width of the Container, setting this will actually modify the scale to achieve the value set.
+Returns number
The width of the Container, setting this will actually modify the scale to achieve the value set.
+Parameters
value: number
Returns void
world
Returns Matrix4
world
Indicates if the object is globally visible.
-{boolean}
-Returns boolean
x
Returns boolean
x
The position of the displayObject on the x axis relative to the local coordinates of the parent. An alias to position.x
-{number}
-Returns 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
-{number}
-Parameters
value: number
Returns void
y
Parameters
value: number
Returns void
y
The position of the displayObject on the y axis relative to the local coordinates of the parent. An alias to position.y
-{number}
-Returns 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
-{number}
-Parameters
value: number
Returns void
z
Parameters
value: number
Returns void
z
The position of the object on the z axis relative to the local coordinates of the parent.
-Returns number
Returns number
The position of the object on the z axis relative to the local coordinates of the parent.
-Parameters
value: number
Returns void
z
Parameters
value: number
Returns void
z
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.
-{number}
-PIXI.Container#sortableChildren
-Returns number
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.
-{number}
-PIXI.Container#sortableChildren
-Parameters
value: number
Returns void
Methods
Protected _calculate
PIXI.Container#sortableChildren
+Parameters
value: number
Returns void
Methods
Protected _calculate
Recalculates the content bounds of this object. This should be overriden to calculate the bounds of this specific object (not including children).
-Returns void
Protected _recursive
Recursively updates transform of all objects from the root to this one -internal function for toLocal()
-Returns void
Protected _render
Returns void
Protected _recursive
Recursively updates transform of all objects from the root to this one internal function for toLocal()
+Returns void
Protected _render
To be overridden by the subclasses.
-Parameters
_renderer: Renderer
Returns void
add
Parameters
_renderer: Renderer
The renderer
+Returns void
Protected _render
Renders this object and its children with culling.
+Parameters
renderer: Renderer
The renderer
+Returns void
add
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
Type parameters
U: DisplayObject[]
Parameters
Rest ...children: U
The DisplayObject(s) to add to the container
-Returns T[0]
The first child that was added.
-add
Returns U[0]
+- The first child that was added.
+
+add
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
Type parameters
U: DisplayObject<U>
Parameters
child: U
The child to add
index: number
The index to place the child in
-Returns T
The child that was added.
-add
Parameters
event: string | symbol
fn: ListenerFn
Optional context: any
Returns Camera
calculate
Returns U
The child that was added.
+add
Parameters
event: string | symbol
fn: ListenerFn
Optional context: any
Returns Camera
calculate
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
Returns void
destroy
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
disable
Parameters
Optional options: boolean | IDestroyOptions
Returns void
disable
Pair method for
-enableTempParentParameters
cacheParent: DisplayObject
Parameters
cacheParent: Container<DisplayObject>
Actual parent of element
Returns void
emit
Calls each of the listeners registered for a given event.
-Parameters
event: string | symbol
Rest ...args: any[]
Returns boolean
enable
Parameters
event: string | symbol
Rest ...args: any[]
Returns boolean
enable
Used in Renderer, cacheAsBitmap and other places where you call an
-updateTransformon rootReturns DisplayObject
current parent
+Returns Container<DisplayObject>
+- current parent
+
event
Return an array listing the events for which the emitter has registered listeners.
-Returns (string | symbol)[]
get
Returns (string | symbol)[]
get
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 @@ -218,13 +279,11 @@
-displayObject._bounds.getRectangle()when traversing through all the bounds in a scene graph. Otherwise, callinggetBoundson 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 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
-_boundsobject stores the last calculation of the bounds. You can use to entirely skip bounds calculation if needed.Parameters
Optional skipUpdate: boolean
Optional rect: Rectangle
Returns Rectangle
The minimum axis-aligned rectangle in world space that fits around this object.
-get
Parameters
Optional skipUpdate: boolean
Setting to
+truewill 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.Optional rect: Rectangle
Optional rectangle to store the result of the bounds calculation.
+Returns Rectangle
+- The minimum axis-aligned rectangle in world space that fits around this object.
+
+get
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 get
Parameters
name: string
Optional isRecursive: boolean
Returns DisplayObject
get
Returns DisplayObject
+- The child at the given index, if any.
+
+get
Type parameters
T: DisplayObject<T> = DisplayObject
Parameters
name: string
Optional deep: boolean
Returns T
get
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
-get
Returns number
+- The index position of the child display object to identify
+
+get
Retrieves the local bounds of the displayObject as a rectangle object.
Calling
-getLocalBoundsmay invalidate the_boundsof the whole subtree below. If using it inside a render() call, it is advised to callgetBounds()immediately after to recalculate the world bounds of the subtree.Parameters
Optional rect: Rectangle
Optional skipChildrenUpdate: boolean
Returns Rectangle
The rectangular bounding area.
+Parameters
Optional rect: Rectangle
Optional rectangle to store the result of the bounds calculation.
+Optional skipChildrenUpdate: boolean
Setting to
+truewill stop re-calculation of children transforms, + it was default behaviour of pixi 4.0-5.2 and caused many problems to users.Returns Rectangle
+- The rectangular bounding area.
+
listener
Return the number of listeners listening to a given event.
Parameters
event: string | symbol
Returns number
listeners
Return the listeners registered for a given event.
Parameters
event: string | symbol
Returns ListenerFn[]
off
Parameters
event: string | symbol
Optional fn: ListenerFn
Optional context: any
Optional once: boolean
Returns Camera
on
Add a listener for a given event.
-Parameters
event: string | symbol
fn: ListenerFn
Optional context: any
Returns Camera
Protected on
Overridable method that can be used by Container subclasses whenever the children array is modified
-Parameters
Optional _length: number
Returns void
once
Parameters
event: string | symbol
fn: ListenerFn
Optional context: any
Returns Camera
Protected on
Overridable method that can be used by Container subclasses whenever the children array is modified.
+Parameters
Optional _length: number
Returns void
once
Add a one-time listener for a given event.
Parameters
event: string | symbol
fn: ListenerFn
Optional context: any
Returns Camera
remove
Remove all listeners, or those of the specified event.
-Parameters
Optional event: string | symbol
Returns Camera
remove
Parameters
Optional event: string | symbol
Returns Camera
remove
Removes one or more children from the container.
-Type parameters
T: DisplayObject[]
Parameters
Rest ...children: T
Type parameters
U: DisplayObject[]
Parameters
Rest ...children: U
The DisplayObject(s) to remove
-Returns T[0]
The first child that was removed.
-remove
Returns U[0]
The first child that was removed.
+remove
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.
-remove
remove
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
+Parameters
Optional beginIndex: number
The beginning position.
+Optional endIndex: number
The ending position. Default value is size of the container.
+Returns DisplayObject[]
+- List of removed children
+
remove
Remove the listeners of a given event.
-Parameters
event: string | symbol
Optional fn: ListenerFn
Optional context: any
Optional once: boolean
Returns Camera
render
Parameters
event: string | symbol
Optional fn: ListenerFn
Optional context: any
Optional once: boolean
Returns Camera
render
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
-rendermethod will invoke it, and also invoke therendermethods of all children afterward.If
renderableorvisibleis false or ifworldAlphais not positive, this implementation will entirely -skip rendering. See {@link PIXI.DisplayObject} for choosing betweenrenderableorvisible. Generally, +If
renderableorvisibleis false or ifworldAlphais not positive or ifcullableis true and +the bounds of this object are out of frame, this implementation will entirely skip rendering. +See {@link PIXI.DisplayObject} for choosing betweenrenderableorvisible. 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 +advised to employ culling to automatically skip rendering objects outside of the current screen. +See [cullable]{@link PIXI.DisplayObject#cullable} and [cullArea]{@link PIXI.DisplayObject#cullArea}. +Other culling methods might be better suited for a large number static objects; see @pixi-essentials/cull and -pixi-cull packages do this out of the box.
+pixi-cull.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 render
Returns void
Protected render
Render the object using the WebGL renderer and advanced features.
Parameters
renderer: Renderer
The renderer
-Returns void
screen
Returns void
screen
Converts screen coordinates to a ray.
Parameters
x: number
Screen x coordinate.
@@ -304,7 +392,7 @@Screen y coordinate.
viewSize: { height: number; width: number } = ...
The size of the view when not rendering to the entire screen.
-height: number
width: number
Returns undefined | Ray
screen
height: number
width: number
Returns undefined | Ray
screen
Converts screen coordinates to world coordinates.
Parameters
x: number
Screen x coordinate.
@@ -316,41 +404,79 @@Point to set.
viewSize: { height: number; width: number } = ...
The size of the view when not rendering to the entire screen.
-height: number
width: number
Returns undefined | ObservablePoint3D
set
height: number
width: number
Returns undefined | ObservablePoint3D
set
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
set
Returns void
set
Set the parent Container of this DisplayObject.
-Parameters
container: Container
Parameters
container: Container<DisplayObject>
The Container to add this DisplayObject to.
-Returns Container
The Container that this DisplayObject was added to.
-set
Returns Container<DisplayObject>
+- The Container that this DisplayObject was added to.
+
+set
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 Camera
The DisplayObject instance
-sort
Parameters
Optional x: number
The X position
+Optional y: number
The Y position
+Optional scaleX: number
The X scale value
+Optional scaleY: number
The Y scale value
+Optional rotation: number
The rotation
+Optional skewX: number
The X skew value
+Optional skewY: number
The Y skew value
+Optional pivotX: number
The X pivot value
+Optional pivotY: number
The Y pivot value
+Returns Camera
+- The DisplayObject instance
+
+sort
Sorts children by zIndex. Previous order is maintained for 2 children with the same zIndex.
-Returns void
swap
Returns void
swap
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
to
Returns void
to
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.
-to
Optional point: P
A Point object in which to store the value, optional + (otherwise will create a new Point).
+Optional skipUpdate: boolean
Should we skip the update transform.
+Returns P
+- A point object representing the position of this object.
+
+to
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
-update
Updates the transform on all children of this container for rendering
-Returns void
world
Optional from: DisplayObject
The DisplayObject to calculate the global position from.
+Optional point: P
A Point object in which to store the value, optional + (otherwise will create a new Point).
+Optional skipUpdate: boolean
Should we skip the update transform
+Returns P
+- A point object representing the position of this object
+
+update
Updates the transform on all children of this container for rendering.
+Returns void
world
Converts world coordinates to screen coordinates.
Parameters
x: number
World x coordinate.
@@ -362,8 +488,8 @@Point to set.
viewSize: { height: number; width: number } = ...
The size of the view when not rendering to the entire screen.
-height: number
width: number
Returns Point
Static mixin
height: number
width: number
Returns Point
Static mixin
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
Returns void
Generated using TypeDoc
- Preparing search index...
- The search index is not available
Pixi3D - v1.5.1Class CameraOrbitControl
- Preparing search index...
- The search index is not available
Pixi3D - v1.6.0Class CameraOrbitControl
Allows the user to control the camera by orbiting the target.
-Hierarchy
Index
Constructors
Properties
Accessors
Methods
Constructors
constructor
Hierarchy
Index
Constructors
Properties
Accessors
Methods
Constructors
constructor
Creates a new camera orbit control.
Parameters
element: HTMLElement
The element for listening to user events.
camera: Camera = Camera.main
The camera to control. If not set, the main camera will be used by default.
-Returns CameraOrbitControl
Properties
allow
Returns CameraOrbitControl
Properties
allow
Allows the camera to be controlled by user.
-camera
target
camera
target
Target position (x, y, z) to orbit.
-Type declaration
x: number
y: number
z: number
Accessors
angles
Type declaration
x: number
y: number
z: number
Accessors
angles
Orientation euler angles (x-axis and y-axis). The angle for the x-axis will be clamped between -85 and 85 degrees.
-Returns ObservablePoint<undefined>
distance
Returns ObservablePoint<undefined>
distance
Distance between camera and the target. Default value is 5.
-Returns number
Returns number
Distance between camera and the target. Default value is 5.
-Parameters
value: number
Returns void
Methods
update
Parameters
value: number
Returns void
Methods
update
Updates the position and rotation of the camera.
Returns void
Generated using TypeDoc
- Preparing search index...
- The search index is not available
Pixi3D - v1.5.1Class Color
- Preparing search index...
- The search index is not available
Pixi3D - v1.6.0Class Color
Represents a color containing RGBA components.
-Hierarchy
Index
Constructors
Accessors
Methods
Constructors
constructor
Hierarchy
Index
Constructors
Accessors
Methods
Constructors
constructor
Creates a new color with the specified components (in range 0-1).
Parameters
r: number = 0
The R (red) component.
@@ -10,31 +10,31 @@The B (blue) component.
a: number = 1
The A (alpha) component.
-Returns Color
Accessors
a
Returns Color
Accessors
a
The A (alpha) component.
-Returns number
Returns number
The A (alpha) component.
-Parameters
value: number
Returns void
b
Parameters
value: number
Returns void
b
The B (blue) component.
-Returns number
Returns number
The B (blue) component.
-Parameters
value: number
Returns void
g
Parameters
value: number
Returns void
g
The G (green) component.
-Returns number
Returns number
The G (green) component.
-Parameters
value: number
Returns void
r
Parameters
value: number
Returns void
r
The R (red) component.
-Returns number
Returns number
The R (red) component.
-Parameters
value: number
Returns void
rgb
Parameters
value: number
Returns void
rgb
The color as an typed array containing RGB.
-Returns Float32Array
rgba
Returns Float32Array
rgba
The color as an typed array containing RGBA.
-Returns Float32Array
Methods
Static from
Returns Float32Array
Methods
Static from
Creates a new color from the specified source.
Parameters
source: Float32Array | number[]
The source to create the color from.
-Returns Color
Static from
Returns Color
Static from
Creates a new color with the specified components (in range 0-255).
Parameters
r: number = 0
The R (red) component.
@@ -44,7 +44,7 @@The B (blue) component.
a: number = 255
The A (alpha) component.
-Returns Color
Static from
Returns Color
Static from
Creates a new color from the specified hex value.
Parameters
hex: string | number
The hex value as a string or a number.
diff --git a/docs/classes/Container3D.html b/docs/classes/Container3D.html index 8b052eb6..b355466e 100644 --- a/docs/classes/Container3D.html +++ b/docs/classes/Container3D.html @@ -1,25 +1,92 @@ -- Preparing search index...
- The search index is not available
Pixi3D - v1.5.1Class Container3D
- Preparing search index...
- The search index is not available
Pixi3D - v1.6.0Class Container3D
A container represents a collection of 3D objects.
-Hierarchy
Index
Constructors
Properties
Accessors
Methods
Constructors
constructor
Returns Container3D
Properties
_bounds
Protected _boundsID
Protected _bounds
Protected _destroyed
Protected _enabled
Protected _height
_last
_local
Protected _local
_mask
Optional _tracked
Type declaration
[x: number]: InteractionTrackingData
Protected _width
Protected _z
alpha
Optional button
Readonly children
container
Type declaration
Returns void
Optional cursor
display
Type declaration
Returns void
filter
filters
Optional hit
Optional interactive
Optional interactive
is
is
Optional name
parent
renderable
sort
sortable
Optional tracked
Type declaration
[x: number]: InteractionTrackingData
transform
visible
world
Static prefixed
Accessors
Protected _temp
{PIXI.Container}
-Returns TemporaryDisplayObject
angle
Hierarchy
Index
Constructors
Properties
Accessors
Methods
Constructors
constructor
Returns Container3D
Properties
_bounds
The bounds object, this is used to calculate and store the bounds of the displayObject.
+Protected _boundsID
Flags the cached bounds as dirty.
+Protected _bounds
Cache of this display-object's bounds-rectangle.
+Protected _destroyed
If the object has been destroyed via destroy(). If true, it should not be used.
+Protected _enabled
Currently enabled filters.
+Protected _height
Protected _last
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
Local bounds object, swapped with
+_boundswhen usinggetLocalBounds().Protected _local
Cache of this display-object's local-bounds rectangle.
+Protected _mask
The original, cached mask of the object.
+_tracked
Type declaration
[x: number]: InteractionTrackingData
Protected _width
Protected _z
The zIndex of the displayObject. +A higher value will mean it will be rendered on top of other displayObjects within the same container.
+alpha
The opacity of the object.
+button
Readonly children
The array of children of this container.
+container
Type declaration
Returns void
cull
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.
+cullable
Should this object be rendered if the bounds of this object are out of frame?
+Culling has no effect on whether updateTransform is called.
+cursor
display
Type declaration
Returns void
filter
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
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'.hit
interactive
interactive
is
Does any other displayObject use this object as a mask?
+is
Used to fast check if a sprite is.. a sprite!
+name
parent
renderable
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.
+sort
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.
+sortable
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 @link https://github.com/pixijs/pixi-display
+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.
+PIXI.settings.SORTABLE_CHILDREN
+tracked
Type declaration
[x: number]: InteractionTrackingData
transform
visible
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.
+world
The multiplied alpha of the displayObject.
+Static prefixed
Accessors
Protected _temp
{PIXI.Container}
+Returns TemporaryDisplayObject
angle
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.
-{number}
-Returns 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.
-{number}
-Parameters
value: number
Returns void
height
The height of the Container, setting this will actually modify the scale to achieve the value set
-{number}
-Returns number
The height of the Container, setting this will actually modify the scale to achieve the value set
-{number}
-Parameters
value: number
Returns void
local
Returns Matrix4
mask
Parameters
value: number
Returns void
destroyed
Readonly flag for destroyed display objects.
+Returns boolean
height
The height of the Container, setting this will actually modify the scale to achieve the value set.
+Returns number
The height of the Container, setting this will actually modify the scale to achieve the value set.
+Parameters
value: number
Returns void
local
Returns Matrix4
mask
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
+utilities shape clipping. Furthermore, a mask of an object must be in the subtree of its parent. +Otherwise,null.getLocalBoundsmay calculate incorrect bounds, which makes the container's width and height wrong. +To remove a mask, set this property tonull.For sprite mask both alpha and red channel are used. Black mask is the same as transparent mask.
const graphics = new PIXI.Graphics(); graphics.beginFill(0xFF3300); @@ -28,12 +95,13 @@
const sprite = new PIXI.Sprite(texture); sprite.mask = graphics;
At the moment, PIXI.CanvasRenderer doesn't support PIXI.Sprite as mask.
-{PIXI.Container|PIXI.MaskData|null}
-Returns null | Container | MaskData
Returns null | Container<DisplayObject> | 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
+utilities shape clipping. Furthermore, a mask of an object must be in the subtree of its parent. +Otherwise,null.getLocalBoundsmay calculate incorrect bounds, which makes the container's width and height wrong. +To remove a mask, set this property tonull.For sprite mask both alpha and red channel are used. Black mask is the same as transparent mask.
const graphics = new PIXI.Graphics(); graphics.beginFill(0xFF3300); @@ -42,125 +110,121 @@
const sprite = new PIXI.Sprite(texture); sprite.mask = graphics;
At the moment, PIXI.CanvasRenderer doesn't support PIXI.Sprite as mask.
-{PIXI.Container|PIXI.MaskData|null}
-Parameters
value: null | Container | MaskData
Returns void
pivot
Parameters
value: null | Container<DisplayObject> | MaskData
Returns void
pivot
The center of rotation, scaling, and skewing for this display object in its local space. The
positionis the projection ofpivotin the parent's local space.By default, the pivot is the origin (0, 0).
-PixiJS 4
-{PIXI.ObservablePoint}
-Returns ObservablePoint<any>
4.0.0
+Returns ObservablePoint<any>
The center of rotation, scaling, and skewing for this display object in its local space. The
positionis the projection ofpivotin the parent's local space.By default, the pivot is the origin (0, 0).
-PixiJS 4
-{PIXI.ObservablePoint}
-Parameters
value: ObservablePoint<any>
Returns void
position
Returns ObservablePoint3D
Parameters
value: ObservablePoint3D
Returns void
rotation
4.0.0
+Parameters
value: IPointData
Returns void
position
Returns ObservablePoint3D
Parameters
value: ObservablePoint3D
Returns void
rotation
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.
-{number}
-Returns 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.
-{number}
-Parameters
value: number
Returns void
rotation
Parameters
value: number
Returns void
rotation
The quaternion rotation of the object.
-Returns ObservableQuaternion
Parameters
value: ObservableQuaternion
Returns void
scale
Returns ObservablePoint3D
Parameters
value: ObservablePoint3D
Returns void
skew
Returns ObservableQuaternion
Parameters
value: ObservableQuaternion
Returns void
scale
Returns ObservablePoint3D
Parameters
value: ObservablePoint3D
Returns void
skew
The skew factor for the object in radians.
-PixiJS 4
-{PIXI.ObservablePoint}
-Returns ObservablePoint<any>
4.0.0
+Returns ObservablePoint<any>
The skew factor for the object in radians.
-PixiJS 4
-{PIXI.ObservablePoint}
-Parameters
value: ObservablePoint<any>
Returns void
width
The width of the Container, setting this will actually modify the scale to achieve the value set
-{number}
-Returns number
The width of the Container, setting this will actually modify the scale to achieve the value set
-{number}
-Parameters
value: number
Returns void
world
Returns Matrix4
world
4.0.0
+Parameters
value: IPointData
Returns void
width
The width of the Container, setting this will actually modify the scale to achieve the value set.
+Returns number
The width of the Container, setting this will actually modify the scale to achieve the value set.
+Parameters
value: number
Returns void
world
Returns Matrix4
world
Indicates if the object is globally visible.
-{boolean}
-Returns boolean
x
Returns boolean
x
The position of the displayObject on the x axis relative to the local coordinates of the parent. An alias to position.x
-{number}
-Returns 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
-{number}
-Parameters
value: number
Returns void
y
Parameters
value: number
Returns void
y
The position of the displayObject on the y axis relative to the local coordinates of the parent. An alias to position.y
-{number}
-Returns 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
-{number}
-Parameters
value: number
Returns void
z
Parameters
value: number
Returns void
z
The position of the object on the z axis relative to the local coordinates of the parent.
-Returns number
Returns number
The position of the object on the z axis relative to the local coordinates of the parent.
-Parameters
value: number
Returns void
z
Parameters
value: number
Returns void
z
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.
-{number}
-PIXI.Container#sortableChildren
-Returns number
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.
-{number}
-PIXI.Container#sortableChildren
-Parameters
value: number
Returns void
Methods
Protected _calculate
PIXI.Container#sortableChildren
+Parameters
value: number
Returns void
Methods
Protected _calculate
Recalculates the content bounds of this object. This should be overriden to calculate the bounds of this specific object (not including children).
-Returns void
Protected _recursive
Recursively updates transform of all objects from the root to this one -internal function for toLocal()
-Returns void
Protected _render
Returns void
Protected _recursive
Recursively updates transform of all objects from the root to this one internal function for toLocal()
+Returns void
Protected _render
To be overridden by the subclasses.
-Parameters
_renderer: Renderer
Returns void
add
Parameters
_renderer: Renderer
The renderer
+Returns void
Protected _render
Renders this object and its children with culling.
+Parameters
renderer: Renderer
The renderer
+Returns void
add
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
Type parameters
U: DisplayObject[]
Parameters
Rest ...children: U
The DisplayObject(s) to add to the container
-Returns T[0]
The first child that was added.
-add
Returns U[0]
+- The first child that was added.
+
+add
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
Type parameters
U: DisplayObject<U>
Parameters
child: U
The child to add
index: number
The index to place the child in
-Returns T
The child that was added.
-add
Parameters
event: string | symbol
fn: ListenerFn
Optional context: any
Returns Container3D
calculate
Returns U
The child that was added.
+add
Parameters
event: string | symbol
fn: ListenerFn
Optional context: any
Returns Container3D
calculate
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
Returns void
destroy
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
disable
Parameters
Optional options: boolean | IDestroyOptions
Options parameter. A boolean will act as if all options + have been set to that value
+Returns void
disable
Pair method for
-enableTempParentParameters
cacheParent: DisplayObject
Parameters
cacheParent: Container<DisplayObject>
Actual parent of element
Returns void
emit
Calls each of the listeners registered for a given event.
-Parameters
event: string | symbol
Rest ...args: any[]
Returns boolean
enable
Parameters
event: string | symbol
Rest ...args: any[]
Returns boolean
enable
Used in Renderer, cacheAsBitmap and other places where you call an
-updateTransformon rootReturns DisplayObject
current parent
+Returns Container<DisplayObject>
+- current parent
+
event
Return an array listing the events for which the emitter has registered listeners.
-Returns (string | symbol)[]
get
Returns (string | symbol)[]
get
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 @@ -169,13 +233,11 @@
-displayObject._bounds.getRectangle()when traversing through all the bounds in a scene graph. Otherwise, callinggetBoundson 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 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
-_boundsobject stores the last calculation of the bounds. You can use to entirely skip bounds calculation if needed.Parameters
Optional skipUpdate: boolean
Optional rect: Rectangle
Returns Rectangle
The minimum axis-aligned rectangle in world space that fits around this object.
-get
Parameters
Optional skipUpdate: boolean
Setting to
+truewill 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.Optional rect: Rectangle
Optional rectangle to store the result of the bounds calculation.
+Returns Rectangle
+- The minimum axis-aligned rectangle in world space that fits around this object.
+
+get
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 get
Parameters
name: string
Optional isRecursive: boolean
Returns DisplayObject
get
Returns DisplayObject
+- The child at the given index, if any.
+
+get
Type parameters
T: DisplayObject<T> = DisplayObject
Parameters
name: string
Optional deep: boolean
Returns T
get
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
-get
Returns number
+- The index position of the child display object to identify
+
+get
Retrieves the local bounds of the displayObject as a rectangle object.
Calling
-getLocalBoundsmay invalidate the_boundsof the whole subtree below. If using it inside a render() call, it is advised to callgetBounds()immediately after to recalculate the world bounds of the subtree.Parameters
Optional rect: Rectangle
Optional skipChildrenUpdate: boolean
Returns Rectangle
The rectangular bounding area.
+Parameters
Optional rect: Rectangle
Optional rectangle to store the result of the bounds calculation.
+Optional skipChildrenUpdate: boolean
Setting to
+truewill stop re-calculation of children transforms, + it was default behaviour of pixi 4.0-5.2 and caused many problems to users.Returns Rectangle
+- The rectangular bounding area.
+
listener
Return the number of listeners listening to a given event.
Parameters
event: string | symbol
Returns number
listeners
Return the listeners registered for a given event.
Parameters
event: string | symbol
Returns ListenerFn[]
off
Parameters
event: string | symbol
Optional fn: ListenerFn
Optional context: any
Optional once: boolean
Returns Container3D
on
Add a listener for a given event.
-Parameters
event: string | symbol
fn: ListenerFn
Optional context: any
Returns Container3D
Protected on
Overridable method that can be used by Container subclasses whenever the children array is modified
-Parameters
Optional _length: number
Returns void
once
Parameters
event: string | symbol
fn: ListenerFn
Optional context: any
Returns Container3D
Protected on
Overridable method that can be used by Container subclasses whenever the children array is modified.
+Parameters
Optional _length: number
Returns void
once
Add a one-time listener for a given event.
Parameters
event: string | symbol
fn: ListenerFn
Optional context: any
Returns Container3D
remove
Remove all listeners, or those of the specified event.
-Parameters
Optional event: string | symbol
Returns Container3D
remove
Parameters
Optional event: string | symbol
Returns Container3D
remove
Removes one or more children from the container.
-Type parameters
T: DisplayObject[]
Parameters
Rest ...children: T
Type parameters
U: DisplayObject[]
Parameters
Rest ...children: U
The DisplayObject(s) to remove
-Returns T[0]
The first child that was removed.
-remove
Returns U[0]
The first child that was removed.
+remove
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.
-remove
remove
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
+Parameters
Optional beginIndex: number
The beginning position.
+Optional endIndex: number
The ending position. Default value is size of the container.
+Returns DisplayObject[]
+- List of removed children
+
remove
Remove the listeners of a given event.
-Parameters
event: string | symbol
Optional fn: ListenerFn
Optional context: any
Optional once: boolean
Returns Container3D
render
Parameters
event: string | symbol
Optional fn: ListenerFn
Optional context: any
Optional once: boolean
Returns Container3D
render
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
-rendermethod will invoke it, and also invoke therendermethods of all children afterward.If
renderableorvisibleis false or ifworldAlphais not positive, this implementation will entirely -skip rendering. See {@link PIXI.DisplayObject} for choosing betweenrenderableorvisible. Generally, +If
renderableorvisibleis false or ifworldAlphais not positive or ifcullableis true and +the bounds of this object are out of frame, this implementation will entirely skip rendering. +See {@link PIXI.DisplayObject} for choosing betweenrenderableorvisible. 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 +advised to employ culling to automatically skip rendering objects outside of the current screen. +See [cullable]{@link PIXI.DisplayObject#cullable} and [cullArea]{@link PIXI.DisplayObject#cullArea}. +Other culling methods might be better suited for a large number static objects; see @pixi-essentials/cull and -pixi-cull packages do this out of the box.
+pixi-cull.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 render
Returns void
Protected render
Render the object using the WebGL renderer and advanced features.
Parameters
renderer: Renderer
The renderer
-Returns void
set
Returns void
set
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
set
Returns void
set
Set the parent Container of this DisplayObject.
-Parameters
container: Container
Parameters
container: Container<DisplayObject>
The Container to add this DisplayObject to.
-Returns Container
The Container that this DisplayObject was added to.
-set
Returns Container<DisplayObject>
+- The Container that this DisplayObject was added to.
+
+set
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
-sort
Parameters
Optional x: number
The X position
+Optional y: number
The Y position
+Optional scaleX: number
The X scale value
+Optional scaleY: number
The Y scale value
+Optional rotation: number
The rotation
+Optional skewX: number
The X skew value
+Optional skewY: number
The Y skew value
+Optional pivotX: number
The X pivot value
+Optional pivotY: number
The Y pivot value
+Returns Container3D
+- The DisplayObject instance
+
+sort
Sorts children by zIndex. Previous order is maintained for 2 children with the same zIndex.
-Returns void
swap
Returns void
swap
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
to
Returns void
to
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.
-to
Optional point: P
A Point object in which to store the value, optional + (otherwise will create a new Point).
+Optional skipUpdate: boolean
Should we skip the update transform.
+Returns P
+- A point object representing the position of this object.
+
+to
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
-update
Updates the transform on all children of this container for rendering
-Returns void
Static mixin
Optional from: DisplayObject
The DisplayObject to calculate the global position from.
+Optional point: P
A Point object in which to store the value, optional + (otherwise will create a new Point).
+Optional skipUpdate: boolean
Should we skip the update transform
+Returns P
+- A point object representing the position of this object
+
+update
Updates the transform on all children of this container for rendering.
+Returns void
Static mixin
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
Returns void
Generated using TypeDoc
- Preparing search index...
- The search index is not available
Pixi3D - v1.5.1Class Cubemap
- Preparing search index...
- The search index is not available
Pixi3D - v1.6.0Class Cubemap
Cubemap which supports multiple user specified mipmaps.
-Hierarchy
Index
Constructors
Properties
Accessors
Methods
Constructors
constructor
Parameters
Optional resource: any
Optional options: IBaseTextureOptions<IAutoDetectOptions>
Returns Cubemap
Properties
_batch
_batch
_gl
Type declaration
[key: number]: GLTexture
Optional alpha
Optional anisotropic
cache
destroyed
dirty
dirty
Optional format
height
is
Optional mipmap
parent
resolution
resource
Optional scale
Optional target
texture
touched
Optional type
Readonly uid
valid
width
Optional wrap
Static _global
Global number of the texture batch, used by multi-texture renderers
-{number}
-Static prefixed
Accessors
levels
Hierarchy
Index
Constructors
Properties
Accessors
Methods
Constructors
constructor
Parameters
Optional resource: any
Optional options: IBaseTextureOptions<IAutoDetectOptions>
Collection of options
+Returns Cubemap
Properties
_batch
Number of the texture batch, used by multi-texture renderers
+{number}
+_batch
Location inside texture batch, used by multi-texture renderers
+{number}
+Optional alpha
How to treat premultiplied alpha, see {@link PIXI.ALPHA_MODES}.
+{PIXI.ALPHA_MODES}
+PIXI.ALPHA_MODES.UNPACK
+Optional anisotropic
Anisotropic filtering level of texture
+{number}
+PIXI.settings.ANISOTROPIC_LEVEL
+cache
Currently default cache ID.
+{string}
+destroyed
Flag if BaseTexture has been destroyed.
+{boolean}
+dirty
Used by TextureSystem to only update texture to the GPU when needed. +Please call
+update()to increment it.Protected dirty
Used by TextureSystem to only update texture style when needed.
+Optional format
The pixel format of the texture
+PIXI.FORMATS.RGBA
+height
The height of the base texture set when the image has loaded
+is
Whether or not the texture is a power of two, try to use power of two textures as much +as you can
+false
+parent
Whether its a part of another texture, handled by ArrayResource or CubeResource
+{PIXI.BaseTexture}
+resolution
The resolution / device pixel ratio of the texture
+PIXI.settings.RESOLUTION
+resource
The resource used by this BaseTexture, there can only +be one resource per BaseTexture, but textures can share +resources.
+{PIXI.Resource}
+Optional target
The target type
+PIXI.TARGETS.TEXTURE_2D
+texture
The collection of alternative cache ids, since some BaseTextures +can have more than one ID, short name and longer full URL
+{Array}
+Protected touched
Used by automatic texture Garbage Collection, stores last GC tick when it was bound
+Optional type
The type of resource data
+PIXI.TYPES.UNSIGNED_BYTE
+Readonly Protected uid
Global unique identifier for this BaseTexture
+valid
Generally speaking means when resource is loaded.
+{boolean}
+width
The width of the base texture set when the image has loaded
+Static _global
Global number of the texture batch, used by multi-texture renderers.
+Static prefixed
Accessors
levels
Returns the number of mipmap levels.
-Returns number
real
Returns number
mipmap
Mipmap mode of the texture, affects downscaled images
+PIXI.settings.MIPMAP_TEXTURES
+Returns MIPMAP_MODES
Mipmap mode of the texture, affects downscaled images
+PIXI.settings.MIPMAP_TEXTURES
+Parameters
value: MIPMAP_MODES
Returns void
real
Pixel height of the source of this texture
-{number}
-Returns number
real
Returns number
real
Pixel width of the source of this texture
-{number}
-Returns number
Static faces
Returns number
scale
The scale mode to apply when scaling this texture
+PIXI.settings.SCALE_MODE
+Returns SCALE_MODES
The scale mode to apply when scaling this texture
+PIXI.settings.SCALE_MODE
+Parameters
value: SCALE_MODES
Returns void
wrap
How the texture wraps
+PIXI.settings.WRAP_MODE
+Returns WRAP_MODES
How the texture wraps
+PIXI.settings.WRAP_MODE
+Parameters
value: WRAP_MODES
Returns void
Static faces
Returns an array of faces.
-Returns ["posx", "negx", "posy", "negy", "posz", "negz"]
Methods
add
Parameters
event: string | symbol
fn: ListenerFn
Optional context: any
Returns Cubemap
cast
Utility function for BaseTexture|Texture cast
-Returns BaseTexture<Resource, IAutoDetectOptions>
destroy
Returns ["posx", "negx", "posy", "negy", "posz", "negz"]
Methods
add
Parameters
event: string | symbol
fn: ListenerFn
Optional context: any
Returns Cubemap
cast
Utility function for BaseTexture|Texture cast.
+Returns BaseTexture<Resource, IAutoDetectOptions>
destroy
Destroys this base texture. The method stops if resource doesn't want this texture to be destroyed. Removes texture from all caches.
-Returns void
dispose
Returns void
dispose
Frees the texture from WebGL memory without destroying this texture object. This means you can still use the texture later which will upload it to GPU memory again.
@@ -41,62 +122,87 @@Remove all listeners, or those of the specified event.
Parameters
Optional event: string | symbol
Returns Cubemap
remove
Remove the listeners of a given event.
-Parameters
event: string | symbol
Optional fn: ListenerFn
Optional context: any
Optional once: boolean
Returns Cubemap
set
Parameters
event: string | symbol
Optional fn: ListenerFn
Optional context: any
Optional once: boolean
Returns Cubemap
set
Sets real size of baseTexture, preserves current resolution.
Parameters
realWidth: number
Full rendered width
realHeight: number
Full rendered height
-Optional resolution: number
Returns Cubemap
this
-set
Optional resolution: number
Optionally set resolution
+Returns Cubemap
+- this
+
+set
Changes resolution
Parameters
resolution: number
res
-Returns Cubemap
this
-set
Returns Cubemap
+- this
+
+set
Sets the resource if it wasn't set. Throws error if resource already present
Parameters
resource: CubemapResource
that is managing this BaseTexture
-Returns Cubemap
this
-set
Returns Cubemap
+- this
+
+set
Changes w/h/resolution. Texture becomes valid if width and height are greater than zero.
-Parameters
width: number
Visual width
-height: number
Visual height
-Optional resolution: number
Returns Cubemap
this
-set
Parameters
desiredWidth: number
Desired visual width
+desiredHeight: number
Desired visual height
+Optional resolution: number
Optionally set resolution
+Returns Cubemap
+- this
+
+set
Changes style options of BaseTexture
-Parameters
Optional scaleMode: SCALE_MODES
Optional mipmap: MIPMAP_MODES
Returns Cubemap
this
-update
Parameters
Optional scaleMode: SCALE_MODES
Pixi scalemode
+Optional mipmap: MIPMAP_MODES
enable mipmaps
+Returns Cubemap
+- this
+
+update
Invalidates the object. Texture becomes valid if width and height are greater than zero.
-Returns void
Static add
Returns void
Static add
Adds a BaseTexture to the global BaseTextureCache. This cache is shared across the whole PIXI object.
-Parameters
baseTexture: BaseTexture<Resource, IAutoDetectOptions>
Parameters
baseTexture: BaseTexture<Resource, IAutoDetectOptions>
The BaseTexture to add to the cache.
id: string
The id that the BaseTexture will be stored against.
-Returns void
Static from
Returns void
Static from
Helper function that creates a base texture based on the source you provide. The source can be - image url, image element, canvas element. If the source is an image url or an image element and not in the base texture cache, it will be created and loaded.
-Type parameters
R: Resource<R> = Resource
RO = IAutoDetectOptions
Parameters
source: string | ImageSource
Type parameters
R: Resource<R> = Resource
RO = IAutoDetectOptions
Parameters
source: string | ImageSource | string[]
The source to create base texture from.
-Optional options: IBaseTextureOptions<RO>
Optional strict: boolean
Returns BaseTexture<R, IAutoDetectOptions>
The new base texture.
-Static from
Optional options: IBaseTextureOptions<RO>
See {@link PIXI.BaseTexture}'s constructor for options.
+Optional strict: boolean
Returns BaseTexture<R, IAutoDetectOptions>
The new base texture.
+Static from
Create a new BaseTexture with a BufferResource from a Float32Array. RGBA values are floats from 0 to 1.
-Parameters
buffer: Float32Array | Uint8Array
Parameters
buffer: Float32Array | Uint8Array
The optional array to use, if no data is provided, a new Float32Array is created.
width: number
Width of the resource
height: number
Height of the resource
-Optional options: IBaseTextureOptions<any>
Returns BaseTexture<BufferResource, IAutoDetectOptions>
The resulting new BaseTexture
-Static from
Optional options: IBaseTextureOptions<any>
See {@link PIXI.BaseTexture}'s constructor for options. + Default properties are different from the constructor's defaults.
+Returns BaseTexture<BufferResource, IAutoDetectOptions>
+- The resulting new BaseTexture
+
+Static from
Creates a new cubemap from the specified colors.
Parameters
posx: Color
The color for positive x.
@@ -110,13 +216,13 @@The color for positive z.
negz: Color = posx
The color for negative z.
-Returns Cubemap
Static from
Returns Cubemap
Static from
Creates a new cubemap from the specified faces.
Parameters
faces: CubemapFaces | CubemapFaces[]
The faces to create the cubemap from.
-Returns Cubemap
Static remove
Returns Cubemap
Static remove
Remove a BaseTexture from the global BaseTextureCache.
-Parameters
baseTexture: string | BaseTexture<Resource, IAutoDetectOptions>
Parameters
baseTexture: string | BaseTexture<Resource, IAutoDetectOptions>
id of a BaseTexture to be removed, or a BaseTexture instance itself.
Returns null | BaseTexture<Resource, IAutoDetectOptions>
The BaseTexture that was removed.
-Generated using TypeDoc
Generated using TypeDoc
- Preparing search index...
- The search index is not available
Pixi3D - v1.5.1Class CubemapResource
Hierarchy
Index
Constructors
Properties
Accessors
Methods
Constructors
constructor
Parameters
source: MipmapResourceArray
levels: number = 1
Returns CubemapResource
Properties
Protected _height
Protected _width
base
destroyed
internal
item
items
Readonly length
levels
link
Protected on
Protected on
Protected on
Static SIDES
Number of texture sides to store for CubeResources
-PIXI.CubeResource.SIDES
-{number}
-6
-Accessors
height
- Preparing search index...
- The search index is not available
Pixi3D - v1.6.0Class CubemapResource
Hierarchy
Index
Constructors
Properties
Accessors
Methods
Constructors
constructor
Parameters
source: MipmapResourceArray
levels: number = 1
Returns CubemapResource
Properties
Protected _height
Internal height of the resource.
+Protected _width
Internal width of the resource.
+base
Bound baseTexture, there can only be one.
+destroyed
If resource has been destroyed.
+false
+internal
+trueif resource is created by BaseTexture +useful for doing cleanup with BaseTexture destroy +and not cleaning up resources that were created +externally.item
Dirty IDs for each part.
+items
Readonly length
Number of elements in array.
+levels
Protected link
In case BaseTextures are supplied, whether to use same resource or bind baseTexture itself.
+src
The url of the resource
+Static SIDES
Number of texture sides to store for CubeResources.
+Accessors
height
The height of the resource.
-{number}
-Returns number
valid
Returns number
valid
Has been validated
-{boolean}
-Returns boolean
width
Returns boolean
width
The width of the resource.
-{number}
-Returns number
Methods
add
Parameters
baseTexture: BaseTexture<Resource, IAutoDetectOptions>
index: number
Optional linkBaseTexture: boolean
Returns CubemapResource
add
Returns number
Methods
add
Parameters
baseTexture: BaseTexture<Resource, IAutoDetectOptions>
index: number
Optional linkBaseTexture: boolean
Returns CubemapResource
add
Set a resource by ID
Parameters
resource: Resource
index: number
Zero-based index of resource to set
-Returns CubemapResource
Instance for chaining
-bind
Add binding
-Parameters
baseTexture: BaseTexture<Resource, IAutoDetectOptions>
Returns CubemapResource
+- Instance for chaining
+
+bind
Add binding.
+Parameters
baseTexture: BaseTexture<Resource, IAutoDetectOptions>
parent base texture
-Returns void
destroy
Returns void
destroy
Call when destroying resource, unbind any BaseTexture object before calling this method, as reference counts are maintained internally.
-Returns void
dispose
Destroy this BaseImageResource
-Returns void
Protected init
used from ArrayResource and CubeResource constructors
+Returns void
dispose
Destroy this BaseImageResource.
+Returns void
Protected init
Used from ArrayResource and CubeResource constructors.
Parameters
resources: any[]
Can be resources, image elements, canvas, etc. , length should be same as constructor length
-Optional options: IAutoDetectOptions
Returns void
load
Optional options: IAutoDetectOptions
Detect options for resources
+Returns void
load
Load all the resources simultaneously
-Returns Promise<CubemapResource>
When load is resolved
-resize
Returns Promise<CubemapResource>
+- When load is resolved
+
+resize
Trigger a resize event
Parameters
width: number
X dimension
height: number
Y dimension
-Returns void
style
Parameters
renderer: Renderer
Returns boolean
unbind
Unset the parent base texture
-{PIXI.BaseTexture}
-Parameters
baseTexture: BaseTexture<Resource, IAutoDetectOptions>
Returns void
update
Has been updated trigger event
-Returns void
upload
Returns void
style
Parameters
renderer: Renderer
Returns boolean
unbind
Unset the parent base texture.
+Parameters
baseTexture: BaseTexture<Resource, IAutoDetectOptions>
Returns void
update
Has been updated trigger event.
+Returns void
upload
Upload the resource
Parameters
renderer: Renderer
_baseTexture: BaseTexture<Resource, IAutoDetectOptions>
glTexture: GLTexture
Returns boolean
true is success
-Static test
Static test
Used to auto-detect the type of resource.
-Parameters
source: unknown
Parameters
source: unknown
The source object
Returns source is ArrayFixed<string | Resource, 6>
-trueif source is an array of 6 elementsGenerated using TypeDoc
Generated using TypeDoc
- Preparing search index...
- The search index is not available
Pixi3D - v1.5.1Class ImageBasedLighting
- Preparing search index...
- The search index is not available
Pixi3D - v1.6.0Class ImageBasedLighting
Collection of components used for image-based lighting (IBL), a rendering technique which involves capturing an omnidirectional representation of real-world light information as an image.
-Hierarchy
Index
Constructors
Properties
Accessors
Constructors
constructor
Hierarchy
Index
Constructors
Properties
Accessors
Constructors
constructor
Creates a new image-based lighting object.
Parameters
diffuse: Cubemap
Cubemap used for the diffuse component.
specular: Cubemap
Cubemap used for the specular component.
-Returns ImageBasedLighting
Properties
Optional lookup
Returns ImageBasedLighting
Properties
Optional lookup
BRDF integration map lookup texture.
-Static default
Static default
The default BRDF integration map lookup texture.
-Accessors
diffuse
Accessors
diffuse
Cube texture used for the diffuse component.
-Returns Cubemap
specular
Returns Cubemap
specular
Cube mipmap texture used for the specular component.
-Returns Cubemap
valid
Returns Cubemap
valid
Value indicating if this object is valid to be used for rendering.
Returns boolean
Generated using TypeDoc
- Preparing search index...
- The search index is not available
Pixi3D - v1.5.1Class InstancedMesh3D
Hierarchy
Index
Constructors
Properties
Accessors
Methods
Constructors
constructor
Parameters
mesh: Mesh3D
material: unknown
Returns InstancedMesh3D
Properties
_bounds
Protected _boundsID
Protected _bounds
Protected _destroyed
Protected _enabled
Protected _height
_last
_local
Protected _local
_mask
Optional _tracked
Type declaration
[x: number]: InteractionTrackingData
Protected _width
Protected _z
alpha
Optional button
Readonly children
container
Type declaration
Returns void
Optional cursor
display
Type declaration
Returns void
filter
filters
Optional hit
Optional interactive
Optional interactive
is
is
Readonly material
Readonly mesh
Optional name
parent
renderable
sort
sortable
Optional tracked
Type declaration
[x: number]: InteractionTrackingData
transform
visible
world
Static prefixed
Accessors
Protected _temp
{PIXI.Container}
-Returns TemporaryDisplayObject
angle
- Preparing search index...
- The search index is not available
Pixi3D - v1.6.0Class InstancedMesh3D
Hierarchy
Index
Constructors
Properties
Accessors
Methods
Constructors
constructor
Parameters
mesh: Mesh3D
material: unknown
Returns InstancedMesh3D
Properties
_bounds
The bounds object, this is used to calculate and store the bounds of the displayObject.
+Protected _boundsID
Flags the cached bounds as dirty.
+Protected _bounds
Cache of this display-object's bounds-rectangle.
+Protected _destroyed
If the object has been destroyed via destroy(). If true, it should not be used.
+Protected _enabled
Currently enabled filters.
+Protected _height
Protected _last
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
Local bounds object, swapped with
+_boundswhen usinggetLocalBounds().Protected _local
Cache of this display-object's local-bounds rectangle.
+Protected _mask
The original, cached mask of the object.
+_tracked
Type declaration
[x: number]: InteractionTrackingData
Protected _width
Protected _z
The zIndex of the displayObject. +A higher value will mean it will be rendered on top of other displayObjects within the same container.
+alpha
The opacity of the object.
+button
Readonly children
The array of children of this container.
+container
Type declaration
Returns void
cull
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.
+cullable
Should this object be rendered if the bounds of this object are out of frame?
+Culling has no effect on whether updateTransform is called.
+cursor
display
Type declaration
Returns void
filter
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
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'.hit
interactive
interactive
is
Does any other displayObject use this object as a mask?
+is
Used to fast check if a sprite is.. a sprite!
+Readonly material
Readonly mesh
name
parent
renderable
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.
+sort
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.
+sortable
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 @link https://github.com/pixijs/pixi-display
+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.
+PIXI.settings.SORTABLE_CHILDREN
+tracked
Type declaration
[x: number]: InteractionTrackingData
transform
visible
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.
+world
The multiplied alpha of the displayObject.
+Static prefixed
Accessors
Protected _temp
{PIXI.Container}
+Returns TemporaryDisplayObject
angle
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.
-{number}
-Returns 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.
-{number}
-Parameters
value: number
Returns void
height
The height of the Container, setting this will actually modify the scale to achieve the value set
-{number}
-Returns number
The height of the Container, setting this will actually modify the scale to achieve the value set
-{number}
-Parameters
value: number
Returns void
local
Returns Matrix4
mask
Parameters
value: number
Returns void
destroyed
Readonly flag for destroyed display objects.
+Returns boolean
height
The height of the Container, setting this will actually modify the scale to achieve the value set.
+Returns number
The height of the Container, setting this will actually modify the scale to achieve the value set.
+Parameters
value: number
Returns void
local
Returns Matrix4
mask
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
+utilities shape clipping. Furthermore, a mask of an object must be in the subtree of its parent. +Otherwise,null.getLocalBoundsmay calculate incorrect bounds, which makes the container's width and height wrong. +To remove a mask, set this property tonull.For sprite mask both alpha and red channel are used. Black mask is the same as transparent mask.
const graphics = new PIXI.Graphics(); graphics.beginFill(0xFF3300); @@ -26,12 +93,13 @@
const sprite = new PIXI.Sprite(texture); sprite.mask = graphics;
At the moment, PIXI.CanvasRenderer doesn't support PIXI.Sprite as mask.
-{PIXI.Container|PIXI.MaskData|null}
-Returns null | Container | MaskData
Returns null | Container<DisplayObject> | 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
+utilities shape clipping. Furthermore, a mask of an object must be in the subtree of its parent. +Otherwise,null.getLocalBoundsmay calculate incorrect bounds, which makes the container's width and height wrong. +To remove a mask, set this property tonull.For sprite mask both alpha and red channel are used. Black mask is the same as transparent mask.
const graphics = new PIXI.Graphics(); graphics.beginFill(0xFF3300); @@ -40,125 +108,118 @@
const sprite = new PIXI.Sprite(texture); sprite.mask = graphics;
At the moment, PIXI.CanvasRenderer doesn't support PIXI.Sprite as mask.
-{PIXI.Container|PIXI.MaskData|null}
-Parameters
value: null | Container | MaskData
Returns void
pivot
Parameters
value: null | Container<DisplayObject> | MaskData
Returns void
pivot
The center of rotation, scaling, and skewing for this display object in its local space. The
positionis the projection ofpivotin the parent's local space.By default, the pivot is the origin (0, 0).
-PixiJS 4
-{PIXI.ObservablePoint}
-Returns ObservablePoint<any>
4.0.0
+Returns ObservablePoint<any>
The center of rotation, scaling, and skewing for this display object in its local space. The
positionis the projection ofpivotin the parent's local space.By default, the pivot is the origin (0, 0).
-PixiJS 4
-{PIXI.ObservablePoint}
-Parameters
value: ObservablePoint<any>
Returns void
position
Returns ObservablePoint3D
Parameters
value: ObservablePoint3D
Returns void
rotation
4.0.0
+Parameters
value: IPointData
Returns void
position
Returns ObservablePoint3D
Parameters
value: ObservablePoint3D
Returns void
rotation
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.
-{number}
-Returns 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.
-{number}
-Parameters
value: number
Returns void
rotation
Parameters
value: number
Returns void
rotation
The quaternion rotation of the object.
-Returns ObservableQuaternion
Parameters
value: ObservableQuaternion
Returns void
scale
Returns ObservablePoint3D
Parameters
value: ObservablePoint3D
Returns void
skew
Returns ObservableQuaternion
Parameters
value: ObservableQuaternion
Returns void
scale
Returns ObservablePoint3D
Parameters
value: ObservablePoint3D
Returns void
skew
The skew factor for the object in radians.
-PixiJS 4
-{PIXI.ObservablePoint}
-Returns ObservablePoint<any>
4.0.0
+Returns ObservablePoint<any>
The skew factor for the object in radians.
-PixiJS 4
-{PIXI.ObservablePoint}
-Parameters
value: ObservablePoint<any>
Returns void
width
The width of the Container, setting this will actually modify the scale to achieve the value set
-{number}
-Returns number
The width of the Container, setting this will actually modify the scale to achieve the value set
-{number}
-Parameters
value: number
Returns void
world
Returns Matrix4
world
4.0.0
+Parameters
value: IPointData
Returns void
width
The width of the Container, setting this will actually modify the scale to achieve the value set.
+Returns number
The width of the Container, setting this will actually modify the scale to achieve the value set.
+Parameters
value: number
Returns void
world
Returns Matrix4
world
Indicates if the object is globally visible.
-{boolean}
-Returns boolean
x
Returns boolean
x
The position of the displayObject on the x axis relative to the local coordinates of the parent. An alias to position.x
-{number}
-Returns 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
-{number}
-Parameters
value: number
Returns void
y
Parameters
value: number
Returns void
y
The position of the displayObject on the y axis relative to the local coordinates of the parent. An alias to position.y
-{number}
-Returns 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
-{number}
-Parameters
value: number
Returns void
z
Parameters
value: number
Returns void
z
The position of the object on the z axis relative to the local coordinates of the parent.
-Returns number
Returns number
The position of the object on the z axis relative to the local coordinates of the parent.
-Parameters
value: number
Returns void
z
Parameters
value: number
Returns void
z
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.
-{number}
-PIXI.Container#sortableChildren
-Returns number
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.
-{number}
-PIXI.Container#sortableChildren
-Parameters
value: number
Returns void
Methods
Protected _calculate
PIXI.Container#sortableChildren
+Parameters
value: number
Returns void
Methods
Protected _calculate
Recalculates the content bounds of this object. This should be overriden to calculate the bounds of this specific object (not including children).
-Returns void
Protected _recursive
Recursively updates transform of all objects from the root to this one -internal function for toLocal()
-Returns void
Protected _render
Returns void
Protected _recursive
Recursively updates transform of all objects from the root to this one internal function for toLocal()
+Returns void
Protected _render
To be overridden by the subclasses.
-Parameters
_renderer: Renderer
Returns void
add
Parameters
_renderer: Renderer
The renderer
+Returns void
Protected _render
Renders this object and its children with culling.
+Parameters
renderer: Renderer
The renderer
+Returns void
add
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
Type parameters
U: DisplayObject[]
Parameters
Rest ...children: U
The DisplayObject(s) to add to the container
-Returns T[0]
The first child that was added.
-add
Returns U[0]
+- The first child that was added.
+
+add
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
Type parameters
U: DisplayObject<U>
Parameters
child: U
The child to add
index: number
The index to place the child in
-Returns T
The child that was added.
-add
Parameters
event: string | symbol
fn: ListenerFn
Optional context: any
Returns InstancedMesh3D
calculate
Returns U
The child that was added.
+add
Parameters
event: string | symbol
fn: ListenerFn
Optional context: any
Returns InstancedMesh3D
calculate
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
Returns void
destroy
Removes all internal references and listeners as well as removes children from the display list. Do not use a Container after calling
-destroy.Parameters
options: undefined | boolean | IDestroyOptions
Returns void
disable
Parameters
options: undefined | boolean | IDestroyOptions
Returns void
disable
Pair method for
-enableTempParentParameters
cacheParent: DisplayObject
Parameters
cacheParent: Container<DisplayObject>
Actual parent of element
Returns void
emit
Calls each of the listeners registered for a given event.
-Parameters
event: string | symbol
Rest ...args: any[]
Returns boolean
enable
Parameters
event: string | symbol
Rest ...args: any[]
Returns boolean
enable
Used in Renderer, cacheAsBitmap and other places where you call an
-updateTransformon rootReturns DisplayObject
current parent
+Returns Container<DisplayObject>
+- current parent
+
event
Return an array listing the events for which the emitter has registered listeners.
-Returns (string | symbol)[]
get
Returns (string | symbol)[]
get
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 @@ -167,13 +228,11 @@
-displayObject._bounds.getRectangle()when traversing through all the bounds in a scene graph. Otherwise, callinggetBoundson 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 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
-_boundsobject stores the last calculation of the bounds. You can use to entirely skip bounds calculation if needed.Parameters
Optional skipUpdate: boolean
Optional rect: Rectangle
Returns Rectangle
The minimum axis-aligned rectangle in world space that fits around this object.
-get
Parameters
Optional skipUpdate: boolean
Setting to
+truewill 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.Optional rect: Rectangle
Optional rectangle to store the result of the bounds calculation.
+Returns Rectangle
+- The minimum axis-aligned rectangle in world space that fits around this object.
+
+get
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 get
Parameters
name: string
Optional isRecursive: boolean
Returns DisplayObject
get
Returns DisplayObject
+- The child at the given index, if any.
+
+get
Type parameters
T: DisplayObject<T> = DisplayObject
Parameters
name: string
Optional deep: boolean
Returns T
get
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
-get
Returns number
+- The index position of the child display object to identify
+
+get
Retrieves the local bounds of the displayObject as a rectangle object.
Calling
-getLocalBoundsmay invalidate the_boundsof the whole subtree below. If using it inside a render() call, it is advised to callgetBounds()immediately after to recalculate the world bounds of the subtree.Parameters
Optional rect: Rectangle
Optional skipChildrenUpdate: boolean
Returns Rectangle
The rectangular bounding area.
+Parameters
Optional rect: Rectangle
Optional rectangle to store the result of the bounds calculation.
+Optional skipChildrenUpdate: boolean
Setting to
+truewill stop re-calculation of children transforms, + it was default behaviour of pixi 4.0-5.2 and caused many problems to users.Returns Rectangle
+- The rectangular bounding area.
+
listener
Return the number of listeners listening to a given event.
Parameters
event: string | symbol
Returns number
listeners
Return the listeners registered for a given event.
Parameters
event: string | symbol
Returns ListenerFn[]
off
Parameters
event: string | symbol
Optional fn: ListenerFn
Optional context: any
Optional once: boolean
Returns InstancedMesh3D
on
Add a listener for a given event.
-Parameters
event: string | symbol
fn: ListenerFn
Optional context: any
Returns InstancedMesh3D
Protected on
Overridable method that can be used by Container subclasses whenever the children array is modified
-Parameters
Optional _length: number
Returns void
once
Parameters
event: string | symbol
fn: ListenerFn
Optional context: any
Returns InstancedMesh3D
Protected on
Overridable method that can be used by Container subclasses whenever the children array is modified.
+Parameters
Optional _length: number
Returns void
once
Add a one-time listener for a given event.
Parameters
event: string | symbol
fn: ListenerFn
Optional context: any
Returns InstancedMesh3D
remove
Remove all listeners, or those of the specified event.
-Parameters
Optional event: string | symbol
Returns InstancedMesh3D
remove
Parameters
Optional event: string | symbol
Returns InstancedMesh3D
remove
Removes one or more children from the container.
-Type parameters
T: DisplayObject[]
Parameters
Rest ...children: T
Type parameters
U: DisplayObject[]
Parameters
Rest ...children: U
The DisplayObject(s) to remove
-Returns T[0]
The first child that was removed.
-remove
Returns U[0]
The first child that was removed.
+remove
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.
-remove
remove
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
+Parameters
Optional beginIndex: number
The beginning position.
+Optional endIndex: number
The ending position. Default value is size of the container.
+Returns DisplayObject[]
+- List of removed children
+
remove
Remove the listeners of a given event.
-Parameters
event: string | symbol
Optional fn: ListenerFn
Optional context: any
Optional once: boolean
Returns InstancedMesh3D
render
Parameters
event: string | symbol
Optional fn: ListenerFn
Optional context: any
Optional once: boolean
Returns InstancedMesh3D
render
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
-rendermethod will invoke it, and also invoke therendermethods of all children afterward.If
renderableorvisibleis false or ifworldAlphais not positive, this implementation will entirely -skip rendering. See {@link PIXI.DisplayObject} for choosing betweenrenderableorvisible. Generally, +If
renderableorvisibleis false or ifworldAlphais not positive or ifcullableis true and +the bounds of this object are out of frame, this implementation will entirely skip rendering. +See {@link PIXI.DisplayObject} for choosing betweenrenderableorvisible. 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 +advised to employ culling to automatically skip rendering objects outside of the current screen. +See [cullable]{@link PIXI.DisplayObject#cullable} and [cullArea]{@link PIXI.DisplayObject#cullArea}. +Other culling methods might be better suited for a large number static objects; see @pixi-essentials/cull and -pixi-cull packages do this out of the box.
+pixi-cull.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 render
Returns void
Protected render
Render the object using the WebGL renderer and advanced features.
Parameters
renderer: Renderer
The renderer
-Returns void
set
Returns void
set
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
set
Returns void
set
Set the parent Container of this DisplayObject.
-Parameters
container: Container
Parameters
container: Container<DisplayObject>
The Container to add this DisplayObject to.
-Returns Container
The Container that this DisplayObject was added to.
-set
Returns Container<DisplayObject>
+- The Container that this DisplayObject was added to.
+
+set
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 InstancedMesh3D
The DisplayObject instance
-sort
Parameters
Optional x: number
The X position
+Optional y: number
The Y position
+Optional scaleX: number
The X scale value
+Optional scaleY: number
The Y scale value
+Optional rotation: number
The rotation
+Optional skewX: number
The X skew value
+Optional skewY: number
The Y skew value
+Optional pivotX: number
The X pivot value
+Optional pivotY: number
The Y pivot value
+Returns InstancedMesh3D
+- The DisplayObject instance
+
+sort
Sorts children by zIndex. Previous order is maintained for 2 children with the same zIndex.
-Returns void
swap
Returns void
swap
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
to
Returns void
to
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.
-to
Optional point: P
A Point object in which to store the value, optional + (otherwise will create a new Point).
+Optional skipUpdate: boolean
Should we skip the update transform.
+Returns P
+- A point object representing the position of this object.
+
+to
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
-update
Updates the transform on all children of this container for rendering
-Returns void
Static mixin
Optional from: DisplayObject
The DisplayObject to calculate the global position from.
+Optional point: P
A Point object in which to store the value, optional + (otherwise will create a new Point).
+Optional skipUpdate: boolean
Should we skip the update transform
+Returns P
+- A point object representing the position of this object
+
+update
Updates the transform on all children of this container for rendering.
+Returns void
Static mixin
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
Returns void
Generated using TypeDoc
- Preparing search index...
- The search index is not available
Pixi3D - v1.5.1Class InstancedModel
- Preparing search index...
- The search index is not available
Pixi3D - v1.6.0Class InstancedModel
Represents an instance of a model.
-Hierarchy
Index
Constructors
Properties
Accessors
Methods
Constructors
constructor
Hierarchy
Index
Constructors
Properties
Accessors
Methods
Constructors
constructor
Creates a new model instance from the specified model.
Parameters
model: Model
The model to create instance from.
-Returns InstancedModel
Properties
_bounds
Protected _boundsID
Protected _bounds
Protected _destroyed
Protected _enabled
Protected _height
_last
_local
Protected _local
_mask
Optional _tracked
Type declaration
[x: number]: InteractionTrackingData
Protected _width
Protected _z
alpha
Optional button
Readonly children
container
Type declaration
Returns void
Optional cursor
display
Type declaration
Returns void
filter
filters
Optional hit
Optional interactive
Optional interactive
is
is
meshes
Returns InstancedModel
Properties
_bounds
The bounds object, this is used to calculate and store the bounds of the displayObject.
+Protected _boundsID
Flags the cached bounds as dirty.
+Protected _bounds
Cache of this display-object's bounds-rectangle.
+Protected _destroyed
If the object has been destroyed via destroy(). If true, it should not be used.
+Protected _enabled
Currently enabled filters.
+Protected _height
Protected _last
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
Local bounds object, swapped with
+_boundswhen usinggetLocalBounds().Protected _local
Cache of this display-object's local-bounds rectangle.
+Protected _mask
The original, cached mask of the object.
+_tracked
Type declaration
[x: number]: InteractionTrackingData
Protected _width
Protected _z
The zIndex of the displayObject. +A higher value will mean it will be rendered on top of other displayObjects within the same container.
+alpha
The opacity of the object.
+button
Readonly children
The array of children of this container.
+container
Type declaration
Returns void
cull
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.
+cullable
Should this object be rendered if the bounds of this object are out of frame?
+Culling has no effect on whether updateTransform is called.
+cursor
display
Type declaration
Returns void
filter
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
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'.hit
interactive
interactive
is
Does any other displayObject use this object as a mask?
+is
Used to fast check if a sprite is.. a sprite!
+meshes
The meshes included in the model.
-Optional name
parent
renderable
sort
sortable
Optional tracked
Type declaration
[x: number]: InteractionTrackingData
transform
visible
world
Static prefixed
Accessors
Protected _temp
{PIXI.Container}
-Returns TemporaryDisplayObject
angle
name
parent
renderable
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.
+sort
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.
+sortable
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 @link https://github.com/pixijs/pixi-display
+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.
+PIXI.settings.SORTABLE_CHILDREN
+tracked
Type declaration
[x: number]: InteractionTrackingData
transform
visible
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.
+world
The multiplied alpha of the displayObject.
+Static prefixed
Accessors
Protected _temp
{PIXI.Container}
+Returns TemporaryDisplayObject
angle
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.
-{number}
-Returns 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.
-{number}
-Parameters
value: number
Returns void
height
The height of the Container, setting this will actually modify the scale to achieve the value set
-{number}
-Returns number
The height of the Container, setting this will actually modify the scale to achieve the value set
-{number}
-Parameters
value: number
Returns void
local
Returns Matrix4
mask
Parameters
value: number
Returns void
destroyed
Readonly flag for destroyed display objects.
+Returns boolean
height
The height of the Container, setting this will actually modify the scale to achieve the value set.
+Returns number
The height of the Container, setting this will actually modify the scale to achieve the value set.
+Parameters
value: number
Returns void
local
Returns Matrix4
mask
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
+utilities shape clipping. Furthermore, a mask of an object must be in the subtree of its parent. +Otherwise,null.getLocalBoundsmay calculate incorrect bounds, which makes the container's width and height wrong. +To remove a mask, set this property tonull.For sprite mask both alpha and red channel are used. Black mask is the same as transparent mask.
const graphics = new PIXI.Graphics(); graphics.beginFill(0xFF3300); @@ -34,12 +101,13 @@
const sprite = new PIXI.Sprite(texture); sprite.mask = graphics;
At the moment, PIXI.CanvasRenderer doesn't support PIXI.Sprite as mask.
-{PIXI.Container|PIXI.MaskData|null}
-Returns null | Container | MaskData
Returns null | Container<DisplayObject> | 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
+utilities shape clipping. Furthermore, a mask of an object must be in the subtree of its parent. +Otherwise,null.getLocalBoundsmay calculate incorrect bounds, which makes the container's width and height wrong. +To remove a mask, set this property tonull.For sprite mask both alpha and red channel are used. Black mask is the same as transparent mask.
const graphics = new PIXI.Graphics(); graphics.beginFill(0xFF3300); @@ -48,125 +116,121 @@
const sprite = new PIXI.Sprite(texture); sprite.mask = graphics;
At the moment, PIXI.CanvasRenderer doesn't support PIXI.Sprite as mask.
-{PIXI.Container|PIXI.MaskData|null}
-Parameters
value: null | Container | MaskData
Returns void
pivot
Parameters
value: null | Container<DisplayObject> | MaskData
Returns void
pivot
The center of rotation, scaling, and skewing for this display object in its local space. The
positionis the projection ofpivotin the parent's local space.By default, the pivot is the origin (0, 0).
-PixiJS 4
-{PIXI.ObservablePoint}
-Returns ObservablePoint<any>
4.0.0
+Returns ObservablePoint<any>
The center of rotation, scaling, and skewing for this display object in its local space. The
positionis the projection ofpivotin the parent's local space.By default, the pivot is the origin (0, 0).
-PixiJS 4
-{PIXI.ObservablePoint}
-Parameters
value: ObservablePoint<any>
Returns void
position
Returns ObservablePoint3D
Parameters
value: ObservablePoint3D
Returns void
rotation
4.0.0
+Parameters
value: IPointData
Returns void
position
Returns ObservablePoint3D
Parameters
value: ObservablePoint3D
Returns void
rotation
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.
-{number}
-Returns 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.
-{number}
-Parameters
value: number
Returns void
rotation
Parameters
value: number
Returns void
rotation
The quaternion rotation of the object.
-Returns ObservableQuaternion
Parameters
value: ObservableQuaternion
Returns void
scale
Returns ObservablePoint3D
Parameters
value: ObservablePoint3D
Returns void
skew
Returns ObservableQuaternion
Parameters
value: ObservableQuaternion
Returns void
scale
Returns ObservablePoint3D
Parameters
value: ObservablePoint3D
Returns void
skew
The skew factor for the object in radians.
-PixiJS 4
-{PIXI.ObservablePoint}
-Returns ObservablePoint<any>
4.0.0
+Returns ObservablePoint<any>
The skew factor for the object in radians.
-PixiJS 4
-{PIXI.ObservablePoint}
-Parameters
value: ObservablePoint<any>
Returns void
width
The width of the Container, setting this will actually modify the scale to achieve the value set
-{number}
-Returns number
The width of the Container, setting this will actually modify the scale to achieve the value set
-{number}
-Parameters
value: number
Returns void
world
Returns Matrix4
world
4.0.0
+Parameters
value: IPointData
Returns void
width
The width of the Container, setting this will actually modify the scale to achieve the value set.
+Returns number
The width of the Container, setting this will actually modify the scale to achieve the value set.
+Parameters
value: number
Returns void
world
Returns Matrix4
world
Indicates if the object is globally visible.
-{boolean}
-Returns boolean
x
Returns boolean
x
The position of the displayObject on the x axis relative to the local coordinates of the parent. An alias to position.x
-{number}
-Returns 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
-{number}
-Parameters
value: number
Returns void
y
Parameters
value: number
Returns void
y
The position of the displayObject on the y axis relative to the local coordinates of the parent. An alias to position.y
-{number}
-Returns 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
-{number}
-Parameters
value: number
Returns void
z
Parameters
value: number
Returns void
z
The position of the object on the z axis relative to the local coordinates of the parent.
-Returns number
Returns number
The position of the object on the z axis relative to the local coordinates of the parent.
-Parameters
value: number
Returns void
z
Parameters
value: number
Returns void
z
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.
-{number}
-PIXI.Container#sortableChildren
-Returns number
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.
-{number}
-PIXI.Container#sortableChildren
-Parameters
value: number
Returns void
Methods
Protected _calculate
PIXI.Container#sortableChildren
+Parameters
value: number
Returns void
Methods
Protected _calculate
Recalculates the content bounds of this object. This should be overriden to calculate the bounds of this specific object (not including children).
-Returns void
Protected _recursive
Recursively updates transform of all objects from the root to this one -internal function for toLocal()
-Returns void
Protected _render
Returns void
Protected _recursive
Recursively updates transform of all objects from the root to this one internal function for toLocal()
+Returns void
Protected _render
To be overridden by the subclasses.
-Parameters
_renderer: Renderer
Returns void
add
Parameters
_renderer: Renderer
The renderer
+Returns void
Protected _render
Renders this object and its children with culling.
+Parameters
renderer: Renderer
The renderer
+Returns void
add
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
Type parameters
U: DisplayObject[]
Parameters
Rest ...children: U
The DisplayObject(s) to add to the container
-Returns T[0]
The first child that was added.
-add
Returns U[0]
+- The first child that was added.
+
+add
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
Type parameters
U: DisplayObject<U>
Parameters
child: U
The child to add
index: number
The index to place the child in
-Returns T
The child that was added.
-add
Parameters
event: string | symbol
fn: ListenerFn
Optional context: any
Returns InstancedModel
calculate
Returns U
The child that was added.
+add
Parameters
event: string | symbol
fn: ListenerFn
Optional context: any
Returns InstancedModel
calculate
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
Returns void
destroy
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
disable
Parameters
Optional options: boolean | IDestroyOptions
Options parameter. A boolean will act as if all options + have been set to that value
+Returns void
disable
Pair method for
-enableTempParentParameters
cacheParent: DisplayObject
Parameters
cacheParent: Container<DisplayObject>
Actual parent of element
Returns void
emit
Calls each of the listeners registered for a given event.
-Parameters
event: string | symbol
Rest ...args: any[]
Returns boolean
enable
Parameters
event: string | symbol
Rest ...args: any[]
Returns boolean
enable
Used in Renderer, cacheAsBitmap and other places where you call an
-updateTransformon rootReturns DisplayObject
current parent
+Returns Container<DisplayObject>
+- current parent
+
event
Return an array listing the events for which the emitter has registered listeners.
-Returns (string | symbol)[]
get
Returns (string | symbol)[]
get
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 @@ -175,13 +239,11 @@
-displayObject._bounds.getRectangle()when traversing through all the bounds in a scene graph. Otherwise, callinggetBoundson 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 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
-_boundsobject stores the last calculation of the bounds. You can use to entirely skip bounds calculation if needed.Parameters
Optional skipUpdate: boolean
Optional rect: Rectangle
Returns Rectangle
The minimum axis-aligned rectangle in world space that fits around this object.
-get
Parameters
Optional skipUpdate: boolean
Setting to
+truewill 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.Optional rect: Rectangle
Optional rectangle to store the result of the bounds calculation.
+Returns Rectangle
+- The minimum axis-aligned rectangle in world space that fits around this object.
+
+get
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 get
Parameters
name: string
Optional isRecursive: boolean
Returns DisplayObject
get
Returns DisplayObject
+- The child at the given index, if any.
+
+get
Type parameters
T: DisplayObject<T> = DisplayObject
Parameters
name: string
Optional deep: boolean
Returns T
get
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
-get
Returns number
+- The index position of the child display object to identify
+
+get
Retrieves the local bounds of the displayObject as a rectangle object.
Calling
-getLocalBoundsmay invalidate the_boundsof the whole subtree below. If using it inside a render() call, it is advised to callgetBounds()immediately after to recalculate the world bounds of the subtree.Parameters
Optional rect: Rectangle
Optional skipChildrenUpdate: boolean
Returns Rectangle
The rectangular bounding area.
+Parameters
Optional rect: Rectangle
Optional rectangle to store the result of the bounds calculation.
+Optional skipChildrenUpdate: boolean
Setting to
+truewill stop re-calculation of children transforms, + it was default behaviour of pixi 4.0-5.2 and caused many problems to users.Returns Rectangle
+- The rectangular bounding area.
+
listener
Return the number of listeners listening to a given event.
Parameters
event: string | symbol
Returns number
listeners
Return the listeners registered for a given event.
Parameters
event: string | symbol
Returns ListenerFn[]
off
Parameters
event: string | symbol
Optional fn: ListenerFn
Optional context: any
Optional once: boolean
Returns InstancedModel
on
Add a listener for a given event.
-Parameters
event: string | symbol
fn: ListenerFn
Optional context: any
Returns InstancedModel
Protected on
Overridable method that can be used by Container subclasses whenever the children array is modified
-Parameters
Optional _length: number
Returns void
once
Parameters
event: string | symbol
fn: ListenerFn
Optional context: any
Returns InstancedModel
Protected on
Overridable method that can be used by Container subclasses whenever the children array is modified.
+Parameters
Optional _length: number
Returns void
once
Add a one-time listener for a given event.
Parameters
event: string | symbol
fn: ListenerFn
Optional context: any
Returns InstancedModel
remove
Remove all listeners, or those of the specified event.
-Parameters
Optional event: string | symbol
Returns InstancedModel
remove
Parameters
Optional event: string | symbol
Returns InstancedModel
remove
Removes one or more children from the container.
-Type parameters
T: DisplayObject[]
Parameters
Rest ...children: T
Type parameters
U: DisplayObject[]
Parameters
Rest ...children: U
The DisplayObject(s) to remove
-Returns T[0]
The first child that was removed.
-remove
Returns U[0]
The first child that was removed.
+remove
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.
-remove
remove
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
+Parameters
Optional beginIndex: number
The beginning position.
+Optional endIndex: number
The ending position. Default value is size of the container.
+Returns DisplayObject[]
+- List of removed children
+
remove
Remove the listeners of a given event.
-Parameters
event: string | symbol
Optional fn: ListenerFn
Optional context: any
Optional once: boolean
Returns InstancedModel
render
Parameters
event: string | symbol
Optional fn: ListenerFn
Optional context: any
Optional once: boolean
Returns InstancedModel
render
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
-rendermethod will invoke it, and also invoke therendermethods of all children afterward.If
renderableorvisibleis false or ifworldAlphais not positive, this implementation will entirely -skip rendering. See {@link PIXI.DisplayObject} for choosing betweenrenderableorvisible. Generally, +If
renderableorvisibleis false or ifworldAlphais not positive or ifcullableis true and +the bounds of this object are out of frame, this implementation will entirely skip rendering. +See {@link PIXI.DisplayObject} for choosing betweenrenderableorvisible. 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 +advised to employ culling to automatically skip rendering objects outside of the current screen. +See [cullable]{@link PIXI.DisplayObject#cullable} and [cullArea]{@link PIXI.DisplayObject#cullArea}. +Other culling methods might be better suited for a large number static objects; see @pixi-essentials/cull and -pixi-cull packages do this out of the box.
+pixi-cull.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 render
Returns void
Protected render
Render the object using the WebGL renderer and advanced features.
Parameters
renderer: Renderer
The renderer
-Returns void
set
Returns void
set
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
set
Returns void
set
Set the parent Container of this DisplayObject.
-Parameters
container: Container
Parameters
container: Container<DisplayObject>
The Container to add this DisplayObject to.
-Returns Container
The Container that this DisplayObject was added to.
-set
Returns Container<DisplayObject>
+- The Container that this DisplayObject was added to.
+
+set
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 InstancedModel
The DisplayObject instance
-sort
Parameters
Optional x: number
The X position
+Optional y: number
The Y position
+Optional scaleX: number
The X scale value
+Optional scaleY: number
The Y scale value
+Optional rotation: number
The rotation
+Optional skewX: number
The X skew value
+Optional skewY: number
The Y skew value
+Optional pivotX: number
The X pivot value
+Optional pivotY: number
The Y pivot value
+Returns InstancedModel
+- The DisplayObject instance
+
+sort
Sorts children by zIndex. Previous order is maintained for 2 children with the same zIndex.
-Returns void
swap
Returns void
swap
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
to
Returns void
to
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.
-to
Optional point: P
A Point object in which to store the value, optional + (otherwise will create a new Point).
+Optional skipUpdate: boolean
Should we skip the update transform.
+Returns P
+- A point object representing the position of this object.
+
+to
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
-update
Updates the transform on all children of this container for rendering
-Returns void
Static mixin
Optional from: DisplayObject
The DisplayObject to calculate the global position from.
+Optional point: P
A Point object in which to store the value, optional + (otherwise will create a new Point).
+Optional skipUpdate: boolean
Should we skip the update transform
+Returns P
+- A point object representing the position of this object
+
+update
Updates the transform on all children of this container for rendering.
+Returns void
Static mixin
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
Returns void
Generated using TypeDoc
- Preparing search index...
- The search index is not available
Pixi3D - v1.5.1Class InstancedStandardMaterial
- Preparing search index...
- The search index is not available
Pixi3D - v1.6.0Class InstancedStandardMaterial
Material for instanced meshes which uses the standard material.
-Hierarchy
Index
Constructors
Properties
Constructors
constructor
Hierarchy
Index
Constructors
Properties
Constructors
constructor
Creates a new instanced standard material from the specified material.
-Parameters
material: StandardMaterial
Returns InstancedStandardMaterial
Properties
base
Parameters
material: StandardMaterial
Returns InstancedStandardMaterial
Properties
base
The base color of the material.
Generated using TypeDoc
- Preparing search index...
- The search index is not available
Pixi3D - v1.5.1Class Joint
- Preparing search index...
- The search index is not available
Pixi3D - v1.6.0Class Joint
Represents a joint used for vertex skinning.
-Hierarchy
Index
Constructors
Properties
Accessors
Methods
Constructors
constructor
Hierarchy
Index
Constructors
Properties
Accessors
Methods
Constructors
constructor
Creates a new joint.
Parameters
inverseBindMatrix: Float32Array
The inverse of the global transform matrix.
-Returns Joint
Properties
_bounds
Protected _boundsID
Protected _bounds
Protected _destroyed
Protected _enabled
Protected _height
_last
_local
Protected _local
_mask
Optional _tracked
Type declaration
[x: number]: InteractionTrackingData
Protected _width
Protected _z
alpha
Optional button
Readonly children
container
Type declaration
Returns void
Optional cursor
display
Type declaration
Returns void
filter
filters
Optional hit
Optional interactive
Optional interactive
Readonly inverse
is
is
Optional name
parent
renderable
sort
sortable
Optional tracked
Type declaration
[x: number]: InteractionTrackingData
transform
visible
world
Static prefixed
Accessors
Protected _temp
{PIXI.Container}
-Returns TemporaryDisplayObject
angle
Returns Joint
Properties
_bounds
The bounds object, this is used to calculate and store the bounds of the displayObject.
+Protected _boundsID
Flags the cached bounds as dirty.
+Protected _bounds
Cache of this display-object's bounds-rectangle.
+Protected _destroyed
If the object has been destroyed via destroy(). If true, it should not be used.
+Protected _enabled
Currently enabled filters.
+Protected _height
Protected _last
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
Local bounds object, swapped with
+_boundswhen usinggetLocalBounds().Protected _local
Cache of this display-object's local-bounds rectangle.
+Protected _mask
The original, cached mask of the object.
+_tracked
Type declaration
[x: number]: InteractionTrackingData
Protected _width
Protected _z
The zIndex of the displayObject. +A higher value will mean it will be rendered on top of other displayObjects within the same container.
+alpha
The opacity of the object.
+button
Readonly children
The array of children of this container.
+container
Type declaration
Returns void
cull
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.
+cullable
Should this object be rendered if the bounds of this object are out of frame?
+Culling has no effect on whether updateTransform is called.
+cursor
display
Type declaration
Returns void
filter
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
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'.hit
interactive
interactive
Readonly inverse
is
Does any other displayObject use this object as a mask?
+is
Used to fast check if a sprite is.. a sprite!
+name
parent
renderable
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.
+sort
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.
+sortable
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 @link https://github.com/pixijs/pixi-display
+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.
+PIXI.settings.SORTABLE_CHILDREN
+tracked
Type declaration
[x: number]: InteractionTrackingData
transform
visible
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.
+world
The multiplied alpha of the displayObject.
+Static prefixed
Accessors
Protected _temp
{PIXI.Container}
+Returns TemporaryDisplayObject
angle
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.
-{number}
-Returns 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.
-{number}
-Parameters
value: number
Returns void
height
The height of the Container, setting this will actually modify the scale to achieve the value set
-{number}
-Returns number
The height of the Container, setting this will actually modify the scale to achieve the value set
-{number}
-Parameters
value: number
Returns void
local
Returns Matrix4
mask
Parameters
value: number
Returns void
destroyed
Readonly flag for destroyed display objects.
+Returns boolean
height
The height of the Container, setting this will actually modify the scale to achieve the value set.
+Returns number
The height of the Container, setting this will actually modify the scale to achieve the value set.
+Parameters
value: number
Returns void
local
Returns Matrix4
mask
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
+utilities shape clipping. Furthermore, a mask of an object must be in the subtree of its parent. +Otherwise,null.getLocalBoundsmay calculate incorrect bounds, which makes the container's width and height wrong. +To remove a mask, set this property tonull.For sprite mask both alpha and red channel are used. Black mask is the same as transparent mask.
const graphics = new PIXI.Graphics(); graphics.beginFill(0xFF3300); @@ -32,12 +99,13 @@
const sprite = new PIXI.Sprite(texture); sprite.mask = graphics;
At the moment, PIXI.CanvasRenderer doesn't support PIXI.Sprite as mask.
-{PIXI.Container|PIXI.MaskData|null}
-Returns null | Container | MaskData
Returns null | Container<DisplayObject> | 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
+utilities shape clipping. Furthermore, a mask of an object must be in the subtree of its parent. +Otherwise,null.getLocalBoundsmay calculate incorrect bounds, which makes the container's width and height wrong. +To remove a mask, set this property tonull.For sprite mask both alpha and red channel are used. Black mask is the same as transparent mask.
const graphics = new PIXI.Graphics(); graphics.beginFill(0xFF3300); @@ -46,125 +114,121 @@
const sprite = new PIXI.Sprite(texture); sprite.mask = graphics;
At the moment, PIXI.CanvasRenderer doesn't support PIXI.Sprite as mask.
-{PIXI.Container|PIXI.MaskData|null}
-Parameters
value: null | Container | MaskData
Returns void
pivot
Parameters
value: null | Container<DisplayObject> | MaskData
Returns void
pivot
The center of rotation, scaling, and skewing for this display object in its local space. The
positionis the projection ofpivotin the parent's local space.By default, the pivot is the origin (0, 0).
-PixiJS 4
-{PIXI.ObservablePoint}
-Returns ObservablePoint<any>
4.0.0
+Returns ObservablePoint<any>
The center of rotation, scaling, and skewing for this display object in its local space. The
positionis the projection ofpivotin the parent's local space.By default, the pivot is the origin (0, 0).
-PixiJS 4
-{PIXI.ObservablePoint}
-Parameters
value: ObservablePoint<any>
Returns void
position
Returns ObservablePoint3D
Parameters
value: ObservablePoint3D
Returns void
rotation
4.0.0
+Parameters
value: IPointData
Returns void
position
Returns ObservablePoint3D
Parameters
value: ObservablePoint3D
Returns void
rotation
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.
-{number}
-Returns 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.
-{number}
-Parameters
value: number
Returns void
rotation
Parameters
value: number
Returns void
rotation
The quaternion rotation of the object.
-Returns ObservableQuaternion
Parameters
value: ObservableQuaternion
Returns void
scale
Returns ObservablePoint3D
Parameters
value: ObservablePoint3D
Returns void
skew
Returns ObservableQuaternion
Parameters
value: ObservableQuaternion
Returns void
scale
Returns ObservablePoint3D
Parameters
value: ObservablePoint3D
Returns void
skew
The skew factor for the object in radians.
-PixiJS 4
-{PIXI.ObservablePoint}
-Returns ObservablePoint<any>
4.0.0
+Returns ObservablePoint<any>
The skew factor for the object in radians.
-PixiJS 4
-{PIXI.ObservablePoint}
-Parameters
value: ObservablePoint<any>
Returns void
width
The width of the Container, setting this will actually modify the scale to achieve the value set
-{number}
-Returns number
The width of the Container, setting this will actually modify the scale to achieve the value set
-{number}
-Parameters
value: number
Returns void
world
Returns Matrix4
world
4.0.0
+Parameters
value: IPointData
Returns void
width
The width of the Container, setting this will actually modify the scale to achieve the value set.
+Returns number
The width of the Container, setting this will actually modify the scale to achieve the value set.
+Parameters
value: number
Returns void
world
Returns Matrix4
world
Indicates if the object is globally visible.
-{boolean}
-Returns boolean
x
Returns boolean
x
The position of the displayObject on the x axis relative to the local coordinates of the parent. An alias to position.x
-{number}
-Returns 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
-{number}
-Parameters
value: number
Returns void
y
Parameters
value: number
Returns void
y
The position of the displayObject on the y axis relative to the local coordinates of the parent. An alias to position.y
-{number}
-Returns 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
-{number}
-Parameters
value: number
Returns void
z
Parameters
value: number
Returns void
z
The position of the object on the z axis relative to the local coordinates of the parent.
-Returns number
Returns number
The position of the object on the z axis relative to the local coordinates of the parent.
-Parameters
value: number
Returns void
z
Parameters
value: number
Returns void
z
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.
-{number}
-PIXI.Container#sortableChildren
-Returns number
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.
-{number}
-PIXI.Container#sortableChildren
-Parameters
value: number
Returns void
Methods
Protected _calculate
PIXI.Container#sortableChildren
+Parameters
value: number
Returns void
Methods
Protected _calculate
Recalculates the content bounds of this object. This should be overriden to calculate the bounds of this specific object (not including children).
-Returns void
Protected _recursive
Recursively updates transform of all objects from the root to this one -internal function for toLocal()
-Returns void
Protected _render
Returns void
Protected _recursive
Recursively updates transform of all objects from the root to this one internal function for toLocal()
+Returns void
Protected _render
To be overridden by the subclasses.
-Parameters
_renderer: Renderer
Returns void
add
Parameters
_renderer: Renderer
The renderer
+Returns void
Protected _render
Renders this object and its children with culling.
+Parameters
renderer: Renderer
The renderer
+Returns void
add
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
Type parameters
U: DisplayObject[]
Parameters
Rest ...children: U
The DisplayObject(s) to add to the container
-Returns T[0]
The first child that was added.
-add
Returns U[0]
+- The first child that was added.
+
+add
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
Type parameters
U: DisplayObject<U>
Parameters
child: U
The child to add
index: number
The index to place the child in
-Returns T
The child that was added.
-add
Parameters
event: string | symbol
fn: ListenerFn
Optional context: any
Returns Joint
calculate
Returns U
The child that was added.
+add
Parameters
event: string | symbol
fn: ListenerFn
Optional context: any
Returns Joint
calculate
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
Returns void
destroy
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
disable
Parameters
Optional options: boolean | IDestroyOptions
Options parameter. A boolean will act as if all options + have been set to that value
+Returns void
disable
Pair method for
-enableTempParentParameters
cacheParent: DisplayObject
Parameters
cacheParent: Container<DisplayObject>
Actual parent of element
Returns void
emit
Calls each of the listeners registered for a given event.
-Parameters
event: string | symbol
Rest ...args: any[]
Returns boolean
enable
Parameters
event: string | symbol
Rest ...args: any[]
Returns boolean
enable
Used in Renderer, cacheAsBitmap and other places where you call an
-updateTransformon rootReturns DisplayObject
current parent
+Returns Container<DisplayObject>
+- current parent
+
event
Return an array listing the events for which the emitter has registered listeners.
-Returns (string | symbol)[]
get
Returns (string | symbol)[]
get
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 @@ -173,13 +237,11 @@
-displayObject._bounds.getRectangle()when traversing through all the bounds in a scene graph. Otherwise, callinggetBoundson 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 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
-_boundsobject stores the last calculation of the bounds. You can use to entirely skip bounds calculation if needed.Parameters
Optional skipUpdate: boolean
Optional rect: Rectangle
Returns Rectangle
The minimum axis-aligned rectangle in world space that fits around this object.
-get
Parameters
Optional skipUpdate: boolean
Setting to
+truewill 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.Optional rect: Rectangle
Optional rectangle to store the result of the bounds calculation.
+Returns Rectangle
+- The minimum axis-aligned rectangle in world space that fits around this object.
+
+get
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 get
Parameters
name: string
Optional isRecursive: boolean
Returns DisplayObject
get
Returns DisplayObject
+- The child at the given index, if any.
+
+get
Type parameters
T: DisplayObject<T> = DisplayObject
Parameters
name: string
Optional deep: boolean
Returns T
get
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
-get
Returns number
+- The index position of the child display object to identify
+
+get
Retrieves the local bounds of the displayObject as a rectangle object.
Calling
-getLocalBoundsmay invalidate the_boundsof the whole subtree below. If using it inside a render() call, it is advised to callgetBounds()immediately after to recalculate the world bounds of the subtree.Parameters
Optional rect: Rectangle
Optional skipChildrenUpdate: boolean
Returns Rectangle
The rectangular bounding area.
+Parameters
Optional rect: Rectangle
Optional rectangle to store the result of the bounds calculation.
+Optional skipChildrenUpdate: boolean
Setting to
+truewill stop re-calculation of children transforms, + it was default behaviour of pixi 4.0-5.2 and caused many problems to users.Returns Rectangle
+- The rectangular bounding area.
+
listener
Return the number of listeners listening to a given event.
Parameters
event: string | symbol
Returns number
listeners
Return the listeners registered for a given event.
Parameters
event: string | symbol
Returns ListenerFn[]
off
Parameters
event: string | symbol
Optional fn: ListenerFn
Optional context: any
Optional once: boolean
Returns Joint
on
Add a listener for a given event.
-Parameters
event: string | symbol
fn: ListenerFn
Optional context: any
Returns Joint
Protected on
Overridable method that can be used by Container subclasses whenever the children array is modified
-Parameters
Optional _length: number
Returns void
once
Parameters
event: string | symbol
fn: ListenerFn
Optional context: any
Returns Joint
Protected on
Overridable method that can be used by Container subclasses whenever the children array is modified.
+Parameters
Optional _length: number
Returns void
once
Add a one-time listener for a given event.
Parameters
event: string | symbol
fn: ListenerFn
Optional context: any
Returns Joint
remove
Remove all listeners, or those of the specified event.
-Parameters
Optional event: string | symbol
Returns Joint
remove
Parameters
Optional event: string | symbol
Returns Joint
remove
Removes one or more children from the container.
-Type parameters
T: DisplayObject[]
Parameters
Rest ...children: T
Type parameters
U: DisplayObject[]
Parameters
Rest ...children: U
The DisplayObject(s) to remove
-Returns T[0]
The first child that was removed.
-remove
Returns U[0]
The first child that was removed.
+remove
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.
-remove
remove
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
+Parameters
Optional beginIndex: number
The beginning position.
+Optional endIndex: number
The ending position. Default value is size of the container.
+Returns DisplayObject[]
+- List of removed children
+
remove
Remove the listeners of a given event.
-Parameters
event: string | symbol
Optional fn: ListenerFn
Optional context: any
Optional once: boolean
Returns Joint
render
Parameters
event: string | symbol
Optional fn: ListenerFn
Optional context: any
Optional once: boolean
Returns Joint
render
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
-rendermethod will invoke it, and also invoke therendermethods of all children afterward.If
renderableorvisibleis false or ifworldAlphais not positive, this implementation will entirely -skip rendering. See {@link PIXI.DisplayObject} for choosing betweenrenderableorvisible. Generally, +If
renderableorvisibleis false or ifworldAlphais not positive or ifcullableis true and +the bounds of this object are out of frame, this implementation will entirely skip rendering. +See {@link PIXI.DisplayObject} for choosing betweenrenderableorvisible. 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 +advised to employ culling to automatically skip rendering objects outside of the current screen. +See [cullable]{@link PIXI.DisplayObject#cullable} and [cullArea]{@link PIXI.DisplayObject#cullArea}. +Other culling methods might be better suited for a large number static objects; see @pixi-essentials/cull and -pixi-cull packages do this out of the box.
+pixi-cull.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 render
Returns void
Protected render
Render the object using the WebGL renderer and advanced features.
Parameters
renderer: Renderer
The renderer
-Returns void
set
Returns void
set
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
set
Returns void
set
Set the parent Container of this DisplayObject.
-Parameters
container: Container
Parameters
container: Container<DisplayObject>
The Container to add this DisplayObject to.
-Returns Container
The Container that this DisplayObject was added to.
-set
Returns Container<DisplayObject>
+- The Container that this DisplayObject was added to.
+
+set
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 Joint
The DisplayObject instance
-sort
Parameters
Optional x: number
The X position
+Optional y: number
The Y position
+Optional scaleX: number
The X scale value
+Optional scaleY: number
The Y scale value
+Optional rotation: number
The rotation
+Optional skewX: number
The X skew value
+Optional skewY: number
The Y skew value
+Optional pivotX: number
The X pivot value
+Optional pivotY: number
The Y pivot value
+Returns Joint
+- The DisplayObject instance
+
+sort
Sorts children by zIndex. Previous order is maintained for 2 children with the same zIndex.
-Returns void
swap
Returns void
swap
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
to
Returns void
to
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.
-to
Optional point: P
A Point object in which to store the value, optional + (otherwise will create a new Point).
+Optional skipUpdate: boolean
Should we skip the update transform.
+Returns P
+- A point object representing the position of this object.
+
+to
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
-update
Updates the transform on all children of this container for rendering
-Returns void
Static mixin
Optional from: DisplayObject
The DisplayObject to calculate the global position from.
+Optional point: P
A Point object in which to store the value, optional + (otherwise will create a new Point).
+Optional skipUpdate: boolean
Should we skip the update transform
+Returns P
+- A point object representing the position of this object
+
+update
Updates the transform on all children of this container for rendering.
+Returns void
Static mixin
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
Returns void
Generated using TypeDoc
- Preparing search index...
- The search index is not available
Pixi3D - v1.5.1Class Light
Hierarchy
Index
Constructors
Properties
Accessors
Methods
Constructors
constructor
Returns Light
Properties
_bounds
Protected _boundsID
Protected _bounds
Protected _destroyed
Protected _enabled
Protected _height
_last
_local
Protected _local
_mask
Optional _tracked
Type declaration
[x: number]: InteractionTrackingData
Protected _width
Protected _z
alpha
Optional button
Readonly children
color
- Preparing search index...
- The search index is not available
Pixi3D - v1.6.0Class Light
Hierarchy
Index
Constructors
Properties
Accessors
Methods
Constructors
constructor
Returns Light
Properties
_bounds
The bounds object, this is used to calculate and store the bounds of the displayObject.
+Protected _boundsID
Flags the cached bounds as dirty.
+Protected _bounds
Cache of this display-object's bounds-rectangle.
+Protected _destroyed
If the object has been destroyed via destroy(). If true, it should not be used.
+Protected _enabled
Currently enabled filters.
+Protected _height
Protected _last
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
Local bounds object, swapped with
+_boundswhen usinggetLocalBounds().Protected _local
Cache of this display-object's local-bounds rectangle.
+Protected _mask
The original, cached mask of the object.
+_tracked
Type declaration
[x: number]: InteractionTrackingData
Protected _width
Protected _z
The zIndex of the displayObject. +A higher value will mean it will be rendered on top of other displayObjects within the same container.
+alpha
The opacity of the object.
+button
Readonly children
The array of children of this container.
+color
The color of the light.
-container
Type declaration
Returns void
Optional cursor
display
Type declaration
Returns void
filter
filters
Optional hit
inner
container
Type declaration
Returns void
cull
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.
+cullable
Should this object be rendered if the bounds of this object are out of frame?
+Culling has no effect on whether updateTransform is called.
+cursor
display
Type declaration
Returns void
filter
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
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'.hit
inner
The inner cone angle specified in degrees.
-intensity
intensity
The intensity of the light.
-Optional interactive
Optional interactive
is
is
Optional name
outer
interactive
interactive
is
Does any other displayObject use this object as a mask?
+is
Used to fast check if a sprite is.. a sprite!
+name
outer
The outer cone angle specified in degrees.
-parent
range
parent
range
The range of the light.
-renderable
sort
sortable
Optional tracked
Type declaration
[x: number]: InteractionTrackingData
transform
type
renderable
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.
+sort
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.
+sortable
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 @link https://github.com/pixijs/pixi-display
+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.
+PIXI.settings.SORTABLE_CHILDREN
+tracked
Type declaration
[x: number]: InteractionTrackingData
transform
type
The type of the light.
-visible
world
Static prefixed
Accessors
Protected _temp
{PIXI.Container}
-Returns TemporaryDisplayObject
angle
visible
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.
+world
The multiplied alpha of the displayObject.
+Static prefixed
Accessors
Protected _temp
{PIXI.Container}
+Returns TemporaryDisplayObject
angle
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.
-{number}
-Returns 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.
-{number}
-Parameters
value: number
Returns void
height
The height of the Container, setting this will actually modify the scale to achieve the value set
-{number}
-Returns number
The height of the Container, setting this will actually modify the scale to achieve the value set
-{number}
-Parameters
value: number
Returns void
local
Returns Matrix4
mask
Parameters
value: number
Returns void
destroyed
Readonly flag for destroyed display objects.
+Returns boolean
height
The height of the Container, setting this will actually modify the scale to achieve the value set.
+Returns number
The height of the Container, setting this will actually modify the scale to achieve the value set.
+Parameters
value: number
Returns void
local
Returns Matrix4
mask
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
+utilities shape clipping. Furthermore, a mask of an object must be in the subtree of its parent. +Otherwise,null.getLocalBoundsmay calculate incorrect bounds, which makes the container's width and height wrong. +To remove a mask, set this property tonull.For sprite mask both alpha and red channel are used. Black mask is the same as transparent mask.
const graphics = new PIXI.Graphics(); graphics.beginFill(0xFF3300); @@ -38,12 +105,13 @@
const sprite = new PIXI.Sprite(texture); sprite.mask = graphics;
At the moment, PIXI.CanvasRenderer doesn't support PIXI.Sprite as mask.
-{PIXI.Container|PIXI.MaskData|null}
-Returns null | Container | MaskData
Returns null | Container<DisplayObject> | 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
+utilities shape clipping. Furthermore, a mask of an object must be in the subtree of its parent. +Otherwise,null.getLocalBoundsmay calculate incorrect bounds, which makes the container's width and height wrong. +To remove a mask, set this property tonull.For sprite mask both alpha and red channel are used. Black mask is the same as transparent mask.
const graphics = new PIXI.Graphics(); graphics.beginFill(0xFF3300); @@ -52,125 +120,121 @@
const sprite = new PIXI.Sprite(texture); sprite.mask = graphics;
At the moment, PIXI.CanvasRenderer doesn't support PIXI.Sprite as mask.
-{PIXI.Container|PIXI.MaskData|null}
-Parameters
value: null | Container | MaskData
Returns void
pivot
Parameters
value: null | Container<DisplayObject> | MaskData
Returns void
pivot
The center of rotation, scaling, and skewing for this display object in its local space. The
positionis the projection ofpivotin the parent's local space.By default, the pivot is the origin (0, 0).
-PixiJS 4
-{PIXI.ObservablePoint}
-Returns ObservablePoint<any>
4.0.0
+Returns ObservablePoint<any>
The center of rotation, scaling, and skewing for this display object in its local space. The
positionis the projection ofpivotin the parent's local space.By default, the pivot is the origin (0, 0).
-PixiJS 4
-{PIXI.ObservablePoint}
-Parameters
value: ObservablePoint<any>
Returns void
position
Returns ObservablePoint3D
Parameters
value: ObservablePoint3D
Returns void
rotation
4.0.0
+Parameters
value: IPointData
Returns void
position
Returns ObservablePoint3D
Parameters
value: ObservablePoint3D
Returns void
rotation
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.
-{number}
-Returns 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.
-{number}
-Parameters
value: number
Returns void
rotation
Parameters
value: number
Returns void
rotation
The quaternion rotation of the object.
-Returns ObservableQuaternion
Parameters
value: ObservableQuaternion
Returns void
scale
Returns ObservablePoint3D
Parameters
value: ObservablePoint3D
Returns void
skew
Returns ObservableQuaternion
Parameters
value: ObservableQuaternion
Returns void
scale
Returns ObservablePoint3D
Parameters
value: ObservablePoint3D
Returns void
skew
The skew factor for the object in radians.
-PixiJS 4
-{PIXI.ObservablePoint}
-Returns ObservablePoint<any>
4.0.0
+Returns ObservablePoint<any>
The skew factor for the object in radians.
-PixiJS 4
-{PIXI.ObservablePoint}
-Parameters
value: ObservablePoint<any>
Returns void
width
The width of the Container, setting this will actually modify the scale to achieve the value set
-{number}
-Returns number
The width of the Container, setting this will actually modify the scale to achieve the value set
-{number}
-Parameters
value: number
Returns void
world
Returns Matrix4
world
4.0.0
+Parameters
value: IPointData
Returns void
width
The width of the Container, setting this will actually modify the scale to achieve the value set.
+Returns number
The width of the Container, setting this will actually modify the scale to achieve the value set.
+Parameters
value: number
Returns void
world
Returns Matrix4
world
Indicates if the object is globally visible.
-{boolean}
-Returns boolean
x
Returns boolean
x
The position of the displayObject on the x axis relative to the local coordinates of the parent. An alias to position.x
-{number}
-Returns 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
-{number}
-Parameters
value: number
Returns void
y
Parameters
value: number
Returns void
y
The position of the displayObject on the y axis relative to the local coordinates of the parent. An alias to position.y
-{number}
-Returns 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
-{number}
-Parameters
value: number
Returns void
z
Parameters
value: number
Returns void
z
The position of the object on the z axis relative to the local coordinates of the parent.
-Returns number
Returns number
The position of the object on the z axis relative to the local coordinates of the parent.
-Parameters
value: number
Returns void
z
Parameters
value: number
Returns void
z
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.
-{number}
-PIXI.Container#sortableChildren
-Returns number
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.
-{number}
-PIXI.Container#sortableChildren
-Parameters
value: number
Returns void
Methods
Protected _calculate
PIXI.Container#sortableChildren
+Parameters
value: number
Returns void
Methods
Protected _calculate
Recalculates the content bounds of this object. This should be overriden to calculate the bounds of this specific object (not including children).
-Returns void
Protected _recursive
Recursively updates transform of all objects from the root to this one -internal function for toLocal()
-Returns void
Protected _render
Returns void
Protected _recursive
Recursively updates transform of all objects from the root to this one internal function for toLocal()
+Returns void
Protected _render
To be overridden by the subclasses.
-Parameters
_renderer: Renderer
Returns void
add
Parameters
_renderer: Renderer
The renderer
+Returns void
Protected _render
Renders this object and its children with culling.
+Parameters
renderer: Renderer
The renderer
+Returns void
add
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
Type parameters
U: DisplayObject[]
Parameters
Rest ...children: U
The DisplayObject(s) to add to the container
-Returns T[0]
The first child that was added.
-add
Returns U[0]
+- The first child that was added.
+
+add
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
Type parameters
U: DisplayObject<U>
Parameters
child: U
The child to add
index: number
The index to place the child in
-Returns T
The child that was added.
-add
Parameters
event: string | symbol
fn: ListenerFn
Optional context: any
Returns Light
calculate
Returns U
The child that was added.
+add
Parameters
event: string | symbol
fn: ListenerFn
Optional context: any
Returns Light
calculate
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
Returns void
destroy
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
disable
Parameters
Optional options: boolean | IDestroyOptions
Options parameter. A boolean will act as if all options + have been set to that value
+Returns void
disable
Pair method for
-enableTempParentParameters
cacheParent: DisplayObject
Parameters
cacheParent: Container<DisplayObject>
Actual parent of element
Returns void
emit
Calls each of the listeners registered for a given event.
-Parameters
event: string | symbol
Rest ...args: any[]
Returns boolean
enable
Parameters
event: string | symbol
Rest ...args: any[]
Returns boolean
enable
Used in Renderer, cacheAsBitmap and other places where you call an
-updateTransformon rootReturns DisplayObject
current parent
+Returns Container<DisplayObject>
+- current parent
+
event
Return an array listing the events for which the emitter has registered listeners.
-Returns (string | symbol)[]
get
Returns (string | symbol)[]
get
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 @@ -179,13 +243,11 @@
-displayObject._bounds.getRectangle()when traversing through all the bounds in a scene graph. Otherwise, callinggetBoundson 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 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
-_boundsobject stores the last calculation of the bounds. You can use to entirely skip bounds calculation if needed.Parameters
Optional skipUpdate: boolean
Optional rect: Rectangle
Returns Rectangle
The minimum axis-aligned rectangle in world space that fits around this object.
-get
Parameters
Optional skipUpdate: boolean
Setting to
+truewill 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.Optional rect: Rectangle
Optional rectangle to store the result of the bounds calculation.
+Returns Rectangle
+- The minimum axis-aligned rectangle in world space that fits around this object.
+
+get
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 get
Parameters
name: string
Optional isRecursive: boolean
Returns DisplayObject
get
Returns DisplayObject
+- The child at the given index, if any.
+
+get
Type parameters
T: DisplayObject<T> = DisplayObject
Parameters
name: string
Optional deep: boolean
Returns T
get
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
-get
Returns number
+- The index position of the child display object to identify
+
+get
Retrieves the local bounds of the displayObject as a rectangle object.
Calling
-getLocalBoundsmay invalidate the_boundsof the whole subtree below. If using it inside a render() call, it is advised to callgetBounds()immediately after to recalculate the world bounds of the subtree.Parameters
Optional rect: Rectangle
Optional skipChildrenUpdate: boolean
Returns Rectangle
The rectangular bounding area.
+Parameters
Optional rect: Rectangle
Optional rectangle to store the result of the bounds calculation.
+Optional skipChildrenUpdate: boolean
Setting to
+truewill stop re-calculation of children transforms, + it was default behaviour of pixi 4.0-5.2 and caused many problems to users.Returns Rectangle
+- The rectangular bounding area.
+
listener
Return the number of listeners listening to a given event.
Parameters
event: string | symbol
Returns number
listeners
Return the listeners registered for a given event.
Parameters
event: string | symbol
Returns ListenerFn[]
off
Parameters
event: string | symbol
Optional fn: ListenerFn
Optional context: any
Optional once: boolean
Returns Light
on
Add a listener for a given event.
-Parameters
event: string | symbol
fn: ListenerFn
Optional context: any
Returns Light
Protected on
Overridable method that can be used by Container subclasses whenever the children array is modified
-Parameters
Optional _length: number
Returns void
once
Parameters
event: string | symbol
fn: ListenerFn
Optional context: any
Returns Light
Protected on
Overridable method that can be used by Container subclasses whenever the children array is modified.
+Parameters
Optional _length: number
Returns void
once
Add a one-time listener for a given event.
Parameters
event: string | symbol
fn: ListenerFn
Optional context: any
Returns Light
remove
Remove all listeners, or those of the specified event.
-Parameters
Optional event: string | symbol
Returns Light
remove
Parameters
Optional event: string | symbol
Returns Light
remove
Removes one or more children from the container.
-Type parameters
T: DisplayObject[]
Parameters
Rest ...children: T
Type parameters
U: DisplayObject[]
Parameters
Rest ...children: U
The DisplayObject(s) to remove
-Returns T[0]
The first child that was removed.
-remove
Returns U[0]
The first child that was removed.
+remove
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.
-remove
remove
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
+Parameters
Optional beginIndex: number
The beginning position.
+Optional endIndex: number
The ending position. Default value is size of the container.
+Returns DisplayObject[]
+- List of removed children
+
remove
Remove the listeners of a given event.
-Parameters
event: string | symbol
Optional fn: ListenerFn
Optional context: any
Optional once: boolean
Returns Light
render
Parameters
event: string | symbol
Optional fn: ListenerFn
Optional context: any
Optional once: boolean
Returns Light
render
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
-rendermethod will invoke it, and also invoke therendermethods of all children afterward.If
renderableorvisibleis false or ifworldAlphais not positive, this implementation will entirely -skip rendering. See {@link PIXI.DisplayObject} for choosing betweenrenderableorvisible. Generally, +If
renderableorvisibleis false or ifworldAlphais not positive or ifcullableis true and +the bounds of this object are out of frame, this implementation will entirely skip rendering. +See {@link PIXI.DisplayObject} for choosing betweenrenderableorvisible. 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 +advised to employ culling to automatically skip rendering objects outside of the current screen. +See [cullable]{@link PIXI.DisplayObject#cullable} and [cullArea]{@link PIXI.DisplayObject#cullArea}. +Other culling methods might be better suited for a large number static objects; see @pixi-essentials/cull and -pixi-cull packages do this out of the box.
+pixi-cull.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 render
Returns void
Protected render
Render the object using the WebGL renderer and advanced features.
Parameters
renderer: Renderer
The renderer
-Returns void
set
Returns void
set
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
set
Returns void
set
Set the parent Container of this DisplayObject.
-Parameters
container: Container
Parameters
container: Container<DisplayObject>
The Container to add this DisplayObject to.
-Returns Container
The Container that this DisplayObject was added to.
-set
Returns Container<DisplayObject>
+- The Container that this DisplayObject was added to.
+
+set
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 Light
The DisplayObject instance
-sort
Parameters
Optional x: number
The X position
+Optional y: number
The Y position
+Optional scaleX: number
The X scale value
+Optional scaleY: number
The Y scale value
+Optional rotation: number
The rotation
+Optional skewX: number
The X skew value
+Optional skewY: number
The Y skew value
+Optional pivotX: number
The X pivot value
+Optional pivotY: number
The Y pivot value
+Returns Light
+- The DisplayObject instance
+
+sort
Sorts children by zIndex. Previous order is maintained for 2 children with the same zIndex.
-Returns void
swap
Returns void
swap
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
to
Returns void
to
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.
-to
Optional point: P
A Point object in which to store the value, optional + (otherwise will create a new Point).
+Optional skipUpdate: boolean
Should we skip the update transform.
+Returns P
+- A point object representing the position of this object.
+
+to
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
-update
Updates the transform on all children of this container for rendering
-Returns void
Static mixin
Optional from: DisplayObject
The DisplayObject to calculate the global position from.
+Optional point: P
A Point object in which to store the value, optional + (otherwise will create a new Point).
+Optional skipUpdate: boolean
Should we skip the update transform
+Returns P
+- A point object representing the position of this object
+
+update
Updates the transform on all children of this container for rendering.
+Returns void
Static mixin
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
Returns void
Generated using TypeDoc
- Preparing search index...
- The search index is not available
Pixi3D - v1.5.1Class LightingEnvironment
- Preparing search index...
- The search index is not available
Pixi3D - v1.6.0Class LightingEnvironment
A lighting environment represents the different lighting conditions for a specific object or an entire scene.
-Hierarchy
Implements
Index
Constructors
Properties
Accessors
Methods
Constructors
constructor
Hierarchy
Implements
Index
Constructors
Properties
Accessors
Methods
Constructors
constructor
Creates a new lighting environment using the specified renderer.
Parameters
renderer: Renderer
The renderer to use.
-Optional imageBasedLighting: ImageBasedLighting
Returns LightingEnvironment
Properties
Optional image
Optional imageBasedLighting: ImageBasedLighting
Returns LightingEnvironment
Properties
Optional image
The image-based lighting object.
-lights
lights
The lights affecting this lighting environment.
-renderer
Static main
renderer
Static main
The main lighting environment which is used by default.
-Accessors
valid
Accessors
valid
Value indicating if this object is valid to be used for rendering.
-Returns boolean
Methods
destroy
Returns void
Generated using TypeDoc
Returns boolean
Methods
destroy
Returns void
Generated using TypeDoc
- Preparing search index...
- The search index is not available
Pixi3D - v1.5.1Class Mat4
Hierarchy
Index
Constructors
Methods
Constructors
constructor
Returns Mat4
Methods
Static copy
Parameters
a: Float32Array
out: Float32Array = ...
Returns Float32Array
Static create
Returns Float32Array
Static from
Parameters
q: Float32Array
out: Float32Array = ...
Returns Float32Array
Static from
Parameters
rad: number
axis: Float32Array
out: Float32Array = ...
Returns Float32Array
Static from
Parameters
q: Float32Array
v: Float32Array
s: Float32Array
out: Float32Array = ...
Returns Float32Array
Static from
Parameters
v: Float32Array
out: Float32Array = ...
Returns Float32Array
Static from
Parameters
v: Float32Array
out: Float32Array = ...
Returns Float32Array
Static get
Parameters
mat: Float32Array
out: Float32Array = ...
Returns Float32Array
Static get
Parameters
mat: Float32Array
out: Float32Array = ...
Returns Float32Array
Static get
Parameters
mat: Float32Array
out: Float32Array = ...
Returns Float32Array
Static identity
Parameters
out: Float32Array = ...
Returns Float32Array
Static invert
Parameters
a: Float32Array
out: Float32Array = ...
Returns Float32Array
Static look
Parameters
eye: Float32Array
center: Float32Array
up: Float32Array
out: Float32Array = ...
Returns Float32Array
Static multiply
Parameters
a: Float32Array
b: Float32Array
out: Float32Array = ...
Returns Float32Array
Static ortho
Parameters
left: number
right: number
bottom: number
top: number
near: number
far: number
out: Float32Array = ...
Returns Float32Array
Static perspective
Parameters
fovy: number
aspect: number
near: number
far: number
out: Float32Array = ...
Returns Float32Array
Static rotate
Parameters
a: Float32Array
rad: number
axis: Float32Array
out: Float32Array = ...
Returns Float32Array
Static rotateX
Parameters
a: Float32Array
rad: number
out: Float32Array = ...
Returns Float32Array
Static rotateY
Parameters
a: Float32Array
rad: number
out: Float32Array = ...
Returns Float32Array
Static rotateZ
Parameters
a: Float32Array
rad: number
out: Float32Array = ...
Returns Float32Array
Static scale
Parameters
a: Float32Array
v: Float32Array
out: Float32Array = ...
Returns Float32Array
Static target
Parameters
eye: Float32Array
target: Float32Array
up: Float32Array
out: Float32Array = ...
Returns Float32Array
Static translate
Parameters
mat: Float32Array
v: Float32Array
out: Float32Array = ...
Returns Float32Array
Static transpose
Parameters
a: Float32Array
out: Float32Array = ...
Returns Float32Array
Generated using TypeDoc
- Preparing search index...
- The search index is not available
Pixi3D - v1.6.0Class Mat4
Hierarchy
Index
Constructors
Methods
Constructors
constructor
Returns Mat4
Methods
Static copy
Parameters
a: Float32Array
out: Float32Array = ...
Returns Float32Array
Static create
Returns Float32Array
Static from
Parameters
q: Float32Array
out: Float32Array = ...
Returns Float32Array
Static from
Parameters
rad: number
axis: Float32Array
out: Float32Array = ...
Returns Float32Array
Static from
Parameters
q: Float32Array
v: Float32Array
s: Float32Array
out: Float32Array = ...
Returns Float32Array
Static from
Parameters
v: Float32Array
out: Float32Array = ...
Returns Float32Array
Static from
Parameters
v: Float32Array
out: Float32Array = ...
Returns Float32Array
Static get
Parameters
mat: Float32Array
out: Float32Array = ...
Returns Float32Array
Static get
Parameters
mat: Float32Array
out: Float32Array = ...
Returns Float32Array
Static get
Parameters
mat: Float32Array
out: Float32Array = ...
Returns Float32Array
Static identity
Parameters
out: Float32Array = ...
Returns Float32Array
Static invert
Parameters
a: Float32Array
out: Float32Array = ...
Returns Float32Array
Static look
Parameters
eye: Float32Array
center: Float32Array
up: Float32Array
out: Float32Array = ...
Returns Float32Array
Static multiply
Parameters
a: Float32Array
b: Float32Array
out: Float32Array = ...
Returns Float32Array
Static ortho
Parameters
left: number
right: number
bottom: number
top: number
near: number
far: number
out: Float32Array = ...
Returns Float32Array
Static perspective
Parameters
fovy: number
aspect: number
near: number
far: number
out: Float32Array = ...
Returns Float32Array
Static rotate
Parameters
a: Float32Array
rad: number
axis: Float32Array
out: Float32Array = ...
Returns Float32Array
Static rotateX
Parameters
a: Float32Array
rad: number
out: Float32Array = ...
Returns Float32Array
Static rotateY
Parameters
a: Float32Array
rad: number
out: Float32Array = ...
Returns Float32Array
Static rotateZ
Parameters
a: Float32Array
rad: number
out: Float32Array = ...
Returns Float32Array
Static scale
Parameters
a: Float32Array
v: Float32Array
out: Float32Array = ...
Returns Float32Array
Static target
Parameters
eye: Float32Array
target: Float32Array
up: Float32Array
out: Float32Array = ...
Returns Float32Array
Static translate
Parameters
mat: Float32Array
v: Float32Array
out: Float32Array = ...
Returns Float32Array
Static transpose
Parameters
a: Float32Array
out: Float32Array = ...
Returns Float32Array
Generated using TypeDoc
- Preparing search index...
- The search index is not available
Pixi3D - v1.5.1Class Material
- Preparing search index...
- The search index is not available
Pixi3D - v1.6.0Class Material
Materials are used to render a mesh with a specific visual appearance.
-Hierarchy
Index
Constructors
Properties
Accessors
Methods
Constructors
constructor
Returns Material
Properties
Protected _render
Protected Optional _shader
draw
Hierarchy
Index
Constructors
Properties
Accessors
Methods
Constructors
constructor
Returns Material
Properties
Protected _render
Protected Optional _shader
draw
Draw mode used to render a mesh.
-render
render
Sort type used to render a mesh. Transparent materials will be rendered after opaque materials.
-state
state
State used to render a mesh.
-Accessors
blend
Accessors
blend
Blend mode used to render a mesh.
-Returns BLEND_MODES
Returns BLEND_MODES
Blend mode used to render a mesh.
-Parameters
value: BLEND_MODES
Returns void
depth
Parameters
value: BLEND_MODES
Returns void
depth
Value indicating if writing into the depth buffer is enabled or disabled. Depth mask feature is only available in PixiJS 6.0+ and won't have any effects in previous versions.
-Returns boolean
Returns boolean
Value indicating if writing into the depth buffer is enabled or disabled. Depth mask feature is only available in PixiJS 6.0+ and won't have any effects in previous versions.
-Parameters
value: boolean
Returns void
double
Parameters
value: boolean
Returns void
double
Value indicating if the material is double sided. When set to true, the culling state will be set to false.
-Returns boolean
Returns boolean
Value indicating if the material is double sided. When set to true, the culling state will be set to false.
-Parameters
value: boolean
Returns void
is
Parameters
value: boolean
Returns void
is
Returns a value indicating if this material supports instancing.
-Returns boolean
Methods
create
Returns boolean
Methods
create
Creates a new instanced version of this material.
-Returns unknown
create
Returns unknown
create
Creates a shader used to render the specified mesh.
Parameters
mesh: Mesh3D
The mesh to create the shader for.
renderer: Renderer
The renderer to use.
-Returns undefined | MeshShader
destroy
Returns undefined | MeshShader
destroy
Destroys the material and it's used resources.
-Returns void
render
Returns void
render
Renders the specified mesh.
Parameters
mesh: Mesh3D
The mesh to render.
renderer: Renderer
The renderer to use.
-Returns void
Optional update
Returns void
Optional update
Updates the uniforms for the specified shader.
Parameters
mesh: Mesh3D
The mesh used for updating the uniforms.
shader: MeshShader
The shader to update.
-Returns void
Static from
Returns void
Static from
Creates a new material from the specified vertex/fragment source.
Parameters
vertexSrc: string
The vertex shader source.
diff --git a/docs/classes/MaterialRenderPass.html b/docs/classes/MaterialRenderPass.html index 633d27d0..2a4670c6 100644 --- a/docs/classes/MaterialRenderPass.html +++ b/docs/classes/MaterialRenderPass.html @@ -1,21 +1,21 @@ -- Preparing search index...
- The search index is not available
Pixi3D - v1.5.1Class MaterialRenderPass
- Preparing search index...
- The search index is not available
Pixi3D - v1.6.0Class MaterialRenderPass
Pass used for rendering materials.
-Hierarchy
Implements
Index
Constructors
Properties
Accessors
Methods
Constructors
constructor
Hierarchy
Implements
Index
Constructors
Properties
Accessors
Methods
Constructors
constructor
Creates a new material render pass.
Parameters
renderer: Renderer
The renderer to use.
name: string
The name of the render pass.
-Returns MaterialRenderPass
Properties
Optional clear
Returns MaterialRenderPass
Properties
Optional clear
The color (r,g,b,a) used for clearing the render texture. If this value is empty, the render texture will not be cleared.
name
The name of the render pass.
-renderer
Accessors
render
renderer
Accessors
render
The texture used when rendering to a texture.
-Returns undefined | RenderTexture
Returns undefined | RenderTexture
The texture used when rendering to a texture.
-Parameters
value: undefined | RenderTexture
Returns void
Methods
clear
Parameters
value: undefined | RenderTexture
Returns void
Methods
clear
Clears the render pass. Used when rendering to a texture.
-Returns void
render
Returns void
render
Renders the specified meshes.
Parameters
meshes: Mesh3D[]
Returns void
Generated using TypeDoc
- Preparing search index...
- The search index is not available
Pixi3D - v1.5.1Class Matrix4
- Preparing search index...
- The search index is not available
Pixi3D - v1.6.0Class Matrix4
Represents a 4x4 matrix.
-Hierarchy
Implements
Index
Constructors
Properties
Accessors
Methods
Constructors
constructor
Hierarchy
Implements
Index
Constructors
Properties
Accessors
Methods
Constructors
constructor
Creates a new transform matrix using the specified matrix array.
Parameters
Optional array: ArrayLike<number>
The matrix array, expected length is 16. If empty, an identity matrix is used by default.
-Returns Matrix4
Properties
a
array
Returns Matrix4
Properties
a
1
+array
The array containing the matrix data.
-b
c
d
tx
ty
Accessors
backward
b
0
+c
0
+d
1
+tx
0
+ty
0
+Accessors
backward
Returns the backward vector of the matrix.
-Returns Float32Array
down
Returns Float32Array
down
Returns the down vector of the matrix.
-Returns Float32Array
forward
Returns Float32Array
forward
Returns the forward vector of the matrix.
-Returns Float32Array
left
Returns Float32Array
left
Returns the right vector of the matrix.
-Returns Float32Array
position
Returns Float32Array
position
Returns the position component of the matrix.
-Returns Float32Array
right
Returns Float32Array
right
Returns the left vector of the matrix.
-Returns Float32Array
rotation
Returns Float32Array
rotation
Returns the rotation quaternion of the matrix.
-Returns Float32Array
scaling
Returns Float32Array
scaling
Returns the scaling component of the matrix.
-Returns Float32Array
transform
Returns number
up
Returns Float32Array
transform
Returns number
up
Returns the up vector of the matrix.
-Returns Float32Array
Static IDENTITY
Returns Float32Array
Static IDENTITY
A default (identity) matrix
-{PIXI.Matrix}
-Returns Matrix
Static TEMP_
Returns Matrix
Static TEMP_
A temp matrix
-{PIXI.Matrix}
-Returns Matrix
Methods
append
Returns Matrix
Methods
append
Appends the given Matrix to this Matrix.
Parameters
matrix: Matrix
The matrix to append.
Returns Matrix4
This matrix. Good for chaining method calls.
-apply
apply
Get a new position with the current transformation applied. Can be used to go from a child's coordinate space to the world coordinate space. (e.g. rendering)
Type parameters
P: IPointData = Point
Parameters
pos: IPointData
The origin
Optional newPos: P
Returns P
The new point, transformed through this matrix
-apply
apply
Get a new position with the inverse of the current transformation applied. Can be used to go from the world coordinate space to a child's coordinate space. (e.g. input)
Type parameters
P: IPointData = Point
Parameters
pos: IPointData
The origin
Optional newPos: P
Returns P
The new point, inverse-transformed through this matrix
-clone
clone
Creates a new Matrix object with the same values as this one.
Returns Matrix
A copy of this matrix. Good for chaining method calls.
-copy
Parameters
matrix: Matrix4
Returns Matrix4
copy
copy
Parameters
matrix: Matrix4
Returns Matrix4
copy
Changes the values of the given matrix to be the same as the ones in this matrix
Parameters
matrix: Matrix
The matrix to copy to.
Returns Matrix
The matrix given in parameter with its values updated.
-decompose
decompose
Decomposes the matrix (x, y, scaleX, scaleY, and rotation) and sets the properties on to a transform.
Parameters
transform: Transform
The transform to apply the properties to.
Returns Transform
The transform with the newly applied properties
-from
from
Creates a Matrix object based on the given array. The Element to Matrix mapping order is as follows:
a = array[0] b = array[1] @@ -71,35 +75,35 @@ ty = array[5]
Parameters
array: number[]
The array that the matrix will be populated from.
-Returns void
identity
Returns void
identity
Resets this Matrix to an identity (default) matrix.
Returns Matrix4
This matrix. Good for chaining method calls.
-invert
invert
Inverts this matrix
Returns Matrix4
This matrix. Good for chaining method calls.
-multiply
multiply
Multiplies this matrix with another matrix.
Parameters
matrix: Matrix4
The matrix to multiply with.
-Returns void
prepend
Returns void
prepend
Prepends the given Matrix to this Matrix.
Parameters
matrix: Matrix
The matrix to prepend
Returns Matrix4
This matrix. Good for chaining method calls.
-rotate
rotate
Applies a rotation transformation to the matrix.
Parameters
angle: number
The angle in radians.
Returns Matrix4
This matrix. Good for chaining method calls.
-scale
scale
Applies a scale transformation to the matrix.
Parameters
x: number
The amount to scale horizontally
y: number
The amount to scale vertically
Returns Matrix4
This matrix. Good for chaining method calls.
-set
sets the matrix properties
+set
Sets the matrix properties.
Parameters
a: number
Matrix component
b: number
ty: number
Matrix component
Returns Matrix4
This matrix. Good for chaining method calls.
-set
set
Sets the rotation, position and scale components.
Parameters
rotation: ObservableQuaternion
The rotation to set.
@@ -121,7 +125,7 @@The position to set.
scaling: ObservablePoint3D
The scale to set.
-Returns void
set
Returns void
set
Sets the matrix based on all the available properties
Parameters
x: number
Position on the x axis
@@ -142,7 +146,7 @@skewY: number
Skew on the y axis
Returns Matrix4
This matrix. Good for chaining method calls.
-to
Parameters
transpose: boolean
Optional out: Float32Array
Returns Float32Array
to
Returns string
translate
to
Parameters
transpose: boolean
Optional out: Float32Array
Returns Float32Array
to
Returns string
translate
Translates the matrix on the x and y.
Parameters
x: number
How much to translate x by
diff --git a/docs/classes/Mesh3D.html b/docs/classes/Mesh3D.html index 3ac3df92..14dc4832 100644 --- a/docs/classes/Mesh3D.html +++ b/docs/classes/Mesh3D.html @@ -1,43 +1,110 @@ -- Preparing search index...
- The search index is not available
Pixi3D - v1.5.1Class Mesh3D
- Preparing search index...
- The search index is not available
Pixi3D - v1.6.0Class Mesh3D
Represents a mesh which contains geometry and has a material.
-Hierarchy
Index
Constructors
Properties
Accessors
Methods
Constructors
constructor
Hierarchy
Index
Constructors
Properties
Accessors
Methods
Constructors
constructor
Creates a new mesh with the specified geometry and material.
Parameters
geometry: MeshGeometry3D
The geometry for the mesh.
Optional material: Material
The material for the mesh. If the material is empty the mesh won't be rendered.
-Returns Mesh3D
Properties
_bounds
Protected _boundsID
Protected _bounds
Protected _destroyed
Protected _enabled
Protected _height
_last
_local
Protected _local
_mask
Optional _tracked
Type declaration
[x: number]: InteractionTrackingData
Protected _width
Protected _z
alpha
Optional button
Readonly children
container
Type declaration
Returns void
Optional cursor
display
Type declaration
Returns void
enabled
Returns Mesh3D
Properties
_bounds
The bounds object, this is used to calculate and store the bounds of the displayObject.
+Protected _boundsID
Flags the cached bounds as dirty.
+Protected _bounds
Cache of this display-object's bounds-rectangle.
+Protected _destroyed
If the object has been destroyed via destroy(). If true, it should not be used.
+Protected _enabled
Currently enabled filters.
+Protected _height
Protected _last
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
Local bounds object, swapped with
+_boundswhen usinggetLocalBounds().Protected _local
Cache of this display-object's local-bounds rectangle.
+Protected _mask
The original, cached mask of the object.
+_tracked
Type declaration
[x: number]: InteractionTrackingData
Protected _width
Protected _z
The zIndex of the displayObject. +A higher value will mean it will be rendered on top of other displayObjects within the same container.
+alpha
The opacity of the object.
+button
Readonly children
The array of children of this container.
+container
Type declaration
Returns void
cull
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.
+cullable
Should this object be rendered if the bounds of this object are out of frame?
+Culling has no effect on whether updateTransform is called.
+cursor
display
Type declaration
Returns void
enabled
The enabled render passes for this mesh.
-Type declaration
[name: string]: unknown
filter
filters
geometry
Optional hit
Optional interactive
Optional interactive
is
is
Optional material
Optional name
parent
plugin
Type declaration
[name: string]: unknown
filter
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
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'.geometry
hit
interactive
interactive
is
Does any other displayObject use this object as a mask?
+is
Used to fast check if a sprite is.. a sprite!
+Optional material
name
parent
plugin
The name of the plugin used for rendering the mesh.
-render
render
Used for sorting the mesh before render.
-renderable
Optional skin
renderable
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.
+Optional skin
The skin used for vertex skinning.
-sort
sortable
Optional target
sort
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.
+sortable
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 @link https://github.com/pixijs/pixi-display
+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.
+PIXI.settings.SORTABLE_CHILDREN
+Optional target
Array of weights used for morphing between geometry targets.
-Optional tracked
Type declaration
[x: number]: InteractionTrackingData
transform
visible
world
Static prefixed
Accessors
Protected _temp
{PIXI.Container}
-Returns TemporaryDisplayObject
angle
tracked
Type declaration
[x: number]: InteractionTrackingData
transform
visible
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.
+world
The multiplied alpha of the displayObject.
+Static prefixed
Accessors
Protected _temp
{PIXI.Container}
+Returns TemporaryDisplayObject
angle
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.
-{number}
-Returns 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.
-{number}
-Parameters
value: number
Returns void
height
The height of the Container, setting this will actually modify the scale to achieve the value set
-{number}
-Returns number
The height of the Container, setting this will actually modify the scale to achieve the value set
-{number}
-Parameters
value: number
Returns void
instances
Parameters
value: number
Returns void
destroyed
Readonly flag for destroyed display objects.
+Returns boolean
height
The height of the Container, setting this will actually modify the scale to achieve the value set.
+Returns number
The height of the Container, setting this will actually modify the scale to achieve the value set.
+Parameters
value: number
Returns void
instances
An array of instances created from this mesh.
-Returns InstancedMesh3D[]
local
Returns Matrix4
mask
Returns InstancedMesh3D[]
local
Returns Matrix4
mask
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
+utilities shape clipping. Furthermore, a mask of an object must be in the subtree of its parent. +Otherwise,null.getLocalBoundsmay calculate incorrect bounds, which makes the container's width and height wrong. +To remove a mask, set this property tonull.For sprite mask both alpha and red channel are used. Black mask is the same as transparent mask.
const graphics = new PIXI.Graphics(); graphics.beginFill(0xFF3300); @@ -46,12 +113,13 @@
const sprite = new PIXI.Sprite(texture); sprite.mask = graphics;
At the moment, PIXI.CanvasRenderer doesn't support PIXI.Sprite as mask.
-{PIXI.Container|PIXI.MaskData|null}
-Returns null | Container | MaskData
Returns null | Container<DisplayObject> | 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
+utilities shape clipping. Furthermore, a mask of an object must be in the subtree of its parent. +Otherwise,null.getLocalBoundsmay calculate incorrect bounds, which makes the container's width and height wrong. +To remove a mask, set this property tonull.For sprite mask both alpha and red channel are used. Black mask is the same as transparent mask.
const graphics = new PIXI.Graphics(); graphics.beginFill(0xFF3300); @@ -60,136 +128,127 @@
const sprite = new PIXI.Sprite(texture); sprite.mask = graphics;
At the moment, PIXI.CanvasRenderer doesn't support PIXI.Sprite as mask.
-{PIXI.Container|PIXI.MaskData|null}
-Parameters
value: null | Container | MaskData
Returns void
pivot
Parameters
value: null | Container<DisplayObject> | MaskData
Returns void
pivot
The center of rotation, scaling, and skewing for this display object in its local space. The
positionis the projection ofpivotin the parent's local space.By default, the pivot is the origin (0, 0).
-PixiJS 4
-{PIXI.ObservablePoint}
-Returns ObservablePoint<any>
4.0.0
+Returns ObservablePoint<any>
The center of rotation, scaling, and skewing for this display object in its local space. The
positionis the projection ofpivotin the parent's local space.By default, the pivot is the origin (0, 0).
-PixiJS 4
-{PIXI.ObservablePoint}
-Parameters
value: ObservablePoint<any>
Returns void
position
Returns ObservablePoint3D
Parameters
value: ObservablePoint3D
Returns void
rotation
4.0.0
+Parameters
value: IPointData
Returns void
position
Returns ObservablePoint3D
Parameters
value: ObservablePoint3D
Returns void
rotation
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.
-{number}
-Returns 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.
-{number}
-Parameters
value: number
Returns void
rotation
Parameters
value: number
Returns void
rotation
The quaternion rotation of the object.
-Returns ObservableQuaternion
Parameters
value: ObservableQuaternion
Returns void
scale
Returns ObservablePoint3D
Parameters
value: ObservablePoint3D
Returns void
skew
Returns ObservableQuaternion
Parameters
value: ObservableQuaternion
Returns void
scale
Returns ObservablePoint3D
Parameters
value: ObservablePoint3D
Returns void
skew
The skew factor for the object in radians.
-PixiJS 4
-{PIXI.ObservablePoint}
-Returns ObservablePoint<any>
4.0.0
+Returns ObservablePoint<any>
The skew factor for the object in radians.
-PixiJS 4
-{PIXI.ObservablePoint}
-Parameters
value: ObservablePoint<any>
Returns void
width
The width of the Container, setting this will actually modify the scale to achieve the value set
-{number}
-Returns number
The width of the Container, setting this will actually modify the scale to achieve the value set
-{number}
-Parameters
value: number
Returns void
world
Returns Matrix4
world
4.0.0
+Parameters
value: IPointData
Returns void
width
The width of the Container, setting this will actually modify the scale to achieve the value set.
+Returns number
The width of the Container, setting this will actually modify the scale to achieve the value set.
+Parameters
value: number
Returns void
world
Returns Matrix4
world
Indicates if the object is globally visible.
-{boolean}
-Returns boolean
x
Returns boolean
x
The position of the displayObject on the x axis relative to the local coordinates of the parent. An alias to position.x
-{number}
-Returns 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
-{number}
-Parameters
value: number
Returns void
y
Parameters
value: number
Returns void
y
The position of the displayObject on the y axis relative to the local coordinates of the parent. An alias to position.y
-{number}
-Returns 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
-{number}
-Parameters
value: number
Returns void
z
Parameters
value: number
Returns void
z
The position of the object on the z axis relative to the local coordinates of the parent.
-Returns number
Returns number
The position of the object on the z axis relative to the local coordinates of the parent.
-Parameters
value: number
Returns void
z
Parameters
value: number
Returns void
z
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.
-{number}
-PIXI.Container#sortableChildren
-Returns number
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.
-{number}
-PIXI.Container#sortableChildren
-Parameters
value: number
Returns void
Methods
Protected _calculate
PIXI.Container#sortableChildren
+Parameters
value: number
Returns void
Methods
Protected _calculate
Recalculates the content bounds of this object. This should be overriden to calculate the bounds of this specific object (not including children).
-Returns void
Protected _recursive
Recursively updates transform of all objects from the root to this one -internal function for toLocal()
-Returns void
_render
Returns void
Protected _recursive
Recursively updates transform of all objects from the root to this one internal function for toLocal()
+Returns void
_render
To be overridden by the subclasses.
-Parameters
renderer: Renderer
Returns void
add
Parameters
renderer: Renderer
Returns void
Protected _render
Renders this object and its children with culling.
+Parameters
renderer: Renderer
The renderer
+Returns void
add
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
Type parameters
U: DisplayObject[]
Parameters
Rest ...children: U
The DisplayObject(s) to add to the container
-Returns T[0]
The first child that was added.
-add
Returns U[0]
+- The first child that was added.
+
+add
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
Type parameters
U: DisplayObject<U>
Parameters
child: U
The child to add
index: number
The index to place the child in
-Returns T
The child that was added.
-add
Parameters
event: string | symbol
fn: ListenerFn
Optional context: any
Returns Mesh3D
calculate
Returns U
The child that was added.
+add
Parameters
event: string | symbol
fn: ListenerFn
Optional context: any
Returns Mesh3D
calculate
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
create
Returns void
create
Creates a new instance of this mesh.
-Returns InstancedMesh3D
destroy
Returns InstancedMesh3D
destroy
Destroys the mesh and it's used resources.
-Parameters
Optional options: boolean | MeshDestroyOptions
Returns void
disable
Parameters
Optional options: boolean | MeshDestroyOptions
Returns void
disable
Disables the render pass with the specified name.
Parameters
name: string
The name of the render pass to disable.
-Returns void
disable
Returns void
disable
Pair method for
-enableTempParentParameters
cacheParent: DisplayObject
Parameters
cacheParent: Container<DisplayObject>
Actual parent of element
Returns void
emit
Calls each of the listeners registered for a given event.
-Parameters
event: string | symbol
Rest ...args: any[]
Returns boolean
enable
Parameters
event: string | symbol
Rest ...args: any[]
Returns boolean
enable
Enables the render pass with the specified name.
Parameters
name: string
The name of the render pass to enable.
-Optional options: unknown
Returns void
enable
Optional options: unknown
Returns void
enable
Used in Renderer, cacheAsBitmap and other places where you call an
-updateTransformon rootReturns DisplayObject
current parent
+Returns Container<DisplayObject>
+- current parent
+
event
Return an array listing the events for which the emitter has registered listeners.
-Returns (string | symbol)[]
get
Returns (string | symbol)[]
get
Calculates and returns a axis-aligned bounding box of the mesh in world space.
-Returns undefined | AABB
get
Returns undefined | AABB
get
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 @@ -198,13 +257,11 @@
-displayObject._bounds.getRectangle()when traversing through all the bounds in a scene graph. Otherwise, callinggetBoundson 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 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
-_boundsobject stores the last calculation of the bounds. You can use to entirely skip bounds calculation if needed.Parameters
Optional skipUpdate: boolean
Optional rect: Rectangle
Returns Rectangle
The minimum axis-aligned rectangle in world space that fits around this object.
-get
Parameters
Optional skipUpdate: boolean
Setting to
+truewill 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.Optional rect: Rectangle
Optional rectangle to store the result of the bounds calculation.
+Returns Rectangle
+- The minimum axis-aligned rectangle in world space that fits around this object.
+
+get
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 get
Parameters
name: string
Optional isRecursive: boolean
Returns DisplayObject
get
Returns DisplayObject
+- The child at the given index, if any.
+
+get
Type parameters
T: DisplayObject<T> = DisplayObject
Parameters
name: string
Optional deep: boolean
Returns T
get
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
-get
Returns number
+- The index position of the child display object to identify
+
+get
Retrieves the local bounds of the displayObject as a rectangle object.
Calling
-getLocalBoundsmay invalidate the_boundsof the whole subtree below. If using it inside a render() call, it is advised to callgetBounds()immediately after to recalculate the world bounds of the subtree.Parameters
Optional rect: Rectangle
Optional skipChildrenUpdate: boolean
Returns Rectangle
The rectangular bounding area.
-is
Parameters
Optional rect: Rectangle
Optional rectangle to store the result of the bounds calculation.
+Optional skipChildrenUpdate: boolean
Setting to
+truewill stop re-calculation of children transforms, + it was default behaviour of pixi 4.0-5.2 and caused many problems to users.Returns Rectangle
+- The rectangular bounding area.
+
+is
Returns a value indicating if the specified render pass is enabled.
Parameters
name: string
The name of the render pass to check.
@@ -238,106 +314,154 @@Return the listeners registered for a given event.
Parameters
event: string | symbol
Returns ListenerFn[]
off
Parameters
event: string | symbol
Optional fn: ListenerFn
Optional context: any
Optional once: boolean
Returns Mesh3D
on
Add a listener for a given event.
-Parameters
event: string | symbol
fn: ListenerFn
Optional context: any
Returns Mesh3D
Protected on
Overridable method that can be used by Container subclasses whenever the children array is modified
-Parameters
Optional _length: number
Returns void
once
Parameters
event: string | symbol
fn: ListenerFn
Optional context: any
Returns Mesh3D
Protected on
Overridable method that can be used by Container subclasses whenever the children array is modified.
+Parameters
Optional _length: number
Returns void
once
Add a one-time listener for a given event.
Parameters
event: string | symbol
fn: ListenerFn
Optional context: any
Returns Mesh3D
remove
Remove all listeners, or those of the specified event.
-Parameters
Optional event: string | symbol
Returns Mesh3D
remove
Parameters
Optional event: string | symbol
Returns Mesh3D
remove
Removes one or more children from the container.
-Type parameters
T: DisplayObject[]
Parameters
Rest ...children: T
Type parameters
U: DisplayObject[]
Parameters
Rest ...children: U
The DisplayObject(s) to remove
-Returns T[0]
The first child that was removed.
-remove
Returns U[0]
The first child that was removed.
+remove
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.
-remove
remove
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
-remove
Parameters
Optional beginIndex: number
The beginning position.
+Optional endIndex: number
The ending position. Default value is size of the container.
+Returns DisplayObject[]
+- List of removed children
+
+remove
Removes an instance from this mesh.
Parameters
instance: InstancedMesh3D
The instance to remove.
Returns void
remove
Remove the listeners of a given event.
-Parameters
event: string | symbol
Optional fn: ListenerFn
Optional context: any
Optional once: boolean
Returns Mesh3D
render
Parameters
event: string | symbol
Optional fn: ListenerFn
Optional context: any
Optional once: boolean
Returns Mesh3D
render
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
-rendermethod will invoke it, and also invoke therendermethods of all children afterward.If
renderableorvisibleis false or ifworldAlphais not positive, this implementation will entirely -skip rendering. See {@link PIXI.DisplayObject} for choosing betweenrenderableorvisible. Generally, +If
renderableorvisibleis false or ifworldAlphais not positive or ifcullableis true and +the bounds of this object are out of frame, this implementation will entirely skip rendering. +See {@link PIXI.DisplayObject} for choosing betweenrenderableorvisible. 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 +advised to employ culling to automatically skip rendering objects outside of the current screen. +See [cullable]{@link PIXI.DisplayObject#cullable} and [cullArea]{@link PIXI.DisplayObject#cullArea}. +Other culling methods might be better suited for a large number static objects; see @pixi-essentials/cull and -pixi-cull packages do this out of the box.
+pixi-cull.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 render
Returns void
Protected render
Render the object using the WebGL renderer and advanced features.
Parameters
renderer: Renderer
The renderer
-Returns void
set
Returns void
set
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
set
Returns void
set
Set the parent Container of this DisplayObject.
-Parameters
container: Container
Parameters
container: Container<DisplayObject>
The Container to add this DisplayObject to.
-Returns Container
The Container that this DisplayObject was added to.
-set
Returns Container<DisplayObject>
+- The Container that this DisplayObject was added to.
+
+set
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 Mesh3D
The DisplayObject instance
-sort
Parameters
Optional x: number
The X position
+Optional y: number
The Y position
+Optional scaleX: number
The X scale value
+Optional scaleY: number
The Y scale value
+Optional rotation: number
The rotation
+Optional skewX: number
The X skew value
+Optional skewY: number
The Y skew value
+Optional pivotX: number
The X pivot value
+Optional pivotY: number
The Y pivot value
+Returns Mesh3D
+- The DisplayObject instance
+
+sort
Sorts children by zIndex. Previous order is maintained for 2 children with the same zIndex.
-Returns void
swap
Returns void
swap
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
to
Returns void
to
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.
-to
Optional point: P
A Point object in which to store the value, optional + (otherwise will create a new Point).
+Optional skipUpdate: boolean
Should we skip the update transform.
+Returns P
+- A point object representing the position of this object.
+
+to
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
-update
Updates the transform on all children of this container for rendering
-Returns void
Static create
Optional from: DisplayObject
The DisplayObject to calculate the global position from.
+Optional point: P
A Point object in which to store the value, optional + (otherwise will create a new Point).
+Optional skipUpdate: boolean
Should we skip the update transform
+Returns P
+- A point object representing the position of this object
+
+update
Updates the transform on all children of this container for rendering.
+Returns void
Static create
Creates a new cube (six faces) mesh with the specified material.
Parameters
material: Material = ...
The material to use.
-Returns Mesh3D
Static create
Returns Mesh3D
Static create
Creates a new plane (flat square) mesh with the specified material.
Parameters
material: Material = ...
The material to use.
-Returns Mesh3D
Static create
Returns Mesh3D
Static create
Creates a new quad (flat square) mesh with the specified material.
Parameters
material: Material = ...
The material to use.
-Returns Mesh3D
Static create
Returns Mesh3D
Static create
Creates a new uv sphere mesh with the specified material.
Parameters
material: Material = ...
The material to use.
Optional options: SphereGeometryOptions
The options used when creating the geometry.
-Returns Mesh3D
Static mixin
Returns Mesh3D
Static mixin
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
Returns void
Generated using TypeDoc
- Preparing search index...
- The search index is not available
Pixi3D - v1.5.1Class MeshGeometry3D
- Preparing search index...
- The search index is not available
Pixi3D - v1.6.0Class MeshGeometry3D
Geometry with mesh data (i.e. positions, normals, uvs).
-Hierarchy
Index
Constructors
Properties
Methods
Constructors
constructor
Returns MeshGeometry3D
Properties
Optional colors
Optional indices
Optional joints
Optional normals
Optional positions
Optional tangents
Optional targets
Optional uvs
Optional weights
Methods
add
Hierarchy
Index
Constructors
Properties
Methods
Constructors
constructor
Returns MeshGeometry3D
Properties
Optional colors
Optional indices
Optional joints
Optional normals
Optional positions
Optional tangents
Optional targets
Optional uvs
Optional weights
Methods
add
Creates geometry with attributes required by the specified shader.
Parameters
shader: MeshShader
The shader to use.
instanced: boolean
Value indicating if the geometry will be instanced.
-Returns void
destroy
Returns void
destroy
Destroys the geometry and it's used resources.
-Returns void
get
Returns void
get
Returns geometry with attributes required by the specified shader.
Parameters
shader: MeshShader
The shader to use.
-Returns Geometry
has
Returns Geometry
has
Returns a value indicating if geometry with required attributes has been created by the specified shader.
Parameters
shader: MeshShader
- Preparing search index...
- The search index is not available
Pixi3D - v1.5.1Class MeshShader
- Preparing search index...
- The search index is not available
Pixi3D - v1.6.0Class MeshShader
Shader used specifically to render a mesh.
-Hierarchy
Index
Constructors
Properties
Accessors
Methods
Constructors
constructor
Parameters
program: Program
Optional uniforms: Dict<any>
Returns MeshShader
Properties
program
uniform
Accessors
name
Hierarchy
Index
Constructors
Properties
Accessors
Methods
Constructors
constructor
Parameters
program: Program
The program the shader will use.
+Optional uniforms: Dict<any>
Custom uniforms to use to augment the built-in ones.
+Returns MeshShader
Properties
program
Program that the shader uses.
+uniform
Accessors
name
The name of the mesh shader. Used for figuring out if geometry attributes is compatible with the shader. This needs to be set to something different than default value when custom attributes is used.
-Returns string
uniforms
Shader uniform values, shortcut for
-uniformGroup.uniforms{object}
-Returns Dict<any>
Methods
check
Parameters
name: string
group: UniformGroup
Returns boolean
create
Returns string
uniforms
Shader uniform values, shortcut for
+uniformGroup.uniforms.Returns Dict<any>
Methods
check
Parameters
name: string
group: UniformGroup<Dict<any>>
Returns boolean
create
Creates geometry with required attributes used by this shader. Override when using custom attributes.
Parameters
geometry: MeshGeometry3D
The geometry with mesh data.
instanced: boolean
Value indicating if the geometry will be instanced.
-Returns Geometry
destroy
Returns void
render
Returns Geometry
destroy
Returns void
render
Renders the geometry of the specified mesh.
Parameters
mesh: Mesh3D
Mesh to render.
@@ -21,7 +26,13 @@Rendering state to use.
drawMode: DRAW_MODES = DRAW_MODES.TRIANGLES
Draw mode to use.
-Returns void
Static from
A short hand function to create a shader based of a vertex and fragment shader
-Parameters
Optional vertexSrc: string
Optional fragmentSrc: string
Optional uniforms: Dict<any>
Returns Shader
an shiny new Pixi shader!
+Returns void
Static from
A short hand function to create a shader based of a vertex and fragment shader.
+Parameters
Optional vertexSrc: string
The source of the vertex shader.
+Optional fragmentSrc: string
The source of the fragment shader.
+Optional uniforms: Dict<any>
Custom uniforms to use to augment the built-in ones.
+Returns Shader
A shiny new PixiJS shader!
Generated using TypeDoc
- Preparing search index...
- The search index is not available
Pixi3D - v1.5.1Class Model
- Preparing search index...
- The search index is not available
Pixi3D - v1.6.0Class Model
Represents a model which has been loaded from a file. Contains a hierarchy of meshes and animations.
-Hierarchy
Index
Constructors
Properties
Accessors
Methods
Constructors
constructor
Returns Model
Properties
_bounds
Protected _boundsID
Protected _bounds
Protected _destroyed
Protected _enabled
Protected _height
_last
_local
Protected _local
_mask
Optional _tracked
Type declaration
[x: number]: InteractionTrackingData
Protected _width
Protected _z
alpha
animations
Hierarchy
Index
Constructors
Properties
Accessors
Methods
Constructors
constructor
Returns Model
Properties
_bounds
The bounds object, this is used to calculate and store the bounds of the displayObject.
+Protected _boundsID
Flags the cached bounds as dirty.
+Protected _bounds
Cache of this display-object's bounds-rectangle.
+Protected _destroyed
If the object has been destroyed via destroy(). If true, it should not be used.
+Protected _enabled
Currently enabled filters.
+Protected _height
Protected _last
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
Local bounds object, swapped with
+_boundswhen usinggetLocalBounds().Protected _local
Cache of this display-object's local-bounds rectangle.
+Protected _mask
The original, cached mask of the object.
+_tracked
Type declaration
[x: number]: InteractionTrackingData
Protected _width
Protected _z
The zIndex of the displayObject. +A higher value will mean it will be rendered on top of other displayObjects within the same container.
+alpha
The opacity of the object.
+animations
The animations included in the model.
-Optional button
Readonly children
container
Type declaration
Returns void
Optional cursor
display
Type declaration
Returns void
filter
filters
Optional hit
Optional interactive
Optional interactive
is
is
meshes
button
Readonly children
The array of children of this container.
+container
Type declaration
Returns void
cull
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.
+cullable
Should this object be rendered if the bounds of this object are out of frame?
+Culling has no effect on whether updateTransform is called.
+cursor
display
Type declaration
Returns void
filter
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
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'.hit
interactive
interactive
is
Does any other displayObject use this object as a mask?
+is
Used to fast check if a sprite is.. a sprite!
+meshes
The meshes included in the model. Note that this array and the actual childen are not automatically synchronized after the model has been loaded.
-Optional name
parent
renderable
sort
sortable
Optional tracked
Type declaration
[x: number]: InteractionTrackingData
transform
visible
world
Static prefixed
Accessors
Protected _temp
{PIXI.Container}
-Returns TemporaryDisplayObject
angle
name
parent
renderable
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.
+sort
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.
+sortable
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 @link https://github.com/pixijs/pixi-display
+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.
+PIXI.settings.SORTABLE_CHILDREN
+tracked
Type declaration
[x: number]: InteractionTrackingData
transform
visible
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.
+world
The multiplied alpha of the displayObject.
+Static prefixed
Accessors
Protected _temp
{PIXI.Container}
+Returns TemporaryDisplayObject
angle
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.
-{number}
-Returns 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.
-{number}
-Parameters
value: number
Returns void
height
The height of the Container, setting this will actually modify the scale to achieve the value set
-{number}
-Returns number
The height of the Container, setting this will actually modify the scale to achieve the value set
-{number}
-Parameters
value: number
Returns void
local
Returns Matrix4
mask
Parameters
value: number
Returns void
destroyed
Readonly flag for destroyed display objects.
+Returns boolean
height
The height of the Container, setting this will actually modify the scale to achieve the value set.
+Returns number
The height of the Container, setting this will actually modify the scale to achieve the value set.
+Parameters
value: number
Returns void
local
Returns Matrix4
mask
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
+utilities shape clipping. Furthermore, a mask of an object must be in the subtree of its parent. +Otherwise,null.getLocalBoundsmay calculate incorrect bounds, which makes the container's width and height wrong. +To remove a mask, set this property tonull.For sprite mask both alpha and red channel are used. Black mask is the same as transparent mask.
const graphics = new PIXI.Graphics(); graphics.beginFill(0xFF3300); @@ -33,12 +100,13 @@
const sprite = new PIXI.Sprite(texture); sprite.mask = graphics;
At the moment, PIXI.CanvasRenderer doesn't support PIXI.Sprite as mask.
-{PIXI.Container|PIXI.MaskData|null}
-Returns null | Container | MaskData
Returns null | Container<DisplayObject> | 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
+utilities shape clipping. Furthermore, a mask of an object must be in the subtree of its parent. +Otherwise,null.getLocalBoundsmay calculate incorrect bounds, which makes the container's width and height wrong. +To remove a mask, set this property tonull.For sprite mask both alpha and red channel are used. Black mask is the same as transparent mask.
const graphics = new PIXI.Graphics(); graphics.beginFill(0xFF3300); @@ -47,130 +115,126 @@
const sprite = new PIXI.Sprite(texture); sprite.mask = graphics;
At the moment, PIXI.CanvasRenderer doesn't support PIXI.Sprite as mask.
-{PIXI.Container|PIXI.MaskData|null}
-Parameters
value: null | Container | MaskData
Returns void
pivot
Parameters
value: null | Container<DisplayObject> | MaskData
Returns void
pivot
The center of rotation, scaling, and skewing for this display object in its local space. The
positionis the projection ofpivotin the parent's local space.By default, the pivot is the origin (0, 0).
-PixiJS 4
-{PIXI.ObservablePoint}
-Returns ObservablePoint<any>
4.0.0
+Returns ObservablePoint<any>
The center of rotation, scaling, and skewing for this display object in its local space. The
positionis the projection ofpivotin the parent's local space.By default, the pivot is the origin (0, 0).
-PixiJS 4
-{PIXI.ObservablePoint}
-Parameters
value: ObservablePoint<any>
Returns void
position
Returns ObservablePoint3D
Parameters
value: ObservablePoint3D
Returns void
rotation
4.0.0
+Parameters
value: IPointData
Returns void
position
Returns ObservablePoint3D
Parameters
value: ObservablePoint3D
Returns void
rotation
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.
-{number}
-Returns 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.
-{number}
-Parameters
value: number
Returns void
rotation
Parameters
value: number
Returns void
rotation
The quaternion rotation of the object.
-Returns ObservableQuaternion
Parameters
value: ObservableQuaternion
Returns void
scale
Returns ObservablePoint3D
Parameters
value: ObservablePoint3D
Returns void
skew
Returns ObservableQuaternion
Parameters
value: ObservableQuaternion
Returns void
scale
Returns ObservablePoint3D
Parameters
value: ObservablePoint3D
Returns void
skew
The skew factor for the object in radians.
-PixiJS 4
-{PIXI.ObservablePoint}
-Returns ObservablePoint<any>
4.0.0
+Returns ObservablePoint<any>
The skew factor for the object in radians.
-PixiJS 4
-{PIXI.ObservablePoint}
-Parameters
value: ObservablePoint<any>
Returns void
width
The width of the Container, setting this will actually modify the scale to achieve the value set
-{number}
-Returns number
The width of the Container, setting this will actually modify the scale to achieve the value set
-{number}
-Parameters
value: number
Returns void
world
Returns Matrix4
world
4.0.0
+Parameters
value: IPointData
Returns void
width
The width of the Container, setting this will actually modify the scale to achieve the value set.
+Returns number
The width of the Container, setting this will actually modify the scale to achieve the value set.
+Parameters
value: number
Returns void
world
Returns Matrix4
world
Indicates if the object is globally visible.
-{boolean}
-Returns boolean
x
Returns boolean
x
The position of the displayObject on the x axis relative to the local coordinates of the parent. An alias to position.x
-{number}
-Returns 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
-{number}
-Parameters
value: number
Returns void
y
Parameters
value: number
Returns void
y
The position of the displayObject on the y axis relative to the local coordinates of the parent. An alias to position.y
-{number}
-Returns 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
-{number}
-Parameters
value: number
Returns void
z
Parameters
value: number
Returns void
z
The position of the object on the z axis relative to the local coordinates of the parent.
-Returns number
Returns number
The position of the object on the z axis relative to the local coordinates of the parent.
-Parameters
value: number
Returns void
z
Parameters
value: number
Returns void
z
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.
-{number}
-PIXI.Container#sortableChildren
-Returns number
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.
-{number}
-PIXI.Container#sortableChildren
-Parameters
value: number
Returns void
Methods
Protected _calculate
PIXI.Container#sortableChildren
+Parameters
value: number
Returns void
Methods
Protected _calculate
Recalculates the content bounds of this object. This should be overriden to calculate the bounds of this specific object (not including children).
-Returns void
Protected _recursive
Recursively updates transform of all objects from the root to this one -internal function for toLocal()
-Returns void
Protected _render
Returns void
Protected _recursive
Recursively updates transform of all objects from the root to this one internal function for toLocal()
+Returns void
Protected _render
To be overridden by the subclasses.
-Parameters
_renderer: Renderer
Returns void
add
Parameters
_renderer: Renderer
The renderer
+Returns void
Protected _render
Renders this object and its children with culling.
+Parameters
renderer: Renderer
The renderer
+Returns void
add
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
Type parameters
U: DisplayObject[]
Parameters
Rest ...children: U
The DisplayObject(s) to add to the container
-Returns T[0]
The first child that was added.
-add
Returns U[0]
+- The first child that was added.
+
+add
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
Type parameters
U: DisplayObject<U>
Parameters
child: U
The child to add
index: number
The index to place the child in
-Returns T
The child that was added.
-add
Parameters
event: string | symbol
fn: ListenerFn
Optional context: any
Returns Model
calculate
Returns U
The child that was added.
+add
Parameters
event: string | symbol
fn: ListenerFn
Optional context: any
Returns Model
calculate
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
create
Returns void
create
Creates a new instance of this model.
-Returns InstancedModel
destroy
Returns InstancedModel
destroy
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
disable
Parameters
Optional options: boolean | IDestroyOptions
Options parameter. A boolean will act as if all options + have been set to that value
+Returns void
disable
Pair method for
-enableTempParentParameters
cacheParent: DisplayObject
Parameters
cacheParent: Container<DisplayObject>
Actual parent of element
Returns void
emit
Calls each of the listeners registered for a given event.
-Parameters
event: string | symbol
Rest ...args: any[]
Returns boolean
enable
Parameters
event: string | symbol
Rest ...args: any[]
Returns boolean
enable
Used in Renderer, cacheAsBitmap and other places where you call an
-updateTransformon rootReturns DisplayObject
current parent
+Returns Container<DisplayObject>
+- current parent
+
event
Return an array listing the events for which the emitter has registered listeners.
-Returns (string | symbol)[]
get
Returns (string | symbol)[]
get
Calculates and returns a axis-aligned bounding box of the model in world space. The bounding box will encapsulate the meshes included in the model.
-Returns AABB
get
Returns AABB
get
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 @@ -179,13 +243,11 @@
-displayObject._bounds.getRectangle()when traversing through all the bounds in a scene graph. Otherwise, callinggetBoundson 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 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
-_boundsobject stores the last calculation of the bounds. You can use to entirely skip bounds calculation if needed.Parameters
Optional skipUpdate: boolean
Optional rect: Rectangle
Returns Rectangle
The minimum axis-aligned rectangle in world space that fits around this object.
-get
Parameters
Optional skipUpdate: boolean
Setting to
+truewill 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.Optional rect: Rectangle
Optional rectangle to store the result of the bounds calculation.
+Returns Rectangle
+- The minimum axis-aligned rectangle in world space that fits around this object.
+
+get
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 get
Parameters
name: string
Optional isRecursive: boolean
Returns DisplayObject
get
Returns DisplayObject
+- The child at the given index, if any.
+
+get
Type parameters
T: DisplayObject<T> = DisplayObject
Parameters
name: string
Optional deep: boolean
Returns T
get
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
-get
Returns number
+- The index position of the child display object to identify
+
+get
Retrieves the local bounds of the displayObject as a rectangle object.
Calling
-getLocalBoundsmay invalidate the_boundsof the whole subtree below. If using it inside a render() call, it is advised to callgetBounds()immediately after to recalculate the world bounds of the subtree.Parameters
Optional rect: Rectangle
Optional skipChildrenUpdate: boolean
Returns Rectangle
The rectangular bounding area.
+Parameters
Optional rect: Rectangle
Optional rectangle to store the result of the bounds calculation.
+Optional skipChildrenUpdate: boolean
Setting to
+truewill stop re-calculation of children transforms, + it was default behaviour of pixi 4.0-5.2 and caused many problems to users.Returns Rectangle
+- The rectangular bounding area.
+
listener
Return the number of listeners listening to a given event.
Parameters
event: string | symbol
Returns number
listeners
Return the listeners registered for a given event.
Parameters
event: string | symbol
Returns ListenerFn[]
off
Parameters
event: string | symbol
Optional fn: ListenerFn
Optional context: any
Optional once: boolean
Returns Model
on
Add a listener for a given event.
-Parameters
event: string | symbol
fn: ListenerFn
Optional context: any
Returns Model
Protected on
Overridable method that can be used by Container subclasses whenever the children array is modified
-Parameters
Optional _length: number
Returns void
once
Parameters
event: string | symbol
fn: ListenerFn
Optional context: any
Returns Model
Protected on
Overridable method that can be used by Container subclasses whenever the children array is modified.
+Parameters
Optional _length: number
Returns void
once
Add a one-time listener for a given event.
Parameters
event: string | symbol
fn: ListenerFn
Optional context: any
Returns Model
remove
Remove all listeners, or those of the specified event.
-Parameters
Optional event: string | symbol
Returns Model
remove
Parameters
Optional event: string | symbol
Returns Model
remove
Removes one or more children from the container.
-Type parameters
T: DisplayObject[]
Parameters
Rest ...children: T
Type parameters
U: DisplayObject[]
Parameters
Rest ...children: U
The DisplayObject(s) to remove
-Returns T[0]
The first child that was removed.
-remove
Returns U[0]
The first child that was removed.
+remove
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.
-remove
remove
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
+Parameters
Optional beginIndex: number
The beginning position.
+Optional endIndex: number
The ending position. Default value is size of the container.
+Returns DisplayObject[]
+- List of removed children
+
remove
Remove the listeners of a given event.
-Parameters
event: string | symbol
Optional fn: ListenerFn
Optional context: any
Optional once: boolean
Returns Model
render
Parameters
event: string | symbol
Optional fn: ListenerFn
Optional context: any
Optional once: boolean
Returns Model
render
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
-rendermethod will invoke it, and also invoke therendermethods of all children afterward.If
renderableorvisibleis false or ifworldAlphais not positive, this implementation will entirely -skip rendering. See {@link PIXI.DisplayObject} for choosing betweenrenderableorvisible. Generally, +If
renderableorvisibleis false or ifworldAlphais not positive or ifcullableis true and +the bounds of this object are out of frame, this implementation will entirely skip rendering. +See {@link PIXI.DisplayObject} for choosing betweenrenderableorvisible. 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 +advised to employ culling to automatically skip rendering objects outside of the current screen. +See [cullable]{@link PIXI.DisplayObject#cullable} and [cullArea]{@link PIXI.DisplayObject#cullArea}. +Other culling methods might be better suited for a large number static objects; see @pixi-essentials/cull and -pixi-cull packages do this out of the box.
+pixi-cull.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 render
Returns void
Protected render
Render the object using the WebGL renderer and advanced features.
Parameters
renderer: Renderer
The renderer
-Returns void
set
Returns void
set
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
set
Returns void
set
Set the parent Container of this DisplayObject.
-Parameters
container: Container
Parameters
container: Container<DisplayObject>
The Container to add this DisplayObject to.
-Returns Container
The Container that this DisplayObject was added to.
-set
Returns Container<DisplayObject>
+- The Container that this DisplayObject was added to.
+
+set
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 Model
The DisplayObject instance
-sort
Parameters
Optional x: number
The X position
+Optional y: number
The Y position
+Optional scaleX: number
The X scale value
+Optional scaleY: number
The Y scale value
+Optional rotation: number
The rotation
+Optional skewX: number
The X skew value
+Optional skewY: number
The Y skew value
+Optional pivotX: number
The X pivot value
+Optional pivotY: number
The Y pivot value
+Returns Model
+- The DisplayObject instance
+
+sort
Sorts children by zIndex. Previous order is maintained for 2 children with the same zIndex.
-Returns void
swap
Returns void
swap
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
to
Returns void
to
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.
-to
Optional point: P
A Point object in which to store the value, optional + (otherwise will create a new Point).
+Optional skipUpdate: boolean
Should we skip the update transform.
+Returns P
+- A point object representing the position of this object.
+
+to
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
-update
Updates the transform on all children of this container for rendering
-Returns void
Static from
Optional from: DisplayObject
The DisplayObject to calculate the global position from.
+Optional point: P
A Point object in which to store the value, optional + (otherwise will create a new Point).
+Optional skipUpdate: boolean
Should we skip the update transform
+Returns P
+- A point object representing the position of this object
+
+update
Updates the transform on all children of this container for rendering.
+Returns void
Static from
Creates a new model from a source.
Parameters
source: glTFAsset
The source to create the model from.
Optional materialFactory: MaterialFactory
The factory to use for creating materials.
-Returns Model
Static mixin
Returns Model
Static mixin
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
Returns void
Generated using TypeDoc
- Preparing search index...
- The search index is not available
Pixi3D - v1.5.1Class ObservablePoint3D
- Preparing search index...
- The search index is not available
Pixi3D - v1.6.0Class ObservablePoint3D
Represents a point in 3D space.
-Hierarchy
Index
Constructors
Properties
Accessors
Methods
Constructors
constructor
Hierarchy
Index
Constructors
Properties
Accessors
Methods
Constructors
constructor
Creates a new observable point.
Parameters
cb: () => void
The callback when changed.
@@ -12,23 +12,29 @@The position on the y axis.
z: number = 0
The position on the z axis.
-Returns ObservablePoint3D
Properties
_x
_y
cb
Type declaration
Returns any
scope
Accessors
array
Returns ObservablePoint3D
Properties
_x
_y
cb
Type declaration
The callback function triggered when
+xand/oryare changedReturns any
scope
The owner of the callback
+Accessors
array
Array containing the x, y, z values.
-Returns Float32Array
Returns Float32Array
Array containing the x, y, z values.
-Parameters
value: Float32Array
Returns void
x
Parameters
value: Float32Array
Returns void
x
Position on the x axis relative to the local coordinates of the parent.
-Returns number
Returns number
Position on the x axis relative to the local coordinates of the parent.
-Parameters
value: number
Returns void
y
Parameters
value: number
Returns void
y
Position on the y axis relative to the local coordinates of the parent.
-Returns number
Returns number
Position on the y axis relative to the local coordinates of the parent.
-Parameters
value: number
Returns void
z
Parameters
value: number
Returns void
z
Position on the z axis relative to the local coordinates of the parent.
-Returns number
Returns number
Position on the z axis relative to the local coordinates of the parent.
-Parameters
value: number
Returns void
Methods
clone
Parameters
cb: () => any = ...
Returns any
scope: any = ...
Returns ObservablePoint3D
copy
Parameters
p: ObservablePoint3D
Returns ObservablePoint3D
copy
Type parameters
T: IPoint<T>
Parameters
p: T
Returns T
equals
Parameters
p: ObservablePoint3D
Returns boolean
set
Parameters
value: number
Returns void
Methods
clone
Parameters
cb: () => any = ...
The callback function triggered when
+xand/oryare changedReturns any
scope: any = ...
Returns ObservablePoint3D
copy
Parameters
p: ObservablePoint3D
Returns ObservablePoint3D
copy
Type parameters
T: IPoint<T>
Parameters
p: T
Returns T
equals
Parameters
p: ObservablePoint3D
Returns boolean
set
Sets the point to a new x, y and z position.
Parameters
x: number
The position on the x axis.
@@ -36,8 +42,8 @@The position on the y axis.
z: number = x
The position on the z axis.
-Returns ObservablePoint3D
set
Returns ObservablePoint3D
set
Sets the point to a new x, y and z position.
Parameters
array: ArrayLike<number>
The array containing x, y and z, expected length is 3.
-Returns ObservablePoint3D
to
Returns string
Generated using TypeDoc
Returns ObservablePoint3D
to
Returns string
Generated using TypeDoc
- Preparing search index...
- The search index is not available
Pixi3D - v1.5.1Class ObservableQuaternion
- Preparing search index...
- The search index is not available
Pixi3D - v1.6.0Class ObservableQuaternion
Represents a rotation quaternion in 3D space.
-Hierarchy
Index
Constructors
Properties
Accessors
Methods
Constructors
constructor
Hierarchy
Index
Constructors
Properties
Accessors
Methods
Constructors
constructor
Creates a new observable quaternion.
Parameters
cb: () => void
The callback when changed.
@@ -14,45 +14,51 @@The z component.
w: number = 1
The w component.
-Returns ObservableQuaternion
Properties
_x
_y
cb
Type declaration
Returns any
scope
Accessors
array
Returns ObservableQuaternion
Properties
_x
_y
cb
Type declaration
The callback function triggered when
+xand/oryare changedReturns any
scope
The owner of the callback
+Accessors
array
Array containing the x, y, z, w values.
-Returns Float32Array
Returns Float32Array
Array containing the x, y, z, w values.
-Parameters
value: Float32Array
Returns void
w
Parameters
value: Float32Array
Returns void
w
The w component of the quaternion.
-Returns number
Returns number
The w component of the quaternion.
-Parameters
value: number
Returns void
x
Parameters
value: number
Returns void
x
The x component of the quaternion.
-Returns number
Returns number
The x component of the quaternion.
-Parameters
value: number
Returns void
y
Parameters
value: number
Returns void
y
The y component of the quaternion.
-Returns number
Returns number
The y component of the quaternion.
-Parameters
value: number
Returns void
z
Parameters
value: number
Returns void
z
The z component of the quaternion.
-Returns number
Returns number
The z component of the quaternion.
-Parameters
value: number
Returns void
Methods
clone
Parameters
value: number
Returns void
Methods
clone
Creates a clone of this quaternion.
Parameters
cb: () => any = ...
Callback when changed.
-Returns any
scope: any = ...
The callback function triggered when
+xand/oryare changedReturns any
scope: any = ...
Owner of callback.
-Returns ObservableQuaternion
copy
Returns ObservableQuaternion
copy
Copies x, y, z, and w from the given quaternion.
Parameters
p: ObservableQuaternion
The quaternion to copy from.
-Returns ObservableQuaternion
copy
Returns ObservableQuaternion
copy
Copies x, y, z and w into the given quaternion.
Type parameters
T: IPoint<T>
Parameters
p: T
The quaternion to copy to.
-Returns T
equals
Returns T
equals
Returns true if the given quaternion is equal to this quaternion.
Parameters
p: ObservableQuaternion
The quaternion to check.
-Returns boolean
set
Returns boolean
set
Sets the quaternion to new x, y, z and w components.
Parameters
x: number
X component to set.
@@ -62,7 +68,7 @@Z component to set.
w: number = x
W component to set.
-Returns ObservableQuaternion
set
Returns ObservableQuaternion
set
Sets the euler angles in degrees.
Parameters
x: number
The x angle.
@@ -70,8 +76,8 @@The y angle.
z: number
The z angle.
-Returns void
set
Returns void
set
Sets the quaternion to a new x, y, z and w components.
Parameters
array: ArrayLike<number>
The array containing x, y, z and w, expected length is 4.
-Returns ObservableQuaternion
to
Returns string
Generated using TypeDoc
Returns ObservableQuaternion
to
Returns string
Generated using TypeDoc
- Preparing search index...
- The search index is not available
Pixi3D - v1.5.1Class PickingHitArea
- Preparing search index...
- The search index is not available
Pixi3D - v1.6.0Class PickingHitArea
Hit area which uses the shape of an object to determine interaction.
-Hierarchy
Implements
Index
Constructors
Properties
Methods
Constructors
constructor
Hierarchy
Implements
Index
Constructors
Properties
Methods
Constructors
constructor
Creates a new hitarea using the specified object.
Parameters
renderer: undefined | Renderer
Not used, accepts any value. Only here for compatibility reasons.
@@ -9,9 +9,9 @@Optional camera: Camera
The camera to use when rendering the object picking shape. If not set, the main camera will be used as default.
-Returns PickingHitArea
Properties
Optional camera
id
Returns PickingHitArea
Properties
Optional camera
id
The id which maps to the object.
-object
Methods
contains
Parameters
x: number
y: number
Returns boolean
Static from
object
Methods
contains
Parameters
x: number
y: number
Returns boolean
Static from
Creates a new hitarea using the specified object.
Parameters
object: Mesh3D | Model
The model or mesh to use as the shape for hit testing.
diff --git a/docs/classes/PickingInteraction.html b/docs/classes/PickingInteraction.html index b01bd599..d0c5dd6e 100644 --- a/docs/classes/PickingInteraction.html +++ b/docs/classes/PickingInteraction.html @@ -1,15 +1,15 @@ -- Preparing search index...
- The search index is not available
Pixi3D - v1.5.1Class PickingInteraction
- Preparing search index...
- The search index is not available
Pixi3D - v1.6.0Class PickingInteraction
Manages the picking hit areas by keeping track on which hit areas needs to be checked for interaction. Renders the hit area meshes to a texture which is then used to map a mesh to a x/y coordinate. The picking manager is registered as a renderer plugin.
-Hierarchy
Implements
Index
Constructors
Properties
Methods
Constructors
constructor
Hierarchy
Implements
Index
Constructors
Properties
Methods
Constructors
constructor
Creates a new picking manager using the specified renderer.
Parameters
renderer: Renderer
The renderer to use.
-Returns PickingInteraction
Properties
renderer
Static main
Returns PickingInteraction
Properties
renderer
Static main
The main picking interaction which is used by default.
-Methods
contains
Methods
contains
Hit tests a area using the specified x/y coordinates.
Parameters
x: number
The x coordinate.
@@ -17,4 +17,4 @@The y coordinate.
hitArea: PickingHitArea
The hit area to test.
-Returns boolean
destroy
Returns void
Generated using TypeDoc
Returns boolean
destroy
Returns void
Generated using TypeDoc
- Preparing search index...
- The search index is not available
Pixi3D - v1.5.1Class Plane
Hierarchy
Index
Constructors
Properties
Accessors
Methods
Constructors
constructor
Parameters
normal: Float32Array
distance: number
Returns Plane
Properties
distance
Accessors
normal
Returns Float32Array
Methods
ray
Parameters
ray: Ray
Returns number
Generated using TypeDoc
- Preparing search index...
- The search index is not available
Pixi3D - v1.6.0Class Plane
Hierarchy
Index
Constructors
Properties
Accessors
Methods
Constructors
constructor
Parameters
normal: Float32Array
distance: number
Returns Plane
Properties
distance
Accessors
normal
Returns Float32Array
Methods
ray
Parameters
ray: Ray
Returns number
Generated using TypeDoc
- Preparing search index...
- The search index is not available
Pixi3D - v1.5.1Class PostProcessingSprite
- Preparing search index...
- The search index is not available
Pixi3D - v1.6.0Class PostProcessingSprite
Represents a sprite which can have post processing effects. Can be used for rendering 3D objects as 2D sprites.
-Hierarchy
Index
Constructors
Properties
Accessors
Methods
Constructors
constructor
Hierarchy
Index
Constructors
Properties
Accessors
Methods
Constructors
constructor
Creates a new post processing sprite using the specified options.
Parameters
renderer: Renderer
The renderer to use.
Optional options: PostProcessingSpriteOptions
The options for the render texture. If both width and height has not been set, it will automatically be resized to the renderer size.
-Returns PostProcessingSprite
Properties
Protected _anchor
_bounds
Protected _boundsID
Protected _bounds
_cached
Protected _destroyed
Protected _enabled
_height
_last
_local
Protected _local
_mask
_texture
_textureID
Protected _texture
_tintRGB
Optional _tracked
Type declaration
[x: number]: InteractionTrackingData
_width
Protected _z
alpha
blend
Optional button
Readonly children
container
Type declaration
Returns void
Optional cursor
display
Type declaration
Returns void
filter
filters
Optional hit
indices
Optional interactive
Optional interactive
is
is
Optional name
parent
plugin
renderable
renderer
sort
sortable
Optional tracked
Type declaration
[x: number]: InteractionTrackingData
transform
Protected uvs
Protected vertex
visible
world
Static prefixed
Accessors
Protected _temp
{PIXI.Container}
-Returns TemporaryDisplayObject
anchor
Returns PostProcessingSprite
Properties
Protected _anchor
The anchor point defines the normalized coordinates +in the texture that map to the position of this +sprite.
+By default, this is
+(0,0)(ortexture.defaultAnchor+if you have modified that), which means the position +(x,y)of thisSpritewill be the top-left corner.Note: Updating
+texture.defaultAnchorafter +constructing aSpritedoes not update its anchor.https://docs.cocos2d-x.org/cocos2d-x/en/sprites/manipulation.html
+
+this.texture.defaultAnchor_bounds
The bounds object, this is used to calculate and store the bounds of the displayObject.
+Protected _boundsID
Flags the cached bounds as dirty.
+Protected _bounds
Cache of this display-object's bounds-rectangle.
+Protected _cached
Cached tint value so we can tell when the tint is changed. +Value is used for 2d CanvasRenderer.
+0xFFFFFF
+Protected _destroyed
If the object has been destroyed via destroy(). If true, it should not be used.
+Protected _enabled
Currently enabled filters.
+Protected _height
The height of the sprite (this is initially set by the texture)
+Protected _last
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
Local bounds object, swapped with
+_boundswhen usinggetLocalBounds().Protected _local
Cache of this display-object's local-bounds rectangle.
+Protected _mask
The original, cached mask of the object.
+_textureID
Protected _texture
_tracked
Type declaration
[x: number]: InteractionTrackingData
Protected _width
The width of the sprite (this is initially set by the texture).
+Protected _z
The zIndex of the displayObject. +A higher value will mean it will be rendered on top of other displayObjects within the same container.
+alpha
The opacity of the object.
+blend
The blend mode to be applied to the sprite. Apply a value of
+PIXI.BLEND_MODES.NORMALto reset the blend mode.PIXI.BLEND_MODES.NORMAL
+button
Readonly children
The array of children of this container.
+container
Type declaration
Returns void
cull
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.
+cullable
Should this object be rendered if the bounds of this object are out of frame?
+Culling has no effect on whether updateTransform is called.
+cursor
display
Type declaration
Returns void
filter
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
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'.hit
indices
interactive
interactive
is
Does any other displayObject use this object as a mask?
+is
Used to fast check if a sprite is.. a sprite!
+name
parent
plugin
Plugin that is responsible for rendering this element. +Allows to customize the rendering process without overriding '_render' & '_renderCanvas' methods.
+'batch'
+renderable
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.
+renderer
sort
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.
+sortable
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 @link https://github.com/pixijs/pixi-display
+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.
+PIXI.settings.SORTABLE_CHILDREN
+tracked
Type declaration
[x: number]: InteractionTrackingData
transform
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.
+Protected uvs
This is used to store the uvs data of the sprite, assigned at the same time +as the vertexData in calculateVertices().
+{Float32Array}
+Protected vertex
This is used to store the vertex data of the sprite (basically a quad).
+{Float32Array}
+visible
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.
+world
The multiplied alpha of the displayObject.
+Static prefixed
Accessors
Protected _temp
{PIXI.Container}
+Returns TemporaryDisplayObject
anchor
The anchor sets the origin point of the sprite. The default value is taken from the {@link PIXI.Texture|Texture} and passed to the constructor.
The default is
@@ -18,8 +121,7 @@(0,0), this means the sprite's origin is the top left.If you pass only single parameter, it will set both x and y to the same value as shown in the example below.
const sprite = new PIXI.Sprite(texture); sprite.anchor.set(0.5); // This will set the origin to center. (0.5) is same as (0.5, 0.5).
-{PIXI.ObservablePoint}
-Returns ObservablePoint<any>
Returns ObservablePoint<any>
The anchor sets the origin point of the sprite. The default value is taken from the {@link PIXI.Texture|Texture} and passed to the constructor.
The default is
@@ -28,31 +130,29 @@(0,0), this means the sprite's origin is the top left.If you pass only single parameter, it will set both x and y to the same value as shown in the example below.
const sprite = new PIXI.Sprite(texture); sprite.anchor.set(0.5); // This will set the origin to center. (0.5) is same as (0.5, 0.5).
-{PIXI.ObservablePoint}
-Parameters
value: ObservablePoint<any>
Returns void
angle
Parameters
value: ObservablePoint<any>
Returns void
angle
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.
-{number}
-Returns 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.
-{number}
-Parameters
value: number
Returns void
depth
Parameters
value: number
Returns void
depth
The depth texture.
-Returns undefined | BaseTexture<Resource, IAutoDetectOptions>
height
The height of the sprite, setting this will actually modify the scale to achieve the value set
-{number}
-Returns number
The height of the sprite, setting this will actually modify the scale to achieve the value set
-{number}
-Parameters
value: number
Returns void
local
Returns undefined | BaseTexture<Resource, IAutoDetectOptions>
destroyed
Readonly flag for destroyed display objects.
+Returns boolean
height
The height of the sprite, setting this will actually modify the scale to achieve the value set.
+Returns number
The height of the sprite, setting this will actually modify the scale to achieve the value set.
+Parameters
value: number
Returns void
local
Current transform of the object based on local factors: position, scale, other stuff.
-{PIXI.Matrix}
-Returns Matrix
mask
Returns Matrix
mask
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
+utilities shape clipping. Furthermore, a mask of an object must be in the subtree of its parent. +Otherwise,null.getLocalBoundsmay calculate incorrect bounds, which makes the container's width and height wrong. +To remove a mask, set this property tonull.For sprite mask both alpha and red channel are used. Black mask is the same as transparent mask.
const graphics = new PIXI.Graphics(); graphics.beginFill(0xFF3300); @@ -61,12 +161,13 @@
const sprite = new PIXI.Sprite(texture); sprite.mask = graphics;
At the moment, PIXI.CanvasRenderer doesn't support PIXI.Sprite as mask.
-{PIXI.Container|PIXI.MaskData|null}
-Returns null | Container | MaskData
Returns null | Container<DisplayObject> | 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
+utilities shape clipping. Furthermore, a mask of an object must be in the subtree of its parent. +Otherwise,null.getLocalBoundsmay calculate incorrect bounds, which makes the container's width and height wrong. +To remove a mask, set this property tonull.For sprite mask both alpha and red channel are used. Black mask is the same as transparent mask.
const graphics = new PIXI.Graphics(); graphics.beginFill(0xFF3300); @@ -75,180 +176,160 @@
const sprite = new PIXI.Sprite(texture); sprite.mask = graphics;
At the moment, PIXI.CanvasRenderer doesn't support PIXI.Sprite as mask.
-{PIXI.Container|PIXI.MaskData|null}
-Parameters
value: null | Container | MaskData
Returns void
pivot
Parameters
value: null | Container<DisplayObject> | MaskData
Returns void
pivot
The center of rotation, scaling, and skewing for this display object in its local space. The
positionis the projection ofpivotin the parent's local space.By default, the pivot is the origin (0, 0).
-PixiJS 4
-{PIXI.ObservablePoint}
-Returns ObservablePoint<any>
4.0.0
+Returns ObservablePoint<any>
The center of rotation, scaling, and skewing for this display object in its local space. The
positionis the projection ofpivotin the parent's local space.By default, the pivot is the origin (0, 0).
-PixiJS 4
-{PIXI.ObservablePoint}
-Parameters
value: ObservablePoint<any>
Returns void
position
4.0.0
+Parameters
value: IPointData
Returns void
position
The coordinate of the object relative to the local coordinates of the parent.
-PixiJS 4
-{PIXI.ObservablePoint}
-Returns ObservablePoint<any>
4.0.0
+Returns ObservablePoint<any>
The coordinate of the object relative to the local coordinates of the parent.
-PixiJS 4
-{PIXI.ObservablePoint}
-Parameters
value: ObservablePoint<any>
Returns void
render
4.0.0
+Parameters
value: IPointData
Returns void
render
The render texture.
-Returns RenderTexture
rotation
Returns RenderTexture
rotation
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.
-{number}
-Returns 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.
-{number}
-Parameters
value: number
Returns void
round
If true PixiJS will Math.floor() x/y values when rendering, stopping pixel interpolation. -Advantages can include sharper image quality (like text) and faster rendering on canvas. -The main disadvantage is movement of objects may appear less smooth. -To set the global default, change {@link PIXI.settings.ROUND_PIXELS}
-{boolean}
-false
-Returns boolean
If true PixiJS will Math.floor() x/y values when rendering, stopping pixel interpolation. -Advantages can include sharper image quality (like text) and faster rendering on canvas. -The main disadvantage is movement of objects may appear less smooth. -To set the global default, change {@link PIXI.settings.ROUND_PIXELS}
-{boolean}
-false
-Parameters
value: boolean
Returns void
scale
Parameters
value: number
Returns void
round
If true PixiJS will Math.floor() x/y values when rendering, stopping pixel interpolation.
+Advantages can include sharper image quality (like text) and faster rendering on canvas. +The main disadvantage is movement of objects may appear less smooth.
+To set the global default, change {@link PIXI.settings.ROUND_PIXELS}.
+false
+Returns boolean
If true PixiJS will Math.floor() x/y values when rendering, stopping pixel interpolation.
+Advantages can include sharper image quality (like text) and faster rendering on canvas. +The main disadvantage is movement of objects may appear less smooth.
+To set the global default, change {@link PIXI.settings.ROUND_PIXELS}.
+false
+Parameters
value: boolean
Returns void
scale
The scale factors of this object along the local coordinate axes.
The default scale is (1, 1).
-PixiJS 4
-{PIXI.ObservablePoint}
-Returns ObservablePoint<any>
4.0.0
+Returns ObservablePoint<any>
The scale factors of this object along the local coordinate axes.
The default scale is (1, 1).
-PixiJS 4
-{PIXI.ObservablePoint}
-Parameters
value: ObservablePoint<any>
Returns void
skew
4.0.0
+Parameters
value: IPointData
Returns void
skew
The skew factor for the object in radians.
-PixiJS 4
-{PIXI.ObservablePoint}
-Returns ObservablePoint<any>
4.0.0
+Returns ObservablePoint<any>
The skew factor for the object in radians.
-PixiJS 4
-{PIXI.ObservablePoint}
-Parameters
value: ObservablePoint<any>
Returns void
texture
The texture that the sprite is using
-{PIXI.Texture}
-Returns Texture<Resource>
The texture that the sprite is using
-{PIXI.Texture}
-Parameters
value: Texture<Resource>
Returns void
tint
The tint applied to the sprite. This is a hex value. -A value of 0xFFFFFF will remove any tint effect.
-{number}
-0xFFFFFF
-Returns number
The tint applied to the sprite. This is a hex value. -A value of 0xFFFFFF will remove any tint effect.
-{number}
-0xFFFFFF
-Parameters
value: number
Returns void
width
The width of the sprite, setting this will actually modify the scale to achieve the value set
-{number}
-Returns number
The width of the sprite, setting this will actually modify the scale to achieve the value set
-{number}
-Parameters
value: number
Returns void
world
4.0.0
+Parameters
value: IPointData
Returns void
texture
The texture that the sprite is using.
+Returns Texture<Resource>
The texture that the sprite is using.
+Parameters
value: Texture<Resource>
Returns void
tint
The tint applied to the sprite. This is a hex value.
+A value of 0xFFFFFF will remove any tint effect.
+0xFFFFFF
+Returns number
The tint applied to the sprite. This is a hex value.
+A value of 0xFFFFFF will remove any tint effect.
+0xFFFFFF
+Parameters
value: number
Returns void
width
The width of the sprite, setting this will actually modify the scale to achieve the value set.
+Returns number
The width of the sprite, setting this will actually modify the scale to achieve the value set.
+Parameters
value: number
Returns void
world
Current transform of the object based on world (parent) factors.
-{PIXI.Matrix}
-Returns Matrix
world
Returns Matrix
world
Indicates if the object is globally visible.
-{boolean}
-Returns boolean
x
Returns boolean
x
The position of the displayObject on the x axis relative to the local coordinates of the parent. An alias to position.x
-{number}
-Returns 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
-{number}
-Parameters
value: number
Returns void
y
Parameters
value: number
Returns void
y
The position of the displayObject on the y axis relative to the local coordinates of the parent. An alias to position.y
-{number}
-Returns 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
-{number}
-Parameters
value: number
Returns void
z
Parameters
value: number
Returns void
z
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.
-{number}
-PIXI.Container#sortableChildren
-Returns number
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.
-{number}
-PIXI.Container#sortableChildren
-Parameters
value: number
Returns void
Methods
Protected _calculate
PIXI.Container#sortableChildren
+Parameters
value: number
Returns void
Methods
Protected _calculate
Updates the bounds of the sprite.
-Returns void
Protected _on
When the texture is updated, this event will fire to update the scale and frame
-Returns void
Protected _recursive
Recursively updates transform of all objects from the root to this one -internal function for toLocal()
-Returns void
Protected _render
Returns void
Protected _on
When the texture is updated, this event will fire to update the scale and frame.
+Returns void
Protected _recursive
Recursively updates transform of all objects from the root to this one internal function for toLocal()
+Returns void
Protected _render
Renders the object using the WebGL renderer
Parameters
renderer: Renderer
The webgl renderer to use.
-Returns void
add
Returns void
Protected _render
Renders this object and its children with culling.
+Parameters
renderer: Renderer
The renderer
+Returns void
add
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
Type parameters
U: DisplayObject[]
Parameters
Rest ...children: U
The DisplayObject(s) to add to the container
-Returns T[0]
The first child that was added.
-add
Returns U[0]
+- The first child that was added.
+
+add
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
Type parameters
U: DisplayObject<U>
Parameters
child: U
The child to add
index: number
The index to place the child in
-Returns T
The child that was added.
-add
Parameters
event: string | symbol
fn: ListenerFn
Optional context: any
Returns PostProcessingSprite
calculate
Returns U
The child that was added.
+add
Parameters
event: string | symbol
fn: ListenerFn
Optional context: any
Returns PostProcessingSprite
calculate
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
calculate
calculates worldTransform * vertices for a non texture with a trim. store it in vertexTrimmedData -This is used to ensure that the true width and height of a trimmed texture is respected
-Returns void
calculate
calculates worldTransform * vertices, store it in vertexData
-Returns void
contains
Returns void
calculate
Calculates worldTransform * vertices for a non texture with a trim. store it in vertexTrimmedData.
+This is used to ensure that the true width and height of a trimmed texture is respected.
+Returns void
calculate
Calculates worldTransform * vertices, store it in vertexData.
+Returns void
contains
Tests if a point is inside this sprite
Parameters
point: IPointData
the point to test
-Returns boolean
the result of the test
-destroy
Parameters
Optional options: boolean | IDestroyOptions
Returns void
disable
Returns boolean
The result of the test
+destroy
Parameters
Optional options: boolean | IDestroyOptions
Returns void
disable
Pair method for
-enableTempParentParameters
cacheParent: DisplayObject
Parameters
cacheParent: Container<DisplayObject>
Actual parent of element
Returns void
emit
Calls each of the listeners registered for a given event.
-Parameters
event: string | symbol
Rest ...args: any[]
Returns boolean
enable
Parameters
event: string | symbol
Rest ...args: any[]
Returns boolean
enable
Used in Renderer, cacheAsBitmap and other places where you call an
-updateTransformon rootReturns DisplayObject
current parent
+Returns Container<DisplayObject>
+- current parent
+
event
Return an array listing the events for which the emitter has registered listeners.
-Returns (string | symbol)[]
get
Returns (string | symbol)[]
get
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 @@ -257,13 +338,11 @@
-displayObject._bounds.getRectangle()when traversing through all the bounds in a scene graph. Otherwise, callinggetBoundson 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 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
-_boundsobject stores the last calculation of the bounds. You can use to entirely skip bounds calculation if needed.Parameters
Optional skipUpdate: boolean
Optional rect: Rectangle
Returns Rectangle
The minimum axis-aligned rectangle in world space that fits around this object.
-get
Parameters
Optional skipUpdate: boolean
Setting to
+truewill 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.Optional rect: Rectangle
Optional rectangle to store the result of the bounds calculation.
+Returns Rectangle
+- The minimum axis-aligned rectangle in world space that fits around this object.
+
+get
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 get
Parameters
name: string
Optional isRecursive: boolean
Returns DisplayObject
get
Returns DisplayObject
+- The child at the given index, if any.
+
+get
Type parameters
T: DisplayObject<T> = DisplayObject
Parameters
name: string
Optional deep: boolean
Returns T
get
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
-get
Returns number
+- The index position of the child display object to identify
+
+get
Gets the local bounds of the sprite object.
-Parameters
Optional rect: Rectangle
Returns Rectangle
The bounds.
+Parameters
Optional rect: Rectangle
Optional output rectangle.
+Returns Rectangle
The bounds.
listener
Return the number of listeners listening to a given event.
Parameters
event: string | symbol
Returns number
listeners
Return the listeners registered for a given event.
Parameters
event: string | symbol
Returns ListenerFn[]
off
Parameters
event: string | symbol
Optional fn: ListenerFn
Optional context: any
Optional once: boolean
Returns PostProcessingSprite
on
Add a listener for a given event.
-Parameters
event: string | symbol
fn: ListenerFn
Optional context: any
Returns PostProcessingSprite
Protected on
Overridable method that can be used by Container subclasses whenever the children array is modified
-Parameters
Optional _length: number
Returns void
once
Parameters
event: string | symbol
fn: ListenerFn
Optional context: any
Returns PostProcessingSprite
Protected on
Overridable method that can be used by Container subclasses whenever the children array is modified.
+Parameters
Optional _length: number
Returns void
once
Add a one-time listener for a given event.
Parameters
event: string | symbol
fn: ListenerFn
Optional context: any
Returns PostProcessingSprite
remove
Remove all listeners, or those of the specified event.
-Parameters
Optional event: string | symbol
Returns PostProcessingSprite
remove
Parameters
Optional event: string | symbol
Returns PostProcessingSprite
remove
Removes one or more children from the container.
-Type parameters
T: DisplayObject[]
Parameters
Rest ...children: T
Type parameters
U: DisplayObject[]
Parameters
Rest ...children: U
The DisplayObject(s) to remove
-Returns T[0]
The first child that was removed.
-remove
Returns U[0]
The first child that was removed.
+remove
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.
-remove
remove
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
+Parameters
Optional beginIndex: number
The beginning position.
+Optional endIndex: number
The ending position. Default value is size of the container.
+Returns DisplayObject[]
+- List of removed children
+
remove
Remove the listeners of a given event.
-Parameters
event: string | symbol
Optional fn: ListenerFn
Optional context: any
Optional once: boolean
Returns PostProcessingSprite
render
Parameters
event: string | symbol
Optional fn: ListenerFn
Optional context: any
Optional once: boolean
Returns PostProcessingSprite
render
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
-rendermethod will invoke it, and also invoke therendermethods of all children afterward.If
renderableorvisibleis false or ifworldAlphais not positive, this implementation will entirely -skip rendering. See {@link PIXI.DisplayObject} for choosing betweenrenderableorvisible. Generally, +If
renderableorvisibleis false or ifworldAlphais not positive or ifcullableis true and +the bounds of this object are out of frame, this implementation will entirely skip rendering. +See {@link PIXI.DisplayObject} for choosing betweenrenderableorvisible. 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 +advised to employ culling to automatically skip rendering objects outside of the current screen. +See [cullable]{@link PIXI.DisplayObject#cullable} and [cullArea]{@link PIXI.DisplayObject#cullArea}. +Other culling methods might be better suited for a large number static objects; see @pixi-essentials/cull and -pixi-cull packages do this out of the box.
+pixi-cull.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 render
Returns void
Protected render
Render the object using the WebGL renderer and advanced features.
Parameters
renderer: Renderer
The renderer
-Returns void
render
Returns void
render
Updates the sprite's texture by rendering the specified object to it.
Parameters
object: DisplayObject
The object to render.
-Returns void
set
Returns void
set
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
set
Returns void
set
Set the parent Container of this DisplayObject.
-Parameters
container: Container
Parameters
container: Container<DisplayObject>
The Container to add this DisplayObject to.
-Returns Container
The Container that this DisplayObject was added to.
-set
Returns Container<DisplayObject>
+- The Container that this DisplayObject was added to.
+
+set
Sets the resolution of the render texture.
Parameters
resolution: number
The resolution to set.
-Returns void
set
Returns void
set
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 PostProcessingSprite
The DisplayObject instance
-sort
Parameters
Optional x: number
The X position
+Optional y: number
The Y position
+Optional scaleX: number
The X scale value
+Optional scaleY: number
The Y scale value
+Optional rotation: number
The rotation
+Optional skewX: number
The X skew value
+Optional skewY: number
The Y skew value
+Optional pivotX: number
The X pivot value
+Optional pivotY: number
The Y pivot value
+Returns PostProcessingSprite
+- The DisplayObject instance
+
+sort
Sorts children by zIndex. Previous order is maintained for 2 children with the same zIndex.
-Returns void
swap
Returns void
swap
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
to
Returns void
to
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.
-to
Optional point: P
A Point object in which to store the value, optional + (otherwise will create a new Point).
+Optional skipUpdate: boolean
Should we skip the update transform.
+Returns P
+- A point object representing the position of this object.
+
+to
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
-update
Updates the transform on all children of this container for rendering
-Returns void
Static from
Optional from: DisplayObject
The DisplayObject to calculate the global position from.
+Optional point: P
A Point object in which to store the value, optional + (otherwise will create a new Point).
+Optional skipUpdate: boolean
Should we skip the update transform
+Returns P
+- A point object representing the position of this object
+
+update
Updates the transform on all children of this container for rendering.
+Returns void
Static from
Helper function that creates a new sprite based on the source you provide. The source can be - frame id, image url, video url, canvas element, video element, base texture
-Parameters
source: SpriteSource
Parameters
source: SpriteSource
Source to create texture from
Optional options: IBaseTextureOptions<any>
Returns Sprite
The newly created sprite
-Static mixin
Static mixin
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
Returns void
Generated using TypeDoc
- Preparing search index...
- The search index is not available
Pixi3D - v1.5.1Class Quat
Hierarchy
Index
Constructors
Methods
Constructors
constructor
Returns Quat
Methods
Static conjugate
Parameters
a: Float32Array
out: Float32Array = ...
Returns Float32Array
Static create
Returns Float32Array
Static from
Parameters
x: number
y: number
z: number
out: Float32Array = ...
Returns Float32Array
Static from
Parameters
x: number
y: number
z: number
w: number
Returns Float32Array
Static normalize
Parameters
a: Float32Array
out: Float32Array = ...
Returns Float32Array
Static rotateX
Parameters
a: Float32Array
rad: number
out: Float32Array = ...
Returns Float32Array
Static rotateY
Parameters
a: Float32Array
rad: number
out: Float32Array = ...
Returns Float32Array
Static rotateZ
Parameters
a: Float32Array
rad: number
out: Float32Array = ...
Returns Float32Array
Static set
Parameters
x: number
y: number
z: number
w: number
out: Float32Array = ...
Returns Float32Array
Static slerp
Parameters
a: Float32Array
b: Float32Array
t: number
out: Float32Array = ...
Returns Float32Array
Generated using TypeDoc
- Preparing search index...
- The search index is not available
Pixi3D - v1.6.0Class Quat
Hierarchy
Index
Constructors
Methods
Constructors
constructor
Returns Quat
Methods
Static conjugate
Parameters
a: Float32Array
out: Float32Array = ...
Returns Float32Array
Static create
Returns Float32Array
Static from
Parameters
x: number
y: number
z: number
out: Float32Array = ...
Returns Float32Array
Static from
Parameters
x: number
y: number
z: number
w: number
Returns Float32Array
Static normalize
Parameters
a: Float32Array
out: Float32Array = ...
Returns Float32Array
Static rotateX
Parameters
a: Float32Array
rad: number
out: Float32Array = ...
Returns Float32Array
Static rotateY
Parameters
a: Float32Array
rad: number
out: Float32Array = ...
Returns Float32Array
Static rotateZ
Parameters
a: Float32Array
rad: number
out: Float32Array = ...
Returns Float32Array
Static set
Parameters
x: number
y: number
z: number
w: number
out: Float32Array = ...
Returns Float32Array
Static slerp
Parameters
a: Float32Array
b: Float32Array
t: number
out: Float32Array = ...
Returns Float32Array
Generated using TypeDoc
- Preparing search index...
- The search index is not available
Pixi3D - v1.5.1Class Ray
Hierarchy
Index
Constructors
Accessors
Methods
Constructors
constructor
Parameters
origin: Float32Array
direction: Float32Array
Returns Ray
Accessors
direction
Returns Float32Array
origin
Returns Float32Array
Methods
get
Parameters
distance: number
point: Float32Array = ...
Returns Float32Array
Generated using TypeDoc
- Preparing search index...
- The search index is not available
Pixi3D - v1.6.0Class Ray
Hierarchy
Index
Constructors
Accessors
Methods
Constructors
constructor
Parameters
origin: Float32Array
direction: Float32Array
Returns Ray
Accessors
direction
Returns Float32Array
origin
Returns Float32Array
Methods
get
Parameters
distance: number
point: Float32Array = ...
Returns Float32Array
Generated using TypeDoc
- Preparing search index...
- The search index is not available
Pixi3D - v1.5.1Class ShadowCastingLight
- Preparing search index...
- The search index is not available
Pixi3D - v1.6.0Class ShadowCastingLight
Contains the required components used for rendering a shadow casted by a light.
-Hierarchy
Index
Constructors
Properties
Accessors
Methods
Constructors
constructor
Hierarchy
Index
Constructors
Properties
Accessors
Methods
Constructors
constructor
Creates a new shadow casting light used for rendering a shadow texture.
Parameters
renderer: Renderer
The renderer to use.
@@ -8,35 +8,35 @@The light which is casting the shadow.
Optional options: ShadowCastingLightOptions
The options to use when creating the shadow texture.
-Returns ShadowCastingLight
Properties
Optional camera
Returns ShadowCastingLight
Properties
Optional camera
The camera to follow when using directional lights.
-follow
follow
Value indicating if the shadow should follow the specified camera. If the camera is not set, the main camera will be used as default. Only available when using directional lights.
-light
renderer
shadow
light
renderer
shadow
The area in units of the shadow when using directional lights. Reducing the area will improve the quality of the shadow.
-softness
softness
The softness of the edges for the shadow.
-Accessors
filter
Accessors
filter
The rendered filter texture.
-Returns RenderTexture
light
Returns RenderTexture
light
The light view projection matrix.
-Returns Float32Array
shadow
Returns Float32Array
shadow
The rendered shadow texture.
-Returns RenderTexture
Methods
clear
Returns RenderTexture
Methods
clear
Clears the rendered shadow texture.
-Returns void
destroy
Returns void
destroy
Destroys the shadow casting light and it's used resources.
-Returns void
update
Returns void
update
Updates the light view projection matrix.
-Returns void
Static is
Returns void
Static is
Returns a value indicating if high quality (32-bit precision) shadows is supported by current platform.
Parameters
renderer: Renderer
The renderer to use.
-Returns boolean
Static is
Returns boolean
Static is
Returns a value indicating if medium quality (16-bit precision) shadows is supported by current platform.
Parameters
renderer: Renderer
- Preparing search index...
- The search index is not available
Pixi3D - v1.5.1Class ShadowRenderPass
- Preparing search index...
- The search index is not available
Pixi3D - v1.6.0Class ShadowRenderPass
Pass used for rendering shadows.
-Hierarchy
Implements
Index
Constructors
Properties
Methods
Constructors
constructor
Hierarchy
Implements
Index
Constructors
Properties
Methods
Constructors
constructor
Creates a new shadow render pass using the specified renderer.
Parameters
renderer: Renderer
The renderer to use.
@@ -8,16 +8,16 @@The name for the render pass.
Returns ShadowRenderPass
Properties
name
The name of the render pass.
-renderer
Methods
add
renderer
Methods
add
Adds a shadow casting light.
Parameters
shadowCastingLight: ShadowCastingLight
The light to add.
-Returns void
clear
Returns void
clear
Clears the render pass. Used when rendering to a texture.
-Returns void
remove
Returns void
remove
Removes a shadow casting light.
Parameters
shadowCastingLight: ShadowCastingLight
The light to remove.
-Returns void
render
Returns void
render
Renders the specified meshes.
Parameters
meshes: Mesh3D[]
Returns void
Generated using TypeDoc
- Preparing search index...
- The search index is not available
Pixi3D - v1.5.1Class Skin
- Preparing search index...
- The search index is not available
Pixi3D - v1.6.0