跳到主要内容
版本：v10.0

M3D / M3D / Render / Material

Class: Material

M3D.Render.Material

Memberof

M3D.Render

Description

Phong材质

Date

2022-1-17

Version

1.0

Copyright

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

Hierarchy​

Table of contents​

Constructors​

Properties​

Methods​

Constructors​

constructor​

• new Material(): Material

Returns​

Material

Description

构造函数

Overrides​

InnerMaterial.constructor

• new Material(org): Material

Parameters​

NameType
orgMaterial

Returns​

Material

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

defaultSpecular​

▪ Static defaultSpecular: number

Methods​

addUniformMap​

▸ addUniformMap(para, uniformValue): void

Parameters​

NameType
paraShaderParameter
uniformValueany

Returns​

void

Description

添加Uniform参数

Inherited from​

InnerMaterial.addUniformMap

addUniformTextureMap​

▸ addUniformTextureMap(para, obj): void

Parameters​

NameType
paraShaderParameter
objTextureObject

Returns​

void

Description

添加纹理Uniform参数

Inherited from​

InnerMaterial.addUniformTextureMap

clearUniformMap​

▸ clearUniformMap(): void

Returns​

void

Description

清空材质UniformMap

Inherited from​

InnerMaterial.clearUniformMap

clone​

▸ clone(): Material

Returns​

Material

Description

材质克隆

Overrides​

InnerMaterial.clone

compare​

▸ compare(sBaseMaterial): boolean

Parameters​

NameType
sBaseMaterialBaseMaterial

Returns​

boolean

Description

材质比较

Overrides​

InnerMaterial.compare

getAcceptLight​

▸ getAcceptLight(): boolean

Returns​

boolean

Description

获取是否接收灯光配置

Inherited from​

InnerMaterial.getAcceptLight

getAmbient​

▸ getAmbient(): Color

Returns​

Color

环境光颜色

Description

获取环境光颜色

getAmbientMap​

▸ getAmbientMap(): TextureObject

Returns​

TextureObject

Description

获取环境贴图

getBumpMap​

▸ getBumpMap(): TextureObject

Returns​

TextureObject

Description

获取凹凸映射纹理

getCompare​

▸ getCompare(smaterial): boolean

Parameters​

NameTypeDescription
smaterialBaseMaterial基础材质类

Returns​

boolean

Description

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

Inherited from​

InnerMaterial.getCompare

getDefine​

▸ getDefine(): Object

Returns​

Object

Description

获取材质定义

Inherited from​

InnerMaterial.getDefine

getDiffuse​

▸ getDiffuse(): Color

Returns​

Color

漫反射光颜色

Description

获取漫反射光颜色

getDiffuseMap​

▸ getDiffuseMap(): TextureObject

Returns​

TextureObject

Description

获取漫反射纹理

getDisplacementBias​

▸ getDisplacementBias(): number

Returns​

number

位移偏差

Description

获取位移偏差

getDisplacementMap​

▸ getDisplacementMap(): TextureObject

Returns​

TextureObject

Description

获取位移贴图

getDisplacementScale​

▸ getDisplacementScale(): number

Returns​

number

位移标度

Description

获取位移标度

getDisplayName​

▸ getDisplayName(): string

Returns​

string

Inherited from​

InnerMaterial.getDisplayName

getEmissive​

▸ getEmissive(): Color

Returns​

Color

Description

获取辐射光

getEmissiveMap​

▸ getEmissiveMap(): any

Returns​

any

Description

获取辐射光Map

getEnvTextureMapping​

▸ getEnvTextureMapping(): EnvTextureMappingType

Returns​

EnvTextureMappingType

纹理映射方式

Description

获取纹理映射方式

getEvents​

▸ getEvents(): M3DEvent[]

Returns​

M3DEvent[]

Description

获得事件列表

Inherited from​

InnerMaterial.getEvents

getEvnMap​

▸ getEvnMap(): any

Returns​

any

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

getMatcapMap​

▸ getMatcapMap(): TextureObject

Returns​

TextureObject

Description

获取Matcap贴图

getMaterialType​

▸ getMaterialType(): MaterialType

Returns​

MaterialType

Description

获取材质类型

Inherited from​

InnerMaterial.getMaterialType

getMaterialTypeStr​

▸ getMaterialTypeStr(material): string

Parameters​

NameTypeDescription
materialMaterialType材质类型

Returns​

string

Description

获取材质类型字符串

Inherited from​

InnerMaterial.getMaterialTypeStr

getName​

