MotionKeyCycle

Artifact: androidx.constraintlayout:constraintlayout-core

Added in 1.1.0

Kotlin |Java

class MotionKeyCycle : MotionKey

kotlin.Any
↳	androidx.constraintlayout.core.motion.key.MotionKey
	↳	androidx.constraintlayout.core.motion.key.MotionKeyCycle

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
`MotionKeyCycle()`

Public functions
`Unit`	`addCycleValues(oscSet: HashMap<String!, KeyCycleOscillator!>!)`
`Unit`	`addValues(splines: HashMap<String!, SplineSet!>!)` Defines method to add a a view to splines derived form this key frame.
`MotionKey!`	`clone()`
`Unit`	`dump()`
`Unit`	`getAttributeNames(attributes: HashSet<String!>!)`
`Int`	`getId(name: String!)`
`Float`	`getValue(key: String!)`
`Unit`	`printAttributes()`
`Boolean`	`setValue(type: Int, value: Float)` Used to set float values
`Boolean`	`setValue(type: Int, value: Int)` Used to set integer values
`Boolean`	`setValue(type: Int, value: String!)` Used to set String values

Inherited Constants

From androidx.constraintlayout.core.motion.key.MotionKey

`const String!`	`ALPHA = "alpha"`
`const String!`	`CUSTOM = "CUSTOM"`
`const String!`	`ELEVATION = "elevation"`
`const String!`	`ROTATION = "rotationZ"`
`const String!`	`ROTATION_X = "rotationX"`
`const String!`	`SCALE_X = "scaleX"`
`const String!`	`SCALE_Y = "scaleY"`
`const String!`	`TRANSITION_PATH_ROTATE = "transitionPathRotate"`
`const String!`	`TRANSLATION_X = "translationX"`
`const String!`	`TRANSLATION_Y = "translationY"`
`const String!`	`VISIBILITY = "visibility"`

From androidx.constraintlayout.core.motion.utils.TypedValues

`const Int`	`BOOLEAN_MASK = 1`
`const Int`	`FLOAT_MASK = 4`
`const Int`	`INT_MASK = 2`
`const Int`	`STRING_MASK = 8`
`const String!`	`S_CUSTOM = "CUSTOM"`
`const Int`	`TYPE_FRAME_POSITION = 100`
`const Int`	`TYPE_TARGET = 101`

Inherited functions

From androidx.constraintlayout.core.motion.key.MotionKey

`MotionKey!`	`copy(src: MotionKey!)`
`Int`	`getFramePosition()` Gets the current frame position
`Unit`	`setCustomAttribute(name: String!, type: Int, value: Boolean)`
`Unit`	`setCustomAttribute(name: String!, type: Int, value: Float)`
`Unit`	`setCustomAttribute(name: String!, type: Int, value: Int)`
`Unit`	`setCustomAttribute(name: String!, type: Int, value: String!)`
`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
`Boolean`	`setValue(type: Int, value: Boolean)` Used to set boolean values
`MotionKey!`	`setViewId(id: Int)`

From androidx.constraintlayout.core.motion.utils.TypedValues

`abstract Boolean`	`setValue(id: Int, value: Boolean)` Used to set boolean values
`abstract Boolean`	`setValue(id: Int, value: Float)` Used to set float values
`abstract Boolean`	`setValue(id: Int, value: Int)` Used to set integer values
`abstract Boolean`	`setValue(id: Int, value: String!)` Used to set String values

Inherited properties

From androidx.constraintlayout.core.motion.key.MotionKey

`java-static Int`	`UNSET`
`HashMap<String!, CustomVariable!>!`	`mCustom`
`Int`	`mFramePosition`
`Int`	`mType`

Constants

KEY_TYPE

Added in 1.1.0

const val KEY_TYPE = 4: Int

SHAPE_BOUNCE

Added in 1.1.0

const val SHAPE_BOUNCE = 6: Int

SHAPE_COS_WAVE

Added in 1.1.0

const val SHAPE_COS_WAVE = 5: Int

SHAPE_REVERSE_SAW_WAVE

Added in 1.1.0

const val SHAPE_REVERSE_SAW_WAVE = 4: Int

SHAPE_SAW_WAVE

Added in 1.1.0

const val SHAPE_SAW_WAVE = 3: Int

SHAPE_SIN_WAVE

Added in 1.1.0

const val SHAPE_SIN_WAVE = 0: Int

SHAPE_SQUARE_WAVE

Added in 1.1.0

const val SHAPE_SQUARE_WAVE = 1: Int

SHAPE_TRIANGLE_WAVE

Added in 1.1.0

const val SHAPE_TRIANGLE_WAVE = 2: Int

WAVE_OFFSET

Added in 1.1.0

const val WAVE_OFFSET = "waveOffset": String!

WAVE_PERIOD

Added in 1.1.0

const val WAVE_PERIOD = "wavePeriod": String!

WAVE_PHASE

Added in 1.1.0

const val WAVE_PHASE = "wavePhase": String!

WAVE_SHAPE

Added in 1.1.0

const val WAVE_SHAPE = "waveShape": String!

Public constructors

MotionKeyCycle

Added in 1.1.0

MotionKeyCycle()

Public functions

addCycleValues

Added in 1.1.0

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

addValues

Added in 1.1.0

fun addValues(splines: HashMap<String!, SplineSet!>!): 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!, SplineSet!>!`	splines to write values to

clone

Added in 1.1.0

fun clone(): MotionKey!

dump

Added in 1.1.0

fun dump(): Unit

getAttributeNames

Added in 1.1.0

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

getId

Added in 1.1.0

fun getId(name: String!): Int

getValue

Added in 1.1.0

fun getValue(key: String!): Float

printAttributes

Added in 1.1.0

fun printAttributes(): Unit

setValue

fun setValue(type: Int, value: Float): Boolean

Used to set float values

Returns
`Boolean`	true if it accepted the value

setValue

fun setValue(type: Int, value: Int): Boolean

Used to set integer values

Returns
`Boolean`	true if it accepted the value

setValue

fun setValue(type: Int, value: String!): Boolean

Used to set String values

Returns
`Boolean`	true if it accepted the value