TSL Docs

SkinningNode

Last modified: Jun 30, 2024

This node implements the vertex transformation shader logic which is required for skinning/skeletal animation.

Constructor

new SkinningNode(skinnedMesh)

Parameter	Type	Default Value
skinnedMesh	`SkinnedMesh`	—

Constructs a new skinning node.

Accessor	Type
get type	`string`
Modifiers `static`

Properties

Property	Type
skinnedMesh	`SkinnedMesh`	—
skinIndexNode	`AttributeNode`	—
skinWeightNode	`AttributeNode`	—
bindMatrixNode	`any`	—
bindMatrixInverseNode	`any`	—
boneMatricesNode	`Node`	—
positionNode	`any`	—
toPositionNode	`any`	—
previousBoneMatricesNode	`null \| Node`	—

Method Type

getSkinnedPosition (boneMatrices?: Node, position?: Node<…>) => any

Transforms the given vertex position via skinning.

Parameter	Type	Default Value
boneMatrices?	`Node`	`this.boneMatricesNode`
position?	`Node<vec3>`	`this.positionNode`

Returns

any

getSkinnedNormalAndTangent (boneMatrices?: Node, normal?: Node<…>, tangent?: Node<…>) => { skinNormal: Node<…>; skinTangent: Node<vec3>; }

Transforms the given vertex normal and tangent via skinning.

Parameter	Type	Default Value
boneMatrices?	`Node`	`this.boneMatricesNode`
normal?	`Node<vec3>`	`normalLocal`
tangent?	`Node<vec3>`	`tangentLocal`

Returns

Property	Type	Modifiers
skinNormal	`Node<vec3>`	`—`
skinTangent	`Node<vec3>`	`—`

getPreviousSkinnedPosition (builder: NodeBuilder) => any

Computes the transformed/skinned vertex position of the previous frame.

Parameter	Type	Default Value
builder	`NodeBuilder`	—

Returns

any

setup (builder: NodeBuilder) => any

Setups the skinning node by assigning the transformed vertex data to predefined node variables.

Parameter	Type	Default Value
builder	`NodeBuilder`	—

Returns

any

generate (builder: NodeBuilder, output: string) => string

Generates the code snippet of the skinning node.

Parameter	Type	Default Value
builder	`NodeBuilder`	—
output	`string`	—

Returns

string

update (frame: NodeFrame) => void

Updates the state of the skinned mesh by updating the skeleton once per frame.

Parameter	Type	Default Value
frame	`NodeFrame`	—

Returns

void

Extends

Node

skinning

TSL function for creating a skinning node.

Parameter	Type	Default Value
skinnedMesh	`SkinnedMesh`	—

Returns

SkinningNode

computeSkinning

TSL function for computing skinning.

Parameter	Type	Default Value
skinnedMesh	`SkinnedMesh`	—
toPosition?	`Node<vec3>`	`null`

Returns

SkinningNode