ChangeImageTransform

Kotlin |Java

open class ChangeImageTransform : Transition

kotlin.Any
↳	android.transition.Transition
	↳	android.transition.ChangeImageTransform

This Transition captures an ImageView's matrix before and after the scene change and animates it during the transition.

In combination with ChangeBounds, ChangeImageTransform allows ImageViews that change size, shape, or android.widget.ImageView.ScaleType to animate contents smoothly.

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
`ChangeImageTransform()`
`ChangeImageTransform(context: Context!, attrs: AttributeSet!)`

Public methods
open Unit	`captureEndValues(transitionValues: TransitionValues!)` Captures the values in the end scene for the properties that this transition monitors.
open Unit	`captureStartValues(transitionValues: TransitionValues!)` Captures the values in the start scene for the properties that this transition monitors.
open Animator?	`createAnimator(sceneRoot: ViewGroup, startValues: TransitionValues?, endValues: TransitionValues?)` Creates an Animator for ImageViews moving, changing dimensions, and/or changing `android.widget.ImageView.ScaleType`.
open Array<String!>!	`getTransitionProperties()` Returns the set of property names used stored in the `TransitionValues` object passed into `captureStartValues(android.transition.TransitionValues)` that this transition cares about for the purposes of canceling overlapping animations.

Inherited functions

From class Transition

