ChangeTransform

Kotlin |Java

open class ChangeTransform : Transition

kotlin.Any
↳	androidx.transition.Transition
	↳	androidx.transition.ChangeTransform

This Transition captures scale and rotation for Views before and after the scene change and animates those changes during the transition. A change in parent is handled as well by capturing the transforms from the parent before and after the scene change and animating those during the transition.

Summary

Inherited constants

From class Transition

`Int`	`MATCH_ID` With `setMatchOrder(int...)`, chooses to match by `android.view.View#getId()`. Negative IDs will not be matched.
`Int`	`MATCH_INSTANCE` With `setMatchOrder(int...)`, chooses to match by View instance.
`Int`	`MATCH_ITEM_ID` With `setMatchOrder(int...)`, chooses to match by the `android.widget.Adapter` item id. When `android.widget.Adapter#hasStableIds()` returns false, no match will be made for items.
`Int`	`MATCH_NAME` With `setMatchOrder(int...)`, chooses to match by `android.view.View#getTransitionName()`. Null names will not be matched.

Public constructors
`<init>()`
`<init>(@NonNull context: Context, @NonNull attrs: AttributeSet)`

Public methods
open Unit	`captureEndValues(@NonNull transitionValues: TransitionValues)`
open Unit	`captureStartValues(@NonNull transitionValues: TransitionValues)`
open Animator?	`createAnimator(@NonNull sceneRoot: ViewGroup, @Nullable startValues: TransitionValues?, @Nullable endValues: TransitionValues?)`
open Boolean	`getReparent()` Returns whether parent changes will be tracked by the ChangeTransform.
open Boolean	`getReparentWithOverlay()` Returns whether changes to parent should use an overlay or not.
open Array<String!>	`getTransitionProperties()`
open Unit	`setReparent(reparent: Boolean)` Sets whether parent changes will be tracked by the ChangeTransform.
open Unit	`setReparentWithOverlay(reparentWithOverlay: Boolean)` Sets whether changes to parent should use an overlay or not.

Inherited functions

From class Transition

