# Class PBMMeshMaterial

#### Hierarchy (View Summary)

- PBMMaterial
  - PBMMeshMaterial

#### Implements

- MeshBasicMaterial
- MeshPhongMaterial
- MeshStandardMaterial

- Defined in lib/five/model/materials/pbmMeshMaterial.ts:189

##### Index

### Constructors

constructor

### Properties

alphaMap
alphaMode
aoMap
aoMapIntensity
brightness
bumpMap
bumpScale
clearcoat
clearcoatMap
clearcoatNormalMap
clearcoatNormalScale
clearcoatRoughness
clearcoatRoughnessMap
clippers
clipping
color
colorAlpha
colorBrightness
colorSaturation
colorStyle
combine
constantColor
customShaders
displacementBias
displacementMap
displacementScale
emissive
emissiveIntensity
emissiveMap
envMap
envMapIntensity
floorIndex
floorStyle
gradientTexture
isMeshBasicMaterial
isMeshPhongMaterial
isMeshPhysicalMaterial
isMeshStandardMaterial
isPBMMeshMaterial
isShaderMaterial
lightMap
lightMapIntensity
map
metal
metalness
metalnessMap
modelAlpha
modelBoundingMax
modelBoundingMin
morphNormals
morphTargets
normalMap
normalMapType
normalScale
onBeforeRender?
pano0
pano0Depth
pano1
pano1Depth
panoFilter
progress
refinedScreen
reflectivity
refractionRatio
roughness
roughnessMap
shaderType
sheen
shininess
shownFloorIndex
skinning
specular
specularMap
transition
transparency
useHQDepth
useHQWeight
vertexMarks
vertexTangents
wireframe
wireframeLinecap
wireframeLinejoin
wireframeLinewidth

### Methods

clone
copy
refreshUniforms

## Constructors

### constructor

- new PBMMeshMaterial(
  parameters?: PBMMeshShaderType | PBMMeshMaterialParameters,
  ): PBMMeshMaterial

  #### Parameters

  - `Optional` parameters: PBMMeshShaderType | PBMMeshMaterialParameters

  #### Returns PBMMeshMaterial

  Overrides PBMMaterial.constructor

  - Defined in lib/five/model/materials/pbmMeshMaterial.ts:301

## Properties

### alphaMap

alphaMap: Texture | null = null

Implementation of THREE.MeshBasicMaterial.alphaMap

- Defined in lib/five/model/materials/pbmMeshMaterial.ts:221

### alphaMode

alphaMode: PBMAlphaMode = 'OPAQUE'

- Defined in lib/five/model/materials/pbmMeshMaterial.ts:269

### aoMap

aoMap: Texture | null = null

Implementation of THREE.MeshBasicMaterial.aoMap

- Defined in lib/five/model/materials/pbmMeshMaterial.ts:208

### aoMapIntensity

aoMapIntensity: number = 1.0

Implementation of THREE.MeshBasicMaterial.aoMapIntensity

- Defined in lib/five/model/materials/pbmMeshMaterial.ts:209

### brightness

brightness: number

- Defined in lib/five/model/materials/pbmMeshMaterial.ts:286

### bumpMap

bumpMap: Texture | null = null

Implementation of THREE.MeshPhongMaterial.bumpMap

- Defined in lib/five/model/materials/pbmMeshMaterial.ts:233

### bumpScale

bumpScale: number = 1

Implementation of THREE.MeshPhongMaterial.bumpScale

- Defined in lib/five/model/materials/pbmMeshMaterial.ts:234

### clearcoat

clearcoat: number = 0

- Defined in lib/five/model/materials/pbmMeshMaterial.ts:244

### clearcoatMap

clearcoatMap: Texture | null = null

- Defined in lib/five/model/materials/pbmMeshMaterial.ts:245

### clearcoatNormalMap

clearcoatNormalMap: Texture | null = null

- Defined in lib/five/model/materials/pbmMeshMaterial.ts:249

### clearcoatNormalScale

clearcoatNormalScale: Vector2 = ...

- Defined in lib/five/model/materials/pbmMeshMaterial.ts:248

### clearcoatRoughness

clearcoatRoughness: number = 0

- Defined in lib/five/model/materials/pbmMeshMaterial.ts:246

