Transition.CreateAnimator Method

Reference

Definition

Namespace:: Android.Transitions

Assembly:: Mono.Android.dll

Important

Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.

This method creates an animation that will be run for this transition given the information in the startValues and endValues structures captured earlier for the start and end scenes.

[Android.Runtime.Register("createAnimator", "(Landroid/view/ViewGroup;Landroid/transition/TransitionValues;Landroid/transition/TransitionValues;)Landroid/animation/Animator;", "GetCreateAnimator_Landroid_view_ViewGroup_Landroid_transition_TransitionValues_Landroid_transition_TransitionValues_Handler")]
public virtual Android.Animation.Animator? CreateAnimator (Android.Views.ViewGroup? sceneRoot, Android.Transitions.TransitionValues? startValues, Android.Transitions.TransitionValues? endValues);

[<Android.Runtime.Register("createAnimator", "(Landroid/view/ViewGroup;Landroid/transition/TransitionValues;Landroid/transition/TransitionValues;)Landroid/animation/Animator;", "GetCreateAnimator_Landroid_view_ViewGroup_Landroid_transition_TransitionValues_Landroid_transition_TransitionValues_Handler")>]
abstract member CreateAnimator : Android.Views.ViewGroup * Android.Transitions.TransitionValues * Android.Transitions.TransitionValues -> Android.Animation.Animator
override this.CreateAnimator : Android.Views.ViewGroup * Android.Transitions.TransitionValues * Android.Transitions.TransitionValues -> Android.Animation.Animator

Parameters

sceneRoot: ViewGroup

The root of the transition hierarchy.

startValues: TransitionValues

The values for a specific target in the start scene.

endValues: TransitionValues

The values for the target in the end scene.

Returns

Animator

A Animator to be started at the appropriate time in the overall transition for this scene change. A null value means no animation should be run.

Attributes: RegisterAttribute

Remarks

This method creates an animation that will be run for this transition given the information in the startValues and endValues structures captured earlier for the start and end scenes. Subclasses of Transition should override this method. The method should only be called by the transition system; it is not intended to be called from external classes.

This method is called by the transition's parent (all the way up to the topmost Transition in the hierarchy) with the sceneRoot and start/end values that the transition may need to set up initial target values and construct an appropriate animation. For example, if an overall Transition is a TransitionSet consisting of several child transitions in sequence, then some of the child transitions may want to set initial values on target views prior to the overall Transition commencing, to put them in an appropriate state for the delay between that start and the child Transition start time. For example, a transition that fades an item in may wish to set the starting alpha value to 0, to avoid it blinking in prior to the transition actually starting the animation. This is necessary because the scene change that triggers the Transition will automatically set the end-scene on all target views, so a Transition that wants to animate from a different value should set that value prior to returning from this method.

Additionally, a Transition can perform logic to determine whether the transition needs to run on the given target and start/end values. For example, a transition that resizes objects on the screen may wish to avoid running for views which are not present in either the start or end scenes.

If there is an animator created and returned from this method, the transition mechanism will apply any applicable duration, startDelay, and interpolator to that animation and start it. A return value of null indicates that no animation should run. The default implementation returns null.

The method is called for every applicable target object, which is stored in the TransitionValues#view field.

Java documentation for android.transition.Transition.createAnimator(android.view.ViewGroup, android.transition.TransitionValues, android.transition.TransitionValues).

Portions of this page are modifications based on work created and shared by the Android Open Source Project and used according to terms described in the Creative Commons 2.5 Attribution License.

Applies to