`Transition`	`addListener(@NonNull listener: Transition.TransitionListener)` Adds a listener to the set of listeners that are sent events through the life of an animation, such as start, repeat, and end.
`Transition`	`addTarget(@NonNull target: View)` Sets the target view instances that this Transition is interested in animating. By default, there are no targets, and a Transition will listen for changes on every view in the hierarchy below the sceneRoot of the Scene being transitioned into. Setting targets constrains the Transition to only listen for, and act on, these views. All other views will be ignored. The target list is like the `targetId` list except this list specifies the actual View instances, not the ids of the views. This is an important distinction when scene changes involve view hierarchies which have been inflated separately; different views may share the same id but not actually be the same instance. If the transition should treat those views as the same, then `addTarget(int)` should be used instead of `addTarget(View)`. If, on the other hand, scene changes involve changes all within the same view hierarchy, among views which do not necessarily have ids set on them, then the target list of views may be more convenient.
`Transition`	`addTarget(@IdRes targetId: Int)` Adds the id of a target view that this Transition is interested in animating. By default, there are no targetIds, and a Transition will listen for changes on every view in the hierarchy below the sceneRoot of the Scene being transitioned into. Setting targetIds constrains the Transition to only listen for, and act on, views with these IDs. Views with different IDs, or no IDs whatsoever, will be ignored. Note that using ids to specify targets implies that ids should be unique within the view hierarchy underneath the scene root.
`Transition`	`addTarget(@NonNull targetName: String)` Adds the transitionName of a target view that this Transition is interested in animating. By default, there are no targetNames, and a Transition will listen for changes on every view in the hierarchy below the sceneRoot of the Scene being transitioned into. Setting targetNames constrains the Transition to only listen for, and act on, views with these transitionNames. Views with different transitionNames, or no transitionName whatsoever, will be ignored. Note that transitionNames should be unique within the view hierarchy.
`Transition`	`addTarget(@NonNull targetType: Class<*>)` Adds the Class of a target view that this Transition is interested in animating. By default, there are no targetTypes, and a Transition will listen for changes on every view in the hierarchy below the sceneRoot of the Scene being transitioned into. Setting targetTypes constrains the Transition to only listen for, and act on, views with these classes. Views with different classes will be ignored. Note that any View that can be cast to targetType will be included, so if targetType is `View.class`, all Views will be included.
`Transition`	`clone()`
`Transition`	`excludeChildren(@NonNull target: View, exclude: Boolean)` Whether to add the children of given target to the list of target children to exclude from this transition. The `exclude` parameter specifies whether the target should be added to or removed from the excluded list. Excluding targets is a general mechanism for allowing transitions to run on a view hierarchy while skipping target views that should not be part of the transition. For example, you may want to avoid animating children of a specific ListView or Spinner. Views can be excluded either by their id, or by their instance reference, or by the Class of that view (eg, `Spinner`).
`Transition`	`excludeChildren(@IdRes targetId: Int, exclude: Boolean)` Whether to add the children of the given id to the list of targets to exclude from this transition. The `exclude` parameter specifies whether the children of the target should be added to or removed from the excluded list. Excluding children in this way provides a simple mechanism for excluding all children of specific targets, rather than individually excluding each child individually. Excluding targets is a general mechanism for allowing transitions to run on a view hierarchy while skipping target views that should not be part of the transition. For example, you may want to avoid animating children of a specific ListView or Spinner. Views can be excluded either by their id, or by their instance reference, or by the Class of that view (eg, `Spinner`).
`Transition`	`excludeChildren(@NonNull type: Class<*>, exclude: Boolean)` Whether to add the given type to the list of types whose children should be excluded from this transition. The `exclude` parameter specifies whether the target type should be added to or removed from the excluded list. Excluding targets is a general mechanism for allowing transitions to run on a view hierarchy while skipping target views that should not be part of the transition. For example, you may want to avoid animating children of a specific ListView or Spinner. Views can be excluded either by their id, or by their instance reference, or by the Class of that view (eg, `Spinner`).
`Transition`	`excludeTarget(@NonNull target: View, exclude: Boolean)` Whether to add the given target to the list of targets to exclude from this transition. The `exclude` parameter specifies whether the target should be added to or removed from the excluded list. Excluding targets is a general mechanism for allowing transitions to run on a view hierarchy while skipping target views that should not be part of the transition. For example, you may want to avoid animating children of a specific ListView or Spinner. Views can be excluded either by their id, or by their instance reference, or by the Class of that view (eg, `Spinner`).
`Transition`	`excludeTarget(@IdRes targetId: Int, exclude: Boolean)` Whether to add the given id to the list of target ids to exclude from this transition. The `exclude` parameter specifies whether the target should be added to or removed from the excluded list. Excluding targets is a general mechanism for allowing transitions to run on a view hierarchy while skipping target views that should not be part of the transition. For example, you may want to avoid animating children of a specific ListView or Spinner. Views can be excluded either by their id, or by their instance reference, or by the Class of that view (eg, `Spinner`).
`Transition`	`excludeTarget(@NonNull targetName: String, exclude: Boolean)` Whether to add the given transitionName to the list of target transitionNames to exclude from this transition. The `exclude` parameter specifies whether the target should be added to or removed from the excluded list. Excluding targets is a general mechanism for allowing transitions to run on a view hierarchy while skipping target views that should not be part of the transition. For example, you may want to avoid animating children of a specific ListView or Spinner. Views can be excluded by their id, their instance reference, their transitionName, or by the Class of that view (eg, `Spinner`).
`Transition`	`excludeTarget(@NonNull type: Class<*>, exclude: Boolean)` Whether to add the given type to the list of types to exclude from this transition. The `exclude` parameter specifies whether the target type should be added to or removed from the excluded list. Excluding targets is a general mechanism for allowing transitions to run on a view hierarchy while skipping target views that should not be part of the transition. For example, you may want to avoid animating children of a specific ListView or Spinner. Views can be excluded either by their id, or by their instance reference, or by the Class of that view (eg, `Spinner`).
`Long`	`getDuration()` Returns the duration set on this transition. If no duration has been set, the returned value will be negative, indicating that resulting animators will retain their own durations.
`Rect?`	`getEpicenter()` Returns the epicenter as specified by the `android.transition.Transition.EpicenterCallback` or null if no callback exists.
`Transition.EpicenterCallback?`	`getEpicenterCallback()` Returns the callback used to find the epicenter of the Transition. Transitions like `android.transition.Explode` use a point or Rect to orient the direction of travel. This is called the epicenter of the Transition and is typically centered on a touched View. The `android.transition.Transition.EpicenterCallback` allows a Transition to dynamically retrieve the epicenter during a Transition.
`TimeInterpolator?`	`getInterpolator()` Returns the interpolator set on this transition. If no interpolator has been set, the returned value will be null, indicating that resulting animators will retain their own interpolators.
`String`	`getName()` Returns the name of this Transition. This name is used internally to distinguish between different transitions to determine when interrupting transitions overlap. For example, a ChangeBounds running on the same target view as another ChangeBounds should determine whether the old transition is animating to different end values and should be canceled in favor of the new transition. By default, a Transition's name is simply the value of `Class#getName()`, but subclasses are free to override and return something different.
`PathMotion`	`getPathMotion()` Returns the algorithm object used to interpolate along two dimensions. This is typically used to determine the View motion between two points.
`TransitionPropagation?`	`getPropagation()` Returns the `android.transition.TransitionPropagation` used to calculate Animator start delays. When a Transition affects several Views like `android.transition.Explode` or `android.transition.Slide`, there may be a desire to have a "wave-front" effect such that the Animator start delay depends on position of the View. The TransitionPropagation specifies how the start delays are calculated.
`Long`	`getStartDelay()` Returns the startDelay set on this transition. If no startDelay has been set, the returned value will be negative, indicating that resulting animators will retain their own startDelays.
`MutableList<Int!>`	`getTargetIds()` Returns the array of target IDs that this transition limits itself to tracking and animating. If the array is null for both this method and `getTargets()`, then this transition is not limited to specific views, and will handle changes to any views in the hierarchy of a scene change.
`MutableList<String!>?`	`getTargetNames()` Returns the list of target transitionNames that this transition limits itself to tracking and animating. If the list is null or empty for `getTargetIds()`, `getTargets()`, `getTargetNames()`, and `getTargetTypes()` then this transition is not limited to specific views, and will handle changes to any views in the hierarchy of a scene change.
`MutableList<Class<*>!>?`	`getTargetTypes()` Returns the list of target transitionNames that this transition limits itself to tracking and animating. If the list is null or empty for `getTargetIds()`, `getTargets()`, `getTargetNames()`, and `getTargetTypes()` then this transition is not limited to specific views, and will handle changes to any views in the hierarchy of a scene change.
`MutableList<View!>`	`getTargets()` Returns the array of target views that this transition limits itself to tracking and animating. If the array is null for both this method and `getTargetIds()`, then this transition is not limited to specific views, and will handle changes to any views in the hierarchy of a scene change.
`TransitionValues?`	`getTransitionValues(@NonNull view: View, start: Boolean)` This method can be called by transitions to get the TransitionValues for any particular view during the transition-playing process. This might be necessary, for example, to query the before/after state of related views for a given transition.
`Boolean`	`isTransitionRequired(@Nullable startValues: TransitionValues?, @Nullable endValues: TransitionValues?)` Returns whether or not the transition should create an Animator, based on the values captured during `captureStartValues(TransitionValues)` and `captureEndValues(TransitionValues)`. The default implementation compares the property values returned from `getTransitionProperties()`, or all property values if `getTransitionProperties()` returns null. Subclasses may override this method to provide logic more specific to the transition implementation.
`Transition`	`removeListener(@NonNull listener: Transition.TransitionListener)` Removes a listener from the set listening to this animation.
`Transition`	`removeTarget(@NonNull target: View)` Removes the given target from the list of targets that this Transition is interested in animating.
`Transition`	`removeTarget(@IdRes targetId: Int)` Removes the given targetId from the list of ids that this Transition is interested in animating.
`Transition`	`removeTarget(@NonNull targetName: String)` Removes the given targetName from the list of transitionNames that this Transition is interested in animating.
`Transition`	`removeTarget(@NonNull target: Class<*>)` Removes the given target from the list of targets that this Transition is interested in animating.
`Transition`	`setDuration(duration: Long)` Sets the duration of this transition. By default, there is no duration (indicated by a negative number), which means that the Animator created by the transition will have its own specified duration. If the duration of a Transition is set, that duration will override the Animator duration.
`Unit`	`setEpicenterCallback(@Nullable epicenterCallback: Transition.EpicenterCallback?)` Sets the callback to use to find the epicenter of a Transition. A null value indicates that there is no epicenter in the Transition and onGetEpicenter() will return null. Transitions like `android.transition.Explode` use a point or Rect to orient the direction of travel. This is called the epicenter of the Transition and is typically centered on a touched View. The `android.transition.Transition.EpicenterCallback` allows a Transition to dynamically retrieve the epicenter during a Transition.
`Transition`	`setInterpolator(@Nullable interpolator: TimeInterpolator?)` Sets the interpolator of this transition. By default, the interpolator is null, which means that the Animator created by the transition will have its own specified interpolator. If the interpolator of a Transition is set, that interpolator will override the Animator interpolator.
`Unit`	`setMatchOrder(vararg matches: Int)` Sets the order in which Transition matches View start and end values. The default behavior is to match first by `android.view.View#getTransitionName()`, then by View instance, then by `android.view.View#getId()` and finally by its item ID if it is in a direct child of ListView. The caller can choose to have only some or all of the values of `MATCH_INSTANCE`, `MATCH_NAME`, `MATCH_ITEM_ID`, and `MATCH_ID`. Only the match algorithms supplied will be used to determine whether Views are the the same in both the start and end Scene. Views that do not match will be considered as entering or leaving the Scene.
`Unit`	`setPathMotion(@Nullable pathMotion: PathMotion?)` Sets the algorithm used to calculate two-dimensional interpolation. Transitions such as `android.transition.ChangeBounds` move Views, typically in a straight path between the start and end positions. Applications that desire to have these motions move in a curve can change how Views interpolate in two dimensions by extending PathMotion and implementing `android.transition.PathMotion#getPath(float, float, float, float)`.
`Unit`	`setPropagation(@Nullable transitionPropagation: TransitionPropagation?)` Sets the method for determining Animator start delays. When a Transition affects several Views like `android.transition.Explode` or `android.transition.Slide`, there may be a desire to have a "wave-front" effect such that the Animator start delay depends on position of the View. The TransitionPropagation specifies how the start delays are calculated.
`Transition`	`setStartDelay(startDelay: Long)` Sets the startDelay of this transition. By default, there is no delay (indicated by a negative number), which means that the Animator created by the transition will have its own specified startDelay. If the delay of a Transition is set, that delay will override the Animator delay.
`String`	`toString()`

