core/animation/Animation.idl

/*
 * Copyright (C) 2013 Google Inc. All rights reserved.
 *
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions are
 * met:
 *
 *     * Redistributions of source code must retain the above copyright
 * notice, this list of conditions and the following disclaimer.
 *     * Redistributions in binary form must reproduce the above
 * copyright notice, this list of conditions and the following disclaimer
 * in the documentation and/or other materials provided with the
 * distribution.
 *     * Neither the name of Google Inc. nor the names of its
 * contributors may be used to endorse or promote products derived from
 * this software without specific prior written permission.
 *
 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
 * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
 * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
 * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
 * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
 * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
 * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
 * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
 * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
 * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 */

// https://w3c.github.io/web-animations/#animation

enum AnimationPlayState { "idle", "pending", "running", "paused", "finished" };

[
    Constructor(optional AnimationEffectReadOnly? effect = null, optional AnimationTimeline? timeline),
    Exposed(Window WebAnimationsAPI),
    ConstructorCallWith=ExecutionContext,
    RaisesException=Constructor,
    ActiveScriptWrappable,
    DependentLifetime
] interface Animation : EventTarget {
    // TODO(suzyh): Make timeline mutable.
    [RuntimeEnabled=WebAnimationsAPI] attribute AnimationEffectReadOnly? effect;
    [RuntimeEnabled=WebAnimationsAPI] readonly attribute AnimationTimeline? timeline;
    [Measure] attribute double?    startTime;
    [Measure] attribute double?    currentTime;
    [Measure] attribute double     playbackRate;
    [Measure] readonly attribute AnimationPlayState playState;
    [Measure, RaisesException] void finish();
    [Measure, RaisesException] void play();
    [Measure, RaisesException] void pause();
    [Measure, RaisesException] void reverse();
    [Measure] attribute DOMString id;
    [Measure] void cancel();
    [Measure] attribute EventHandler onfinish;
    [Measure] attribute EventHandler oncancel;
    [RuntimeEnabled=WebAnimationsAPI, CallWith=ScriptState] readonly attribute Promise<Animation> finished;
    [RuntimeEnabled=WebAnimationsAPI, CallWith=ScriptState] readonly attribute Promise<Animation> ready;
};