M3D / M3D / Render / DepthMaterial

Class: DepthMaterial

M3D.Render.DepthMaterial

Memberof

M3D.Render

Description

深度纹理：用来生成深度贴图

Date

2022-1-17

Version

1.0

Copyright

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

Hierarchy

• InnerMaterial

  ↳ DepthMaterial

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
• getUvRotate
• getUvTransform
• registerEvent
• removeEvent
• setAcceptLight
• setDefine
• setDisplayName
• setId
• setIsGammaOutpute
• setLightHash
• setMaterialType
• setName
• setNeedUpdate
• setUniformMap
• setUseLight
• setUuid
• updateUniformMap

Constructors

constructor

• new DepthMaterial(): DepthMaterial

Returns

DepthMaterial

Description

构造函数

Overrides

InnerMaterial.constructor

• new DepthMaterial(org): DepthMaterial

Parameters

Name	Type	Description
org	DepthMaterial	原深度纹理

Returns

DepthMaterial

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(): DepthMaterial

Returns

DepthMaterial

深度贴图

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

---

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

---

getDisplayName

▸ getDisplayName(): string

Returns

string

Inherited from

InnerMaterial.getDisplayName

---

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

---

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

---

getName

▸ getName(): string

Returns

string

材质名称

Description

获取材质名称

Inherited from

InnerMaterial.getName

---

getNeedUpdate

▸ getNeedUpdate(): boolean

Returns

boolean

Description

获取材质是否更新

Inherited from

InnerMaterial.getNeedUpdate

---

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

---

getUseLight

▸ getUseLight(): boolean

Returns

boolean

是否使用灯光

Description

获取是否使用灯光

Overrides

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

---

setDefine

▸ setDefine(key, val): void

Parameters

Name	Type
key	string
val	string

Returns

void

Description

设置材质定义

Inherited from

InnerMaterial.setDefine

---

setDisplayName

▸ setDisplayName(val): void

Parameters

Name	Type
val	string

Returns

void

Inherited from

InnerMaterial.setDisplayName

---

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

---

setMaterialType

▸ setMaterialType(types): void

Parameters

Name	Type	Description
types	MaterialType	材质类型

Returns

void

Description

设置材质类型

Inherited from

InnerMaterial.setMaterialType

---

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

---

setUniformMap

▸ setUniformMap(): void

Returns

void

Description

设置UniformMap

Inherited from

InnerMaterial.setUniformMap

---

setUseLight

▸ setUseLight(val): void

Parameters

Name	Type	Description
val	boolean	是否使用灯光

Returns

void

Description

设置是否使用灯光数据

Overrides

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