three-nebula API
    Preparing search index...

    Class Particle

    A Particle is an object that is emitted by an emitter.

    Hierarchy (View Summary)

    Index
    constructor
    acceleration age alpha behaviours body color dead distanceToCamera easing energy hasBeenInitialized? id index? life mass old parent position radius rotation scale sleep target? transform type useAlpha useColor velocity
    addBehaviour addBehaviours destroy getDirection removeAllBehaviours removeBehaviour reset update

    • Constructs a Particle instance.

      Parameters

      • properties: Record<string, unknown> = {}

        The properties to instantiate the particle with

      Returns Particle

    acceleration: Vector3D
    age: number
    alpha: number
    behaviours: Behaviour[]

    body

    body: unknown
    color: RGB
    dead: boolean
    distanceToCamera: number
    easing: EasingFunction
    energy: number
    hasBeenInitialized?: boolean
    id: string
    index?: number
    life: number
    mass: number
    old: { acceleration: Vector3D; position: Vector3D; velocity: Vector3D }
    parent: Emitter | System | null
    position: Vector3D
    radius: number
    rotation: Vector3D
    scale: number
    sleep: boolean
    target?: unknown
    transform: Record<string, unknown>
    type: string
    useAlpha: boolean
    useColor: boolean
    velocity: Vector3D

    • Resets the particle's default properties and clears its position, velocity, acceleration, color and rotation.

      Returns this

    • Updates the particle's properties by applying each behaviour to it.

      Parameters

      • time: number
      • Optionalindex: number

      Returns void

    Settings
    Member Visibility

    On This Page
    Constructors
    Properties
    Methods