Skip to content

Commit

Permalink
Wires up yuidoc and updates shifty.core.js annotations.
Browse files Browse the repository at this point in the history
  • Loading branch information
@jeremyckahn
jeremyckahn committed Nov 5, 2014
1 parent 037e026 commit 5ade61b
Show file tree
Hide file tree
Showing 3 changed files with 104 additions and 59 deletions.
33 changes: 16 additions & 17 deletions Gruntfile.js
View file
Expand Up @@ -8,7 +8,7 @@ module.exports = function(grunt) {
grunt.loadNpmTasks('grunt-contrib-uglify');
grunt.loadNpmTasks('grunt-bump');
grunt.loadNpmTasks('grunt-codepainter');
grunt.loadNpmTasks('grunt-dox');
grunt.loadNpmTasks('grunt-contrib-yuidoc');

var banner = [
'/*! <%= pkg.name %> - v<%= pkg.version %> - ',
Expand Down Expand Up @@ -86,20 +86,6 @@ module.exports = function(grunt) {
dest: 'dist/shifty.js'
}
},
dox: {
options: {
title: 'Shifty'
},
files: {
src: [
'src/shifty.core.js',
'src/shifty.interpolate.js',
'src/shifty.bezier.js',
'src/shifty.token.js'
],
dest: 'dist/doc'
}
},
bump: {
options: {
files: ['package.json', 'bower.json'],
Expand All @@ -122,6 +108,19 @@ module.exports = function(grunt) {
dest: 'src/'
}]
}
},
yuidoc: {
compile: {
name: 'Shifty',
description: '<%= pkg.description %>',
version: '<%= pkg.version %>',
url: '<%= pkg.homepage %>',
//logo: '../../demo/img/rekapi-logo-200.png',
options: {
paths: ['src'],
outdir: 'dist/doc'
}
}
}
});

Expand All @@ -134,14 +133,14 @@ module.exports = function(grunt) {
'concat:forRekapi',
'uglify:standardTarget',
'concat:forRekapiDebug',
'dox'
'yuidoc'
]);