▸ getName(): string

Returns​

string

Description

获取材质名称

Overrides​

InnerMaterial.getName

getNeedUpdate​

▸ getNeedUpdate(): boolean

Returns​

boolean

Description

获取材质是否更新

Inherited from​

InnerMaterial.getNeedUpdate

getNormalMap​

▸ getNormalMap(): TextureObject

Returns​

TextureObject

Description

获取法向贴图

getNormalMapScale​

▸ getNormalMapScale(): Vector2

Returns​

Vector2

Description

获取normalMap缩放比例

getOpacity​

▸ getOpacity(): number

Returns​

number

Description

获取不透明度

getShadingMode​

▸ getShadingMode(): ShadingMode

Returns​

ShadingMode

着色模式

Description

获取着色模式

getShininess​

▸ getShininess(): number

Returns​

number

光亮度信息

Description

获取光亮度

getSpecular​

▸ getSpecular(): Color

Returns​

Color

Description

获取镜面反射

getSpecularMap​

▸ getSpecularMap(): TextureObject

Returns​

TextureObject

Description

获取镜面反射贴图

getTextureMapMode​

▸ getTextureMapMode(): TextureMapMode

Returns​

TextureMapMode

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

Description

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

getTextureMapping​

▸ getTextureMapping(): TextureMapping

Returns​

TextureMapping

纹理映射方式

Description

获取纹理映射方式

getTextureOp​

▸ getTextureOp(): TextureOp

Returns​

TextureOp

多个纹理叠加方式

Description

获取多个纹理叠加方式

getUnifomParameters​

▸ getUnifomParameters(): void

Returns​

void

getUniformMap​

▸ getUniformMap(): Map<ShaderParameter, any>

Returns​

Map<ShaderParameter, any>

Description

获取UniformMap

Inherited from​

InnerMaterial.getUniformMap

getUniformParameter​

▸ getUniformParameter(key): void

Parameters​

NameType
keystring

Returns​

void

Description

获取材质对应Uniform参数

getUniformTextureMap​

▸ getUniformTextureMap(): Map<ShaderParameter, any>

Returns​

Map<ShaderParameter, any>

Description

获取材质纹理UniformMap

Inherited from​

InnerMaterial.getUniformTextureMap

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

getiSpecular​

▸ getiSpecular(): any

Returns​

any

反射度数据

Description

获取反射度

init​

▸ init(): void

Returns​

void

Description

初始化

registerEvent​

▸ registerEvent(event): void

Parameters​

NameTypeDescription
eventM3DEventM3D事件

Returns​

void

Description

注册事件

Inherited from​

InnerMaterial.registerEvent

removeEvent​

▸ removeEvent(): void

Returns​

void

Description

删除事件

Inherited from​

InnerMaterial.removeEvent

setAcceptLight​

▸ setAcceptLight(val): void

Parameters​

NameType
valboolean

Returns​

void

Description

设置是否接收灯光

Inherited from​

InnerMaterial.setAcceptLight

setAmbient​

▸ setAmbient(ambient): void

Parameters​

NameTypeDescription
ambientColor环境光颜色

Returns​

void

Description

设置环境光颜色

setBumpMap​

▸ setBumpMap(texture): void

Parameters​

NameType
textureTextureObject

Returns​

void

Description

设置凹凸映射纹理

setDefine​

▸ setDefine(key, val): void

Parameters​

NameType
keystring
valstring

Returns​

void

Description

设置材质定义

Inherited from​

InnerMaterial.setDefine

setDiffuse​

▸ setDiffuse(diffuse): void

Parameters​

NameTypeDescription
diffuseColor颜色

Returns​

void

Description

设置漫反射光颜色

setDiffuseMap​

▸ setDiffuseMap(source): void

Parameters​

NameType
sourceTextureObject

Returns​

void

Description

设置漫反射纹理

setDisplacementBias​

▸ setDisplacementBias(val): void

Parameters​

NameTypeDescription
valnumber位移偏差

Returns​

void

Description

设置位移偏差

setDisplacementMap​

▸ setDisplacementMap(texture): void

Parameters​

NameType
textureTextureObject

Returns​

void

Description

设置位移贴图

setDisplacementScale​

▸ setDisplacementScale(val): void

Parameters​

NameTypeDescription
valnumber位移标度

Returns​

void

Description

设置位移标度

setDisplayName​

▸ setDisplayName(val): void

Parameters​

NameType
valstring

Returns​

void

Inherited from​

InnerMaterial.setDisplayName

