Class: InstancedSkinnedMaterial
Every instanced, skinned entity (creatures, boats, drops): bones from a shared texture, each instance's light, hit flash and emissive face from its own attributes, the body's face atlas, and the world's sun shadow, cones and fog. Its program is one per option set; what varies per material is uniform.
Hierarchy
-
NodeMaterial↳
InstancedSkinnedMaterial
Constructors
constructor
• new InstancedSkinnedMaterial(boneTexture, boneTextureWidth, boneTextureHeight, bonesPerInstance, options?): InstancedSkinnedMaterial
Parameters
| Name | Type |
|---|---|
boneTexture | DataTexture |
boneTextureWidth | number |
boneTextureHeight | number |
bonesPerInstance | number |
options | InstancedSkinnedMaterialOptions |
Returns
Overrides
THREE.NodeMaterial.constructor
Properties
atlasGrid
• Readonly atlasGrid: Vector2
boneTexture
• boneTexture: DataTexture
boneTextureHeight
• boneTextureHeight: number
boneTextureWidth
• boneTextureWidth: number
bonesPerInstance
• bonesPerInstance: number
colorMap
• colorMap: Texture<unknown, TextureEventMap>
emissiveColor
• Readonly emissiveColor: Color
emissiveFace
• Readonly emissiveFace: Vector2
(part, face) of the emissive face (emissiveFace).
faceShadesNegative
• Readonly faceShadesNegative: Vector3
faceShadesPositive
• Readonly faceShadesPositive: Vector3
+x, +y, +z and -x, -y, -z face brightness (faceShades).
hitColor
• Readonly hitColor: Color
maxBrightness
• maxBrightness: number = 1.0
opacityValue
• opacityValue: number
perDrawNode
• Readonly perDrawNode: ConstNode<"float", number> = perDrawInputs
receiveShadowsValue
• receiveShadowsValue: number
shadowSelfBoundsMargin
• shadowSelfBoundsMargin: number
shadowSelfSphere
• Readonly shadowSelfSphere: Vector4
The drawn geometry's bounding sphere, which bounds each body.
shadowUniforms
• shadowUniforms: Object
Type declaration
| Name | Type |
|---|---|
uCascadeSplit0 | ValueUniform<16> |
uCascadeSplit1 | ValueUniform<48> |
uCascadeSplit2 | ValueUniform<128> |
uShadowBias | ValueUniform<0.0005> |
uShadowDepthPerBlock | ValueUniform<0> |
uShadowMap0 | TextureNode<"vec4"> |
uShadowMap1 | TextureNode<"vec4"> |
uShadowMap2 | TextureNode<"vec4"> |
uShadowMatrix0 | ValueUniform<Matrix4> |
uShadowMatrix1 | ValueUniform<Matrix4> |
uShadowMatrix2 | ValueUniform<Matrix4> |
uShadowNormalBias | ValueUniform<0.01> |
uShadowStrength | ValueUniform<1> |
uSunColor | ValueUniform<Color> |
uSunDirection | ValueUniform<Vector3> |
uSunlightIntensity | ValueUniform<1> |
tint
• Readonly tint: Color
Accessors
type
• get type(): string
Returns
string
Overrides
THREE.NodeMaterial.type
Methods
customProgramCacheKey
▸ customProgramCacheKey(): string
Returns
string
Overrides
THREE.NodeMaterial.customProgramCacheKey
onBeforeRender
▸ onBeforeRender(_renderer, _scene, _camera, geometry): void
Bounds every instance by the geometry about to be drawn: its bounding sphere, in the space the instance matrix carries into the world. three keeps the sphere on the geometry, so this measures once per geometry.
Parameters
| Name | Type |
|---|---|
_renderer | unknown |
_scene | Scene<Object3DEventMap> |
_camera | Camera |
geometry | BufferGeometry<NormalBufferAttributes, BufferGeometryEventMap> |
Returns
void
Overrides
THREE.NodeMaterial.onBeforeRender
setColorMap
▸ setColorMap(map): void
The face atlas (options.map), swapped in place.
Parameters
| Name | Type |
|---|---|
map | Texture<unknown, TextureEventMap> |
Returns
void
setMaxBrightness
▸ setMaxBrightness(maxBrightness): void
Parameters
| Name | Type |
|---|---|
maxBrightness | number |
Returns
void
setReceiveShadows
▸ setReceiveShadows(receive): void
Parameters
| Name | Type |
|---|---|
receive | boolean |
Returns
void
setupDiffuseColor
▸ setupDiffuseColor(): void
Returns
void
Overrides
THREE.NodeMaterial.setupDiffuseColor
setupLighting
▸ setupLighting(): Node<"vec3">
Returns
Node<"vec3">
Overrides
THREE.NodeMaterial.setupLighting
setupModelViewProjection
▸ setupModelViewProjection(): Node
Parts of one body sit a hair apart or swing through each other, and two nearly coplanar faces flicker as depth precision and pose change: a few depth steps per part give every such pair a fixed winner.
Returns
Node
Overrides
THREE.NodeMaterial.setupModelViewProjection
setupOutput
▸ setupOutput(builder, outputNode): Node
Parameters
| Name | Type |
|---|---|
builder | default |
outputNode | Vec4Node |
Returns
Node
Overrides
THREE.NodeMaterial.setupOutput
setupPosition
▸ setupPosition(builder): AttributeNode<"vec3">
Parameters
| Name | Type |
|---|---|
builder | default |
Returns
AttributeNode<"vec3">
Overrides
THREE.NodeMaterial.setupPosition
updateBoneTexture
▸ updateBoneTexture(texture): void
Parameters
| Name | Type |
|---|---|
texture | DataTexture |
Returns
void