Famo.us - 记录'曲线'功能

时间:2014-06-12 11:02:19

标签: javascript documentation javadoc jsdoc famo.us

我有一个函数fadeOpacity,它基本上设置了一个StateModifier,它具有开始不透明度,结束不透明度,转换和回调函数。

我使用JSDoc作为我自己的代码,只是想知道我应该调用什么类型transition

在Easing.js中famo.us预制曲线的来源中,曲线创建如下:

var Easing = {
    inQuad: function(t) {
        return t*t;
    },

    ...

我对fadeOpacity的JSDoc块如下:

     /**
     * [fadeOpacity description]
     * @param  {!number}   startOpacity [description]
     * @param  {!number}   endOpacity   [description]
     * @param  {function}   transition  [description] <= the param in question...
     * @param  {function} callback      [description]
     * @return {StateModifier}          [description]
     */

transition的类型是否正确?

2 个答案:

答案 0 :(得分:1)

看看Lightbox.js,看起来转换的类型只是转换..

例如。 Lightbox.js的第32行

* @param {Transition} [options.inTransition=true] The transition in charge of showing a renderable.

如果你动画不透明,我假设你想要用户或OP(或你自己;))与另一个famo.us函数进行交互。 Easing.inOutQuad肯定是一个函数,它没有描述转换的持续时间。您希望您的函数采用可以是缓和曲线,物理曲线或可转换的转换。

希望这有帮助!

答案 1 :(得分:0)

是。转换是一个从0到1的数字t的函数,并返回一个数字(通常在0和1之间,负值是下冲,大于1的值是超调)。 Transition也可以是一个字符串,它只是注册函数的关键字。默认情况下,Famo.us附带了一些这样的内容,例如&#34; linear&#34;和&#34; easeIn&#34;等

例如,线性转换将由

表示
function linearTransition(t) { return t; }

这不应该与过渡定义混淆,后者看起来像

{
    transition : linearTransition,
    duration : 500,
    callback : function myCallback(){}
}