M3D / M3D / Render / DecalMaterial

Class: DecalMaterial

M3D.Render.DecalMaterial

Memberof

M3D.Render

Description

贴图材质

Author

SS

Date

2023-2-12

Version

1.0

Copyright

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

Hierarchy

• Material

  ↳ DecalMaterial

Table of contents

Constructors

• constructor

Properties

• id
• instanceRednerMaterial
• count
• defaultSpecular

Methods

• addUniformMap
• addUniformTextureMap
• clearUniformMap
• clone
• compare
• getAcceptLight
• getAmbient
• getAmbientMap
• getBody
• getBumpMap
• getCompare
• getDefine
• getDiffuse
• getDiffuseMap
• getDisplacementBias
• getDisplacementMap
• getDisplacementScale
• getDisplayName
• getEmissive
• getEmissiveMap
• getEnvTextureMapping
• getEvents
• getEvnMap
• getFaceIndexs
• getFaceNormals
• getFaceUVs
• getFaceVertexts
• getId
• getInstancePath
• getIsGammaOutpute
• getLightHash
• getMatcapMap
• getMaterialType
• getMaterialTypeStr
• getName
• getNeedUpdate
• getNormalMap
• getNormalMapScale
• getOpacity
• getShadingMode
• getShininess
• getSpecular
• getSpecularMap
• getTextureMapMode
• getTextureMapping
• getTextureOp
• getUnifomParameters
• getUniformMap
• getUniformParameter
• getUniformTextureMap
• getUseLight
• getUuid
• getUvRotate
• getUvTransform
• getiSpecular
• init
• registerEvent
• removeEvent
• setAcceptLight
• setAmbient
• setBody
• setBumpMap
• setDefine
• setDiffuse
• setDiffuseMap
• setDisplacementBias
• setDisplacementMap
• setDisplacementScale
• setDisplayName
• setEmissive
• setEnvTextureMapping
• setFaceIndexs
• setFaceNormals
• setFaceUVs
• setFaceVertexs
• setId
• setInstancePath
• setIsGammaOutpute
• setLightHash
• setMatcapMap
• setMaterialType
• setName
• setNeedUpdate
• setNormalMap
• setNormalMapScale
• setOpacity
• setShadingMode
• setShininess
• setSpecular
• setSpecularMap
• setTextureMapMode
• setTextureMapping
• setTextureOp
• setUniformMap
• setUniformParameter
• setUseLight
• setUuid
• setiSpecular
• tempOpacity
• updateUniformMap

Constructors

constructor

• new DecalMaterial(): DecalMaterial

Returns

DecalMaterial

Description

构造函数

Overrides

Material.constructor

• new DecalMaterial(org): DecalMaterial

Parameters

Name	Type	Description
org	DecalMaterial	原贴图材质

Returns

DecalMaterial

Description

构造函数

Overrides

Material.constructor

Properties

id

• id: number

Inherited from

Material.id

---

instanceRednerMaterial

• instanceRednerMaterial: boolean

Inherited from

Material.instanceRednerMaterial

---

count

▪ Static count: number

Inherited from

Material.count

---

defaultSpecular

▪ Static defaultSpecular: number

Inherited from

Material.defaultSpecular

Methods

addUniformMap

▸ addUniformMap(para, uniformValue): void

Parameters

Name	Type
para	ShaderParameter
uniformValue	any

Returns

void

Description

添加Uniform参数

Inherited from

Material.addUniformMap

---

addUniformTextureMap

▸ addUniformTextureMap(para, obj): void

Parameters

Name	Type
para	ShaderParameter
obj	TextureObject

Returns

void

Description

添加纹理Uniform参数

Inherited from

Material.addUniformTextureMap

---

clearUniformMap

▸ clearUniformMap(): void

Returns

void

Description

清空材质UniformMap

Inherited from

Material.clearUniformMap

---

clone

▸ clone(): Material

Returns

Material

Description

材质克隆

Inherited from

Material.clone

---

compare

▸ compare(sBaseMaterial): boolean

Parameters

Name	Type
sBaseMaterial	BaseMaterial

Returns

boolean

Description

材质比较

Inherited from

Material.compare

---

getAcceptLight

