Class: PavementMaterial
PavementMaterial
Hierarchy
PhysicMaterial
↳
PavementMaterial
Constructors
Properties
Accessors
- shaderState
- normalMapYFlip
- baseMap
- normalMap
- emissiveColor
- emissiveIntensity
- alphaCutoff
- irradianceMap
- irradianceDepthMap
- baseColor
- topology
- sort
- shaderID
- blendMode
- transparent
- frontFace
- doubleSide
- cullMode
- depthBias
- depthCompare
- envMap
- uvTransform_1
- uvTransform_2
- materialF0
- roughness
- metallic
- ao
- metallic_min
- metallic_max
- roughness_min
- roughness_max
- normalScale
- maskMap
- aoMap
- clearCoatRoughnessMap
- brdfLUT
- emissiveMap
- envIntensity
- ior
- clearcoatFactor
- clearcoatRoughnessFactor
- clearcoatWeight
- clearcoatColor
Methods
Constructors
constructor
• new PavementMaterial()
Overrides
PhysicMaterial.constructor
Defined in
src/materials/PavementMaterial.ts:17
Properties
name
• name: string
name of this material
Inherited from
PhysicMaterial.name
Defined in
src/materials/MaterialBase.ts:25
instanceID
• instanceID: string
Material Unique Identifier
Inherited from
PhysicMaterial.instanceID
Defined in
src/materials/MaterialBase.ts:31
isPassMaterial
• isPassMaterial: boolean
= false
is PassMaterial
Inherited from
PhysicMaterial.isPassMaterial
Defined in
src/materials/MaterialBase.ts:36
receiveEnv
• receiveEnv: boolean
= true
Whether to receive environment effect
Inherited from
PhysicMaterial.receiveEnv
Defined in
src/materials/MaterialBase.ts:41
renderPasses
• renderPasses: Map
<RendererType
, MaterialPass
[]>
Inherited from
PhysicMaterial.renderPasses
Defined in
src/materials/MaterialPass.ts:8
enable
• enable: boolean
= true
whether the pass is enable
Inherited from
PhysicMaterial.enable
Defined in
src/materials/MaterialPass.ts:13
renderShader
• renderShader: RenderShader
Inherited from
PhysicMaterial.renderShader
Defined in
src/materials/MaterialPass.ts:15
Accessors
shaderState
• get
shaderState(): ShaderState
Returns
ShaderState
Inherited from
PhysicMaterial.shaderState
Defined in
src/materials/MaterialBase.ts:46
• set
shaderState(value
): void
Parameters
Name | Type |
---|---|
value | ShaderState |
Returns
void
Inherited from
PhysicMaterial.shaderState
Defined in
src/materials/MaterialBase.ts:50
normalMapYFlip
• get
normalMapYFlip(): boolean
Returns
boolean
Inherited from
PhysicMaterial.normalMapYFlip
Defined in
src/materials/MaterialBase.ts:55
• set
normalMapYFlip(value
): void
Parameters
Name | Type |
---|---|
value | boolean |
Returns
void
Inherited from
PhysicMaterial.normalMapYFlip
Defined in
src/materials/MaterialBase.ts:59
baseMap
• get
baseMap(): Texture
Get base map(main map)
Returns
Inherited from
PhysicMaterial.baseMap
Defined in
src/materials/MaterialBase.ts:93
• set
baseMap(texture
): void
Set base map(main map)
Parameters
Name | Type |
---|---|
texture | Texture |
Returns
void
Inherited from
PhysicMaterial.baseMap
Defined in
src/materials/MaterialBase.ts:83
normalMap
• get
normalMap(): Texture
Get normal map
Returns
Inherited from
PhysicMaterial.normalMap
Defined in
src/materials/MaterialBase.ts:101
• set
normalMap(texture
): void
Set normal map
Parameters
Name | Type |
---|---|
texture | Texture |
Returns
void
Inherited from
PhysicMaterial.normalMap
Defined in
src/materials/MaterialBase.ts:108
emissiveColor
• get
emissiveColor(): Color
Get emissive color
Returns
Inherited from
PhysicMaterial.emissiveColor
Defined in
src/materials/MaterialBase.ts:123
• set
emissiveColor(value
): void
Set emissive color
Parameters
Name | Type |
---|---|
value | Color |
Returns
void
Inherited from
PhysicMaterial.emissiveColor
Defined in
src/materials/MaterialBase.ts:131
emissiveIntensity
• get
emissiveIntensity(): number
Get emissive intensity
Returns
number
Inherited from
PhysicMaterial.emissiveIntensity
Defined in
src/materials/MaterialBase.ts:149
• set
emissiveIntensity(value
): void
Set emissive intensity
Parameters
Name | Type |
---|---|
value | number |
Returns
void
Inherited from
PhysicMaterial.emissiveIntensity
Defined in
src/materials/MaterialBase.ts:140
alphaCutoff
• get
alphaCutoff(): number
Get alphaCutoff, channel transparency threshold parameter
Returns
number
Inherited from
PhysicMaterial.alphaCutoff
Defined in
src/materials/MaterialBase.ts:201
• set
alphaCutoff(value
): void
Set alphaCutoff, channel transparency threshold parameter
Parameters
Name | Type |
---|---|
value | number |
Returns
void
Inherited from
PhysicMaterial.alphaCutoff
Defined in
src/materials/MaterialBase.ts:209
irradianceMap
• get
irradianceMap(): Texture
Get irradiance map
Returns
Inherited from
PhysicMaterial.irradianceMap
Defined in
src/materials/MaterialBase.ts:226
• set
irradianceMap(value
): void
Set irradiance map
Parameters
Name | Type |
---|---|
value | Texture |
Returns
void
Inherited from
PhysicMaterial.irradianceMap
Defined in
src/materials/MaterialBase.ts:233
irradianceDepthMap
• get
irradianceDepthMap(): Texture
Get irradiance depth map
Returns
Inherited from
PhysicMaterial.irradianceDepthMap
Defined in
src/materials/MaterialBase.ts:241
• set
irradianceDepthMap(value
): void
Set irradiance depth map
Parameters
Name | Type |
---|---|
value | Texture |
Returns
void
Inherited from
PhysicMaterial.irradianceDepthMap
Defined in
src/materials/MaterialBase.ts:248
baseColor
• get
baseColor(): Color
Get base color(tint color)
Returns
Inherited from
PhysicMaterial.baseColor
Defined in
src/materials/MaterialBase.ts:260
• set
baseColor(value
): void
Set base color(tint color)
Parameters
Name | Type |
---|---|
value | Color |
Returns
void
Inherited from
PhysicMaterial.baseColor
Defined in
src/materials/MaterialBase.ts:268
topology
• set
topology(topology
): void
Parameters
Name | Type |
---|---|
topology | GPUPrimitiveTopology |
Returns
void
Inherited from
PhysicMaterial.topology
Defined in
src/materials/MaterialBase.ts:321
sort
• get
sort(): number
Returns
number
Inherited from
PhysicMaterial.sort
Defined in
src/materials/MaterialPass.ts:23
• set
sort(value
): void
Parameters
Name | Type |
---|---|
value | number |
Returns
void
Inherited from
PhysicMaterial.sort
Defined in
src/materials/MaterialPass.ts:27
shaderID
• get
shaderID(): string
Returns
string
Inherited from
PhysicMaterial.shaderID
Defined in
src/materials/MaterialPass.ts:31
• set
shaderID(value
): void
Parameters
Name | Type |
---|---|
value | string |
Returns
void
Inherited from
PhysicMaterial.shaderID
Defined in
src/materials/MaterialPass.ts:35
blendMode
• get
blendMode(): BlendMode
Get blend mode, see BlendMode
Returns
Inherited from
PhysicMaterial.blendMode
Defined in
src/materials/MaterialPass.ts:53
• set
blendMode(value
): void
Set blend mode, see BlendMode
Parameters
Name | Type |
---|---|
value | BlendMode |
Returns
void
Inherited from
PhysicMaterial.blendMode
Defined in
src/materials/MaterialPass.ts:60
transparent
• get
transparent(): boolean
Get whether use transparent mode to render
Returns
boolean
Inherited from
PhysicMaterial.transparent
Defined in
src/materials/MaterialPass.ts:67
• set
transparent(value
): void
Set whether use transparent mode to render
Parameters
Name | Type |
---|---|
value | boolean |
Returns
void
Inherited from
PhysicMaterial.transparent
Defined in
src/materials/MaterialPass.ts:74
frontFace
• get
frontFace(): GPUFrontFace
Return GPUFrontFace
Returns
GPUFrontFace
Inherited from
PhysicMaterial.frontFace
Defined in
src/materials/MaterialPass.ts:81
• set
frontFace(value
): void
Set GPUFrontFace
Parameters
Name | Type |
---|---|
value | GPUFrontFace |
Returns
void
Inherited from
PhysicMaterial.frontFace
Defined in
src/materials/MaterialPass.ts:88
doubleSide
• get
doubleSide(): boolean
Get whether use double side to render object
Returns
boolean
Inherited from
PhysicMaterial.doubleSide
Defined in
src/materials/MaterialPass.ts:95
• set
doubleSide(value
): void
Set whether use double side to render object
Parameters
Name | Type |
---|---|
value | boolean |
Returns
void
Inherited from
PhysicMaterial.doubleSide
Defined in
src/materials/MaterialPass.ts:102
cullMode
• get
cullMode(): GPUCullMode
get cull mode, see GPUCullMode
Returns
GPUCullMode
Inherited from
PhysicMaterial.cullMode
Defined in
src/materials/MaterialPass.ts:114
• set
cullMode(value
): void
set cull mode, see GPUCullMode
Parameters
Name | Type |
---|---|
value | GPUCullMode |
Returns
void
Inherited from
PhysicMaterial.cullMode
Defined in
src/materials/MaterialPass.ts:121
depthBias
• get
depthBias(): number
Returns
number
Inherited from
PhysicMaterial.depthBias
Defined in
src/materials/MaterialPass.ts:125
• set
depthBias(value
): void
Parameters
Name | Type |
---|---|
value | number |
Returns
void
Inherited from
PhysicMaterial.depthBias
Defined in
src/materials/MaterialPass.ts:129
depthCompare
• get
depthCompare(): GPUCompareFunction
get depth compare mode, see GPUCompareFunction
Returns
GPUCompareFunction
Inherited from
PhysicMaterial.depthCompare
Defined in
src/materials/MaterialPass.ts:136
• set
depthCompare(value
): void
set depth compare mode, see GPUCompareFunction
Parameters
Name | Type |
---|---|
value | GPUCompareFunction |
Returns
void
Inherited from
PhysicMaterial.depthCompare
Defined in
src/materials/MaterialPass.ts:143
envMap
• set
envMap(texture
): void
set environment texture, usually referring to cubemap
Parameters
Name | Type |
---|---|
texture | Texture |
Returns
void
Overrides
PhysicMaterial.envMap
Defined in
src/materials/PavementMaterial.ts:52
uvTransform_1
• get
uvTransform_1(): Vector4
get transformUV1
Returns
Vector4
Inherited from
PhysicMaterial.uvTransform_1
Defined in
src/materials/PhysicMaterial.ts:18
• set
uvTransform_1(value
): void
set transformUV1
Parameters
Name | Type |
---|---|
value | Vector4 |
Returns
void
Inherited from
PhysicMaterial.uvTransform_1
Defined in
src/materials/PhysicMaterial.ts:25
uvTransform_2
• get
uvTransform_2(): Vector4
get transformUV2
Returns
Vector4
Inherited from
PhysicMaterial.uvTransform_2
Defined in
src/materials/PhysicMaterial.ts:33
• set
uvTransform_2(value
): void
set transformUV2
Parameters
Name | Type |
---|---|
value | Vector4 |
Returns
void
Inherited from
PhysicMaterial.uvTransform_2
Defined in
src/materials/PhysicMaterial.ts:40
materialF0
• get
materialF0(): Vector4
get reflectivity
Returns
Vector4
Inherited from
PhysicMaterial.materialF0
Defined in
src/materials/PhysicMaterial.ts:48
• set
materialF0(value
): void
set reflectivity
Parameters
Name | Type |
---|---|
value | Vector4 |
Returns
void
Inherited from
PhysicMaterial.materialF0
Defined in
src/materials/PhysicMaterial.ts:55
roughness
• get
roughness(): number
get roughness
Returns
number
Inherited from
PhysicMaterial.roughness
Defined in
src/materials/PhysicMaterial.ts:62
• set
roughness(value
): void
set roughness
Parameters
Name | Type |
---|---|
value | number |
Returns
void
Inherited from
PhysicMaterial.roughness
Defined in
src/materials/PhysicMaterial.ts:69
metallic
• get
metallic(): number
get metallic
Returns
number
Inherited from
PhysicMaterial.metallic
Defined in
src/materials/PhysicMaterial.ts:76
• set
metallic(value
): void
set metallic
Parameters
Name | Type |
---|---|
value | number |
Returns
void
Inherited from
PhysicMaterial.metallic
Defined in
src/materials/PhysicMaterial.ts:83
ao
• get
ao(): number
get Ambient Occlussion, dealing with the effect of ambient light on object occlusion
Returns
number
Inherited from
PhysicMaterial.ao
Defined in
src/materials/PhysicMaterial.ts:90
• set
ao(value
): void
set Ambient Occlussion, dealing with the effect of ambient light on object occlusion
Parameters
Name | Type |
---|---|
value | number |
Returns
void
Inherited from
PhysicMaterial.ao
Defined in
src/materials/PhysicMaterial.ts:97
metallic_min
• get
metallic_min(): number
get min metallic
Returns
number
Inherited from
PhysicMaterial.metallic_min
Defined in
src/materials/PhysicMaterial.ts:104
• set
metallic_min(value
): void
set min metallic
Parameters
Name | Type |
---|---|
value | number |
Returns
void
Inherited from
PhysicMaterial.metallic_min
Defined in
src/materials/PhysicMaterial.ts:111
metallic_max
• get
metallic_max(): number
get max metallic
Returns
number
Inherited from
PhysicMaterial.metallic_max
Defined in
src/materials/PhysicMaterial.ts:118
• set
metallic_max(value
): void
set max metallic
Parameters
Name | Type |
---|---|
value | number |
Returns
void
Inherited from
PhysicMaterial.metallic_max
Defined in
src/materials/PhysicMaterial.ts:125
roughness_min
• get
roughness_min(): number
get min roughness
Returns
number
Inherited from
PhysicMaterial.roughness_min
Defined in
src/materials/PhysicMaterial.ts:132
• set
roughness_min(value
): void
set min roughness
Parameters
Name | Type |
---|---|
value | number |
Returns
void
Inherited from
PhysicMaterial.roughness_min
Defined in
src/materials/PhysicMaterial.ts:139
roughness_max
• get
roughness_max(): number
get max roughness
Returns
number
Inherited from
PhysicMaterial.roughness_max
Defined in
src/materials/PhysicMaterial.ts:146
• set
roughness_max(value
): void
set max roughness
Parameters
Name | Type |
---|---|
value | number |
Returns
void
Inherited from
PhysicMaterial.roughness_max
Defined in
src/materials/PhysicMaterial.ts:153
normalScale
• get
normalScale(): number
Get the influence of Normal mapping on materials
Returns
number
Inherited from
PhysicMaterial.normalScale
Defined in
src/materials/PhysicMaterial.ts:160
• set
normalScale(value
): void
Set the influence of Normal mapping on materials
Parameters
Name | Type |
---|---|
value | number |
Returns
void
Inherited from
PhysicMaterial.normalScale
Defined in
src/materials/PhysicMaterial.ts:167
maskMap
• get
maskMap(): Texture
get Mask Map R_chanel -> AoMap G_chanel -> Roughness B_chanel -> Metallic A_chanel -> C
Returns
Inherited from
PhysicMaterial.maskMap
Defined in
src/materials/PhysicMaterial.ts:178
• set
maskMap(value
): void
set Mask Map R_chanel -> AoMap G_chanel -> Roughness B_chanel -> Metallic A_chanel -> C
Parameters
Name | Type |
---|---|
value | Texture |
Returns
void
Inherited from
PhysicMaterial.maskMap
Defined in
src/materials/PhysicMaterial.ts:189
aoMap
• get
aoMap(): Texture
get Ambient Occlussion Map, dealing with the effect of ambient light on object occlusion
Returns
Inherited from
PhysicMaterial.aoMap
Defined in
src/materials/PhysicMaterial.ts:210
• set
aoMap(value
): void
set Ambient Occlussion Map, dealing with the effect of ambient light on object occlusion
Parameters
Name | Type |
---|---|
value | Texture |
Returns
void
Inherited from
PhysicMaterial.aoMap
Defined in
src/materials/PhysicMaterial.ts:199
clearCoatRoughnessMap
• get
clearCoatRoughnessMap(): Texture
get clearCoatRoughnessMap
Returns
Inherited from
PhysicMaterial.clearCoatRoughnessMap
Defined in
src/materials/PhysicMaterial.ts:228
• set
clearCoatRoughnessMap(value
): void
set clearCoatRoughnessMap
Parameters
Name | Type |
---|---|
value | Texture |
Returns
void
Inherited from
PhysicMaterial.clearCoatRoughnessMap
Defined in
src/materials/PhysicMaterial.ts:217
brdfLUT
• get
brdfLUT(): Texture
get brdf query map
Returns
Inherited from
PhysicMaterial.brdfLUT
Defined in
src/materials/PhysicMaterial.ts:235
• set
brdfLUT(value
): void
set brdf query map
Parameters
Name | Type |
---|---|
value | Texture |
Returns
void
Inherited from
PhysicMaterial.brdfLUT
Defined in
src/materials/PhysicMaterial.ts:242
emissiveMap
• get
emissiveMap(): Texture
get emissive map
Returns
Inherited from
PhysicMaterial.emissiveMap
Defined in
src/materials/PhysicMaterial.ts:250
• set
emissiveMap(value
): void
set emissive map
Parameters
Name | Type |
---|---|
value | Texture |
Returns
void
Inherited from
PhysicMaterial.emissiveMap
Defined in
src/materials/PhysicMaterial.ts:257
envIntensity
• get
envIntensity(): number
get intensity of environment light or color of sampled by texture
Returns
number
Inherited from
PhysicMaterial.envIntensity
Defined in
src/materials/PhysicMaterial.ts:271
• set
envIntensity(value
): void
set intensity of environment light or color of sampled by texture
Parameters
Name | Type |
---|---|
value | number |
Returns
void
Inherited from
PhysicMaterial.envIntensity
Defined in
src/materials/PhysicMaterial.ts:264
ior
• get
ior(): number
get factor of refractive
Returns
number
Inherited from
PhysicMaterial.ior
Defined in
src/materials/PhysicMaterial.ts:285
• set
ior(value
): void
set factor of refractive
Parameters
Name | Type |
---|---|
value | number |
Returns
void
Inherited from
PhysicMaterial.ior
Defined in
src/materials/PhysicMaterial.ts:278
clearcoatFactor
• get
clearcoatFactor(): number
get the factor of the clearcoat
Returns
number
Inherited from
PhysicMaterial.clearcoatFactor
Defined in
src/materials/PhysicMaterial.ts:307
• set
clearcoatFactor(value
): void
Set the factor of the clearcoat
Parameters
Name | Type |
---|---|
value | number |
Returns
void
Inherited from
PhysicMaterial.clearcoatFactor
Defined in
src/materials/PhysicMaterial.ts:299
clearcoatRoughnessFactor
• get
clearcoatRoughnessFactor(): number
get the factor of the clearcoat Roughness
Returns
number
Inherited from
PhysicMaterial.clearcoatRoughnessFactor
Defined in
src/materials/PhysicMaterial.ts:322
• set
clearcoatRoughnessFactor(value
): void
set the factor of the clearcoat Roughness
Parameters
Name | Type |
---|---|
value | number |
Returns
void
Inherited from
PhysicMaterial.clearcoatRoughnessFactor
Defined in
src/materials/PhysicMaterial.ts:314
clearcoatWeight
• get
clearcoatWeight(): number
get the weight of the clearcoat
Returns
number
Inherited from
PhysicMaterial.clearcoatWeight
Defined in
src/materials/PhysicMaterial.ts:337
• set
clearcoatWeight(value
): void
set the weight of the clearcoat
Parameters
Name | Type |
---|---|
value | number |
Returns
void
Inherited from
PhysicMaterial.clearcoatWeight
Defined in
src/materials/PhysicMaterial.ts:329
clearcoatColor
• get
clearcoatColor(): Color
set the color of the clearcoat
Returns
Inherited from
PhysicMaterial.clearcoatColor
Defined in
src/materials/PhysicMaterial.ts:352
• set
clearcoatColor(value
): void
get the color of the clearcoat
Parameters
Name | Type |
---|---|
value | Color |
Returns
void
Inherited from
PhysicMaterial.clearcoatColor
Defined in
src/materials/PhysicMaterial.ts:344
Methods
getBaseColor
▸ getBaseColor(ret?
): Color
Parameters
Name | Type |
---|---|
ret? | Color |
Returns
Inherited from
PhysicMaterial.getBaseColor
Defined in
src/materials/MaterialBase.ts:253
setDefine
▸ setDefine(define
, bool
): void
Enable/Disable the definition of shaders
Memberof
MaterialBase
Parameters
Name | Type | Description |
---|---|---|
define | string | key |
bool | boolean | - |
Returns
void
Inherited from
PhysicMaterial.setDefine
Defined in
src/materials/MaterialBase.ts:333
hasPass
▸ hasPass(passType
): boolean
Parameters
Name | Type |
---|---|
passType | RendererType |
Returns
boolean
Inherited from
PhysicMaterial.hasPass
Defined in
src/materials/MaterialBase.ts:337
addPass
▸ addPass(passType
, pass
, index?
): MaterialPass
[]
Parameters
Name | Type | Default value |
---|---|---|
passType | RendererType | undefined |
pass | MaterialPass | undefined |
index | number | -1 |
Returns
Inherited from
PhysicMaterial.addPass
Defined in
src/materials/MaterialBase.ts:341
removePass
▸ removePass(passType
, index
): void
Parameters
Name | Type |
---|---|
passType | RendererType |
index | number |
Returns
void
Inherited from
PhysicMaterial.removePass
Defined in
src/materials/MaterialBase.ts:357
clone
▸ clone(): any
clone one material
Returns
any
Material
Inherited from
PhysicMaterial.clone
Defined in
src/materials/MaterialBase.ts:383
setShader
▸ setShader(vs
, fs
): RenderShader
Parameters
Name | Type |
---|---|
vs | string |
fs | string |
Returns
Inherited from
PhysicMaterial.setShader
Defined in
src/materials/MaterialPass.ts:39
getShader
▸ getShader(): RenderShader
Returns
Inherited from
PhysicMaterial.getShader
Defined in
src/materials/MaterialPass.ts:46
debug
▸ debug(): void
Returns
void
Overrides
PhysicMaterial.debug
Defined in
src/materials/PavementMaterial.ts:64
useCleanCoat
▸ useCleanCoat(): void
valid USE_CLEARCOAT define in shader
Returns
void
Inherited from
PhysicMaterial.useCleanCoat
Defined in
src/materials/PhysicMaterial.ts:292
destroy
▸ destroy(force?
): void
Parameters
Name | Type |
---|---|
force? | boolean |
Returns
void
Inherited from
PhysicMaterial.destroy