Class SkeletonMask

The SkeletonMask class implements a bitfield that determines which skeleton bones are enabled or disabled during skeletal animation. Use SkeletonMaskBuilder to create a mask for a specific Skeleton.

The SkeletonMask is considered to be an immutable class, once created, it cannot be modified. This is important as the SkeletonMask can be shared between different threads.

Hierarchy

  • FrameworkObject
    • SkeletonMask

Constructors

Methods

Constructors

  • Parameters

    • OptionalisInternalConstructor: boolean

    Returns SkeletonMask

Methods

  • Determines if the bone at the specified boneIndex is enabled.

    Parameters

    • boneIndex: number

    Returns boolean

    The caller is expected to know which skeleton the skeleton mask is bound to, in order to determine the bone index.