grunt.registerTask('build-minimal', [
'concat:minimal',
'uglify:standardTarget',
'concat:minimalDebug',
'dox'
'yuidoc'
]);

};
3 changes: 2 additions & 1 deletion package.json
View file
Expand Up @@ -13,7 +13,8 @@
"grunt-contrib-uglify": "~0.1.2",
"grunt-dox": "~0.5.0",
"grunt-bump": "0.0.13",
"grunt-codepainter": "^0.2.0"
"grunt-codepainter": "^0.2.0",
"grunt-contrib-yuidoc": "^0.5.2"
},
"contributors": [
{
Expand Down
127 changes: 86 additions & 41 deletions src/shifty.core.js
View file
Expand Up @@ -212,33 +212,42 @@ var Tweenable = (function () {

/**
* Tweenable constructor.
* @param {Object=} opt_initialState The values that the initial tween should start at if a "from" object is not provided to Tweenable#tween.
* @param {Object=} opt_config See Tweenable.prototype.setConfig()
* @param {Object=} opt_initialState The values that the initial tween should
* start at if a `from` object is not provided to `{{#crossLink
* "Tweenable/tween:method"}}{{/crossLink}}` or `{{#crossLink
* "Tweenable/setConfig:method"}}{{/crossLink}}`.
* @param {Object=} opt_config Configuration object to be passed to
* `{{#crossLink "Tweenable/setConfig:method"}}{{/crossLink}}`.
* @class Tweenable
* @constructor
*/
function Tweenable (opt_initialState, opt_config) {
this._currentState = opt_initialState || {};
this._configured = false;
this._scheduleFunction = DEFAULT_SCHEDULE_FUNCTION;

// To prevent unnecessary calls to setConfig do not set default configuration here.
// Only set default configuration immediately before tweening if none has been set.
// To prevent unnecessary calls to setConfig do not set default
// configuration here. Only set default configuration immediately before
// tweening if none has been set.
if (typeof opt_config !== 'undefined') {
this.setConfig(opt_config);
}
}

/**
* Configure and start a tween.
* @param {Object=} opt_config See Tweenable.prototype.setConfig()
* @return {Tweenable}
* @method tween
* @param {Object=} opt_config Configuration object to be passed to
* `{{#crossLink "Tweenable/setConfig:method"}}{{/crossLink}}`.
* @chainable
*/
Tweenable.prototype.tween = function (opt_config) {
if (this._isTweening) {
return this;
}

// Only set default config if no configuration has been set previously and none is provided now.
// Only set default config if no configuration has been set previously and
// none is provided now.
if (opt_config !== undefined || !this._configured) {
this.setConfig(opt_config);
}
Expand All @@ -249,24 +258,38 @@ var Tweenable = (function () {
};

/**
* Sets the tween configuration. `config` may have the following options:
* Configure a tween that will start at some point in the future.
*
* - __from__ (_Object=_): Starting position. If omitted, the current state is used.
* @method setConfig
* @param {Object} config The following values are valid:
* - __from__ (_Object=_): Starting position. If omitted, `{{#crossLink
* "Tweenable/get:method"}}get(){{/crossLink}}` is used.
* - __to__ (_Object=_): Ending position.
* - __duration__ (_number=_): How many milliseconds to animate for.
* - __start__ (_Function(Object)_): Function to execute when the tween begins. Receives the state of the tween as the first parameter. Attachment is the second parameter.
* - __step__ (_Function(Object, *, number)_): Function to execute on every tick. Receives the state of the tween as the first parameter. Attachment is the second parameter, and the time elapsed since the start of the tween is the third parameter. This function is not called on the final step of the animation, but `finish` is.
* - __finish__ (_Function(Object, *)_): Function to execute upon tween completion. Receives the state of the tween as the first parameter. Attachment is the second parameter.
* - __easing__ (_Object|string=_): Easing curve name(s) to use for the tween.
* - __attachment__ (_Object|string|any=_): Value that is attached to this instance and passed on to the step/start/finish methods.
* @param {Object} config
* @return {Tweenable}
* - __start__ (_Function(Object, *)_): Function to execute when the tween
* begins. Receives the state of the tween as the first parameter and
* `attachment` as the second parameter.
* - __step__ (_Function(Object, *, number)_): Function to execute on every
* tick. Receives `{{#crossLink
* "Tweenable/get:method"}}get(){{/crossLink}}` as the first parameter,
* `attachment` as the second parameter, and the time elapsed since the
* start of the tween as the third. This function is not called on the
* final step of the animation, but `finish` is.
* - __finish__ (_Function(Object, *)_): Function to execute upon tween
* completion. Receives the state of the tween as the first parameter and
* `attachment` as the second parameter.
* - __easing__ (_Object|string=_): Easing curve name(s) to use for the
* tween.
* - __attachment__ (_*_): Cached value that is passed to the
* `step`/`start`/`finish` methods.
* @chainable
*/
Tweenable.prototype.setConfig = function (config) {
config = config || {};
this._configured = true;

// Attach something to this Tweenable instance (e.g.: a DOM element, an object, a string, etc.);
// Attach something to this Tweenable instance (e.g.: a DOM element, an
// object, a string, etc.);
this._attachment = config.attachment;

// Init the internal state
Expand Down Expand Up @@ -298,24 +321,28 @@ var Tweenable = (function () {
};

/**
* Gets the current state.
* @return {Object}
* @method get
* @return {Object} The current state.
*/
Tweenable.prototype.get = function () {
return shallowCopy({}, this._currentState);
};

/**
* Sets the current state.
* @param {Object} state
* @method set
* @param {Object} state The current state.
*/
Tweenable.prototype.set = function (state) {
this._currentState = state;
};

/**
* Pauses a tween. Paused tweens can be resumed from the point at which they were paused. This is different than [`stop()`](#stop), as that method causes a tween to start over when it is resumed.
* @return {Tweenable}
* Pause a tween. Paused tweens can be resumed from the point at which they
* were paused. This is different from `{{#crossLink
* "Tweenable/stop:method"}}{{/crossLink}}`, as that method
* causes a tween to start over when it is resumed.
* @method pause
* @chainable
*/
Tweenable.prototype.pause = function () {
this._pausedAtTime = now();
Expand All @@ -324,8 +351,9 @@ var Tweenable = (function () {
};

/**
* Resumes a paused tween.
* @return {Tweenable}
* Resume a paused tween.
* @method resume
* @chainable
*/
Tweenable.prototype.resume = function () {
if (this._isPaused) {
Expand All @@ -348,11 +376,13 @@ var Tweenable = (function () {
};

/**
* Move the state of the animation to a specific point in the tween's timeline.
* If the animation is not running, this will cause the `step` handlers to be
* called.
* @param {millisecond} millisecond The millisecond of the animation to seek to.
* @return {Tweenable}
* Move the state of the animation to a specific point in the tween's
* timeline. If the animation is not running, this will cause the `step`
* handlers to be called.
* @method seek
* @param {millisecond} millisecond The millisecond of the animation to seek
* to.
* @chainable
*/
Tweenable.prototype.seek = function (millisecond) {
this._timestamp = now() - millisecond;
Expand All @@ -376,8 +406,12 @@ var Tweenable = (function () {

/**
* Stops and cancels a tween.
* @param {boolean=} gotoEnd If false or omitted, the tween just stops at its current state, and the "finish" handler is not invoked. If true, the tweened object's values are instantly set to the target values, and "finish" is invoked.
* @return {Tweenable}
* @param {boolean=} gotoEnd If `false` or omitted, the tween just stops at
* its current state, and the `finish` handler is not invoked. If `true`,
* the tweened object's values are instantly set to the target values, and
* `finish` is invoked.
* @method stop
* @chainable
*/
Tweenable.prototype.stop = function (gotoEnd) {
this._isTweening = false;
Expand All @@ -401,26 +435,33 @@ var Tweenable = (function () {
};

/**
* Returns whether or not a tween is running.
* @return {boolean}
* @method isPlaying
* @return {boolean} Whether or not a tween is running.
*/
Tweenable.prototype.isPlaying = function () {
return this._isTweening && !this._isPaused;
};

/**
* Sets a custom schedule function.
* Set a custom schedule function.
*
* If a custom function is not set the default one is used [`requestAnimationFrame`](https://developer.mozilla.org/en-US/docs/Web/API/window.requestAnimationFrame) if available, otherwise [`setTimeout`](https://developer.mozilla.org/en-US/docs/Web/API/Window.setTimeout)).
*
* @param {Function(Function,number)} scheduleFunction The function to be called to schedule the next frame to be rendered
* If a custom function is not set,
* [`requestAnimationFrame`](https://developer.mozilla.org/en-US/docs/Web/API/window.requestAnimationFrame)
* is used if available, otherwise
* [`setTimeout`](https://developer.mozilla.org/en-US/docs/Web/API/Window.setTimeout)
* is used.
* @method setScheduleFunction
* @param {Function(Function,number)} scheduleFunction The function to be
* used to schedule the next frame to be rendered.
*/
Tweenable.prototype.setScheduleFunction = function (scheduleFunction) {
this._scheduleFunction = scheduleFunction;
};

/**
* `delete`s all "own" properties. Call this when the `Tweenable` instance is no longer needed to free memory.
* `delete` all "own" properties. Call this when the `Tweenable` instance
* is no longer needed to free memory.
* @method dispose
*/
Tweenable.prototype.dispose = function () {
var prop;
Expand All @@ -437,10 +478,14 @@ var Tweenable = (function () {
*/
Tweenable.prototype.filter = {};

/*!
* This object contains all of the tweens available to Shifty. It is extendible - simply attach properties to the Tweenable.prototype.formula Object following the same format at linear.
/**
* This object contains all of the tweens available to Shifty. It is
* extensible - simply attach properties to the `Tweenable.prototype.formula`
* Object following the same format as `linear`.
*
* `pos` should be a normalized `number` (between 0 and 1).
* @property formula
* @type {Object(function)}
*/
Tweenable.prototype.formula = {
linear: function (pos) {
Expand Down

0 comments on commit 5ade61b

Please sign in to comment.