com.amap.api.maps.model.particle

## 类 ParticleOverlayOptions

- java.lang.Object
- - com.amap.api.maps.model.BaseOptions
  - - com.amap.api.maps.model.particle.ParticleOverlayOptions

- 所有已实现的接口:
    android.os.Parcelable, java.lang.Cloneable

      public class ParticleOverlayOptions
      extends BaseOptions
      implements android.os.Parcelable, java.lang.Cloneable

  粒子效果初始化属性控制
  建议在`AMap.OnMapLoadedListener` 之后调用
  Particle effect initialization property control
  It is recommended to call after `AMap.OnMapLoadedListener`
  从以下版本开始:
    6.5.0

- - ### 嵌套类概要

    - ### 从接口继承的嵌套类/接口 android.os.Parcelable

      `android.os.Parcelable.ClassLoaderCreator<T>, android.os.Parcelable.Creator<T>`

  - ### 字段概要

    - ### 从接口继承的字段 android.os.Parcelable

      `CONTENTS_FILE_DESCRIPTOR, PARCELABLE_WRITE_RETURN_VALUE`

  - ### 构造器概要

    构造器
    构造器和说明
    `ParticleOverlayOptions()` 粒子效果初始化属性控制 Particle effect initialization property control

  - ### 方法概要

    所有方法 实例方法 具体方法
    限定符和类型 | 方法和说明
    --- | ---
    `long` | `getDuration()` 整个粒子效果的存活时间,单位毫秒 Survival time of the entire particle effect, in milliseconds
    `BitmapDescriptor` | `getIcon()` 获取粒子效果的图标 Get the icon of the particle effect
    `int` | `getMaxParticles()` 整个粒子效果的粒子最大数量 Maximum number of particles in the entire particle effect
    `ParticleEmissionModule` | `getParticleEmissionModule()` 发射率，每隔多少时间发射粒子数量，越多会越密集 Emission rate, the number of particles emitted at each interval, the more the denser
    `long` | `getParticleLifeTime()` 每个粒子的存活时间,单位毫秒 Survival time of each particle, in milliseconds
    `ParticleOverLifeModule` | `getParticleOverLifeModule()` 每个粒子生命周期过程中状态变化，包含速度、旋转和颜色的变化 State changes during the life cycle of each particle, including changes in speed, rotation, and color
    `ParticleShapeModule` | `getParticleShapeModule()` 发射模型，比如所有粒子从一个点出来，或者从某个区域出来 Emission model, such as all particles coming out from a point or from a certain area
    `ColorGenerate` | `getParticleStartColor()` 每个粒子的初始颜色 Initial color of each particle
    `VelocityGenerate` | `getParticleStartSpeed()` 获取初始速度 Get the initial velocity
    `int` | `getstartParticleH()` 粒子显示大小-高度 Particle display size - height
    `int` | `getStartParticleW()` 粒子显示大小-宽度 Particle display size - width
    `float` | `getZIndex()` 获取覆盖物的Z轴值 Get the Z-axis value of the overlay
    `ParticleOverlayOptions` | `icon(BitmapDescriptor icon)` 设置覆盖物的图标。
    `boolean` | `isLoop()` 整个粒子效果是否循环 Whether the entire particle effect loops
    `boolean` | `isVisible()` 覆盖物的可见属性。
    `ParticleOverlayOptions` | `setDuration(long duration)` 整个粒子效果的存活时间,单位毫秒 Survival time of the entire particle effect, in milliseconds
    `ParticleOverlayOptions` | `setLoop(boolean loop)` 整个粒子效果是否循环 Whether the entire particle effect loops
    `ParticleOverlayOptions` | `setMaxParticles(int maxParticles)` 整个粒子效果的粒子最大数量 Maximum number of particles in the entire particle effect
    `ParticleOverlayOptions` | `setParticleEmissionModule(ParticleEmissionModule particleEmissionModule)` 发射率，每个多少时间发射粒子数量，越多会越密集 Emission rate, the number of particles emitted at each interval, the more the denser
    `ParticleOverlayOptions` | `setParticleLifeTime(long particleLifeTime)` 每个粒子的存活时间,单位毫秒 Survival time of each particle, in milliseconds
    `ParticleOverlayOptions` | `setParticleOverLifeModule(ParticleOverLifeModule particleOverLifeModule)` 每个粒子生命周期过程中状态变化，包含速度、旋转和颜色的变化 State changes during the life cycle of each particle, including changes in speed, rotation, and color
    `ParticleOverlayOptions` | `setParticleShapeModule(ParticleShapeModule particleShapeModule)` 发射模型，比如所有粒子从一个点出来，或者从某个区域出来 Emission model, such as all particles coming out from a point or from a certain area
    `ParticleOverlayOptions` | `setParticleStartColor(ColorGenerate startColor)` 每个粒子的初始颜色 Initial color of each particle
    `ParticleOverlayOptions` | `setParticleStartSpeed(VelocityGenerate startSpeed)` 粒子初始速度，每秒多少个像素 Initial velocity of particles, in pixels per second
    `ParticleOverlayOptions` | `setStartParticleSize(int startParticleW, int startParticleH)` 粒子显示大小-宽高 Particle display size - width and height
    `ParticleOverlayOptions` | `setVisible(boolean visible)` 设置 覆盖物的可见属性。
    `ParticleOverlayOptions` | `zIndex(float zIndex)` 获取覆盖物Z轴的值。

    - ### 从类继承的方法 java.lang.Object

      `clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait`

    - ### 从接口继承的方法 android.os.Parcelable

      `describeContents, writeToParcel`

