<commit_before>Android Animation for Titanium
================================

This Titanium Android module makes the [Honeycomb (Android 3.0) animation API][1]
available to Titanium Android apps. It uses Jake Wharton's excellent
[NineOldAndroids][2] library to make the animations available on pre-Honeycomb
devices as well.

It does this by wrapping and exposing two types of animators that are native to
the Honeycomb Animation API: [ObjectAnimator][3] ([native][4]) and
[ViewPropertyAnimator][5] ([native][6]).

Additionally, it provides access to the [AnimatorSet][7] ([native][8]), which
can run multiple `ObjectAnimator` instances either simultaneously or back-to-back.

The real star of the bunch is the `ViewPropertyAnimator`, which is the one
you should be trying to use first.

Build
=====

The module has so far been built and tested only with Titanium 3.0.2. You build
it the same as you would build any other Titanium module for Android. The build.xml
Ant script is provided, but be sure your machine is setup to build Titanium
Android modules. You can ensure this by creating and building your own test
module using Titanium Studio. In a nutshell, you'll need the Android SDK, the
Android NDK and Python.

Full instructions on how to create and build Titanium modules for Android will
not be provided here. Nor will instructions on how to put modules in to your
Titanium app projects be provided here. Look elsewhere!

If you don't wish to build but just want the packaged module, you should be able
to find recent ZIPs of it at ... (TODO).

Usage
=====

Please see documentation for instructions on how to use the module in
your Titanium app. You can also find code samples under the example/ folder.

Meanwhile here is a very quick example of using the view property animator made
available via this module:

    var animationModule = require("com.billdawson.timodules.animation");
	
	//... setup window / views ...
    
    animationModule.viewPropertyAnimator.animate(myView).xBy(50).yBy(50);

Developed By
============

* <NAME> (http://billdawson.com)

License
=======

	The original code herein is...

	Copyright 2013 <NAME>.

	The NineOldAndroids library, upon which this module is built, is...

    Copyright 2012 <NAME>.

	Both projects:

    Licensed under the Apache License, Version 2.0 (the "License");
    you may not use this file except in compliance with the License.
    You may obtain a copy of the License at

       http://www.apache.org/licenses/LICENSE-2.0

    Unless required by applicable law or agreed to in writing, software
    distributed under the License is distributed on an "AS IS" BASIS,
    WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
    See the License for the specific language governing permissions and
    limitations under the License.



[1]: http://android-developers.blogspot.com/2011/02/animation-in-honeycomb.html
[2]: http://nineoldandroids.com
[3]: https://github.com/billdawson/ti-android-animation/blob/master/src/com/billdawson/timodules/animation/ObjectAnimator_.java
[4]: http://developer.android.com/reference/android/animation/ObjectAnimator.html
[5]: https://github.com/billdawson/ti-android-animation/blob/master/src/com/billdawson/timodules/animation/views/ViewPropertyAnimator_.java
[6]: http://developer.android.com/reference/android/view/ViewPropertyAnimator.html
[7]: https://github.com/billdawson/ti-android-animation/blob/master/src/com/billdawson/timodules/animation/AnimatorSet_.java
[8]: http://developer.android.com/reference/android/animation/AnimatorSet.html<commit_msg>Update README with links to documentation<commit_after>Android Animation for Titanium
================================

This Titanium Android module makes the [Honeycomb (Android 3.0) animation API][1]
available to Titanium Android apps. It uses Jake Wharton's excellent
[NineOldAndroids][2] library to make the animations available on pre-Honeycomb
devices as well.

It does this by wrapping and exposing two types of animators that are native to
the Honeycomb Animation API: [ObjectAnimator][3] ([native][4]) and
[ViewPropertyAnimator][5] ([native][6]).

Additionally, it provides access to the [AnimatorSet][7] ([native][8]), which
can run multiple `ObjectAnimator` instances either simultaneously or back-to-back.

The real star of the bunch is the `ViewPropertyAnimator`, which is the one
you should be trying to use first.

Documentation
=============

Currently [the documentation][9] is in javadoc strings within the code and generated
using Doxygen. The result is not particularly "Javascripty", but I hate
separating documentation from code, so that's the way it is at least
for now.

Usage
=====

Please see [the documentation][9] for instructions on how to use the module in
your Titanium app. You can also find code samples under the example/ folder.

Meanwhile here is a very quick example of using the view property animator made
available via this module:

    var animationModule = require("com.billdawson.timodules.animation");
	
	//... setup window / views ...
    
    animationModule.viewPropertyAnimator.animate(myView).xBy(50).yBy(50);

Build
=====

The module has so far been built and tested only with Titanium 3.0.2. You build
it the same as you would build any other Titanium module for Android. The build.xml
Ant script is provided, but be sure your machine is setup to build Titanium
Android modules. You can ensure this by creating and building your own test
module using Titanium Studio. In a nutshell, you'll need the Android SDK, the
Android NDK and Python.

Full instructions on how to create and build Titanium modules for Android will
not be provided here. Nor will instructions on how to put modules in to your
Titanium app projects be provided here. Look elsewhere!

If you don't wish to build but just want the packaged module, you should be able
to find recent ZIPs of it at ... (TODO).

Developed By
============

* <NAME> (http://billdawson.com)

License
=======

	The original code herein is...

	Copyright 2013 <NAME>.

	The NineOldAndroids library, upon which this module is built, is...

    Copyright 2012 <NAME>.

	Both projects:

    Licensed under the Apache License, Version 2.0 (the "License");
    you may not use this file except in compliance with the License.
    You may obtain a copy of the License at

       http://www.apache.org/licenses/LICENSE-2.0

    Unless required by applicable law or agreed to in writing, software
    distributed under the License is distributed on an "AS IS" BASIS,
    WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
    See the License for the specific language governing permissions and
    limitations under the License.



[1]: http://android-developers.blogspot.com/2011/02/animation-in-honeycomb.html
[2]: http://nineoldandroids.com
[3]: https://github.com/billdawson/ti-android-animation/blob/master/src/com/billdawson/timodules/animation/ObjectAnimator_.java
[4]: http://developer.android.com/reference/android/animation/ObjectAnimator.html
[5]: https://github.com/billdawson/ti-android-animation/blob/master/src/com/billdawson/timodules/animation/views/ViewPropertyAnimator_.java
[6]: http://developer.android.com/reference/android/view/ViewPropertyAnimator.html
[7]: https://github.com/billdawson/ti-android-animation/blob/master/src/com/billdawson/timodules/animation/AnimatorSet_.java
[8]: http://developer.android.com/reference/android/animation/AnimatorSet.html
[9]: http://billdawson.github.com/ti-android-animation/docs/index.html
{'fraction_non_alphanumeric': 0.09778720021200477, 'fraction_numerical': 0.011792765337220087, 'mean_word_length': 4.453757225433526, 'pattern_counts': {'":': 0, '<': 9, '<?xml version=': 0, '>': 9, 'https://': 6, 'lorem ipsum': 0, 'www.': 2, 'xml': 2}, 'pii_count': 0, 'substrings_counts': 0, 'word_list_counts': {'cursed_substrings.json': 2, 'profanity_word_list.json': 0, 'sexual_word_list.json': 0, 'zh_pornsignals.json': 0}}
{'dir': 'git-commits-cleaned', 'id': '7069248', 'n_tokens_mistral': 2165, 'n_tokens_neox': 2014, 'n_words': 859}