Class ParticleStaticMeshShapeOptions

Information describing a ParticleEmitterStaticMeshShape.

Index

Constructors

Properties

_isSequentiallyEmitted _mesh _type

Accessors

isSequentiallyEmitted mesh type

Methods

assign clone isEqual isEqual

Constructors

constructor

new ParticleStaticMeshShapeOptions(type?, isSequentiallyEmitted?, mesh?): ParticleStaticMeshShapeOptions
Parameters
- Optionaltype: EnumValue<ParticleEmitterMeshType, number>
- OptionalisSequentiallyEmitted: boolean
- Optionalmesh: ResourceHandle<Mesh>
Returns ParticleStaticMeshShapeOptions

Properties

`Protected`_isSequentiallyEmitted

_isSequentiallyEmitted: boolean

`Protected`_mesh

_mesh: ResourceHandle<Mesh>

`Protected`_type

_type: EnumValue<ParticleEmitterMeshType, number>

Accessors

isSequentiallyEmitted

get isSequentiallyEmitted(): boolean
When enabled the particles will be emitted sequentially from mesh vertices in the order they are defined. Only relevant for the Vertex emit mode.

Returns boolean
set isSequentiallyEmitted(value): void
Parameters
- value: boolean
Returns void

mesh

get mesh(): ResourceHandle<Mesh>
Mesh to spawn particles on. Must at least contain per-vertex position data encoded as 3D float vectors. Can optionally contain per-vertex normals encoded as 3D float vectors or as 4-byte unsigned-normalized format.

Returns ResourceHandle<Mesh>
set mesh(value): void
Parameters
- value: ResourceHandle<Mesh>
Returns void

type

get type(): EnumValue<ParticleEmitterMeshType, number>
Determines from which portion of the mesh are the particles emitted from.

Returns EnumValue<ParticleEmitterMeshType, number>
set type(value): void
Parameters
- value: EnumValue<ParticleEmitterMeshType, number>
Returns void

Methods

assign

assign(other): ParticleStaticMeshShapeOptions
Copies all properties defined by the prototype of ParticleStaticMeshShapeOptions from other to this instance.
Parameters
- other: Immutable<ParticleStaticMeshShapeOptions>
Returns ParticleStaticMeshShapeOptions

clone

clone(): ParticleStaticMeshShapeOptions
Clones this instance and returns a new ParticleStaticMeshShapeOptions with identical values.

Returns ParticleStaticMeshShapeOptions

isEqual

isEqual(this, other): boolean
Determines if this ParticleStaticMeshShapeOptions instance is equal to the other instance.
Parameters
- this: Immutable<ParticleStaticMeshShapeOptions>
- other: Immutable<ParticleStaticMeshShapeOptions>
Returns boolean

`Static`isEqual

isEqual(lhs, rhs): boolean
Determines if both ParticleStaticMeshShapeOptions instances are equal.
Parameters
- lhs: Immutable<ParticleStaticMeshShapeOptions>
- rhs: Immutable<ParticleStaticMeshShapeOptions>
Returns boolean