Interface AnimationGroupAPI
cancel(positionGroup: PositionGroup): void;
cancelAll(): void;
from(positionGroup: PositionGroup, fromData: TJSPositionDataRelative | GroupDataCallback, options?: TweenOptions | GroupTweenOptionsCallback): BasicAnimation;
fromTo(positionGroup: PositionGroup, fromData: TJSPositionDataRelative | GroupDataCallback, toData: TJSPositionDataRelative | GroupDataCallback, options?: TweenOptions | GroupTweenOptionsCallback): BasicAnimation;
getScheduled(positionGroup: PositionGroup): {
controls: BasicAnimation[];
entry: Positionable;
position: TJSPosition;
}[];
isAnimationKey(key: unknown): key is AnimationKey;
isScheduled(positionGroup: PositionGroup, options?: ScheduleOptions): boolean;
quickTo(positionGroup: PositionGroup, keys: Iterable<AnimationKey, any, any>, options?: QuickTweenOptions | GroupQuickTweenOptionsCallback): GroupQuickToCallback;
to(positionGroup: PositionGroup, toData: TJSPositionDataRelative | GroupDataCallback, options?: TweenOptions | GroupTweenOptionsCallback): BasicAnimation;
}
Index
Methods
cancel
- cancel(positionGroup): void
Cancels any animation for given PositionGroup data.
Parameters
- positionGroup: PositionGroup
The position group to cancel.
Returns void
- positionGroup: PositionGroup
cancelAll
from
- from(positionGroup, fromData, options?): BasicAnimation
Provides the
fromanimation tween for one or more positionable instances as a group.Parameters
- positionGroup: PositionGroup
A position group.
- fromData: TJSPositionDataRelative | GroupDataCallback
A position data object assigned to all positionable instances or a callback function invoked for unique data for each instance.
Optionaloptions: TweenOptions | GroupTweenOptionsCallbackTween options assigned to all positionable instances or a callback function invoked for unique options for each instance.
Returns BasicAnimation
Basic animation control.
- positionGroup: PositionGroup
fromTo
- from
To (positionGroup, fromData, toData, options?): BasicAnimation Provides the
fromToanimation tween for one or more positionable instances as a group.Parameters
- positionGroup: PositionGroup
A position group.
- fromData: TJSPositionDataRelative | GroupDataCallback
A position data object assigned to all positionable instances or a callback function invoked for unique data for each instance.
- toData: TJSPositionDataRelative | GroupDataCallback
A position data object assigned to all positionable instances or a callback function invoked for unique data for each instance.
Optionaloptions: TweenOptions | GroupTweenOptionsCallbackTween options assigned to all positionable instances or a callback function invoked for unique options for each instance.
Returns BasicAnimation
Basic animation control.
- positionGroup: PositionGroup
getScheduled
- get
Scheduled (positionGroup): {
controls: BasicAnimation[];
entry: Positionable;
position: TJSPosition;
}[] Gets all animation controls for the given position group data.
Parameters
- positionGroup: PositionGroup
A position group.
Returns {
controls: BasicAnimation[];
entry: Positionable;
position: TJSPosition;
}[]Results array.
- positionGroup: PositionGroup
isAnimationKey
- is
Animation (key): key is AnimationKeyKey Provides a type guard to test in the given key is an AnimationAPI.AnimationKey.
Parameters
- key: unknown
A key value to test.
Returns key is AnimationKey
Whether the given key is an animation key.
- key: unknown
isScheduled
- is
Scheduled (positionGroup, options?): boolean Returns the status for the entire position group specified if all position instances of the group are scheduled.
Parameters
- positionGroup: PositionGroup
A position group.
Optionaloptions: ScheduleOptionsScheduling options.
Returns boolean
True if all are scheduled / false if just one position instance in the group is not scheduled.
- positionGroup: PositionGroup
quickTo
- quick
To (positionGroup, keys, options?): GroupQuickToCallback Provides the
quickToanimation tweening function for one or more positionable instances as a group.Parameters
- positionGroup: PositionGroup
A position group.
- keys: Iterable<AnimationKey, any, any>
Animation keys to target.
Optionaloptions: QuickTweenOptions | GroupQuickTweenOptionsCallbackQuick tween options assigned to all positionable instances or a callback function invoked for unique options for each instance.
Returns GroupQuickToCallback
quick-to tween function.
- positionGroup: PositionGroup
to
- to(positionGroup, toData, options?): BasicAnimation
Provides the
toanimation tween for one or more positionable instances as a group.Parameters
- positionGroup: PositionGroup
A position group.
- toData: TJSPositionDataRelative | GroupDataCallback
A position data object assigned to all positionable instances or a callback function invoked for unique data for each instance.
Optionaloptions: TweenOptions | GroupTweenOptionsCallbackTween options assigned to all positionable instances or a callback function invoked for unique options for each instance.
Returns BasicAnimation
Basic animation control.
- positionGroup: PositionGroup
Provides a public API for grouping multiple TJSPosition animations together and is accessible from TJSPosition.Animate.
See
AnimationAPI