add extjs 6.0.1 sources

[extjs.git] / extjs / packages / charts / src / draw / Animator.js

/**\r
 * @class Ext.draw.Animator\r
 *\r
 * Singleton class that manages the animation pool.\r
 */\r
Ext.define('Ext.draw.Animator', {\r
    uses: ['Ext.draw.Draw'],\r
    singleton: true,\r
\r
    frameCallbacks: {},\r
    frameCallbackId: 0,\r
    scheduled: 0,\r
    frameStartTimeOffset: Ext.now(),\r
    animations: [],\r
    running: false,\r
\r
    /**\r
     *  Cross platform `animationTime` implementation.\r
     *  @return {Number}\r
     */\r
    animationTime: function () {\r
        return Ext.AnimationQueue.frameStartTime - this.frameStartTimeOffset;\r
    },\r
\r
    /**\r
     * Adds an animated object to the animation pool.\r
     *\r
     * @param {Object} animation The animation descriptor to add to the pool.\r
     */\r
    add: function (animation) {\r
        var me = this;\r
        if (!me.contains(animation)) {\r
            me.animations.push(animation);\r
            me.ignite();\r
            if ('fireEvent' in animation) {\r
                animation.fireEvent('animationstart', animation);\r
            }\r
        }\r
    },\r
\r
    /**\r
     * Removes an animation from the pool.\r
     * TODO: This is broken when called within `step` method.\r
     * @param {Object} animation The animation to remove from the pool.\r
     */\r
    remove: function (animation) {\r
        var me = this,\r
            animations = me.animations,\r
            i = 0,\r
            l = animations.length;\r
\r
        for (; i < l; ++i) {\r
            if (animations[i] === animation) {\r
                animations.splice(i, 1);\r
                if ('fireEvent' in animation) {\r
                    animation.fireEvent('animationend', animation);\r
                }\r
                return;\r
            }\r
        }\r
    },\r
\r
    /**\r
     * Returns `true` or `false` whether it contains the given animation or not.\r
     *\r
     * @param {Object} animation The animation to check for.\r
     * @return {Boolean}\r
     */\r
    contains: function (animation) {\r
        return Ext.Array.indexOf(this.animations, animation) > -1;\r
    },\r
\r
    /**\r
     * Returns `true` or `false` whether the pool is empty or not.\r
     * @return {Boolean}\r
     */\r
    empty: function () {\r
        return this.animations.length === 0;\r
    },\r
\r
    /**\r
     * Given a frame time it will filter out finished animations from the pool.\r
     *\r
     * @param {Number} frameTime The frame's start time, in milliseconds.\r
     */\r
    step: function (frameTime) {\r
        var me = this,\r
            animations = me.animations,\r
            animation,\r
            i = 0,\r
            ln = animations.length;\r
\r
        for (; i < ln; i++) {\r
            animation = animations[i];\r
            animation.step(frameTime);\r
            if (!animation.animating) {\r
                animations.splice(i, 1);\r
                i--;\r
                ln--;\r
                if (animation.fireEvent) {\r
                    animation.fireEvent('animationend', animation);\r
                }\r
            }\r
        }\r
    },\r
\r
    /**\r
     * Register a one-time callback that will be called at the next frame.\r
     * @param {Function/String} callback\r
     * @param {Object} scope\r
     * @return {String} The ID of the scheduled callback.\r
     */\r
    schedule: function (callback, scope) {\r
        scope = scope || this;\r
        var id = 'frameCallback' + (this.frameCallbackId++);\r
\r
        if (Ext.isString(callback)) {\r
            callback = scope[callback];\r
        }\r
        Ext.draw.Animator.frameCallbacks[id] = {fn: callback, scope: scope, once: true};\r
        this.scheduled++;\r
        Ext.draw.Animator.ignite();\r
        return id;\r
    },\r
\r
    /**\r
     * Register a one-time callback that will be called at the next frame,\r
     * if that callback (with a matching function and scope) isn't already scheduled.\r
     * @param {Function/String} callback\r
     * @param {Object} scope\r
     * @return {String/null} The ID of the scheduled callback or null, if that callback has already been scheduled.\r
     */\r
    scheduleIf: function (callback, scope) {\r
        scope = scope || this;\r
        var frameCallbacks = Ext.draw.Animator.frameCallbacks,\r
            cb, id;\r
\r
        if (Ext.isString(callback)) {\r
            callback = scope[callback];\r
        }\r
        for (id in frameCallbacks) {\r
            cb = frameCallbacks[id];\r
            if (cb.once && cb.fn === callback && cb.scope === scope) {\r
                return null;\r
            }\r
        }\r
        return this.schedule(callback, scope);\r
    },\r
\r
    /**\r
     * Cancel a registered one-time callback\r
     * @param {String} id\r
     */\r
    cancel: function (id) {\r
        if (Ext.draw.Animator.frameCallbacks[id] && Ext.draw.Animator.frameCallbacks[id].once) {\r
            this.scheduled--;\r
            delete Ext.draw.Animator.frameCallbacks[id];\r
        }\r
    },\r
\r
    /**\r
     * Register a recursive callback that will be called at every frame.\r
     *\r
     * @param {Function} callback\r
     * @param {Object} scope\r
     * @return {String}\r
     */\r
    addFrameCallback: function (callback, scope) {\r
        scope = scope || this;\r
        if (Ext.isString(callback)) {\r
            callback = scope[callback];\r
        }\r
        var id = 'frameCallback' + (this.frameCallbackId++);\r
\r
        Ext.draw.Animator.frameCallbacks[id] = {fn: callback, scope: scope};\r
        return id;\r
    },\r
\r
    /**\r
     * Unregister a recursive callback.\r
     * @param {String} id\r
     */\r
    removeFrameCallback: function (id) {\r
        delete Ext.draw.Animator.frameCallbacks[id];\r
    },\r
\r
    /**\r
     * @private\r
     */\r
    fireFrameCallbacks: function () {\r
        var callbacks = this.frameCallbacks,\r
            id, fn, cb;\r
\r
        for (id in callbacks) {\r
            cb = callbacks[id];\r
            fn = cb.fn;\r
            if (Ext.isString(fn)) {\r
                fn = cb.scope[fn];\r
            }\r
\r
            fn.call(cb.scope);\r
\r
            if (callbacks[id] && cb.once) {\r
                this.scheduled--;\r
                delete callbacks[id];\r
            }\r
        }\r
    },\r
\r
    handleFrame: function() {\r
        this.step(this.animationTime());\r
        this.fireFrameCallbacks();\r
        if (!this.scheduled && this.empty()) {\r
            Ext.AnimationQueue.stop(this.handleFrame, this);\r
            this.running = false;\r
            Ext.draw.Draw.endUpdateIOS();\r
        }\r
    },\r
\r
    ignite: function() {\r
        if (!this.running) {\r
            this.running = true;\r
            Ext.AnimationQueue.start(this.handleFrame, this);\r
            Ext.draw.Draw.beginUpdateIOS();\r
        }\r
    }\r
});\r