PixiJS Particle Emitter - Spawn Shape

Spawn Shape creates a shape to emit particles from. By default it can emit from shapes formed by a circle, donut, rectangle, and lines between points.

Parameters

• type: string - There are three predefined Spawn Shapes: ‘torus’, ‘rect’, and ‘polygonalChain’. You can also define your own custom shape by modifying the source code. Each type has its own configuration parameters as below.

torus (with an alias of “circle”)

• radius: number - The radius of the torus.
• innerRadius?: number - The inner radius of the torus. Optional, defaults to 0 (a circle).
• x?: number: x position relative to the emitter’s position. Optional, defaults to 0.
• y?: number: y position relative to the emitter’s position. Optional, defaults to 0.
• affectRotation?: If emitted particles should be pointed away from the center of the torus. Optional, defaults to false.

rect

• x: number: X (left) position of the rectangle.
• y: number: Y (top) position of the rectangle.
• w: number: Width of the rectangle.
• h: number: Height of the rectangle.

polygonalChain

• data: number[][]: N array/s of points { x: number, y: number }. The point positions are relative to the emitter’s position.

Examples::

Torus

Example Configurations: – other configuration excluded for brevity

{
  type: 'spawnShape',
  config: {
    type: 'torus',
    data: {
      radius: 42,
      innerRadius: 40,
      affectRotation: true
    }
  }
}

{
  type: 'spawnShape',
  config: {
    type: 'rect',
    data: { x: 0, y: 0, w: 100, h: 10 }
  }
},

{
  type: 'spawnShape',
  config: {
    type: 'polygonalChain',
    data: [
      [
        {x: 0, y: 0},
        {x: 200, y: 0},
        {x: 300, y: 100},
        {x: 260, y: 140},
        {x: -40, y: 140},
        {x: -80, y: 100},
        {x: 0, y: 0}
      ],
      [
        {x: -80, y: 100},
        {x: 300, y: 100}
      ]
    ]
  }
}

PixiJS Particle Emitter: The Unauthorized Manual