new PIXI.particles.ParticleContainer(maxSize, properties, batchSize)
Name | Type | Default | Description | ||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
maxSize |
number | 15000 |
optional
The maximum number of particles that can be renderer by the container. |
||||||||||||||||||||||||
properties |
object |
optional
The properties of children that should be uploaded to the gpu and applied.
|
|||||||||||||||||||||||||
batchSize |
number | 15000 |
optional
Number of particles per batch. |
Extends
Members
-
cacheAsBitmapboolean
-
Set this to true if you want this display object to be cached as a bitmap.
This basically takes a snap shot of the display object as it is at that moment. It can
provide a performance benefit for complex static displayObjects.
To remove simply set this property to 'false' -
filters
-
Shallow copies the array to the filters of the object.
-
height
-
Sets the height of the container by modifying the scale.
-
mask
-
Sets the mask.
-
pivot
-
Copies the point to the pivot of the object.
-
position
-
Copies the point to the position of the object.
-
rotation
-
Sets the rotation of the object.
-
scale
-
Copies the point to the scale of the object.
-
skew
-
Copies the point to the skew of the object.
-
width
-
Sets the width of the container by modifying the scale.
-
x
-
Sets the X position of the object.
-
y
-
Sets the Y position of the object.
Methods
-
inherited _calculateBounds()
-
Recalculates the bounds of the object. Override this to
calculate the bounds of the specific object (not including children). -
inherited _recursivePostUpdateTransform()
-
recursively updates transform of all objects from the root to this one
internal function for toLocal() -
inherited addChild(child){PIXI.DisplayObject}
-
Adds a child or multiple children to the container.
Multple items can be added like so:
myContainer.addChild(thinkOne, thingTwo, thingThree)
Name Type Description child
PIXI.DisplayObject repeatable The DisplayObject(s) to add to the container
Returns:
Type Description PIXI.DisplayObject The first child that was added. -
inherited addChildAt(child, index){PIXI.DisplayObject}
-
Adds a child to the container at a specified index. If the index is out of bounds an error will be thrown
Name Type Description child
PIXI.DisplayObject The child to add
index
number The index to place the child in
Returns:
Type Description PIXI.DisplayObject The child that was added. -
inherited calculateBounds()
-
Recalculates the bounds of the container.
-
destroy(options)
-
Destroys the container
Name Type Description options
object | boolean optional Options parameter. A boolean will act as if all options
have been set to that valueName Type Default Description children
boolean false optional if set to true, all the children will have their
destroy method called as well. 'options' will be passed on to those calls. -
inherited getBounds(skipUpdate, rect){PIXI.Rectangle}
-
Retrieves the bounds of the displayObject as a rectangle object.
Name Type Description 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 boostrect
PIXI.Rectangle Optional rectangle to store the result of the bounds calculation
Returns:
Type Description PIXI.Rectangle the rectangular bounding area -
inherited getChildAt(index){PIXI.DisplayObject}
-
Returns the child at the specified index
Name Type Description index
number The index to get the child at
Returns:
Type Description PIXI.DisplayObject The child at the given index, if any. -
inherited getChildIndex(child){number}
-
Returns the index position of a child DisplayObject instance
Name Type Description child
PIXI.DisplayObject The DisplayObject instance to identify
Returns:
Type Description number The index position of the child display object to identify -
inherited getLocalBounds(rect){PIXI.Rectangle}
-
Retrieves the local bounds of the displayObject as a rectangle object
Name Type Description rect
PIXI.Rectangle optional Optional rectangle to store the result of the bounds calculation
Returns:
Type Description PIXI.Rectangle the rectangular bounding area -
inherited removeChild(childs){PIXI.DisplayObject}
-
Removes a child from the container.
Name Type Description childs
PIXI.DisplayObject repeatable The DisplayObject(s) to remove
Returns:
Type Description PIXI.DisplayObject The first child that was removed. -
inherited removeChildAt(index){PIXI.DisplayObject}
-
Removes a child from the specified index position.
Name Type Description index
number The index to get the child from
Returns:
Type Description PIXI.DisplayObject The child that was removed. -
inherited removeChildren(beginIndex, endIndex){Array.<DisplayObject>}
-
Removes all children from this container that are within the begin and end indexes.
Name Type Default Description beginIndex
number 0 optional The beginning position.
endIndex
number this.children.length optional The ending position. Default value is size of the container.
Returns:
Type Description Array.<DisplayObject> List of removed children -
inherited setChildIndex(child, index)
-
Changes the position of an existing child in the display object container
Name Type Description child
PIXI.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
-
inherited setParent(container){PIXI.Container}
-
Set the parent Container of this DisplayObject
Name Type Description container
PIXI.Container The Container to add this DisplayObject to
Returns:
Type Description PIXI.Container The Container that this DisplayObject was added to -
setProperties(properties)
-
Sets the private properties array to dynamic / static based on the passed properties object
Name Type Description properties
object The properties to be uploaded
-
inherited setTransform(x, y, scaleX, scaleY, rotation, skewX, skewY, pivotX, pivotY){PIXI.DisplayObject}
-
Convenience function to set the postion, scale, skew and pivot at once.
Name Type Default Description x
number 0 optional The X position
y
number 0 optional The Y position
scaleX
number 1 optional The X scale value
scaleY
number 1 optional The Y scale value
rotation
number 0 optional The rotation
skewX
number 0 optional The X skew value
skewY
number 0 optional The Y skew value
pivotX
number 0 optional The X pivot value
pivotY
number 0 optional The Y pivot value
Returns:
Type Description PIXI.DisplayObject The DisplayObject instance -
inherited swapChildren(child, child2)
-
Swaps the position of 2 Display Objects within this container.
Name Type Description child
PIXI.DisplayObject First display object to swap
child2
PIXI.DisplayObject Second display object to swap
-
inherited toGlobal(position, point, skipUpdate){PIXI.Point}
-
Calculates the global position of the display object
Name Type Default Description position
PIXI.Point The world origin to calculate from
point
PIXI.Point optional A Point object in which to store the value, optional
(otherwise will create a new Point)skipUpdate
boolean false optional Should we skip the update transform.
Returns:
Type Description PIXI.Point A point object representing the position of this object -
inherited toLocal(position, from, point, skipUpdate){PIXI.Point}
-
Calculates the local position of the display object relative to another point
Name Type Default Description position
PIXI.Point The world origin to calculate from
from
PIXI.DisplayObject optional The DisplayObject to calculate the global position from
point
PIXI.Point optional A Point object in which to store the value, optional
(otherwise will create a new Point)skipUpdate
boolean false optional Should we skip the update transform
Returns:
Type Description PIXI.Point A point object representing the position of this object