▸ getAcceptLight(): boolean

Returns

boolean

Description

获取是否接收灯光配置

Inherited from

Material.getAcceptLight

---

getAmbient

▸ getAmbient(): Color

Returns

Color

环境光颜色

Description

获取环境光颜色

Inherited from

Material.getAmbient

---

getAmbientMap

▸ getAmbientMap(): TextureObject

Returns

TextureObject

Description

获取环境贴图

Inherited from

Material.getAmbientMap

---

getBody

▸ getBody(): Body

Returns

Body

关联的Body

Description

获取关联的Body数据

---

getBumpMap

▸ getBumpMap(): TextureObject

Returns

TextureObject

Description

获取凹凸映射纹理

Inherited from

Material.getBumpMap

---

getCompare

▸ getCompare(smaterial): boolean

Parameters

Name	Type	Description
smaterial	BaseMaterial	基础材质类

Returns

boolean

Description

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

Inherited from

Material.getCompare

---

getDefine

▸ getDefine(): Object

Returns

Object

Description

获取材质定义

Inherited from

Material.getDefine

---

getDiffuse

▸ getDiffuse(): Color

Returns

Color

漫反射光颜色

Description

获取漫反射光颜色

Inherited from

Material.getDiffuse

---

getDiffuseMap

▸ getDiffuseMap(): TextureObject

Returns

TextureObject

Description

获取漫反射纹理

Inherited from

Material.getDiffuseMap

---

getDisplacementBias

▸ getDisplacementBias(): number

Returns

number

位移偏差

Description

获取位移偏差

Inherited from

Material.getDisplacementBias

---

getDisplacementMap

▸ getDisplacementMap(): TextureObject

Returns

TextureObject

Description

获取位移贴图

Inherited from

Material.getDisplacementMap

---

getDisplacementScale

▸ getDisplacementScale(): number

Returns

number

位移标度

Description

获取位移标度

Inherited from

Material.getDisplacementScale

---

getDisplayName

▸ getDisplayName(): string

Returns

string

Inherited from

Material.getDisplayName

---

getEmissive

▸ getEmissive(): Color

Returns

Color

Description

获取辐射光

Inherited from

Material.getEmissive

---

getEmissiveMap

▸ getEmissiveMap(): any

Returns

any

Description

获取辐射光Map

Inherited from

Material.getEmissiveMap

---

getEnvTextureMapping

▸ getEnvTextureMapping(): EnvTextureMappingType

Returns

EnvTextureMappingType

纹理映射方式

Description

获取纹理映射方式

Inherited from

Material.getEnvTextureMapping

---

getEvents

▸ getEvents(): M3DEvent[]

Returns

M3DEvent[]

Description

获得事件列表

Inherited from

Material.getEvents

---

getEvnMap

▸ getEvnMap(): any

Returns

any

Inherited from

Material.getEvnMap

---

getFaceIndexs

▸ getFaceIndexs(): any

Returns

any

索引数据

Description

获取面的索引数据额

---

getFaceNormals

▸ getFaceNormals(): any

Returns

any

法线数据

Description

获取面的法线数据

---

getFaceUVs

▸ getFaceUVs(): any

Returns

any

纹理坐标数据

Description

获取面纹理坐标

---

getFaceVertexts

▸ getFaceVertexts(): any

Returns

any

顶点数据

Description

设置面的顶点数据

---

getId

▸ getId(): number

Returns

number

Description

获取id

Inherited from

Material.getId

---

getInstancePath

▸ getInstancePath(): string

Returns

string

实例路径

Description

获取实例路径

---

getIsGammaOutpute

▸ getIsGammaOutpute(): boolean

Returns

boolean

Description

获取是否gamma空间输出

Inherited from

Material.getIsGammaOutpute

---

getLightHash

▸ getLightHash(): string

Returns

string

Inherited from

Material.getLightHash

---

getMatcapMap

▸ getMatcapMap(): TextureObject

Returns

TextureObject

Description

获取Matcap贴图

Inherited from

Material.getMatcapMap

---

getMaterialType

▸ getMaterialType(): MaterialType

Returns

MaterialType

Description

获取材质类型

Inherited from

Material.getMaterialType

---

