PatternPathMotion

Artifact: androidx.transition:transition

View Source

Added in 1.0.0

---

Kotlin |Java

public class PatternPathMotion extends PathMotion

java.lang.Object
↳	androidx.transition.PathMotion
	↳	androidx.transition.PatternPathMotion

---

A PathMotion that takes a Path pattern and applies it to the separation between two points. The starting point of the Path will be moved to the origin and the end point will be scaled and rotated so that it matches with the target end point.

This may be used in XML as an element inside a transition.

<changeBounds>
    <patternPathMotion android:patternPathData="M0 0 L0 100 L100 100"/>
</changeBounds>

Summary

Public constructors
PatternPathMotion() Constructs a PatternPathMotion with a straight-line pattern.
PatternPathMotion(@NonNull Path patternPath) Creates a PatternPathMotion with the Path defining a pattern of motion between two coordinates.
PatternPathMotion(@NonNull Context context, @NonNull AttributeSet attrs)

Public methods
@NonNull Path	getPath(float startX, float startY, float endX, float endY) Provide a Path to interpolate between two points (startX, startY) and (endX, endY).
@NonNull Path	getPatternPath() Returns the Path defining a pattern of motion between two coordinates.
void	setPatternPath(@NonNull Path patternPath) Sets the Path defining a pattern of motion between two coordinates.

Public constructors

PatternPathMotion

Added in 1.0.0

public PatternPathMotion()

Constructs a PatternPathMotion with a straight-line pattern.

PatternPathMotion

Added in 1.0.0

public PatternPathMotion(@NonNull Path patternPath)

Creates a PatternPathMotion with the Path defining a pattern of motion between two coordinates. The pattern will be translated, rotated, and scaled to fit between the start and end points. The pattern must not be empty and must have the end point differ from the start point.

Parameters
@NonNull Path patternPath	A Path to be used as a pattern for two-dimensional motion.

PatternPathMotion

Added in 1.0.0

public PatternPathMotion(@NonNull Context context, @NonNull AttributeSet attrs)

Public methods

getPath

Added in 1.5.1

public @NonNull Path getPath(float startX, float startY, float endX, float endY)

Provide a Path to interpolate between two points (startX, startY) and (endX, endY). This allows controlled curved motion along two dimensions.

Parameters
float startX	The x coordinate of the starting point.
float startY	The y coordinate of the starting point.
float endX	The x coordinate of the ending point.
float endY	The y coordinate of the ending point.

Returns
@NonNull Path	A Path along which the points should be interpolated. The returned Path must start at point (startX, startY), typically using moveTo and end at (endX, endY).

getPatternPath

Added in 1.0.0

public @NonNull Path getPatternPath()

Returns the Path defining a pattern of motion between two coordinates. The pattern will be translated, rotated, and scaled to fit between the start and end points. The pattern must not be empty and must have the end point differ from the start point.

Returns
@NonNull Path	the Path defining a pattern of motion between two coordinates.

setPatternPath

Added in 1.0.0

public void setPatternPath(@NonNull Path patternPath)

Sets the Path defining a pattern of motion between two coordinates. The pattern will be translated, rotated, and scaled to fit between the start and end points. The pattern must not be empty and must have the end point differ from the start point.

Parameters
@NonNull Path patternPath	A Path to be used as a pattern for two-dimensional motion.