Public constructors

<init>

ChangeTransform()

<init>

ChangeTransform(
    @NonNull context: Context, 
    @NonNull attrs: AttributeSet)

Public methods

captureEndValues

open fun captureEndValues(@NonNull transitionValues: TransitionValues): Unit

captureStartValues

open fun captureStartValues(@NonNull transitionValues: TransitionValues): Unit

createAnimator

@Nullable open fun createAnimator(
    @NonNull sceneRoot: ViewGroup, 
    @Nullable startValues: TransitionValues?, 
    @Nullable endValues: TransitionValues?
): Animator?

getReparent

open fun getReparent(): Boolean

Returns whether parent changes will be tracked by the ChangeTransform. If parent changes are tracked, then the transform will adjust to the transforms of the different parents. If they aren't tracked, only the transforms of the transitioning view will be tracked. Default is true.

Return
`Boolean`	whether parent changes will be tracked by the ChangeTransform.

getReparentWithOverlay

open fun getReparentWithOverlay(): Boolean

Returns whether changes to parent should use an overlay or not. When the parent change doesn't use an overlay, it affects the transforms of the child. The default value is true.

Note: when Overlays are not used when a parent changes, a view can be clipped when it moves outside the bounds of its parent. Setting android.view.ViewGroup#setClipChildren(boolean) and android.view.ViewGroup#setClipToPadding(boolean) can help. Also, when Overlays are not used and the parent is animating its location, the position of the child view will be relative to its parent's final position, so it may appear to "jump" at the beginning.

Return
`Boolean`	`true` when a changed parent should execute the transition inside the scene root's overlay or `false` if a parent change only affects the transform of the transitioning view.

getTransitionProperties

@NonNull open fun getTransitionProperties(): Array<String!>

setReparent

open fun setReparent(reparent: Boolean): Unit

Sets whether parent changes will be tracked by the ChangeTransform. If parent changes are tracked, then the transform will adjust to the transforms of the different parents. If they aren't tracked, only the transforms of the transitioning view will be tracked. Default is true.

Parameters
`reparent`	Boolean: Set to true to track parent changes or false to only track changes of the transitioning view without considering the parent change.

setReparentWithOverlay

open fun setReparentWithOverlay(reparentWithOverlay: Boolean): Unit

Sets whether changes to parent should use an overlay or not. When the parent change doesn't use an overlay, it affects the transforms of the child. The default value is true.

Parameters
`reparentWithOverlay`	Boolean: `true` when a changed parent should execute the transition inside the scene root's overlay or `false` if a parent change only affects the transform of the transitioning view.