M3D / M3D / Render / PbrMaterial

Class: PbrMaterial

M3D.Render.PbrMaterial

Memberof

M3D.Render

Description

pbr材质

Date

2022-1-17

Version

1.0

Copyright

All Rights Reserved. Copyright (C) 2022 HOTEAMSOFT, Ltd

Hierarchy

• InnerMaterial

  ↳ PbrMaterial

Table of contents

Constructors

• constructor

Properties

• id
• instanceRednerMaterial
• count

Methods

• addUniformMap
• addUniformTextureMap
• clearUniformMap
• clone
• compare
• getAcceptLight
• getAlbedoColor
• getAlbedoMap
• getAmbientOcclusiontMap
• getAoMapIntensity
• getClearCoat
• getClearCoatRoughness
• getCompare
• getDefine
• getDisplacementBias
• getDisplacementMap
• getDisplacementScale
• getDisplayName
• getEmissive
• getEmissiveMap
• getEnvIrradianceMap
• getEnvMap
• getEnvMapIntensity
• getEnvTextureMapping
• getEvents
• getId
• getIsGammaOutpute
• getLightHash
• getLutMap
• getMaterialType
• getMaterialTypeStr
• getMetalnessFactor
• getMetalnessRoughnessMap
• getName
• getNeedUpdate
• getNormalMap
• getNormalMapScale
• getOpacity
• getRougthnessFactor
• getUniformMap
• getUniformTextureMap
• getUseClearCoat
• getUseLight
• getUuid
• getUvRotate
• getUvTransform
• registerEvent
• removeEvent
• setAcceptLight
• setAlbedoColor
• setAlbedoMap
• setAmbientOcclusiontMap
• setAoMapIntensity
• setClearCoat
• setClearCoatRoughness
• setDefine
• setDisplacementBias
• setDisplacementScale
• setDisplayName
• setEmissive
• setEmissiveMap
• setEnvIrradianceMap
• setEnvMap
• setEnvMapIntensity
• setEnvTextureMapping
• setId
• setIsGammaOutpute
• setLightHash
• setLutMap
• setMaterialType
• setMetalnessFactor
• setMetalnessRoughnessMap
• setName
• setNeedUpdate
• setNormalMap
• setNormalMapScale
• setOpacity
• setRougthnessFactor
• setUniformMap
• setUseClearCoat
• setUseLight
• setUuid
• updateUniformMap

Constructors

constructor

• new PbrMaterial(): PbrMaterial

Returns

PbrMaterial

Description

构造函数

Overrides

InnerMaterial.constructor

• new PbrMaterial(org): PbrMaterial

Parameters

Name	Type
org	PbrMaterial

Returns

PbrMaterial

Description

构造函数

Overrides

InnerMaterial.constructor

Properties

id

• id: number

Inherited from

InnerMaterial.id

---

instanceRednerMaterial

• instanceRednerMaterial: boolean

Inherited from

InnerMaterial.instanceRednerMaterial

---

count

▪ Static count: number

Inherited from

InnerMaterial.count

Methods

addUniformMap

▸ addUniformMap(para, uniformValue): void

Parameters

Name	Type
para	ShaderParameter
uniformValue	any

Returns

void

Description

添加Uniform参数

Inherited from

InnerMaterial.addUniformMap

---

addUniformTextureMap

▸ addUniformTextureMap(para, obj): void

Parameters

Name	Type
para	ShaderParameter
obj	TextureObject

Returns

void

Description

添加纹理Uniform参数

Inherited from

InnerMaterial.addUniformTextureMap

---

clearUniformMap

▸ clearUniformMap(): void

Returns

void

Description

清空材质UniformMap

Inherited from

InnerMaterial.clearUniformMap

---

clone

▸ clone(): PbrMaterial

Returns

PbrMaterial

Description

材质克隆

Overrides

InnerMaterial.clone

---

compare

▸ compare(smaterial): boolean

Parameters

Name	Type	Description
smaterial	BaseMaterial	内部材质基类对象

Returns

boolean

Description

材质对比

Inherited from