### clearcoatRoughnessMap

clearcoatRoughnessMap: Texture | null = null

- Defined in lib/five/model/materials/pbmMeshMaterial.ts:247

### clippers

clippers: readonly PBMClipperParameter[]

- Defined in lib/five/model/materials/pbmMeshMaterial.ts:296

### clipping

clipping: boolean = true

- Defined in lib/five/model/materials/pbmMeshMaterial.ts:295

### color

color: Color = ...

Implementation of THREE.MeshBasicMaterial.color

- Defined in lib/five/model/materials/pbmMeshMaterial.ts:202

### colorAlpha

colorAlpha: number

- Defined in lib/five/model/materials/pbmMeshMaterial.ts:270

### colorBrightness

colorBrightness: number

- Defined in lib/five/model/materials/pbmMeshMaterial.ts:288

### colorSaturation

colorSaturation: number

- Defined in lib/five/model/materials/pbmMeshMaterial.ts:287

### colorStyle

colorStyle: PBMColorStyle

- Defined in lib/five/model/materials/pbmMeshMaterial.ts:280

### combine

combine: Combine = ...

Implementation of THREE.MeshBasicMaterial.combine

- Defined in lib/five/model/materials/pbmMeshMaterial.ts:223

### constantColor

constantColor: Vector3

- Defined in lib/five/model/materials/pbmMeshMaterial.ts:281

### customShaders

customShaders: readonly PBMCustomShader[] = []

- Defined in lib/five/model/materials/pbmMeshMaterial.ts:297

### displacementBias

displacementBias: number = 0

Implementation of THREE.MeshPhongMaterial.displacementBias

- Defined in lib/five/model/materials/pbmMeshMaterial.ts:242

### displacementMap

displacementMap: Texture | null = null

Implementation of THREE.MeshPhongMaterial.displacementMap

- Defined in lib/five/model/materials/pbmMeshMaterial.ts:240

### displacementScale

displacementScale: number = 1

Implementation of THREE.MeshPhongMaterial.displacementScale

- Defined in lib/five/model/materials/pbmMeshMaterial.ts:241

### emissive

emissive: Color = ...

Implementation of THREE.MeshPhongMaterial.emissive

- Defined in lib/five/model/materials/pbmMeshMaterial.ts:230

### emissiveIntensity

emissiveIntensity: number = 1

Implementation of THREE.MeshPhongMaterial.emissiveIntensity

- Defined in lib/five/model/materials/pbmMeshMaterial.ts:231

### emissiveMap

emissiveMap: Texture | null = null

Implementation of THREE.MeshPhongMaterial.emissiveMap

- Defined in lib/five/model/materials/pbmMeshMaterial.ts:229

### envMap

envMap: CubeTexture | Texture | null = null

Implementation of THREE.MeshBasicMaterial.envMap

- Defined in lib/five/model/materials/pbmMeshMaterial.ts:224

### envMapIntensity

envMapIntensity: number = 1

Implementation of THREE.MeshStandardMaterial.envMapIntensity

- Defined in lib/five/model/materials/pbmMeshMaterial.ts:225

### floorIndex

floorIndex: number

- Defined in lib/five/model/materials/pbmMeshMaterial.ts:282

### floorStyle

floorStyle: PBMFloorStyle

- Defined in lib/five/model/materials/pbmMeshMaterial.ts:284

### gradientTexture

gradientTexture: Texture | null

- Defined in lib/five/model/materials/pbmMeshMaterial.ts:285

### `Readonly` isMeshBasicMaterial

isMeshBasicMaterial: boolean

- Defined in lib/five/model/materials/pbmMeshMaterial.ts:193

### `Readonly` isMeshPhongMaterial

isMeshPhongMaterial: boolean

- Defined in lib/five/model/materials/pbmMeshMaterial.ts:194

### `Readonly` isMeshPhysicalMaterial

isMeshPhysicalMaterial: boolean

- Defined in lib/five/model/materials/pbmMeshMaterial.ts:196

### `Readonly` isMeshStandardMaterial

isMeshStandardMaterial: boolean

- Defined in lib/five/model/materials/pbmMeshMaterial.ts:195

### `Readonly` isPBMMeshMaterial

isPBMMeshMaterial: true

