Skip to main content

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​

NameType
boneTextureDataTexture
boneTextureWidthnumber
boneTextureHeightnumber
bonesPerInstancenumber
optionsInstancedSkinnedMaterialOptions

Returns​

InstancedSkinnedMaterial

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​

NameType
uCascadeSplit0ValueUniform<16>
uCascadeSplit1ValueUniform<48>
uCascadeSplit2ValueUniform<128>
uShadowBiasValueUniform<0.0005>
uShadowDepthPerBlockValueUniform<0>
uShadowMap0TextureNode<"vec4">
uShadowMap1TextureNode<"vec4">
uShadowMap2TextureNode<"vec4">
uShadowMatrix0ValueUniform<Matrix4>
uShadowMatrix1ValueUniform<Matrix4>
uShadowMatrix2ValueUniform<Matrix4>
uShadowNormalBiasValueUniform<0.01>
uShadowStrengthValueUniform<1>
uSunColorValueUniform<Color>
uSunDirectionValueUniform<Vector3>
uSunlightIntensityValueUniform<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​

NameType
_rendererunknown
_sceneScene<Object3DEventMap>
_cameraCamera
geometryBufferGeometry<NormalBufferAttributes, BufferGeometryEventMap>

Returns​

void

Overrides​

THREE.NodeMaterial.onBeforeRender


setColorMap​

▸ setColorMap(map): void

The face atlas (options.map), swapped in place.

Parameters​

NameType
mapTexture<unknown, TextureEventMap>

Returns​

void


setMaxBrightness​

▸ setMaxBrightness(maxBrightness): void

Parameters​

NameType
maxBrightnessnumber

Returns​

void


setReceiveShadows​

▸ setReceiveShadows(receive): void

Parameters​

NameType
receiveboolean

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​

NameType
builderdefault
outputNodeVec4Node

Returns​

Node

Overrides​

THREE.NodeMaterial.setupOutput


setupPosition​

▸ setupPosition(builder): AttributeNode<"vec3">

Parameters​

NameType
builderdefault

Returns​

AttributeNode<"vec3">

Overrides​

THREE.NodeMaterial.setupPosition


updateBoneTexture​

▸ updateBoneTexture(texture): void

Parameters​

NameType
textureDataTexture

Returns​

void