Tour API Demos Download Tests
Aperture version 1.0
Generated by: JsDoc Toolkit 2.4.0

Class aperture.Transition

Represents an animated transition, consisting of an interpolation / easing / tween function, and a length of time over which the transition will occur. Transitions may be optionally passed into the Layer update function to animate any updates which will occur.

Class Summary
Constructor Attributes Constructor Name and Description
 
aperture.Transition(milliseconds, easing, callback)

Method Summary

Class Detail

aperture.Transition(milliseconds, easing, callback)
Parameters:
{Number} milliseconds Optional, Default: 300
the length of time that the transition will take to complete.
{String} easing Optional, Default: 'ease'
the function that will be used to transition from one state to another. The standard CSS options are supported:

'linear' (constant speed)
'ease' (default, with a slow start and end)
'ease-in' (slow start)
'ease-out' (slow end)
'ease-in-out' (similar to ease)
'cubic-bezier(n,n,n,n)' (a custom function, defined as a bezier curve)
{Function} callback Optional
a function to invoke when the transition is complete.
Returns:
{this} a new Transition

Method Detail

  • {Function} callback()
    Returns a reference to the callback function, if present.
    Returns:
    {Function} the function invoked at transition completion.
  • {String} easing()
    Returns the easing property value.
    Returns:
    {String} the function to use to transition from one state to another.
  • {Number} milliseconds()
    Returns the timing property.
    Returns:
    {Number} the number of milliseconds over which to complete the transition