getMaterialTypeStr

▸ getMaterialTypeStr(material): string

Parameters

Name	Type	Description
material	MaterialType	材质类型

Returns

string

Description

获取材质类型字符串

Inherited from

Material.getMaterialTypeStr

---

getName

▸ getName(): string

Returns

string

Description

获取材质名称

Inherited from

Material.getName

---

getNeedUpdate

▸ getNeedUpdate(): boolean

Returns

boolean

Description

获取材质是否更新

Inherited from

Material.getNeedUpdate

---

getNormalMap

▸ getNormalMap(): TextureObject

Returns

TextureObject

Description

获取法向贴图

Inherited from

Material.getNormalMap

---

getNormalMapScale

▸ getNormalMapScale(): Vector2

Returns

Vector2

Description

获取normalMap缩放比例

Inherited from

Material.getNormalMapScale

---

getOpacity

▸ getOpacity(): number

Returns

number

Description

获取不透明度

Inherited from

Material.getOpacity

---

getShadingMode

▸ getShadingMode(): ShadingMode

Returns

ShadingMode

着色模式

Description

获取着色模式

Inherited from

Material.getShadingMode

---

getShininess

▸ getShininess(): number

Returns

number

光亮度信息

Description

获取光亮度

Inherited from

Material.getShininess

---

getSpecular

▸ getSpecular(): Color

Returns

Color

Description

获取镜面反射

Inherited from

Material.getSpecular

---

getSpecularMap

▸ getSpecularMap(): TextureObject

Returns

TextureObject

Description

获取镜面反射贴图

Inherited from

Material.getSpecularMap

---

getTextureMapMode

▸ getTextureMapMode(): TextureMapMode

Returns

TextureMapMode

纹理坐标超出范围处理方式

Description

获取纹理坐标超出范围处理方式

Inherited from

Material.getTextureMapMode

---

getTextureMapping

▸ getTextureMapping(): TextureMapping

Returns

TextureMapping

纹理映射方式

Description

获取纹理映射方式

Inherited from

Material.getTextureMapping

---

getTextureOp

▸ getTextureOp(): TextureOp

Returns

TextureOp

多个纹理叠加方式

Description

获取多个纹理叠加方式

Inherited from

Material.getTextureOp

---

getUnifomParameters

▸ getUnifomParameters(): void

Returns

void

Inherited from

Material.getUnifomParameters

---

getUniformMap

▸ getUniformMap(): Map<ShaderParameter, any>

Returns

Map<ShaderParameter, any>

Description

获取UniformMap

Inherited from

Material.getUniformMap

---

getUniformParameter

▸ getUniformParameter(key): void

Parameters

Name	Type
key	string

Returns

void

Description

获取材质对应Uniform参数

Inherited from

Material.getUniformParameter

---

getUniformTextureMap

▸ getUniformTextureMap(): Map<ShaderParameter, any>

Returns

Map<ShaderParameter, any>

Description

获取材质纹理UniformMap

Inherited from

Material.getUniformTextureMap

---

getUseLight

▸ getUseLight(): boolean

Returns

boolean

Description

获取是否使用灯光

Inherited from

Material.getUseLight

---

getUuid

▸ getUuid(): string

Returns

string

Description

生成随机的一个id

Inherited from

Material.getUuid

---

getUvRotate

▸ getUvRotate(): number

Returns

number

纹理坐标旋转角度

Description

获取纹理坐标旋转角度

Inherited from

Material.getUvRotate

---

getUvTransform

▸ getUvTransform(): Matrix3

Returns

Matrix3

Description

获取纹理坐标矩阵

Inherited from

Material.getUvTransform

---

getiSpecular

▸ getiSpecular(): any

Returns

any

反射度数据

Description

获取反射度

Inherited from

Material.getiSpecular

---

init

▸ init(): void

Returns

void

Description

初始化

Inherited from

Material.init

---

registerEvent

▸ registerEvent(event): void

Parameters

Name	Type	Description
event	M3DEvent	M3D事件

Returns

void

Description

注册事件

Inherited from

Material.registerEvent

---

removeEvent

▸ removeEvent(): void

Returns

void

Description

删除事件

Inherited from

Material.removeEvent

