Interface: SkinnedFamilyConfig<TVariant, TTexture>
One family of GPU-instanced, bone-skinned entities: its variants, its
rig, and how to build each variant's geometry and texture. Adding a
variant is a row in variants; adding a family is one of these and a
SkinnedInstancePool over it.
Geometry is one box per part, every vertex carrying skinIndex /
skinWeight (its bone), pivotOffset (the bone's pivot) and partIndex
(its row in the part atlas); see buildSkinnedParts for a builder that
writes all of them from a part list.
Type parameters
| Name | Type |
|---|---|
TVariant | extends string = string |
TTexture | extends THREE.Texture = THREE.Texture |
Properties
boneCount
• boneCount: number | (variant: TVariant) => number
buildGeometry
• buildGeometry: (variant: TVariant, isBaby: boolean) => BufferGeometry<NormalBufferAttributes, BufferGeometryEventMap>
Type declaration
▸ (variant, isBaby): BufferGeometry<NormalBufferAttributes, BufferGeometryEventMap>
Parameters
| Name | Type |
|---|---|
variant | TVariant |
isBaby | boolean |
Returns
BufferGeometry<NormalBufferAttributes, BufferGeometryEventMap>
buildTexture
• buildTexture: (variant: TVariant, isBaby: boolean) => TTexture
Type declaration
▸ (variant, isBaby): TTexture
Parameters
| Name | Type |
|---|---|
variant | TVariant |
isBaby | boolean |
Returns
TTexture
emissive
• Optional emissive: (variant: TVariant, isBaby: boolean) => number
Type declaration
▸ (variant, isBaby): number
Parameters
| Name | Type |
|---|---|
variant | TVariant |
isBaby | boolean |
Returns
number
faceShades
• Optional faceShades: EntityFaceShades
family
• family: string
hasAlphaCutShadow
• Optional hasAlphaCutShadow: (variant: TVariant) => boolean
Type declaration
▸ (variant): boolean
Parameters
| Name | Type |
|---|---|
variant | TVariant |
Returns
boolean
hasBabies
• hasBabies: boolean
hitEffectIntensity
• Optional hitEffectIntensity: number
isBakeableVariant
• Optional isBakeableVariant: (variant: string) => boolean
Type declaration
▸ (variant): boolean
Parameters
| Name | Type |
|---|---|
variant | string |
Returns
boolean
material
• Optional material: (variant: TVariant, isBaby: boolean) => Partial<InstancedSkinnedMaterialOptions>
Type declaration
▸ (variant, isBaby): Partial<InstancedSkinnedMaterialOptions>
Parameters
| Name | Type |
|---|---|
variant | TVariant |
isBaby | boolean |
Returns
Partial<InstancedSkinnedMaterialOptions>
partCount
• partCount: number
rigInfo
• Optional rigInfo: (variant: TVariant, isBaby: boolean, measured: SkinnedRigInfo) => object
Type declaration
▸ (variant, isBaby, measured): object
Parameters
| Name | Type |
|---|---|
variant | TVariant |
isBaby | boolean |
measured | SkinnedRigInfo |
Returns
object
surface
• Optional surface: (variant: TVariant, isBaby: boolean) => EntitySurfaceOptions
Type declaration
▸ (variant, isBaby): EntitySurfaceOptions
Parameters
| Name | Type |
|---|---|
variant | TVariant |
isBaby | boolean |
Returns
textureSource
• Optional textureSource: SkinnedTextureSource
variants
• variants: readonly TVariant[]