M3D / M3D / Render / BaseMaterial

Class: BaseMaterial

M3D.Render.BaseMaterial

Memberof

M3D.Render

Description

基础材质类

Hierarchy

• M3DObject

  ↳ BaseMaterial

  ↳↳ InnerMaterial

  ↳↳ DiamondMaterial

  ↳↳ JewelMaterial

  ↳↳ MetalMaterial

  ↳↳ ShaderMaterial

Table of contents

Constructors

• constructor

Properties

• id
• instanceRednerMaterial
• count

Methods

• addUniformMap
• addUniformTextureMap
• clearUniformMap
• clone
• compare
• getAcceptLight
• getCompare
• getDefine
• getDisplayName
• getEvents
• getId
• getIsGammaOutpute
• getLightHash
• getMaterialType
• getMaterialTypeStr
• getName
• getNeedUpdate
• getUniformMap
• getUniformTextureMap
• getUseLight
• getUuid
• registerEvent
• removeEvent
• setAcceptLight
• setDefine
• setDisplayName
• setId
• setIsGammaOutpute
• setLightHash
• setMaterialType
• setName
• setNeedUpdate
• setUniformMap
• setUseLight
• setUuid
• updateUniformMap

Constructors

constructor

• new BaseMaterial(): BaseMaterial

Returns

BaseMaterial

Description

构造函数

Overrides

M3DObject.constructor

• new BaseMaterial(org): BaseMaterial

Parameters

Name	Type
org	BaseMaterial

Returns

BaseMaterial

Description

构造函数

Overrides

M3DObject.constructor

Properties

id

• id: number

Inherited from

M3DObject.id

---

instanceRednerMaterial

• instanceRednerMaterial: boolean

---

count

▪ Static count: number

Inherited from

M3DObject.count

Methods

addUniformMap

▸ addUniformMap(para, uniformValue): void

Parameters

Name	Type
para	ShaderParameter
uniformValue	any

Returns

void

Description

添加Uniform参数

---

addUniformTextureMap

▸ addUniformTextureMap(para, obj): void

Parameters

Name	Type
para	ShaderParameter
obj	TextureObject

Returns

void

Description

添加纹理Uniform参数

---

clearUniformMap

▸ clearUniformMap(): void

Returns

void

Description

清空材质UniformMap

---

clone

▸ clone(): BaseMaterial

Returns

BaseMaterial

Description

克隆材质

---

compare

▸ compare(ptrMaterial): boolean

Parameters

Name	Type
ptrMaterial	BaseMaterial

Returns

boolean

Description

比较材质是否相等

---

getAcceptLight

▸ getAcceptLight(): boolean

Returns

boolean

Description

获取是否接收灯光配置

---

getCompare

▸ getCompare(smaterial): boolean

Parameters

Name	Type	Description
smaterial	BaseMaterial	基础材质类

Returns

boolean

Description

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

---

getDefine

▸ getDefine(): Object

Returns

Object

Description

获取材质定义

---

getDisplayName

▸ getDisplayName(): string

Returns

string

---

getEvents

▸ getEvents(): M3DEvent[]

Returns

M3DEvent[]

Description

获得事件列表

Inherited from

M3DObject.getEvents

---

getId

▸ getId(): number

Returns

number

Description

获取id

Inherited from

M3DObject.getId

---

getIsGammaOutpute

▸ getIsGammaOutpute(): boolean

Returns

boolean

Description

获取是否gamma空间输出

---

getLightHash

▸ getLightHash(): string

Returns

string

---

getMaterialType

▸ getMaterialType(): MaterialType

Returns

MaterialType

Description

获取材质类型

---

getMaterialTypeStr

▸ getMaterialTypeStr(material): string

Parameters

Name	Type	Description
material	MaterialType	材质类型

Returns

string

Description

获取材质类型字符串

---

getName

▸ getName(): string

Returns

string

材质名称

Description

获取材质名称

---

getNeedUpdate

▸ getNeedUpdate(): boolean

Returns

boolean

Description

获取材质是否更新

---

getUniformMap

▸ getUniformMap(): Map<ShaderParameter, any>

Returns

Map<ShaderParameter, any>

Description

获取UniformMap

---

getUniformTextureMap

▸ getUniformTextureMap(): Map<ShaderParameter, any>

Returns

Map<ShaderParameter, any>

Description

获取材质纹理UniformMap

---

getUseLight

▸ getUseLight(): boolean

Returns

boolean

Description

获取是否使用灯光

---

getUuid

▸ getUuid(): string

Returns

string

Description

生成随机的一个id

---

registerEvent

▸ registerEvent(event): void

Parameters

Name	Type	Description
event	M3DEvent	M3D事件

Returns

void

Description

注册事件

Inherited from

M3DObject.registerEvent

---

removeEvent

▸ removeEvent(): void

Returns

void

Description

删除事件

Inherited from

M3DObject.removeEvent

---

setAcceptLight

▸ setAcceptLight(val): void

Parameters

Name	Type
val	boolean

Returns

void

Description

设置是否接收灯光

---

setDefine

▸ setDefine(key, val): void

Parameters

Name	Type
key	string
val	string

Returns

void

Description

设置材质定义

---

setDisplayName

▸ setDisplayName(val): void

Parameters

Name	Type
val	string

Returns

void

---

setId

▸ setId(v): void

Parameters

Name	Type	Description
v	number	ShapeId

Returns

void

Description

设置id

Inherited from

M3DObject.setId

---

setIsGammaOutpute

▸ setIsGammaOutpute(val): void

Parameters

Name	Type
val	boolean

Returns

void

Description

设置是否gamma空间输出

---

setLightHash

▸ setLightHash(val): void

Parameters

Name	Type
val	string

Returns

void

---

setMaterialType

▸ setMaterialType(types): void

Parameters

Name	Type	Description
types	MaterialType	材质类型

Returns

void

Description

设置材质类型

---

setName

▸ setName(name): void

Parameters

Name	Type
name	string

Returns

void

Description

设置材质名称

---

setNeedUpdate

▸ setNeedUpdate(val): void

Parameters

Name	Type
val	boolean

Returns

void

Description

设置材质是否更新

---

setUniformMap

▸ setUniformMap(): void

Returns

void

Description

设置UniformMap

---

setUseLight

▸ setUseLight(val): void

Parameters

Name	Type
val	boolean

Returns

void

Description

设置是否使用灯光

---

setUuid

▸ setUuid(uuid): void

Parameters

Name	Type
uuid	string

Returns

void

Description

设置随机的一个id

---

updateUniformMap

▸ updateUniformMap(): void

Returns

void

Description

更新材质UniformMap