---

setAcceptLight

▸ setAcceptLight(val): void

Parameters

Name	Type
val	boolean

Returns

void

Description

设置是否接收灯光

Inherited from

Material.setAcceptLight

---

setAmbient

▸ setAmbient(ambient): void

Parameters

Name	Type	Description
ambient	Color	环境光颜色

Returns

void

Description

设置环境光颜色

Inherited from

Material.setAmbient

---

setBody

▸ setBody(body): void

Parameters

Name	Type	Description
body	Body	关联的body数据

Returns

void

Description

设置关联的Body

---

setBumpMap

▸ setBumpMap(texture): void

Parameters

Name	Type
texture	TextureObject

Returns

void

Description

设置凹凸映射纹理

Inherited from

Material.setBumpMap

---

setDefine

▸ setDefine(key, val): void

Parameters

Name	Type
key	string
val	string

Returns

void

Description

设置材质定义

Inherited from

Material.setDefine

---

setDiffuse

▸ setDiffuse(diffuse): void

Parameters

Name	Type	Description
diffuse	Color	颜色

Returns

void

Description

设置漫反射光颜色

Inherited from

Material.setDiffuse

---

setDiffuseMap

▸ setDiffuseMap(source): void

Parameters

Name	Type
source	TextureObject

Returns

void

Description

设置漫反射纹理

Inherited from

Material.setDiffuseMap

---

setDisplacementBias

▸ setDisplacementBias(val): void

Parameters

Name	Type	Description
val	number	位移偏差

Returns

void

Description

设置位移偏差

Inherited from

Material.setDisplacementBias

---

setDisplacementMap

▸ setDisplacementMap(texture): void

Parameters

Name	Type
texture	TextureObject

Returns

void

Description

设置位移贴图

Inherited from

Material.setDisplacementMap

---

setDisplacementScale

▸ setDisplacementScale(val): void

Parameters

Name	Type	Description
val	number	位移标度

Returns

void

Description

设置位移标度

Inherited from

Material.setDisplacementScale

---

setDisplayName

▸ setDisplayName(val): void

Parameters

Name	Type
val	string

Returns

void

Inherited from

Material.setDisplayName

---

setEmissive

▸ setEmissive(emissive): void

Parameters

Name	Type
emissive	Color

Returns

void

Description

设置辐射光

Inherited from

Material.setEmissive

---

setEnvTextureMapping

▸ setEnvTextureMapping(val): void

Parameters

Name	Type	Description
val	EnvTextureMappingType	纹理映射方式

Returns

void

Description

设置纹理映射方式

Inherited from

Material.setEnvTextureMapping

---

setFaceIndexs

▸ setFaceIndexs(vecIndex): void

Parameters

Name	Type	Description
vecIndex	any	索引数据

Returns

void

Description

设置面的索引数据

---

setFaceNormals

▸ setFaceNormals(vecNormals): void

Parameters

Name	Type	Description
vecNormals	any	面的法线数据

Returns

void

Description

设置面的法线数据

---

setFaceUVs

▸ setFaceUVs(vecTextureCoordinate): void

Parameters

Name	Type	Description
vecTextureCoordinate	any	面的纹理坐标数据

Returns

void

Description

设置面的纹理坐标数据

---

setFaceVertexs

▸ setFaceVertexs(vecVert): void

Parameters

Name	Type	Description
vecVert	any	面的顶点集

Returns

void

Description

设置面的顶点数据

---

setId

▸ setId(v): void

Parameters

Name	Type	Description
v	number	ShapeId

Returns

void

Description

设置id

Inherited from

Material.setId

---

setInstancePath

▸ setInstancePath(strInstancePath): void

Parameters

Name	Type	Description
strInstancePath	string	实例路径

Returns

void

Description

设置实例路径

---

setIsGammaOutpute

▸ setIsGammaOutpute(val): void

Parameters

Name	Type
val	boolean

Returns

void

Description

设置是否gamma空间输出

Inherited from

Material.setIsGammaOutpute

---

setLightHash

▸ setLightHash(val): void

Parameters

Name	Type
val	string

Returns

void

Inherited from

Material.setLightHash

---

setMatcapMap

▸ setMatcapMap(val): void

