KeyCycle

Artifact: androidx.constraintlayout:constraintlayout

Added in 2.2.0

Kotlin |Java

class KeyCycle : Key

kotlin.Any
↳	androidx.constraintlayout.motion.widget.Key
	↳	androidx.constraintlayout.motion.widget.KeyCycle

Provide the passive data structure to get KeyPosition information form XML

Summary

Constants
`const Int`	`KEY_TYPE = 4`
`const Int`	`SHAPE_BOUNCE = 6`
`const Int`	`SHAPE_COS_WAVE = 5`
`const Int`	`SHAPE_REVERSE_SAW_WAVE = 4`
`const Int`	`SHAPE_SAW_WAVE = 3`
`const Int`	`SHAPE_SIN_WAVE = 0`
`const Int`	`SHAPE_SQUARE_WAVE = 1`
`const Int`	`SHAPE_TRIANGLE_WAVE = 2`
`const String!`	`WAVE_OFFSET = "waveOffset"`
`const String!`	`WAVE_PERIOD = "wavePeriod"`
`const String!`	`WAVE_PHASE = "wavePhase"`
`const String!`	`WAVE_SHAPE = "waveShape"`

Public constructors
`KeyCycle()`

Public functions
`Unit`	`addCycleValues(oscSet: HashMap<String!, ViewOscillator!>!)` Add this key cycle to the keyCycle engines
`Unit`	`addValues(splines: HashMap<String!, ViewSpline!>!)` Defines method to add a a view to splines derived form this key frame.
`Key!`	`clone()` Clone this KeyAttributes
`Key!`	`copy(src: Key!)` Copy the key
`Unit`	`getAttributeNames(attributes: HashSet<String!>!)`
`Float`	`getValue(key: String!)` get the value for a given attribute of the keyCycel
`Unit`	`load(context: Context!, attrs: AttributeSet!)` Load the KeyCycle from xml attributes
`Unit`	`setValue(tag: String!, value: Any!)` Set the value associated with this tag

Inherited Constants

From androidx.constraintlayout.motion.widget.Key

`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"`

Inherited functions

From androidx.constraintlayout.motion.widget.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
`Key!`	`setViewId(id: Int)` set the id of the view

Inherited properties

From androidx.constraintlayout.motion.widget.Key

`java-static Int`	`UNSET`
`Int`	`mType`

Constants

KEY_TYPE

Added in 2.2.0

const val KEY_TYPE = 4: Int

SHAPE_BOUNCE

Added in 2.2.0

const val SHAPE_BOUNCE = 6: Int

SHAPE_COS_WAVE

Added in 2.2.0

const val SHAPE_COS_WAVE = 5: Int

SHAPE_REVERSE_SAW_WAVE

Added in 2.2.0

const val SHAPE_REVERSE_SAW_WAVE = 4: Int

SHAPE_SAW_WAVE

Added in 2.2.0

const val SHAPE_SAW_WAVE = 3: Int

SHAPE_SIN_WAVE

Added in 2.2.0

const val SHAPE_SIN_WAVE = 0: Int

SHAPE_SQUARE_WAVE

Added in 2.2.0

const val SHAPE_SQUARE_WAVE = 1: Int

SHAPE_TRIANGLE_WAVE

Added in 2.2.0

const val SHAPE_TRIANGLE_WAVE = 2: Int

WAVE_OFFSET

Added in 2.2.0

const val WAVE_OFFSET = "waveOffset": String!

WAVE_PERIOD

Added in 2.2.0

const val WAVE_PERIOD = "wavePeriod": String!

WAVE_PHASE

Added in 2.2.0

const val WAVE_PHASE = "wavePhase": String!

WAVE_SHAPE

Added in 2.2.0

const val WAVE_SHAPE = "waveShape": String!

Public constructors

KeyCycle

Added in 2.2.0

KeyCycle()

Public functions

addCycleValues

Added in 2.2.0

fun addCycleValues(oscSet: HashMap<String!, ViewOscillator!>!): Unit

Add this key cycle to the keyCycle engines

Parameters
`oscSet: HashMap<String!, ViewOscillator!>!`

addValues

Added in 2.2.0

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

fun clone(): Key!

Clone this KeyAttributes

Returns
`Key!`

fun copy(src: Key!): Key!

Copy the key

Parameters
`src: Key!`	to be copied

Returns
`Key!`	self

getAttributeNames

Added in 2.2.0

fun getAttributeNames(attributes: HashSet<String!>!): Unit

getValue

Added in 2.2.0

fun getValue(key: String!): Float

get the value for a given attribute of the keyCycel

Parameters
`key: String!`

Returns
`Float`

load

Added in 2.2.0

fun load(context: Context!, attrs: AttributeSet!): Unit

Load the KeyCycle from xml attributes

Parameters
`context: Context!`
`attrs: AttributeSet!`

setValue

Added in 2.2.0

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

Set the value associated with this tag

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