- - ### 构造器详细资料

    - #### ParticleOverlayOptions

          public ParticleOverlayOptions()

      粒子效果初始化属性控制
      Particle effect initialization property control
      从以下版本开始:
        6.5.0

  - ### 方法详细资料

    - #### icon

          public ParticleOverlayOptions icon(BitmapDescriptor icon)

      设置覆盖物的图标。相同图案的 icon 的 覆盖物 最好使用同一个 BitmapDescriptor 对象以节省内存空间。
      Set the icon of the overlay. It is best to use the same BitmapDescriptor object for overlays with the same icon pattern to save memory space.
      参数:
        `icon` - 图标的BitmapDescriptor对象
        BitmapDescriptor object of the icon
      返回:
        ParticleSystemOptions对象。
        ParticleSystemOptions Object
      从以下版本开始:
        6.5.0

    - #### getIcon

          public BitmapDescriptor getIcon()

      获取粒子效果的图标
      Get the icon of the particle effect
      返回:

    - #### getMaxParticles

          public int getMaxParticles()

      整个粒子效果的粒子最大数量
      Maximum number of particles in the entire particle effect
      从以下版本开始:
        6.5.0

    - #### setMaxParticles

          public ParticleOverlayOptions setMaxParticles(int maxParticles)

      整个粒子效果的粒子最大数量
      Maximum number of particles in the entire particle effect
      从以下版本开始:
        6.5.0

    - #### isLoop

          public boolean isLoop()

      整个粒子效果是否循环
      Whether the entire particle effect loops
      从以下版本开始:
        6.5.0

    - #### setLoop

          public ParticleOverlayOptions setLoop(boolean loop)

      整个粒子效果是否循环
      Whether the entire particle effect loops
      从以下版本开始:
        6.5.0

    - #### getDuration

          public long getDuration()

      整个粒子效果的存活时间,单位毫秒
      Survival time of the entire particle effect, in milliseconds
      从以下版本开始:
        6.5.0

    - #### setDuration

          public ParticleOverlayOptions setDuration(long duration)

      整个粒子效果的存活时间,单位毫秒
      Survival time of the entire particle effect, in milliseconds
      从以下版本开始:
        6.5.0

    - #### getParticleLifeTime

          public long getParticleLifeTime()

      每个粒子的存活时间,单位毫秒
      Survival time of each particle, in milliseconds
      从以下版本开始:
        6.5.0

    - #### setParticleLifeTime

          public ParticleOverlayOptions setParticleLifeTime(long particleLifeTime)

      每个粒子的存活时间,单位毫秒
      Survival time of each particle, in milliseconds
      从以下版本开始:
        6.5.0

    - #### getParticleEmissionModule

          public ParticleEmissionModule getParticleEmissionModule()

      发射率，每隔多少时间发射粒子数量，越多会越密集
      Emission rate, the number of particles emitted at each interval, the more the denser
      从以下版本开始:
        6.5.0

    - #### setParticleEmissionModule

          public ParticleOverlayOptions setParticleEmissionModule(ParticleEmissionModule particleEmissionModule)

      发射率，每个多少时间发射粒子数量，越多会越密集
      Emission rate, the number of particles emitted at each interval, the more the denser
      从以下版本开始:
        6.5.0

    - #### getParticleShapeModule

          public ParticleShapeModule getParticleShapeModule()

      发射模型，比如所有粒子从一个点出来，或者从某个区域出来
      Emission model, such as all particles coming out from a point or from a certain area
      从以下版本开始:
        6.5.0

    - #### setParticleShapeModule

          public ParticleOverlayOptions setParticleShapeModule(ParticleShapeModule particleShapeModule)

      发射模型，比如所有粒子从一个点出来，或者从某个区域出来
      Emission model, such as all particles coming out from a point or from a certain area
      从以下版本开始:
        6.5.0

    - #### getParticleStartSpeed

          public VelocityGenerate getParticleStartSpeed()

      获取初始速度
      Get the initial velocity
      返回:
      从以下版本开始:
        6.5.0

    - #### setParticleStartSpeed

          public ParticleOverlayOptions setParticleStartSpeed(VelocityGenerate startSpeed)

      粒子初始速度，每秒多少个像素
      Initial velocity of particles, in pixels per second
      参数:
        `startSpeed` - 单位 像素/秒
        Unit: pixels/second
      从以下版本开始:
        6.5.0

    - #### setParticleStartColor

          public ParticleOverlayOptions setParticleStartColor(ColorGenerate startColor)

      每个粒子的初始颜色
      Initial color of each particle
      从以下版本开始:
        6.5.0

    - #### getParticleStartColor

          public ColorGenerate getParticleStartColor()

      每个粒子的初始颜色
      Initial color of each particle
      从以下版本开始:
        6.5.0

    - #### setParticleOverLifeModule

          public ParticleOverlayOptions setParticleOverLifeModule(ParticleOverLifeModule particleOverLifeModule)

      每个粒子生命周期过程中状态变化，包含速度、旋转和颜色的变化
      State changes during the life cycle of each particle, including changes in speed, rotation, and color
      从以下版本开始:
        6.5.0

    - #### getParticleOverLifeModule

          public ParticleOverLifeModule getParticleOverLifeModule()

      每个粒子生命周期过程中状态变化，包含速度、旋转和颜色的变化
      State changes during the life cycle of each particle, including changes in speed, rotation, and color
      从以下版本开始:
        6.5.0

    - #### setStartParticleSize

          public ParticleOverlayOptions setStartParticleSize(int startParticleW,
                                                             int startParticleH)

      粒子显示大小-宽高
      Particle display size - width and height
      从以下版本开始:
        6.5.0

    - #### getStartParticleW

          public int getStartParticleW()

      粒子显示大小-宽度
      Particle display size - width
      从以下版本开始:
        6.5.0

    - #### getstartParticleH

          public int getstartParticleH()

      粒子显示大小-高度
      Particle display size - height
      从以下版本开始:
        6.5.0

    - #### zIndex

          public ParticleOverlayOptions zIndex(float zIndex)

      获取覆盖物Z轴的值。
      Get the Z-axis value of the overlay.
      参数:
        `zIndex` - 要设置的Z轴的值。
        The value of the Z-axis to be set.
      返回:
        ParticleSystemOptions对象。
        ParticleSystemOptions Object.
      从以下版本开始:
        6.5.0

    - #### getZIndex

          public float getZIndex()

      获取覆盖物的Z轴值
      Get the Z-axis value of the overlay
      返回:
        Z轴值
        Z-axis value
      从以下版本开始:
        6.5.0

    - #### setVisible

          public ParticleOverlayOptions setVisible(boolean visible)

      设置 覆盖物的可见属性。
      Set the visibility property of the overlay.
      参数:
        `visible` - 一个布尔值，表示覆盖物是否可见，true表示可见，false表示不可见。
        A boolean value indicating whether the overlay is visible, true means visible, false means invisible.
      从以下版本开始:
        6.5.0

    - #### isVisible

          public boolean isVisible()

      覆盖物的可见属性。
      Visibility property of the overlay.
      从以下版本开始:
        6.5.0