InnerMaterial.compare

---

getAcceptLight

▸ getAcceptLight(): boolean

Returns

boolean

Description

获取是否接收灯光配置

Inherited from

InnerMaterial.getAcceptLight

---

getAlbedoColor

▸ getAlbedoColor(): Color

Returns

Color

Description

获取颜色

---

getAlbedoMap

▸ getAlbedoMap(): TextureObject

Returns

TextureObject

Description

获取固有色贴图

---

getAmbientOcclusiontMap

▸ getAmbientOcclusiontMap(): TextureObject

Returns

TextureObject

Description

获取环境光遮挡

---

getAoMapIntensity

▸ getAoMapIntensity(): number

Returns

number

Description

获取aoMap强度

---

getClearCoat

▸ getClearCoat(): number

Returns

number

Description

获取清除覆盖

---

getClearCoatRoughness

▸ getClearCoatRoughness(): number

Returns

number

Description

获取清除粗糙覆盖

---

getCompare

▸ getCompare(smaterial): boolean

Parameters

Name	Type	Description
smaterial	BaseMaterial	基础材质类

Returns

boolean

Description

获取基础材质类和本类一致性比较

Inherited from

InnerMaterial.getCompare

---

getDefine

▸ getDefine(): Object

Returns

Object

Description

获取材质定义

Inherited from

InnerMaterial.getDefine

---

getDisplacementBias

▸ getDisplacementBias(): number

Returns

number

---

getDisplacementMap

▸ getDisplacementMap(): TextureObject

Returns

TextureObject

---

getDisplacementScale

▸ getDisplacementScale(): number

Returns

number

---

getDisplayName

▸ getDisplayName(): string

Returns

string

Inherited from

InnerMaterial.getDisplayName

---

getEmissive

▸ getEmissive(): Color

Returns

Color

---

getEmissiveMap

▸ getEmissiveMap(): TextureObject

Returns

TextureObject

Description

获取自发光贴图

---

getEnvIrradianceMap

▸ getEnvIrradianceMap(): TextureObject

Returns

TextureObject

Description

获取辐照贴图

---

getEnvMap

▸ getEnvMap(): TextureObject

Returns

TextureObject

Description

获取环境贴图

---

getEnvMapIntensity

▸ getEnvMapIntensity(): number

Returns

number

---

getEnvTextureMapping

▸ getEnvTextureMapping(): EnvTextureMappingType

Returns

EnvTextureMappingType

Description

获取纹理贴图类型

---

getEvents

▸ getEvents(): M3DEvent[]

Returns

M3DEvent[]

Description

获得事件列表

Inherited from

InnerMaterial.getEvents

---

getId

▸ getId(): number

Returns

number

Description

获取id

Inherited from

InnerMaterial.getId

---

getIsGammaOutpute

▸ getIsGammaOutpute(): boolean

Returns

boolean

Description

获取是否gamma空间输出

Inherited from

InnerMaterial.getIsGammaOutpute

---

getLightHash

▸ getLightHash(): string

Returns

string

Inherited from

InnerMaterial.getLightHash

---

getLutMap

▸ getLutMap(): TextureObject

Returns

TextureObject

Description

获取lut贴图

---

getMaterialType

▸ getMaterialType(): MaterialType

Returns

MaterialType

Description

获取材质类型

Inherited from

InnerMaterial.getMaterialType

---

getMaterialTypeStr

▸ getMaterialTypeStr(material): string

Parameters

Name	Type	Description
material	MaterialType	材质类型

Returns

string

Description

获取材质类型字符串

Inherited from

InnerMaterial.getMaterialTypeStr

---

getMetalnessFactor

▸ getMetalnessFactor(): number

Returns

number

Description

获取金属度

---

getMetalnessRoughnessMap

▸ getMetalnessRoughnessMap(): TextureObject

Returns

TextureObject

Description

获取金属度贴图

---

getName

▸ getName(): string

Returns

string

材质名称

Description

获取材质名称

Inherited from

InnerMaterial.getName

---

getNeedUpdate