- Defined in lib/five/model/materials/pbmMeshMaterial.ts:191

### `Readonly` isShaderMaterial

isShaderMaterial: true

- Defined in lib/five/model/materials/pbmMeshMaterial.ts:192

### lightMap

lightMap: Texture | null = null

Implementation of THREE.MeshPhongMaterial.lightMap

- Defined in lib/five/model/materials/pbmMeshMaterial.ts:205

### lightMapIntensity

lightMapIntensity: number = 1.0

Implementation of THREE.MeshPhongMaterial.lightMapIntensity

- Defined in lib/five/model/materials/pbmMeshMaterial.ts:206

### map

map: Texture | null = null

Implementation of THREE.MeshBasicMaterial.map

- Defined in lib/five/model/materials/pbmMeshMaterial.ts:203

### metal

metal: boolean = false

#### Deprecated

Use MeshStandardMaterial THREE.MeshStandardMaterial instead.

Implementation of THREE.MeshPhongMaterial.metal

- Defined in lib/five/model/materials/pbmMeshMaterial.ts:265

### metalness

metalness: number = 0

Implementation of THREE.MeshStandardMaterial.metalness

- Defined in lib/five/model/materials/pbmMeshMaterial.ts:219

### metalnessMap

metalnessMap: Texture | null = null

Implementation of THREE.MeshStandardMaterial.metalnessMap

- Defined in lib/five/model/materials/pbmMeshMaterial.ts:218

### modelAlpha

modelAlpha: number

- Defined in lib/five/model/materials/pbmMeshMaterial.ts:277

### modelBoundingMax

modelBoundingMax: Vector3

- Defined in lib/five/model/materials/pbmMeshMaterial.ts:292

### modelBoundingMin

modelBoundingMin: Vector3

- Defined in lib/five/model/materials/pbmMeshMaterial.ts:291

### morphNormals

morphNormals: boolean = false

Implementation of THREE.MeshPhongMaterial.morphNormals

- Defined in lib/five/model/materials/pbmMeshMaterial.ts:262

### morphTargets

morphTargets: boolean = false

Implementation of THREE.MeshBasicMaterial.morphTargets

- Defined in lib/five/model/materials/pbmMeshMaterial.ts:261

### normalMap

normalMap: Texture | null = null

Implementation of THREE.MeshPhongMaterial.normalMap

- Defined in lib/five/model/materials/pbmMeshMaterial.ts:236

### normalMapType

normalMapType: NormalMapTypes = THREE.TangentSpaceNormalMap

Implementation of THREE.MeshPhongMaterial.normalMapType

- Defined in lib/five/model/materials/pbmMeshMaterial.ts:237

### normalScale

normalScale: Vector2 = ...

Implementation of THREE.MeshPhongMaterial.normalScale

- Defined in lib/five/model/materials/pbmMeshMaterial.ts:238

### `Optional` onBeforeRender

onBeforeRender?: (
renderer: WebGLRenderer,
scene: Scene,
camera: Camera,
geometry: Geometry | BufferGeometry,
object: Object3D,
group: Group,
) => void

- Defined in lib/five/model/materials/pbmMeshMaterial.ts:299

### pano0

pano0: PBMPanoPicture | null

- Defined in lib/five/model/materials/pbmMeshMaterial.ts:271

### pano0Depth

pano0Depth: PBMPanoDepth | null

- Defined in lib/five/model/materials/pbmMeshMaterial.ts:273

### pano1

pano1: PBMPanoPicture | null

- Defined in lib/five/model/materials/pbmMeshMaterial.ts:272

### pano1Depth

pano1Depth: PBMPanoDepth | null

- Defined in lib/five/model/materials/pbmMeshMaterial.ts:274

### panoFilter

panoFilter: PBMPanoFilterValue | null

- Defined in lib/five/model/materials/pbmMeshMaterial.ts:275

### progress

progress: number

- Defined in lib/five/model/materials/pbmMeshMaterial.ts:278

### refinedScreen

refinedScreen: PBMRefinedScreen | null

- Defined in lib/five/model/materials/pbmMeshMaterial.ts:276

### reflectivity

reflectivity: number = 0.4

Implementation of THREE.MeshBasicMaterial.reflectivity

