awayjs-display/lib/animators/IAnimator.ts

AwayJS displaylist classes

import {IAsset}					from "awayjs-core/lib/library/IAsset";

import {IAnimationSet}			from "../animators/IAnimationSet";
import {IEntity}					from "../display/IEntity";

/**
 * Provides an interface for animator classes that control animation output from a data set subtype of <code>AnimationSetBase</code>.
 *
 * @see away.animators.IAnimationSet
 */
export interface IAnimator extends IAsset
{
	/**
	 *
	 */
	animationSet:IAnimationSet;

	/**
	 *
	 */
	clone():IAnimator;

	/**
	 *
	 */
	dispose();

	/**
	 * Used by the entity object to which the animator is applied, registers the owner for internal use.
	 *
	 * @private
	 */
	addOwner(sprite:IEntity);

	/**
	 * Used by the sprite object from which the animator is removed, unregisters the owner for internal use.
	 *
	 * @private
	 */
	removeOwner(sprite:IEntity);
}