Mesh Shape

MeshShape

2024.4.16

yisky

Hierarchy (view full)

Constructors

Properties

meshShapeType: ParticleSystemMeshShapeType = ParticleSystemMeshShapeType.Vertex

Where on the Mesh to emit particles from.

MeshShape

meshSpawnMode: ParticleSystemShapeMultiModeValue = ParticleSystemShapeMultiModeValue.Random

The mode to use to generate particles on a Mesh.

MeshShape

normalOffset: number = 0.0

Move particles away from the surface of the source Mesh.

MeshShape

useMeshColors: boolean = true

Modulate the particle colors with the vertex colors, or the Material color if no vertex colors exist.

MeshShape

Accessors

  • get mesh(): Mesh<BufferGeometry<NormalBufferAttributes>, Material | Material[], Object3DEventMap>
  • Mesh to emit particles from.

    Returns Mesh<BufferGeometry<NormalBufferAttributes>, Material | Material[], Object3DEventMap>

    MeshShape

  • set mesh(value): void
  • Mesh to emit particles from.

    Parameters

    • value: Mesh<BufferGeometry<NormalBufferAttributes>, Material | Material[], Object3DEventMap>

    Returns void

    MeshShape

  • get meshMaterialIndex(): number
  • Emit particles from a single Material of a Mesh.

    Returns number

    MeshShape

  • set meshMaterialIndex(value): void
  • Emit particles from a single Material of a Mesh.

    Parameters

    • value: number

    Returns void

    MeshShape

  • get useMeshMaterialIndex(): boolean
  • Emit particles from a single Material, or the whole Mesh.

    Returns boolean

    MeshShape

  • set useMeshMaterialIndex(value): void
  • Emit particles from a single Material, or the whole Mesh.

    Parameters

    • value: boolean

    Returns void

    MeshShape

Methods

  • Deserialize

    Parameters

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

    Returns void

    MeshShape

  • Serialize

    Returns {
        [key: string]: any;
    }

    • [key: string]: any

    MeshShape