- Defined in lib/five/model/materials/pbmMeshMaterial.ts:226

### refractionRatio

refractionRatio: number = 0.98

Implementation of THREE.MeshBasicMaterial.refractionRatio

- Defined in lib/five/model/materials/pbmMeshMaterial.ts:227

### roughness

roughness: number = 1

Implementation of THREE.MeshStandardMaterial.roughness

- Defined in lib/five/model/materials/pbmMeshMaterial.ts:216

### roughnessMap

roughnessMap: Texture | null = null

Implementation of THREE.MeshStandardMaterial.roughnessMap

- Defined in lib/five/model/materials/pbmMeshMaterial.ts:215

### shaderType

shaderType: PBMMeshShaderType

- Defined in lib/five/model/materials/pbmMeshMaterial.ts:198

### sheen

sheen: Color | null = null

- Defined in lib/five/model/materials/pbmMeshMaterial.ts:251

### shininess

shininess: number = 30

Implementation of THREE.MeshPhongMaterial.shininess

- Defined in lib/five/model/materials/pbmMeshMaterial.ts:213

### shownFloorIndex

shownFloorIndex: number

- Defined in lib/five/model/materials/pbmMeshMaterial.ts:283

### skinning

skinning: boolean = false

Implementation of THREE.MeshBasicMaterial.skinning

- Defined in lib/five/model/materials/pbmMeshMaterial.ts:260

### specular

specular: Color = ...

Implementation of THREE.MeshPhongMaterial.specular

- Defined in lib/five/model/materials/pbmMeshMaterial.ts:212

### specularMap

specularMap: Texture | null = null

Implementation of THREE.MeshBasicMaterial.specularMap

- Defined in lib/five/model/materials/pbmMeshMaterial.ts:211

### transition

transition: PBMTransition

- Defined in lib/five/model/materials/pbmMeshMaterial.ts:279

### transparency

transparency: number = 0

- Defined in lib/five/model/materials/pbmMeshMaterial.ts:253

### useHQDepth

useHQDepth: boolean

- Defined in lib/five/model/materials/pbmMeshMaterial.ts:290

### useHQWeight

useHQWeight: boolean

- Defined in lib/five/model/materials/pbmMeshMaterial.ts:289

### vertexMarks

vertexMarks: boolean

- Defined in lib/five/model/materials/pbmMeshMaterial.ts:268

### vertexTangents

vertexTangents: boolean = false

Implementation of THREE.MeshStandardMaterial.vertexTangents

- Defined in lib/five/model/materials/pbmMeshMaterial.ts:201

### wireframe

wireframe: boolean = false

Implementation of THREE.MeshBasicMaterial.wireframe

- Defined in lib/five/model/materials/pbmMeshMaterial.ts:255

### wireframeLinecap

wireframeLinecap: string = 'round'

Implementation of THREE.MeshBasicMaterial.wireframeLinecap

- Defined in lib/five/model/materials/pbmMeshMaterial.ts:257

### wireframeLinejoin

wireframeLinejoin: string = 'round'

Implementation of THREE.MeshBasicMaterial.wireframeLinejoin

- Defined in lib/five/model/materials/pbmMeshMaterial.ts:258

### wireframeLinewidth

wireframeLinewidth: number = 1

Implementation of THREE.MeshBasicMaterial.wireframeLinewidth

- Defined in lib/five/model/materials/pbmMeshMaterial.ts:256

## Methods

### clone

- clone(): this

  Return a new material with the same parameters as this material.

  #### Returns this

  Implementation of THREE.MeshBasicMaterial.clone

  Overrides PBMMaterial.clone

  - Defined in lib/five/model/materials/pbmMeshMaterial.ts:1045

### copy

- copy(source: PBMMeshMaterial): this

  Copy the parameters from the passed material into this material.

  #### Parameters

  - source: PBMMeshMaterial

  #### Returns this

  Implementation of THREE.MeshBasicMaterial.copy

  Overrides PBMMaterial.copy

  - Defined in lib/five/model/materials/pbmMeshMaterial.ts:943

### refreshUniforms

- refreshUniforms(): void

  #### Returns void

  #### Deprecated

  已经不需要再被调用了

  - Defined in lib/five/model/materials/pbmMeshMaterial.ts:1054