@awayjs/renderer/lib/base/IAnimator.ts

Renderer for AwayJS

import { IAsset } from '@awayjs/core';
import { _Render_RenderableBase } from './_Render_RenderableBase';
import { IRenderContainer } from './IRenderContainer';
import { ShaderBase } from './ShaderBase';
import { IAnimationSet } from './IAnimationSet';

/**
 * 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 graphics object to which the animator is applied, registers the owner for internal use.
	 *
	 * @private
	 */
	addOwner(entity: IRenderContainer);

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

	testGPUCompatibility(shader: ShaderBase): void;

	setRenderState(shader: ShaderBase, renderState: _Render_RenderableBase): void;
}