README.md
1 Android CustomTransition Sample
2 ===================================
3
4 This sample shows how to implement a custom Transition extending the
5 standard Transition class.
6
7 Introduction
8 ------------
9
10 In order to create a custom Transition, you first need to override
11 [captureStartValues][1] and [captureEndValues][2]. In those method, you have to
12 extract all the relevant properties from a View. These methods are called for
13 each of the Views in the hierarchy.
14
15 Then, you need to override [createAnimator][3] and create an Animator based on
16 the property values you extracted. This method will also be called for each of
17 the Views in the hierarchy. If you want to skip some Views, simply return null.
18
19 The instantiated custom Transition can be applied by passing it as the second
20 parameter of [TransitionManager.go][4].
21
22 ```java
23 TransitionManager.go(mScenes[mCurrentScene], mTransition);
24 ```
25
26 [1]: https://developer.android.com/reference/android/transition/Transition.html#captureStartValues(android.transition.TransitionValues)
27 [2]: https://developer.android.com/reference/android/transition/Transition.html#captureEndValues(android.transition.TransitionValues)
28 [3]: https://developer.android.com/reference/android/transition/Transition.html#createAnimator(android.view.ViewGroup, android.transition.TransitionValues, android.transition.TransitionValues)
29 [4]: https://developer.android.com/reference/android/transition/TransitionManager.html#go(android.transition.Scene, android.transition.Transition)
30
31 Pre-requisites
32 --------------
33
34 - Android SDK v21
35 - Android Build Tools v21.1.1
36 - Android Support Repository
37
38 Screenshots
39 -------------
40
41 <img src="screenshots/main.png" height="400" alt="Screenshot"/>
42
43 Getting Started
44 ---------------
45
46 This sample uses the Gradle build system. To build this project, use the
47 "gradlew build" command or use "Import Project" in Android Studio.
48
49 Support
50 -------
51
52 - Google+ Community: https://plus.google.com/communities/105153134372062985968
53 - Stack Overflow: http://stackoverflow.com/questions/tagged/android
54
55 If you've found an error in this sample, please file an issue:
56 https://github.com/googlesamples/android-CustomTransition
57
58 Patches are encouraged, and may be submitted by forking this project and
59 submitting a pull request through GitHub. Please see CONTRIBUTING.md for more details.
60
61 License
62 -------
63
64 Copyright 2014 The Android Open Source Project, Inc.
65
66 Licensed to the Apache Software Foundation (ASF) under one or more contributor
67 license agreements. See the NOTICE file distributed with this work for
68 additional information regarding copyright ownership. The ASF licenses this
69 file to you under the Apache License, Version 2.0 (the "License"); you may not
70 use this file except in compliance with the License. You may obtain a copy of
71 the License at
72
73 http://www.apache.org/licenses/LICENSE-2.0
74
75 Unless required by applicable law or agreed to in writing, software
76 distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
77 WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
78 License for the specific language governing permissions and limitations under
79 the License.
80