Documentation / scene / GrassLayer
Class: GrassLayer
Defined in: libs/scene/src/scene/terrain-cm/grass.ts:138
Grass layer class
Extends
Disposable
Constructors
Constructor
new GrassLayer(
terrain,bladeWidth,bladeHeight,albedoMap?):GrassLayer
Defined in: libs/scene/src/scene/terrain-cm/grass.ts:152
Creates an instance of GrassLayer
Parameters
terrain
Clipmap terrain object
bladeWidth
number
Grass blade width
bladeHeight
number
Grass blade height
albedoMap?
Texture2D
Albedo texture for the blade
Returns
GrassLayer
Overrides
Disposable.constructor
Accessors
disposed
Get Signature
get disposed():
boolean
Defined in: libs/base/dist/index.d.ts:6065
Returns
boolean
Inherited from
Disposable.disposed
bladeWidth
Get Signature
get bladeWidth():
number
Defined in: libs/scene/src/scene/terrain-cm/grass.ts:210
Grass blade width in this layer
Returns
number
Set Signature
set bladeWidth(
val):void
Defined in: libs/scene/src/scene/terrain-cm/grass.ts:213
Parameters
val
number
Returns
void
bladeHeight
Get Signature
get bladeHeight():
number
Defined in: libs/scene/src/scene/terrain-cm/grass.ts:217
Grass blade height in this layer
Returns
number
Set Signature
set bladeHeight(
val):void
Defined in: libs/scene/src/scene/terrain-cm/grass.ts:220
Parameters
val
number
Returns
void
Methods
on()
on<
K>(type,listener,context?):void
Defined in: libs/base/dist/index.d.ts:594
IEventTarget.on
Type Parameters
K
K extends "dispose"
Parameters
type
K
listener
EventListener<{ dispose: []; }, K>
context?
unknown
Returns
void
Inherited from
Disposable.on
once()
once<
K>(type,listener,context?):void
Defined in: libs/base/dist/index.d.ts:598
IEventTarget.once
Type Parameters
K
K extends "dispose"
Parameters
type
K
listener
EventListener<{ dispose: []; }, K>
context?
unknown
Returns
void
Inherited from
Disposable.once
off()
off<
K>(type,listener?,context?):void
Defined in: libs/base/dist/index.d.ts:602
IEventTarget.off
Type Parameters
K
K extends "dispose"
Parameters
type
K
listener?
EventListener<{ dispose: []; }>
context?
unknown
Returns
void
Inherited from
Disposable.off
dispatchEvent()
dispatchEvent<
K>(type, ...args):void
Defined in: libs/base/dist/index.d.ts:606
IEventTarget.dispatchEvent
Type Parameters
K
K extends "dispose"
Parameters
type
K
args
...object[K]
Returns
void
Inherited from
Disposable.dispatchEvent
dispose()
dispose():
void
Defined in: libs/base/dist/index.d.ts:6066
Returns
void
Inherited from
Disposable.dispose
setAlbedoMap()
setAlbedoMap(
albedoMap):void
Defined in: libs/scene/src/scene/terrain-cm/grass.ts:178
Sets the albedo texture of grass blades in this layer
Parameters
albedoMap
Texture2D
Albedo texture to set
Returns
void
getAlbedoMap()
getAlbedoMap():
Texture2D<unknown>
Defined in: libs/scene/src/scene/terrain-cm/grass.ts:188
Gets the albedo texture of grass blades in this layer
Returns
Texture2D<unknown>
- Albedo texture of grass blades in this layer
addInstances()
addInstances(
instances):number
Defined in: libs/scene/src/scene/terrain-cm/grass.ts:195
Add grass blades to this layer in a region
Parameters
instances
Grass blade instances to add
Returns
number
removeInstances()
removeInstances(
minX,minZ,maxX,maxZ,numInstances):void
Defined in: libs/scene/src/scene/terrain-cm/grass.ts:206
Remove grass blades to this layer in a region
Parameters
minX
number
Minimum x position of the region
minZ
number
Minimum z position of the region
maxX
number
Maximum x position of the region
maxZ
number
Maximum z position of the region
numInstances
number
How many grass blades to add
Returns
void
setBladeSize()
setBladeSize(
width,height):void
Defined in: libs/scene/src/scene/terrain-cm/grass.ts:228
Sets the size of grass blades in this layer
Parameters
width
number
Grass blade width
height
number
Grass blade height
Returns
void