Skip to content

Documentation / scene / HumanoidSkeletalAnimationMaskOptions

Type Alias: HumanoidSkeletalAnimationMaskOptions ​

HumanoidSkeletalAnimationMaskOptions = SkeletalAnimationMaskCommonOptions & object

Defined in: libs/scene/src/animation/animationmask.ts:51

Type Declaration ​

type ​

type: "humanoid"

preset? ​

optional preset?: HumanoidSkeletalAnimationMaskPreset

Optional semantic preset used as the initial joint set.

boundary? ​

optional boundary?: HumanoidBodyRig

Boundary joint for upperBody. Defaults to HumanoidBodyRig.Spine.

includeBody? ​

optional includeBody?: HumanoidBodyRig[]

Additional body joints selected by semantic name.

excludeBody? ​

optional excludeBody?: HumanoidBodyRig[]

Body joints removed from the selected set.

includeLeftHand? ​

optional includeLeftHand?: HumanoidHandRig[]

includeRightHand? ​

optional includeRightHand?: HumanoidHandRig[]

excludeLeftHand? ​

optional excludeLeftHand?: HumanoidHandRig[]

excludeRightHand? ​

optional excludeRightHand?: HumanoidHandRig[]

includeDescendants? ​

optional includeDescendants?: boolean

Whether explicit semantic include/exclude entries affect their descendants.

Defaults to true for humanoid semantic masks.

Released under the MIT License.