Class SkeletonMaskBuilder

The SkeletonMaskBuilder class builds a SkeletonMask for a specific skeleton.

Once all bone states are set using setBoneState the mask must be finalized by a call to finalize before the final mask can be retrieved using mask.

Hierarchy

FrameworkObject
- SkeletonMaskBuilder

Index

Constructors

Accessors

Methods

finalize setBoneState

Constructors

constructor

new SkeletonMaskBuilder(skeleton, isInternalConstructor?): SkeletonMaskBuilder
Parameters
- skeleton: Skeleton
- OptionalisInternalConstructor: boolean
Returns SkeletonMaskBuilder
Overrides FrameworkObject.constructor

Accessors

mask

get mask(): SkeletonMask
Returns the finalized skeleton mask.

Returns SkeletonMask
Note
finalize must be called before the mask can be retrieved.

Methods

finalize

finalize(): boolean
Finalizes the mask. Once finalized, no more changes can be made.

Returns boolean

setBoneState

setBoneState(options): boolean
Enables or disables the bone with the specified name.
Parameters
- options: {
      enabled: boolean;
      name: string;
  } | {
      boneIndex: number;
      enabled: boolean;
  }
  Options object for the function call.
Returns boolean