new HeightMap()
- Description:
Class representing a HeightMap particle system. Extends the ParticleBase class.
Extends ParticleBase
- Source:
Classes
Members
knownKeys :Array.<string>
- Description:
Known keys for shader settings.
- Source:
Known keys for shader settings.
Type:
- Array.<string>
shaderSettings :Object
- Description:
Shader settings for the height map particles.
- Source:
Properties:
| Name | Type | Description |
|---|---|---|
vertCount |
number | Number of vertices. |
pScale |
number | Scale of the particles. |
pOpacity |
number | Opacity of the particles. |
proxDist |
number | Proximity distance. |
atlasRes |
number | Atlas resolution. |
atlasPicks |
Array | Atlas picks. |
randomAtlas |
boolean | Random atlas flag. |
additiveBlend |
boolean | Additive blending flag. |
jumpHeightMult |
number | Jump height multiplier |
offsetPos |
Vector3 | Offset position. |
windDir |
Vector3 | Wind direction. |
hasLights |
boolean | Lights flag. |
fadeOutScalar |
number | Fade out scalar. |
wanderInf |
number | Wander influence. |
wanderRate |
number | Wander rate. |
wanderFrequency |
number | Wander frequency. |
Shader settings for the height map particles.
Type:
- Object
Methods
build(curShaderSettingsopt, objectRefopt) → {Object}
- Description:
Builds the particle system with the given shader settings and object reference.
- Source:
Parameters:
| Name | Type | Attributes | Default | Description |
|---|---|---|---|---|
curShaderSettings |
Object |
<optional> |
{}
|
The current shader settings. |
objectRef |
Object |
<optional> |
null
|
The reference object for positioning and sizing. |
Returns:
The particle system added to the scene.
- Type
- Object
setHeightMapPath(path)
- Description:
Sets the path for the height map texture.
- Source:
Parameters:
| Name | Type | Description |
|---|---|---|
path |
string | The path to the height map texture. |
setSpawnMapPath(path, channelsopt)
- Description:
Sets the path for the spawn map texture and its mode.
- Source:
Parameters:
| Name | Type | Attributes | Default | Description |
|---|---|---|---|---|
path |
string | The path to the spawn map texture. |
||
channels |
number |
<optional> |
1
|
The number of channels in the spawn map texture. |