M3D / M3D / Materials

Class: Materials

M3D.Materials

Memberof

M3D

Description

材质管理类

Date

2022-1-20

Version

1.0

Copyright

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

Table of contents

Constructors

• constructor

Properties

• defaultMaterial

Methods

• addMaterial
• clear
• getDefaultPBREnvIrradianceTextureObject
• getDefaultPBREnvTextureObject
• getDefaultPBRLUTTextureObject
• getMaterial
• getMaterialColorAndAlpha
• getOrCreateJewelMaterial
• getOrCreateMaterial
• hasSpecificTypeMaterial
• isMaterialExisted
• isMaterialUsed
• isModelHaveMultyMaterial
• setMaterialColorAndAlpha

Constructors

constructor

• new Materials(resources): Materials

Parameters

Name	Type
resources	Resources

Returns

Materials

Description

构造函数

Properties

defaultMaterial

▪ Static defaultMaterial: string

Methods

addMaterial

▸ addMaterial(key, material): boolean

Parameters

Name	Type	Description
key	string | number	key值
material	BaseMaterial	材质

Returns

boolean

是否添加成功

Description

添加材质到管理类

---

clear

▸ clear(): void

Returns

void

---

getDefaultPBREnvIrradianceTextureObject

▸ getDefaultPBREnvIrradianceTextureObject(): TextureObject

Returns

TextureObject

Description

获取pbr默认EnvIrradiance TextureObject

---

getDefaultPBREnvTextureObject

▸ getDefaultPBREnvTextureObject(): TextureObject

Returns

TextureObject

Description

获取pbr默认Env TextureObject

---

getDefaultPBRLUTTextureObject

▸ getDefaultPBRLUTTextureObject(): TextureObject

Returns

TextureObject

Description

获取pbr默认LUT TextureObject

---

getMaterial

▸ getMaterial(key): BaseMaterial

Parameters

Name	Type	Description
key	string | number	key值

Returns

BaseMaterial

材质

Description

通过key查询是否存在这个材质，如果存在则返回这个材质

---

getMaterialColorAndAlpha

▸ getMaterialColorAndAlpha(material): any[]

Parameters

Name	Type
material	BaseMaterial

Returns

any[]

Description

获取材质颜色和透明度

---

getOrCreateJewelMaterial

▸ getOrCreateJewelMaterial(key, materialType, jewelType): BaseMaterial

Parameters

Name	Type	Description
key	any	关键字
materialType	any	材质类型
jewelType	any	珠宝类型

Returns

BaseMaterial

Description

获取或创建珠宝材质

---

getOrCreateMaterial

▸ getOrCreateMaterial(key, materialType): BaseMaterial

Parameters

Name	Type	Description
key	any	key值
materialType	any	材质类型

Returns

BaseMaterial

基础材质类

Description

获取或创建材质

---

hasSpecificTypeMaterial

▸ hasSpecificTypeMaterial(type): boolean

Parameters

Name	Type	Description
type	MaterialType	材质类型

Returns

boolean

是否含有该类材质

Description

判断是否含有某类材质

---

isMaterialExisted

▸ isMaterialExisted(outMaterial, pMaterial, color, alpha): boolean

Parameters

Name	Type
outMaterial	BaseMaterial
pMaterial	BaseMaterial
color	Color
alpha	number

Returns

boolean

Description

判断与原材质修改颜色后相同的材质是否已经存在

---

isMaterialUsed

▸ isMaterialUsed(smodel, smaterial, smodelExcept): boolean

Parameters

Name	Type
smodel	Model
smaterial	BaseMaterial
smodelExcept	Model

Returns

boolean

Description

判断材质是否使用

---

isModelHaveMultyMaterial

▸ isModelHaveMultyMaterial(model): boolean

Parameters

Name	Type
model	Model

Returns

boolean

Description

判断模型是否有多种材质

---

setMaterialColorAndAlpha

▸ setMaterialColorAndAlpha(material, color, alpha): void

Parameters

Name	Type
material	BaseMaterial
color	Color
alpha	number

Returns

void

Description

设置材质的颜色