API

Interface IMakeAnimationGroupAdditiveOptions

Options to be used when creating an additive group animation

interface IMakeAnimationGroupAdditiveOptions {
    clipKeys?: boolean;
    clonedAnimationGroupName?: string;
    clonedAnimationName?: string;
    cloneOriginalAnimation?: boolean;
    cloneOriginalAnimationGroup?: boolean;
    fromFrame?: number;
    range?: string;
    referenceFrame?: number;
    toFrame?: number;
}

Hierarchy (View Summary)

Index
clipKeys?: boolean

If true, the key frames will be clipped to the range specified by range or fromFrame / toFrame (default is false)

clonedAnimationGroupName?: string

The name of the cloned animation group if cloneOriginalAnimationGroup is true

clonedAnimationName?: string

The name of the cloned animation if cloneOriginalAnimation is true. If not provided, use the original animation name

cloneOriginalAnimation?: boolean

If true, the original animation will be cloned and converted to additive. If false, the original animation will be converted to additive (default is false)

cloneOriginalAnimationGroup?: boolean

Defines if the animation group should be cloned or not (default is false)

fromFrame?: number

Together with toFrame, defines the range of the animation to convert to additive. Will only be used if range is not provided If range and fromFrame / toFrame are not provided, the whole animation will be converted to additive

range?: string

The name of the animation range to convert to additive. If not provided, fromFrame / toFrame will be used If fromFrame / toFrame are not provided either, the whole animation will be converted to additive

referenceFrame?: number

The frame that the animation should be relative to (if not provided, 0 will be used)

toFrame?: number

Together with fromFrame, defines the range of the animation to convert to additive.