Interface AnimClipEffectDetails

Contains specific details about an animation's effect. Returned by AnimClip.getEffectDetails.

See

AnimClip.getEffectDetails

interface AnimClipEffectDetails {
    category: EffectCategory;
    effectComposer: Readonly<StripDuplicateMethodAutocompletion<{
        defaultConfig?: Partial<unknown>;
        effectCompositionFrequency?: "on-first-play-only" | "on-every-play";
        immutableConfig?: Partial<unknown>;
        composeEffect(...effectOptions: unknown[]): StripDuplicateMethodAutocompletion<{
            backwardKeyframesGenerator?: (() => Keyframes);
            backwardMutatorGenerator?: (() => Mutator);
            forwardKeyframesGenerator?: (() => Keyframes);
            forwardMutatorGenerator?: (() => Mutator);
            reverseKeyframesEffect?: boolean;
            reverseMutatorEffect?: boolean;
        }>;
    }>>;
    effectName: string;
    effectOptions: unknown[];
}

Properties

category effectComposer effectName effectOptions

Properties

category

category: EffectCategory

The category of the effect (e.g., "Entrance", "Exit", "Motion", etc.).

effectComposer

effectComposer: Readonly<StripDuplicateMethodAutocompletion<{
    defaultConfig?: Partial<unknown>;
    effectCompositionFrequency?: "on-first-play-only" | "on-every-play";
    immutableConfig?: Partial<unknown>;
    composeEffect(...effectOptions: unknown[]): StripDuplicateMethodAutocompletion<{
        backwardKeyframesGenerator?: (() => Keyframes);
        backwardMutatorGenerator?: (() => Mutator);
        forwardKeyframesGenerator?: (() => Keyframes);
        forwardMutatorGenerator?: (() => Mutator);
        reverseKeyframesEffect?: boolean;
        reverseMutatorEffect?: boolean;
    }>;
}>>

Object containing both the function used to compose the effect and possibly a set of default configuration options for the effect.

effectName

effectName: string

Name of the animation effect.

effectOptions

effectOptions: unknown[]

An array containing the effect options used to set the behavior of the animation effect.

Settings

Member Visibility

On This Page

Properties