Key

Artifact: androidx.constraintlayout:constraintlayout

Added in 2.2.1

Kotlin |Java

public abstract class Key

Known direct subclasses

KeyAttributes, KeyCycle, KeyPosition, KeyTimeCycle, KeyTrigger

`KeyAttributes`	Defines container for a key frame of for storing KeyAttributes.
`KeyCycle`	Provide the passive data structure to get KeyPosition information form XML
`KeyPosition`	Provide the passive data structure to get KeyPosition information form XML
`KeyTimeCycle`	Defines container for a key frame of for storing KeyTimeCycles.
`KeyTrigger`	Defines container for a key frame of for storing KeyAttributes.

Base class in an element in a KeyFrame

Summary

Constants
`static final String`	`ALPHA = "alpha"`
`static final String`	`CURVEFIT = "curveFit"`
`static final String`	`CUSTOM = "CUSTOM"`
`static final String`	`ELEVATION = "elevation"`
`static final String`	`MOTIONPROGRESS = "motionProgress"`
`static final String`	`PIVOT_X = "transformPivotX"`
`static final String`	`PIVOT_Y = "transformPivotY"`
`static final String`	`PROGRESS = "progress"`
`static final String`	`ROTATION = "rotation"`
`static final String`	`ROTATION_X = "rotationX"`
`static final String`	`ROTATION_Y = "rotationY"`
`static final String`	`SCALE_X = "scaleX"`
`static final String`	`SCALE_Y = "scaleY"`
`static final String`	`TRANSITIONEASING = "transitionEasing"`
`static final String`	`TRANSITION_PATH_ROTATE = "transitionPathRotate"`
`static final String`	`TRANSLATION_X = "translationX"`
`static final String`	`TRANSLATION_Y = "translationY"`
`static final String`	`TRANSLATION_Z = "translationZ"`
`static final String`	`VISIBILITY = "visibility"`
`static final String`	`WAVE_OFFSET = "waveOffset"`
`static final String`	`WAVE_PERIOD = "wavePeriod"`
`static final String`	`WAVE_PHASE = "wavePhase"`
`static final String`	`WAVE_VARIES_BY = "waveVariesBy"`

Public fields
`static int`	`UNSET`

Protected fields
`int`	`mType`

Public constructors
`Key()`

Public methods
`abstract void`	`addValues(HashMap<String, ViewSpline> splines)` Defines method to add a a view to splines derived form this key frame.
`abstract Key`	`clone()` Return a copy of this
`Key`	`copy(Key src)` Return a copy of this key
`int`	`getFramePosition()` Gets the current frame position
`void`	`setFramePosition(int pos)` sets the frame position
`void`	`setInterpolation(HashMap<String, Integer> interpolation)` Key frame can specify the type of interpolation it wants on various attributes For each string it set it to -1, CurveFit.LINEAR or CurveFit.SPLINE
`abstract void`	`setValue(String tag, Object value)` Set the value associated with this tag
`Key`	`setViewId(int id)` set the id of the view

Constants

ALPHA

Added in 2.2.1

public static final String ALPHA = "alpha"

CURVEFIT

Added in 2.2.1

public static final String CURVEFIT = "curveFit"

CUSTOM

Added in 2.2.1

public static final String CUSTOM = "CUSTOM"

ELEVATION

Added in 2.2.1

public static final String ELEVATION = "elevation"

MOTIONPROGRESS

Added in 2.2.1

public static final String MOTIONPROGRESS = "motionProgress"

PIVOT_X

Added in 2.2.1

public static final String PIVOT_X = "transformPivotX"

PIVOT_Y

Added in 2.2.1

public static final String PIVOT_Y = "transformPivotY"

PROGRESS

Added in 2.2.1

public static final String PROGRESS = "progress"

ROTATION

Added in 2.2.1

public static final String ROTATION = "rotation"

ROTATION_X

Added in 2.2.1

public static final String ROTATION_X = "rotationX"

ROTATION_Y

Added in 2.2.1

public static final String ROTATION_Y = "rotationY"

SCALE_X

Added in 2.2.1

public static final String SCALE_X = "scaleX"

SCALE_Y

Added in 2.2.1

public static final String SCALE_Y = "scaleY"

TRANSITIONEASING

Added in 2.2.1

public static final String TRANSITIONEASING = "transitionEasing"

TRANSITION_PATH_ROTATE

Added in 2.2.1

public static final String TRANSITION_PATH_ROTATE = "transitionPathRotate"

TRANSLATION_X

Added in 2.2.1

public static final String TRANSLATION_X = "translationX"

TRANSLATION_Y

Added in 2.2.1

public static final String TRANSLATION_Y = "translationY"

TRANSLATION_Z

Added in 2.2.1

public static final String TRANSLATION_Z = "translationZ"

VISIBILITY

Added in 2.2.1

public static final String VISIBILITY = "visibility"

WAVE_OFFSET

Added in 2.2.1

public static final String WAVE_OFFSET = "waveOffset"

WAVE_PERIOD

Added in 2.2.1

public static final String WAVE_PERIOD = "wavePeriod"

WAVE_PHASE

Added in 2.2.1

public static final String WAVE_PHASE = "wavePhase"

WAVE_VARIES_BY

Added in 2.2.1

public static final String WAVE_VARIES_BY = "waveVariesBy"

Public fields

UNSET

Added in 2.2.1

public static int UNSET

Protected fields

mType

Added in 2.2.1

protected int mType

Public constructors

Key

Added in 2.2.1

public Key()

Public methods

addValues

Added in 2.2.1

public abstract void addValues(HashMap<String, ViewSpline> splines)

Defines method to add a a view to splines derived form this key frame. The values are written to the spline

Parameters
`HashMap<String, ViewSpline> splines`	splines to write values to

clone

Added in 2.2.1

public abstract Key clone()

Return a copy of this

Returns
`Key`

Added in 2.2.1

public Key copy(Key src)

Return a copy of this key

Parameters
`Key src`

Returns
`Key`

getFramePosition

Added in 2.2.1

public int getFramePosition()

Gets the current frame position

Returns
`int`

setFramePosition

Added in 2.2.1

public void setFramePosition(int pos)

sets the frame position

Parameters
`int pos`

setInterpolation

Added in 2.2.1

public void setInterpolation(HashMap<String, Integer> interpolation)

Key frame can specify the type of interpolation it wants on various attributes For each string it set it to -1, CurveFit.LINEAR or CurveFit.SPLINE

Parameters
`HashMap<String, Integer> interpolation`

setValue

Added in 2.2.1

public abstract void setValue(String tag, Object value)

Set the value associated with this tag

Parameters
`String tag`
`Object value`

setViewId

Added in 2.2.1

public Key setViewId(int id)

set the id of the view

Parameters
`int id`

Returns
`Key`