`Transition!`	`addListener(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(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(android.view.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(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(targetType: Class<Any!>!)` 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!`	`addTarget(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.
`Boolean`	`canRemoveViews()`
`Transition`	`clone()` Creates and returns a copy of this object. The precise meaning of "copy" may depend on the class of the object. The general intent is that, for any object `x`, the expression: x.clone() != x will be true, and that the expression: x.clone().getClass() == x.getClass() will be `true`, but these are not absolute requirements. While it is typically the case that: x.clone().equals(x) will be `true`, this is not an absolute requirement. By convention, the returned object should be obtained by calling `super.clone`. If a class and all of its superclasses (except `Object`) obey this convention, it will be the case that `x.clone().getClass() == x.getClass()`. By convention, the object returned by this method should be independent of this object (which is being cloned). To achieve this independence, it may be necessary to modify one or more fields of the object returned by `super.clone` before returning it. Typically, this means copying any mutable objects that comprise the internal "deep structure" of the object being cloned and replacing the references to these objects with references to the copies. If a class contains only primitive fields or references to immutable objects, then it is usually the case that no fields in the object returned by `super.clone` need to be modified.
`Transition!`	`excludeChildren(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(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(type: Class<Any!>!, 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(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(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(type: Class<Any!>!, 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`).
`Transition!`	`excludeTarget(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`).
`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. When describing in XML, use a nested XML tag for the path motion. It can be one of the built-in tags `arcMotion` or `patternPathMotion` or it can be a custom PathMotion using `pathMotion` with the `class` attributed with the fully-described class name. For example: <code><changeBounds> <pathMotion class="my.app.transition.MyPathMotion"/> </changeBounds></code> or <code><changeBounds> <arcMotion android:minimumHorizontalAngle="15" android:minimumVerticalAngle="0" android:maximumAngle="90"/> </changeBounds></code>
`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 list of target IDs 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<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<Any!>!>!`	`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 list of target views 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.
`TransitionValues!`	`getTransitionValues(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(startValues: TransitionValues?, endValues: TransitionValues?)` Returns whether or not the transition should create an Animator, based on the values captured during `captureStartValues(android.transition.TransitionValues)` and `captureEndValues(android.transition.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(listener: Transition.TransitionListener!)` Removes a listener from the set listening to this animation.
`Transition!`	`removeTarget(target: View!)` Removes the given target from the list of targets that this Transition is interested in animating.
`Transition!`	`removeTarget(targetId: Int)` Removes the given targetId from the list of ids that this Transition is interested in animating.
`Transition!`	`removeTarget(target: Class<Any!>!)` Removes the given target from the list of targets that this Transition is interested in animating.
`Transition!`	`removeTarget(targetName: String!)` Removes the given targetName from the list of transitionNames 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(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(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(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)`. When describing in XML, use a nested XML tag for the path motion. It can be one of the built-in tags `arcMotion` or `patternPathMotion` or it can be a custom PathMotion using `pathMotion` with the `class` attributed with the fully-described class name. For example: <code><changeBounds> <pathMotion class="my.app.transition.MyPathMotion"/> </changeBounds> </code> or <code><changeBounds> <arcMotion android:minimumHorizontalAngle="15" android:minimumVerticalAngle="0" android:maximumAngle="90"/> </changeBounds> </code>
`Unit`	`setPropagation(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()` Returns a string representation of the object.

Public constructors

ChangeImageTransform

Added in API level 21

ChangeImageTransform()

ChangeImageTransform

Added in API level 21

ChangeImageTransform(
    context: Context!, 
    attrs: AttributeSet!)

Public methods

captureEndValues

Added in API level 21

open fun captureEndValues(transitionValues: TransitionValues!): Unit

Captures the values in the end scene for the properties that this transition monitors. These values are then passed as the endValues structure in a later call to createAnimator(android.view.ViewGroup,android.transition.TransitionValues,android.transition.TransitionValues). The main concern for an implementation is what the properties are that the transition cares about and what the values are for all of those properties. The start and end values will be compared later during the createAnimator(android.view.ViewGroup,android.transition.TransitionValues,android.transition.TransitionValues) method to determine what, if any, animations, should be run.

Subclasses must implement this method. The method should only be called by the transition system; it is not intended to be called from external classes.

Parameters

transitionValues TransitionValues!: The holder for any values that the Transition wishes to store. Values are stored in the values field of this TransitionValues object and are keyed from a String value. For example, to store a view's rotation value, a transition might call transitionValues.values.put("appname:transitionname:rotation", view.getRotation()). The target view will already be stored in the transitionValues structure when this method is called.

Parameters
`transitionValues`	TransitionValues!: The holder for any values that the Transition wishes to store. Values are stored in the `values` field of this TransitionValues object and are keyed from a String value. For example, to store a view's rotation value, a transition might call `transitionValues.values.put("appname:transitionname:rotation", view.getRotation())`. The target view will already be stored in the transitionValues structure when this method is called.

captureStartValues

Added in API level 21

open fun captureStartValues(transitionValues: TransitionValues!): Unit

Captures the values in the start scene for the properties that this transition monitors. These values are then passed as the startValues structure in a later call to createAnimator(android.view.ViewGroup,android.transition.TransitionValues,android.transition.TransitionValues). The main concern for an implementation is what the properties are that the transition cares about and what the values are for all of those properties. The start and end values will be compared later during the createAnimator(android.view.ViewGroup,android.transition.TransitionValues,android.transition.TransitionValues) method to determine what, if any, animations, should be run.

Subclasses must implement this method. The method should only be called by the transition system; it is not intended to be called from external classes.

Parameters

Parameters
`transitionValues`	TransitionValues!: The holder for any values that the Transition wishes to store. Values are stored in the `values` field of this TransitionValues object and are keyed from a String value. For example, to store a view's rotation value, a transition might call `transitionValues.values.put("appname:transitionname:rotation", view.getRotation())`. The target view will already be stored in the transitionValues structure when this method is called.

createAnimator

Added in API level 21

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

Creates an Animator for ImageViews moving, changing dimensions, and/or changing android.widget.ImageView.ScaleType.

Parameters
`sceneRoot`	ViewGroup: The root of the transition hierarchy. This value cannot be `null`.
`startValues`	TransitionValues?: The values for a specific target in the start scene. This value may be `null`.
`endValues`	TransitionValues?: The values for the target in the end scene. This value may be `null`.

Return
`Animator?`	An Animator to move an ImageView or null if the View is not an ImageView, the Drawable changed, the View is not VISIBLE, or there was no change.

getTransitionProperties

Added in API level 21

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

Returns the set of property names used stored in the TransitionValues object passed into captureStartValues(android.transition.TransitionValues) that this transition cares about for the purposes of canceling overlapping animations. When any transition is started on a given scene root, all transitions currently running on that same scene root are checked to see whether the properties on which they based their animations agree with the end values of the same properties in the new transition. If the end values are not equal, then the old animation is canceled since the new transition will start a new animation to these new values. If the values are equal, the old animation is allowed to continue and no new animation is started for that transition.

A transition does not need to override this method. However, not doing so will mean that the cancellation logic outlined in the previous paragraph will be skipped for that transition, possibly leading to artifacts as old transitions and new transitions on the same targets run in parallel, animating views toward potentially different end values.

Return
`Array<String!>!`	An array of property names as described in the class documentation for `TransitionValues`. The default implementation returns `null`.