diff --git a/greensock/greensock.d.ts b/greensock/greensock.d.ts index df8958be4c..3cc3346af1 100644 --- a/greensock/greensock.d.ts +++ b/greensock/greensock.d.ts @@ -1,139 +1,160 @@ // GreenSock Animation Platform (GSAP) - http://www.greensock.com/get-started-js/ // JavaScript Docs http://api.greensock.com/js/ -// Version 1.0 +// Version 1.1 (TypeScript 0.9) + +interface IDispatcher { + addEventListener(type:string, callback:Function, scope:Object, useParam:boolean, priority:number):void; + removeEventListener(type:string, callback:Function):void; +} //com.greensock.core -interface Animation { +declare class Animation { data:any; - ticker:any; + static ticker:IDispatcher; timeline:SimpleTimeline; vars:Object; - Animation(duration:number, vars?:Object); + constructor(duration?:number, vars?:Object); + delay(value:number):any; duration(value:number):any; eventCallback(type:string, callback?:Function, params?:any[], scope?:any):any; invalidate():any; kill(vars?:Object, target?:Object):any; - pause(atTime?:any, suppressEvents?:bool):any; - paused(value?:bool):any; - play(from?:any, suppressEvents?:bool):any; - restart(includeDelay?:bool, suppressEvents?:bool):any; - resume(from?:any, suppressEvents?:bool):any; - reverse(from?:any, suppressEvents?:bool):any; - reversed(value?:bool):any; - seek(time:any, suppressEvents?:bool):any; + pause(atTime?:any, suppressEvents?:boolean):any; + paused(value?:boolean):any; + play(from?:any, suppressEvents?:boolean):any; + restart(includeDelay?:boolean, suppressEvents?:boolean):any; + resume(from?:any, suppressEvents?:boolean):any; + reverse(from?:any, suppressEvents?:boolean):any; + reversed(value?:boolean):any; + seek(time:any, suppressEvents?:boolean):any; startTime(value:number):any; - time(value:number, suppressEvents?:bool):any; + time(value:number, suppressEvents?:boolean):any; timeScale(value:number):any; totalDuration(value:number):any; - totalTime(time:number, suppressEvents?:bool):any; + totalTime(time:number, suppressEvents?:boolean):any; } -interface SimpleTimeline extends Animation { - autoRemoveChildren:bool; - smoothChildTiming:bool; +declare class SimpleTimeline extends Animation { + autoRemoveChildren:boolean; + smoothChildTiming:boolean; + constructor(vars?:Object); + + add(value:any, position?:any, align?:string, stagger?:number):any; insert(tween:any, time:any):any; - render(time:number, suppressEvents?:bool, force?:bool):void; + render(time:number, suppressEvents?:boolean, force?:boolean):void; } //com.greensock -interface TimelineLite { - addLabel(label:string, time:number):any; - append(value:any, offset:number):any; - appendMultiple(tweens:any[], offset:number, align:string, stagger:number):any; - call(callback:Function, params?:any[], scope?:any, offset?:number, baseTimeOrLabel?:any):any; - clear(labels?:bool):any; - duration(value:number):any; - exportRoot(vars?:Object, omitDelayedCalls?:bool):TimelineLite; - from(target:Object, duration:number, vars:Object, offset:number, baseTimeOrLabel?:any):any; - fromTo(target:Object, duration:number, fromVars:Object, toVars:Object, offset:number, baseTimeOrLabel?:any):any; - getChildren(nested?:bool, tweens?:bool, timelines?:bool, ignoreBeforeTime?:number):any[]; - getLabelTime(label:string):number; - getTweensOf(target:Object, nested?:bool):any[]; - insert(value:any, timeOrLabel:any):any; - insertMultiple(tweens:any[], timeOrLabel:any, align:string, stagger:number):any; +declare class TweenLite extends Animation { + static defaultEase:Ease; + static defaultOverwrite:string; + static selector:any; + target:Object; + static ticker:IDispatcher; + timeline:SimpleTimeline; + vars:Object; + + constructor(target:Object, duration:number, vars:Object); + + static delayedCall(delay:number, callback:Function, params?:any[], scope?:any, useFrames?:boolean):TweenLite; + static from(target:Object, duration:number, vars:Object):TweenLite; + static fromTo(target:Object, duration:number, fromVars:Object, toVars:Object):TweenLite; + static getTweensOf(target:Object):any[]; invalidate():any; + static killDelayedCallsTo(func:Function):void; + static killTweensOf(target:Object, vars?:Object):void; + static set(target:Object, vars:Object):TweenLite; + static to(target:Object, duration:number, vars:Object):TweenLite; +} + +declare class TweenMax extends TweenLite { + static ticker:IDispatcher; + + constructor(target:Object, duration:number, vars:Object); + + static delayedCall(delay:number, callback:Function, params?:any[], scope?:any, useFrames?:boolean):TweenMax; + static from(target:Object, duration:number, vars:Object):TweenMax; + static fromTo(target:Object, duration:number, fromVars:Object, toVars:Object):TweenMax; + static getAllTweens(includeTimelines?:boolean):any[]; + static getTweensOf(target:Object):any[]; + invalidate():any; + static isTweening(target:Object):boolean; + static killAll(complete?:boolean, tweens?:boolean, delayedCalls?:boolean, timelines?:boolean):void; + static killChildTweensOf(parent:any, complete?:boolean):void; + static killDelayedCallsTo(func:Function):void; + static killTweensOf(target:Object, vars?:Object):void; + static pauseAll(tweens?:boolean, delayedCalls?:boolean, timelines?:boolean):void; + progress(value:number):any; + repeat(value:number):any; + repeatDelay(value:number):any; + static resumeAll(tweens?:boolean, delayedCalls?:boolean, timelines?:boolean):void; + static set(target:Object, vars:Object):TweenMax; + static staggerFrom(targets:Object[], duration:number, vars:Object, stagger:number, onCompleteAll?:Function, onCompleteAllParams?:any[], onCompleteAllScope?:any):any[]; + static staggerFromTo(targets:Object[], duration:number, fromVars:Object, toVars:Object, stagger:number, onCompleteAll?:Function, onCompleteAllParams?:any[], onCompleteAllScope?:any):any[]; + static staggerTo(targets:Object[], duration:number, vars:Object, stagger:number, onCompleteAll?:Function, onCompleteAllParams?:any[], onCompleteAllScope?:any):any[]; + time(value:number, suppressEvents?:boolean):any; + static to(target:Object, duration:number, vars:Object):TweenMax; + totalDuration(value:number):any; + totalProgress(value:number):any; + updateTo(vars:Object, resetDuration?:boolean):any; + yoyo(value?:boolean):any; +} + +declare class TimelineLite extends SimpleTimeline { + constructor(vars?:Object); + + add(value:any, position?:any, align?:string, stagger?:number):any + addLabel(label:string, position:any):any + addPause(position?:any, callback?:Function, params?:any[], scope?:any):any + append(value:any, offsetOrLabel?:any):any + appendMultiple(tweens:any[], offsetOrLabel?:any, align?:string, stagger?:number):any + call(callback:Function, params?:any[], scope?:any, position?:any):any + clear(labels?:boolean):any + duration(value:number):any + exportRoot(vars?:Object, omitDelayedCalls?:boolean):TimelineLite + fromTo(target:Object, duration:number, fromVars:Object, toVars:Object, position?:any):any + getChildren(nested?:boolean, tweens?:boolean, timelines?:boolean, ignoreBeforeTime?:number):any[]; + getLabelTime(label:string):number + getTweensOf(target:Object, nested?:boolean):any[]; + insert(value:any, timeOrLabel?:any):any + insertMultiple(tweens:any[], timeOrLabel?:any, align?:string, stagger?:number):any + invalidate():any progress(value:number):any; remove(value:any):any; removeLabel(label:string):any; - seek(timeOrLabel:any, suppressEvents?:bool):any; - set(target:Object, vars:Object, offset:number, baseTimeOrLabel?:any):any; - shiftChildren(amount:number, adjustLabels?:bool, ignoreBeforeTime?:number):any; - staggerFrom(targets:Object[], duration:number, vars:Object, stagger:number, offset:number, baseTimeOrLabel?:any, onCompleteAll?:Function, onCompleteAllParams?:any[], onCompleteAllScope?:any):any; - staggerFromTo(targets:Object[], duration:number, fromVars:Object, toVars:Object, stagger:number, offset:number, baseTimeOrLabel?:any, onCompleteAll?:Function, onCompleteAllParams?:any[], onCompleteAllScope?:any):any; - staggerTo(targets:Object[], duration:number, vars:Object, stagger:number, offset:number, baseTimeOrLabel?:any, onCompleteAll?:Function, onCompleteAllParams?:any[], onCompleteAllScope?:any):any; + seek(position:any, suppressEvents?:boolean):any; + shiftChildren(amount:number, adjustLabels?:boolean, ignoreBeforeTime?:number):any; + staggerFrom(targets:any[], duration:number, vars:Object, stagger?:number, position?:any, onCompleteAll?:Function, onCompleteAllParams?:any[], onCompleteScope?:any):any; + staggerFromTo(targets:any[], duration:number, fromVars:Object, toVars:Object, stagger?:number, position?:any, onCompleteAll?:Function, onCompleteAllParams?:any[], onCompleteAllScope?:any):any; + staggerTo(targets:any[], duration:number, vars:Object, stagger:number, position?:any, onCompleteAll?:Function, onCompleteAllParams?:any[], onCompleteAllScope?:any):any; stop():any; - to(target:Object, duration:number, vars:Object, offset:number, baseTimeOrLabel?:any):any; - totalDuration(value:number):any; - usesFrames():bool; + to(target:Object, duration:number, vars:Object, position?:any):any; + usesFrames():Boolean } -interface TimelineMax { - addCallback(callback:Function, timeOrLabel:any, params?:any[], scope?:any):TimelineMax; +declare class TimelineMax extends TimelineLite { + constructor(vars?:Object); + + addCallback(callback:Function, position:any, params?:any[], scope?:any):TimelineMax; currentLabel(value?:string):any; - getActive(nested?:bool, tweens?:bool, timelines?:bool):any[]; - getLabelAfter(time:number):string; - getLabelBefore(time:number):string; + getActive(nested?:boolean, tweens?:boolean, timelines?:boolean):any[]; + getLabelAfter(time:number):string + getLabelBefore(time:number):string getLabelsArray():any[]; invalidate():any; progress(value:number):any; - removeCallback(callback:Function, timeOrLabel?:any):TimelineMax; - repeat(value:number):any; - repeatDelay(value:number):any; - time(value:number, suppressEvents?:bool):any; + removeCallback(callback:Function, timeOrLabel?:any):TimelineMax + repeat(value?:number):any; + repeatDelay(value?:number):any; + time(value:number, suppressEvents?:boolean):any; totalDuration(value:number):any; totalProgress(value:number):any; - tweenFromTo(fromTimeOrLabel:any, toTimeOrLabel:any, vars?:Object):TweenLite; - tweenTo(timeOrLabel:any, vars?:Object):TweenLite; - yoyo(value?:bool):any; -} - -interface TweenLite extends Animation { - defaultEase:Ease; - defaultOverwrite:string; - target:Object; - ticker:any; - - delayedCall(delay:number, callback:Function, params?:any[], scope?:any, useFrames?:bool):TweenLite; - from(target:Object, duration:number, vars:Object):TweenLite; - fromTo(target:Object, duration:number, fromVars:Object, toVars:Object):TweenLite; - getTweensOf(target:Object):any[]; - invalidate():any; - killDelayedCallsTo(func:Function):void; - killTweensOf(target:Object, vars?:Object):void; - set(target:Object, vars:Object):TweenLite; - to(target:Object, duration:number, vars:Object):TweenLite; -} - -interface TweenMax extends TweenLite { - delayedCall(delay:number, callback:Function, params?:any[], scope?:any, useFrames?:bool):TweenMax; - from(target:Object, duration:number, vars:Object):TweenMax; - fromTo(target:Object, duration:number, fromVars:Object, toVars:Object):TweenMax; - getAllTweens(includeTimelines?:bool):any[]; - getTweensOf(target:Object):any[]; - invalidate():any; - isTweening(target:Object):bool; - killAll(complete?:bool, tweens?:bool, delayedCalls?:bool, timelines?:bool):void; - killChildTweensOf(parent:any, complete?:bool):void; - killDelayedCallsTo(func:Function):void; - killTweensOf(target:Object, vars?:Object):void; - pauseAll(tweens?:bool, delayedCalls?:bool, timelines?:bool):void; - progress(value:number):any; - repeat(value:number):any; - repeatDelay(value:number):any; - resumeAll(tweens?:bool, delayedCalls?:bool, timelines?:bool):void; - set(target:Object, vars:Object):TweenMax; - staggerFrom(targets:Object[], duration:number, vars:Object, stagger:number, onCompleteAll?:Function, onCompleteAllParams?:any[], onCompleteAllScope?:any):any[]; - staggerFromTo(targets:Object[], duration:number, fromVars:Object, toVars:Object, stagger:number, onCompleteAll?:Function, onCompleteAllParams?:any[], onCompleteAllScope?:any):any[]; - staggerTo(targets:Object[], duration:number, vars:Object, stagger:number, onCompleteAll?:Function, onCompleteAllParams?:any[], onCompleteAllScope?:any):any[]; - time(value:number, suppressEvents?:bool):any; - to(target:Object, duration:number, vars:Object):TweenMax; - totalDuration(value:number):any; - totalProgress(value:number):any; - updateTo(vars:Object, resetDuration?:bool):any; - yoyo(value?:bool):any; + tweenFromTo(fromPosition:any, toPosition:any, vars?:Object):TweenLite + tweenTo(position:any, vars?:Object):TweenLite + yoyo(value?:boolean):any; } //com.greensock.easing @@ -228,8 +249,8 @@ interface Sine { interface SlowMo { ease:SlowMo; - SlowMo(linearRatio:number, power:number, yoyoMode:bool); - config(linearRatio:number, power:number, yoyoMode:bool):SlowMo; + SlowMo(linearRatio:number, power:number, yoyoMode:boolean); + config(linearRatio:number, power:number, yoyoMode:boolean):SlowMo; getRatio(p:number):number; } interface SteppedEase { @@ -244,7 +265,7 @@ interface Strong { //com.greensock.plugins interface BezierPlugin extends TweenPlugin { - bezierThrough(values:any[], curviness?:number, quadratic?:bool, correlate?:string, prepend?:Object, calcDifs?:bool):Object; + bezierThrough(values:any[], curviness?:number, quadratic?:boolean, correlate?:string, prepend?:Object, calcDifs?:boolean):Object; cubicToQuadratic(a:number, b:number, c:number, d:number):any[]; quadraticToCubic(a:number, b:number, c:number):Object; } @@ -270,20 +291,9 @@ interface ScrollToPlugin extends TweenPlugin { } interface TweenPlugin { - activate(plugins:any[]):bool; + activate(plugins:any[]):boolean; } - -//com.greensock.core -declare var Animation:Animation; -declare var SimpleTimeline:SimpleTimeline; - -//com.greensock -declare var TimelineLite:TimelineLite; -declare var TimelineMax:TimelineMax; -declare var TweenLite:TweenLite; -declare var TweenMax:TweenMax; - //com.greensock.easing declare var Back:Back; declare var Bounce:Bounce;