▸ getNeedUpdate(): boolean

Returns

boolean

Description

获取材质是否更新

Inherited from

InnerMaterial.getNeedUpdate

---

getNormalMap

▸ getNormalMap(): TextureObject

Returns

TextureObject

TextureObject

Description

获取法向贴图

---

getNormalMapScale

▸ getNormalMapScale(): Vector2

Returns

Vector2

Description

获取法向贴图缩放

---

getOpacity

▸ getOpacity(): number

Returns

number

Description

获取透明度

---

getRougthnessFactor

▸ getRougthnessFactor(): number

Returns

number

粗糙度

Description

获取粗糙度

---

getUniformMap

▸ getUniformMap(): Map<ShaderParameter, any>

Returns

Map<ShaderParameter, any>

Description

获取UniformMap

Inherited from

InnerMaterial.getUniformMap

---

getUniformTextureMap

▸ getUniformTextureMap(): Map<ShaderParameter, any>

Returns

Map<ShaderParameter, any>

Description

获取材质纹理UniformMap

Inherited from

InnerMaterial.getUniformTextureMap

---

getUseClearCoat

▸ getUseClearCoat(): boolean

Returns

boolean

Description

获取是否清除覆盖

---

getUseLight

▸ getUseLight(): boolean

Returns

boolean

Description

获取是否使用灯光

Inherited from

InnerMaterial.getUseLight

---

getUuid

▸ getUuid(): string

Returns

string

Description

生成随机的一个id

Inherited from

InnerMaterial.getUuid

---

getUvRotate

▸ getUvRotate(): number

Returns

number

纹理坐标旋转角度

Description

获取纹理坐标旋转角度

Inherited from

InnerMaterial.getUvRotate

---

getUvTransform

▸ getUvTransform(): Matrix3

Returns

Matrix3

Description

获取纹理坐标矩阵

Inherited from

InnerMaterial.getUvTransform

---

registerEvent

▸ registerEvent(event): void

Parameters

Name	Type	Description
event	M3DEvent	M3D事件

Returns

void

Description

注册事件

Inherited from

InnerMaterial.registerEvent

---

removeEvent

▸ removeEvent(): void

Returns

void

Description

删除事件

Inherited from

InnerMaterial.removeEvent

---

setAcceptLight

▸ setAcceptLight(val): void

Parameters

Name	Type
val	boolean

Returns

void

Description

设置是否接收灯光

Inherited from

InnerMaterial.setAcceptLight

---

setAlbedoColor

▸ setAlbedoColor(val): void

Parameters

Name	Type
val	Color

Returns

void

Description

设置颜色

---

setAlbedoMap

▸ setAlbedoMap(val): void

Parameters

Name	Type
val	TextureObject

Returns

void

Description

设置固有色贴图

---

setAmbientOcclusiontMap

▸ setAmbientOcclusiontMap(val): void

Parameters

Name	Type
val	TextureObject

Returns

void

Description

设置环境光遮挡

---

setAoMapIntensity

▸ setAoMapIntensity(val): void

Parameters

Name	Type
val	number

Returns

void

Description

设置aoMap强度

---

setClearCoat

▸ setClearCoat(val): void

Parameters

Name	Type
val	number

Returns

void

Description

设置清除覆盖

---

setClearCoatRoughness

▸ setClearCoatRoughness(val): void

Parameters

Name	Type
val	number

Returns

void

Description

设置清除粗糙覆盖

---

setDefine

▸ setDefine(key, val): void

Parameters

Name	Type
key	string
val	string

Returns

void

Description

设置材质定义

Inherited from

InnerMaterial.setDefine

---

setDisplacementBias

▸ setDisplacementBias(val): void

Parameters

Name	Type
val	number

Returns

void

---

setDisplacementScale

▸ setDisplacementScale(val): void

Parameters

Name	Type
val	number

Returns

void

---

setDisplayName

▸ setDisplayName(val): void

Parameters

Name	Type
val	string

Returns

void

Inherited from

InnerMaterial.setDisplayName

---

setEmissive

▸ setEmissive(val): void

