Key

Artifact: androidx.constraintlayout:constraintlayout

Kotlin |Java

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
`const String!`	`ALPHA = "alpha"`
`const String!`	`CURVEFIT = "curveFit"`
`const String!`	`CUSTOM = "CUSTOM"`
`const String!`	`ELEVATION = "elevation"`
`const String!`	`MOTIONPROGRESS = "motionProgress"`
`const String!`	`PIVOT_X = "transformPivotX"`
`const String!`	`PIVOT_Y = "transformPivotY"`
`const String!`	`PROGRESS = "progress"`
`const String!`	`ROTATION = "rotation"`
`const String!`	`ROTATION_X = "rotationX"`
`const String!`	`ROTATION_Y = "rotationY"`
`const String!`	`SCALE_X = "scaleX"`
`const String!`	`SCALE_Y = "scaleY"`
`const String!`	`TRANSITIONEASING = "transitionEasing"`
`const String!`	`TRANSITION_PATH_ROTATE = "transitionPathRotate"`
`const String!`	`TRANSLATION_X = "translationX"`
`const String!`	`TRANSLATION_Y = "translationY"`
`const String!`	`TRANSLATION_Z = "translationZ"`
`const String!`	`VISIBILITY = "visibility"`
`const String!`	`WAVE_OFFSET = "waveOffset"`
`const String!`	`WAVE_PERIOD = "wavePeriod"`
`const String!`	`WAVE_PHASE = "wavePhase"`
`const String!`	`WAVE_VARIES_BY = "waveVariesBy"`

Public constructors
`Key()`

Public functions
`abstract Unit`	`addValues(splines: HashMap<String!, ViewSpline!>!)` Defines method to add a a view to splines derived form this key frame.
`abstract Key!`	`clone()` Return a copy of this
`Key!`	`copy(src: Key!)` Return a copy of this key
`Int`	`getFramePosition()` Gets the current frame position
`Unit`	`setFramePosition(pos: Int)` sets the frame position
`Unit`	`setInterpolation(interpolation: HashMap<String!, Int!>!)` 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 Unit`	`setValue(tag: String!, value: Any!)` Set the value associated with this tag
`Key!`	`setViewId(id: Int)` set the id of the view

Public properties
`java-static Int`	`UNSET`

Protected properties
`Int`	`mType`

Constants

ALPHA

Added in 2.2.0-alpha13

const val ALPHA = "alpha": String!

CURVEFIT

Added in 2.2.0-alpha13

const val CURVEFIT = "curveFit": String!

CUSTOM

Added in 2.2.0-alpha13

const val CUSTOM = "CUSTOM": String!

ELEVATION

Added in 2.2.0-alpha13

const val ELEVATION = "elevation": String!

MOTIONPROGRESS

Added in 2.2.0-alpha13

const val MOTIONPROGRESS = "motionProgress": String!

PIVOT_X

Added in 2.2.0-alpha13

const val PIVOT_X = "transformPivotX": String!

PIVOT_Y

Added in 2.2.0-alpha13

const val PIVOT_Y = "transformPivotY": String!

PROGRESS

Added in 2.2.0-alpha13

const val PROGRESS = "progress": String!

ROTATION

Added in 2.2.0-alpha13

const val ROTATION = "rotation": String!

ROTATION_X

Added in 2.2.0-alpha13

const val ROTATION_X = "rotationX": String!

ROTATION_Y

Added in 2.2.0-alpha13

const val ROTATION_Y = "rotationY": String!

SCALE_X

Added in 2.2.0-alpha13

const val SCALE_X = "scaleX": String!

SCALE_Y

Added in 2.2.0-alpha13

const val SCALE_Y = "scaleY": String!

TRANSITIONEASING

Added in 2.2.0-alpha13

const val TRANSITIONEASING = "transitionEasing": String!

TRANSITION_PATH_ROTATE

Added in 2.2.0-alpha13

const val TRANSITION_PATH_ROTATE = "transitionPathRotate": String!

TRANSLATION_X

Added in 2.2.0-alpha13

const val TRANSLATION_X = "translationX": String!

TRANSLATION_Y

Added in 2.2.0-alpha13

const val TRANSLATION_Y = "translationY": String!

TRANSLATION_Z

Added in 2.2.0-alpha13

const val TRANSLATION_Z = "translationZ": String!

VISIBILITY

Added in 2.2.0-alpha13

const val VISIBILITY = "visibility": String!

WAVE_OFFSET

Added in 2.2.0-alpha13

const val WAVE_OFFSET = "waveOffset": String!

WAVE_PERIOD

Added in 2.2.0-alpha13

const val WAVE_PERIOD = "wavePeriod": String!

WAVE_PHASE

Added in 2.2.0-alpha13

const val WAVE_PHASE = "wavePhase": String!

WAVE_VARIES_BY

Added in 2.2.0-alpha13

const val WAVE_VARIES_BY = "waveVariesBy": String!

Public constructors

Key

Added in 2.2.0-alpha13

Key()

Public functions

addValues

Added in 2.2.0-alpha13

abstract fun addValues(splines: HashMap<String!, ViewSpline!>!): Unit

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

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

clone

Added in 2.2.0-alpha13

abstract fun clone(): Key!

Return a copy of this

Returns
`Key!`

Added in 2.2.0-alpha13

fun copy(src: Key!): Key!

Return a copy of this key

Parameters
`src: Key!`

Returns
`Key!`

getFramePosition

Added in 2.2.0-alpha13

fun getFramePosition(): Int

Gets the current frame position

Returns
`Int`

setFramePosition

Added in 2.2.0-alpha13

fun setFramePosition(pos: Int): Unit

sets the frame position

Parameters
`pos: Int`

setInterpolation

Added in 2.2.0-alpha13

fun setInterpolation(interpolation: HashMap<String!, Int!>!): Unit

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
`interpolation: HashMap<String!, Int!>!`

setValue

Added in 2.2.0-alpha13

abstract fun setValue(tag: String!, value: Any!): Unit

Set the value associated with this tag

Parameters
`tag: String!`
`value: Any!`

setViewId

Added in 2.2.0-alpha13

fun setViewId(id: Int): Key!

set the id of the view

Parameters
`id: Int`

Returns
`Key!`

Public properties

UNSET

Added in 2.2.0-alpha13

java-static val UNSET: Int

Protected properties

mType

Added in 2.2.0-alpha13

protected val mType: Int