Class CarbonAnimationSkeletonMaskUtility

The CarbonAnimationSkeletonMaskUtility class provides utility function.

Index

Constructors

Methods

buildMaskForSkeleton evaluateMaskForSkeleton

Constructors

constructor

new CarbonAnimationSkeletonMaskUtility(): CarbonAnimationSkeletonMaskUtility

Returns CarbonAnimationSkeletonMaskUtility

Methods

`Static`buildMaskForSkeleton

buildMaskForSkeleton(
maskEntries: CarbonAnimationSkeletonMaskEntry[],
skeleton: Skeleton,
): SkeletonMask
Builds a SkeletonMask using the CarbonAnimationSkeletonMaskEntry data for the specified Skeleton.
Parameters
- maskEntries: CarbonAnimationSkeletonMaskEntry[]
  The skeleton mask entries.
- skeleton: Skeleton
  The skeleton to build the mask for.
Returns SkeletonMask
The built SkeletonMask or null if no bones are disabled.

`Static`evaluateMaskForSkeleton

evaluateMaskForSkeleton(
    maskEntries: CarbonAnimationSkeletonMaskEntry[],
    skeleton: Skeleton,
    fnOnIterateBone: (boneIndex: number, isEnabled: boolean) => void,
): void
Builds a SkeletonMask using the CarbonAnimationSkeletonMaskEntry data for the specified Skeleton.
Parameters
- maskEntries: CarbonAnimationSkeletonMaskEntry[]
  The skeleton mask entries.
- skeleton: Skeleton
  The skeleton to build the mask for.
- fnOnIterateBone: (boneIndex: number, isEnabled: boolean) => void
  The callback to invoke for each bone with the enabled/disabled state value.
Returns void
The built SkeletonMask or null if no bones are disabled.