Parameters

Name	Type
val	TextureObject

Returns

void

Description

设置MatCap贴图

Inherited from

Material.setMatcapMap

---

setMaterialType

▸ setMaterialType(types): void

Parameters

Name	Type	Description
types	MaterialType	材质类型

Returns

void

Description

设置材质类型

Inherited from

Material.setMaterialType

---

setName

▸ setName(name): void

Parameters

Name	Type
name	string

Returns

void

Description

设置材质名称

Inherited from

Material.setName

---

setNeedUpdate

▸ setNeedUpdate(val): void

Parameters

Name	Type
val	boolean

Returns

void

Description

设置材质是否更新

Inherited from

Material.setNeedUpdate

---

setNormalMap

▸ setNormalMap(texture): void

Parameters

Name	Type
texture	TextureObject

Returns

void

Description

设置法向贴图

Inherited from

Material.setNormalMap

---

setNormalMapScale

▸ setNormalMapScale(val): void

Parameters

Name	Type	Description
val	Vector2	常规纹理缩放

Returns

void

Description

设置常规纹理缩放

Inherited from

Material.setNormalMapScale

---

setOpacity

▸ setOpacity(val): void

Parameters

Name	Type
val	number

Returns

void

Description 设置不透明度

Parameters

Name	Type
val	number

Inherited from

Material.setOpacity

---

setShadingMode

▸ setShadingMode(mode): void

Parameters

Name	Type	Description
mode	ShadingMode	阴影模式

Returns

void

Description

设置着色模式

Inherited from

Material.setShadingMode

---

setShininess

▸ setShininess(shininess): void

Parameters

Name	Type	Description
shininess	number	光亮度

Returns

void

Description

设置光亮度

Inherited from

Material.setShininess

---

setSpecular

▸ setSpecular(specular): void

Parameters

Name	Type
specular	Color

Returns

void

Description

设置镜面反射

Inherited from

Material.setSpecular

---

setSpecularMap

▸ setSpecularMap(texture): void

Parameters

Name	Type
texture	TextureObject

Returns

void

Description

设置Specular纹理

Inherited from

Material.setSpecularMap

---

setTextureMapMode

▸ setTextureMapMode(mode): void

Parameters

Name	Type	Description
mode	TextureMapMode	纹理坐标超出范围处理方式

Returns

void

Description

设置纹理坐标超出范围处理方式

Inherited from

Material.setTextureMapMode

---

setTextureMapping

▸ setTextureMapping(mode): void

Parameters

Name	Type	Description
mode	TextureMapping	材质纹理映射方式

Returns

void

Description

设置纹理映射方式

Inherited from

Material.setTextureMapping

---

setTextureOp

▸ setTextureOp(op): void

Parameters

Name	Type	Description
op	TextureOp	纹理叠加方式

Returns

void

Description

设置多个纹理叠加方式

Inherited from

Material.setTextureOp

---

setUniformMap

▸ setUniformMap(): void

Returns

void

Description

设置UniformMap

Inherited from

Material.setUniformMap

---

setUniformParameter

▸ setUniformParameter(key, uniformValue): boolean

Parameters

Name	Type
key	string
uniformValue	any

Returns

boolean

Description

设置材质对应Uniform参数

Inherited from

Material.setUniformParameter

---

setUseLight

▸ setUseLight(val): void

Parameters

Name	Type
val	boolean

Returns

void

Description

设置是否使用灯光

Inherited from

Material.setUseLight

---

setUuid

▸ setUuid(uuid): void

Parameters

Name	Type
uuid	string

Returns

void

Description

设置随机的一个id

Inherited from

Material.setUuid

---

setiSpecular

▸ setiSpecular(iSpecular): void

Parameters

Name	Type	Description
iSpecular	number	反射度

Returns

void

Description

设置反射度0~255

Inherited from

Material.setiSpecular

---

tempOpacity

▸ tempOpacity(val): void

Parameters

Name	Type
val	number

Returns

void

Description

临时透明度

Inherited from

Material.tempOpacity

---

updateUniformMap

▸ updateUniformMap(): void

Returns

void

Description

更新材质UniformMap

Inherited from

Material.updateUniformMap