Class ShapeModule

constructor

• new ShapeModule(): ShapeModule

• Returns ShapeModule

randomPositionAmount

enable

• get enable(): boolean

• Specifies whether enable the module.

  Returns boolean

  Memberof

  ParticleModule

• set enable(value): void

• Specifies whether enable the module.

  Parameters

  • value: boolean

  Returns void

  Memberof

  ParticleModule

position

• get position(): Readonly<Vector3>

• Get shape position

  Returns Readonly<Vector3>

  Memberof

  ShapeModule

• set position(value): void

• Set shape position

  Parameters

  • value: Vector3

  Returns void

  Memberof

  ShapeModule

randomDirectionAmount

• get randomDirectionAmount(): number

• Get randomizes the starting direction of particles.

  Returns number

  Memberof

  ShapeModule

• set randomDirectionAmount(value): void

• Set randomizes the starting direction of particles.

  Parameters

  • value: number

  Returns void

  Memberof

  ShapeModule

rotation

• get rotation(): Readonly<Euler>

• Get shape rotation

  Returns Readonly<Euler>

  Memberof

  ShapeModule

• set rotation(value): void

• Set shape rotation

  Parameters

  • value: Euler

  Returns void

  Memberof

  ShapeModule

scale

• get scale(): Readonly<Vector3>

• Get shape scale

  Returns Readonly<Vector3>

  Memberof

  ShapeModule

• set scale(value): void

• Set shape scale

  Parameters

  • value: Vector3

  Returns void

  Memberof

  ShapeModule

shape

• get shape(): Shape

• Get active shape to emit particles from.

  Returns Shape

  Memberof

  ShapeModule

shapeType

• get shapeType(): ParticleSystemShapeType

• Get shape type.

  Returns ParticleSystemShapeType

  Memberof

  ShapeModule

• set shapeType(value): void

• Set shape type

  Parameters

  • value: ParticleSystemShapeType

  Returns void

  Memberof

  ShapeModule

sphericalDirectionAmount

• get sphericalDirectionAmount(): number

• Get spherizes the starting direction of particles.

  Returns number

  Memberof

  ShapeModule

• set sphericalDirectionAmount(value): void

• Set spherizes the starting direction of particles.

  Parameters

  • value: number

  Returns void

  Memberof

  ShapeModule

system

• get system(): ParticleSystem

• Get the particle system.

  Returns ParticleSystem

  Memberof

  ParticleModule

dispose

• dispose(): void

• Dispose module.

  Returns void

  Memberof

  ParticleModule

emit

• emit(event): void

• Emit event

  Parameters

  • event: {
        type: string;
        [key: string]: any;
    }

    • [key: string]: any

    • type: string

  Returns void

  Memberof

  EventDispatcher

fromJSON

• fromJSON(json): void

• Deserialize

  Parameters

  • json: {
        [key: string]: any;
    }

    • [key: string]: any

  Returns void

  Memberof

  ShapeModule

off

• off(type, callback?): void

• Unsubscribe a event, if the callback param is not defined, all subscribers of this type will be removed.

  Parameters

  • type: string
  • Optionalcallback: SubscriberCallbackFn

    subscriber callback

  Returns void

  Memberof

  EventDispatcher

on

• on(type, callback, options?): void

• Subscribe a event

  Parameters

  • type: string

    event type
  • callback: SubscriberCallbackFn

    callback functions
  • Optionaloptions: {
        priority?: Priority;
        target?: any;
    }

    options

    • Optionalpriority?: Priority

    • Optionaltarget?: any

  Returns void

  Memberof

  EventDispatcher

once

• once(type, callback, options?): void

• Subscribe a event, just emit once

  Parameters

  • type: string
  • callback: SubscriberCallbackFn

    subscriber callback
  • Optionaloptions: {
        priority?: Priority;
        target?: any;
    }

    • Optionalpriority?: Priority

    • Optionaltarget?: any

  Returns void

  Memberof

  EventDispatcher

toJSON

• toJSON(): {
      [key: string]: any;
  }

• Serialize

  Returns {
      [key: string]: any;
  }

  • [key: string]: any

  Memberof

  ParticleModule