setEmissive​

▸ setEmissive(emissive): void

Parameters​

NameType
emissiveColor

Returns​

void

Description

设置辐射光

setEnvTextureMapping​

▸ setEnvTextureMapping(val): void

Parameters​

NameTypeDescription
valEnvTextureMappingType纹理映射方式

Returns​

void

Description

设置纹理映射方式

setId​

▸ setId(v): void

Parameters​

NameTypeDescription
vnumberShapeId

Returns​

void

Description

设置id

Inherited from​

InnerMaterial.setId

setIsGammaOutpute​

▸ setIsGammaOutpute(val): void

Parameters​

NameType
valboolean

Returns​

void

Description

设置是否gamma空间输出

Inherited from​

InnerMaterial.setIsGammaOutpute

setLightHash​

▸ setLightHash(val): void

Parameters​

NameType
valstring

Returns​

void

Inherited from​

InnerMaterial.setLightHash

setMatcapMap​

▸ setMatcapMap(val): void

Parameters​

NameType
valTextureObject

Returns​

void

Description

设置MatCap贴图

setMaterialType​

▸ setMaterialType(types): void

Parameters​

NameTypeDescription
typesMaterialType材质类型

Returns​

void

Description

设置材质类型

Inherited from​

InnerMaterial.setMaterialType

setName​

▸ setName(name): void

Parameters​

NameType
namestring

Returns​

void

Description

设置材质名称

Overrides​

InnerMaterial.setName

setNeedUpdate​

▸ setNeedUpdate(val): void

Parameters​

NameType
valboolean

Returns​

void

Description

设置材质是否更新

Inherited from​

InnerMaterial.setNeedUpdate

setNormalMap​

▸ setNormalMap(texture): void

Parameters​

NameType
textureTextureObject

Returns​

void

Description

设置法向贴图

setNormalMapScale​

▸ setNormalMapScale(val): void

Parameters​

NameTypeDescription
valVector2常规纹理缩放

Returns​

void

Description

设置常规纹理缩放

setOpacity​

▸ setOpacity(val): void

Parameters​

NameType
valnumber

Returns​

void

Description 设置不透明度

Parameters​

NameType
valnumber

setShadingMode​

▸ setShadingMode(mode): void

Parameters​

NameTypeDescription
modeShadingMode阴影模式

Returns​

void

Description

设置着色模式

setShininess​

▸ setShininess(shininess): void

Parameters​

NameTypeDescription
shininessnumber光亮度

Returns​

void

Description

设置光亮度

setSpecular​

▸ setSpecular(specular): void

Parameters​

NameType
specularColor

Returns​

void

Description

设置镜面反射

setSpecularMap​

▸ setSpecularMap(texture): void

Parameters​

NameType
textureTextureObject

Returns​

void

Description

设置Specular纹理

setTextureMapMode​

▸ setTextureMapMode(mode): void

Parameters​

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

Returns​

void

Description

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

setTextureMapping​

▸ setTextureMapping(mode): void

Parameters​

NameTypeDescription
modeTextureMapping材质纹理映射方式

Returns​

void

Description

设置纹理映射方式

setTextureOp​

▸ setTextureOp(op): void

Parameters​

NameTypeDescription
opTextureOp纹理叠加方式

Returns​

void

Description

设置多个纹理叠加方式

setUniformMap​

▸ setUniformMap(): void

Returns​

void

Description

设置UniformMap

Overrides​

InnerMaterial.setUniformMap

setUniformParameter​

▸ setUniformParameter(key, uniformValue): boolean

Parameters​

NameType
keystring
uniformValueany

Returns​

boolean

Description

设置材质对应Uniform参数

setUseLight​

▸ setUseLight(val): void

Parameters​

NameType
valboolean

Returns​

void

Description

设置是否使用灯光

Inherited from​

InnerMaterial.setUseLight

setUuid​

▸ setUuid(uuid): void

Parameters​

NameType
uuidstring

Returns​

void

Description

设置随机的一个id

Inherited from​

InnerMaterial.setUuid

setiSpecular​

▸ setiSpecular(iSpecular): void

Parameters​

NameTypeDescription
iSpecularnumber反射度

Returns​

void

Description

设置反射度0~255

tempOpacity​

▸ tempOpacity(val): void

Parameters​

NameType
valnumber

Returns​

void

Description

临时透明度

updateUniformMap​

▸ updateUniformMap(): void

Returns​

void

Description

更新材质UniformMap

Inherited from​

InnerMaterial.updateUniformMap