Parameters

Name	Type
val	Color

Returns

void

---

setEmissiveMap

▸ setEmissiveMap(val): void

Parameters

Name	Type
val	TextureObject

Returns

void

Description

设置自发光贴图

---

setEnvIrradianceMap

▸ setEnvIrradianceMap(val): void

Parameters

Name	Type
val	TextureObject

Returns

void

Description

设置辐照度贴图

---

setEnvMap

▸ setEnvMap(val): void

Parameters

Name	Type
val	TextureObject

Returns

void

Description

设置环境贴图

---

setEnvMapIntensity

▸ setEnvMapIntensity(val): void

Parameters

Name	Type
val	number

Returns

void

---

setEnvTextureMapping

▸ setEnvTextureMapping(val): void

Parameters

Name	Type
val	EnvTextureMappingType

Returns

void

Description

设置纹理贴图类型

---

setId

▸ setId(v): void

Parameters

Name	Type	Description
v	number	ShapeId

Returns

void

Description

设置id

Inherited from

InnerMaterial.setId

---

setIsGammaOutpute

▸ setIsGammaOutpute(val): void

Parameters

Name	Type
val	boolean

Returns

void

Description

设置是否gamma空间输出

Inherited from

InnerMaterial.setIsGammaOutpute

---

setLightHash

▸ setLightHash(val): void

Parameters

Name	Type
val	string

Returns

void

Inherited from

InnerMaterial.setLightHash

---

setLutMap

▸ setLutMap(lut): void

Parameters

Name	Type
lut	TextureObject

Returns

void

Description

设置lut贴图

---

setMaterialType

▸ setMaterialType(types): void

Parameters

Name	Type	Description
types	MaterialType	材质类型

Returns

void

Description

设置材质类型

Inherited from

InnerMaterial.setMaterialType

---

setMetalnessFactor

▸ setMetalnessFactor(val): void

Parameters

Name	Type
val	number

Returns

void

Description

设置金属度

---

setMetalnessRoughnessMap

▸ setMetalnessRoughnessMap(metalnessRoughnessMap): void

Parameters

Name	Type
metalnessRoughnessMap	TextureObject

Returns

void

Description

设置金属度贴图

---

setName

▸ setName(name): void

Parameters

Name	Type
name	string

Returns

void

Description

设置材质名称

Inherited from

InnerMaterial.setName

---

setNeedUpdate

▸ setNeedUpdate(val): void

Parameters

Name	Type
val	boolean

Returns

void

Description

设置材质是否更新

Inherited from

InnerMaterial.setNeedUpdate

---

setNormalMap

▸ setNormalMap(val): void

Parameters

Name	Type
val	TextureObject

Returns

void

Description

设置法向贴图

---

setNormalMapScale

▸ setNormalMapScale(val): void

Parameters

Name	Type
val	Vector2

Returns

void

Description

设置法向贴图缩放

---

setOpacity

▸ setOpacity(val): void

Parameters

Name	Type
val	number

Returns

void

Description

设置透明度

---

setRougthnessFactor

▸ setRougthnessFactor(val): void

Parameters

Name	Type	Description
val	number	粗糙度

Returns

void

Description

设置粗糙度

---

setUniformMap

▸ setUniformMap(): void

Returns

void

Description

设置Pbr材质渲染参数

Overrides

InnerMaterial.setUniformMap

---

setUseClearCoat

▸ setUseClearCoat(val): void

Parameters

Name	Type
val	boolean

Returns

void

Description

设置是否清除覆盖

---

setUseLight

▸ setUseLight(val): void

Parameters

Name	Type
val	boolean

Returns

void

Description

设置是否使用灯光

Inherited from

InnerMaterial.setUseLight

---

setUuid

▸ setUuid(uuid): void

Parameters

Name	Type
uuid	string

Returns

void

Description

设置随机的一个id

Inherited from

InnerMaterial.setUuid

---

updateUniformMap

▸ updateUniformMap(): void

Returns

void

Description

更新材质UniformMap

Inherited from

InnerMaterial.updateUniformMap