# MotionKeyCycle

Artifact: [androidx.constraintlayout:constraintlayout-core](https://developer.android.com/jetpack/androidx/releases/constraintlayout) [View Source](https://cs.android.com/search?q=file:androidx/constraintlayout/core/motion/key/MotionKeyCycle.java+class:androidx.constraintlayout.core.motion.key.MotionKeyCycle) Added in [1.1.2](https://developer.android.com/jetpack/androidx/releases/constraintlayout#1.1.2)

*** ** * ** ***


```
public class MotionKeyCycle extends MotionKey
```

<br />

|---|---|---|
| [java.lang.Object](https://developer.android.com/reference/java/lang/Object.html) |||
| ↳ | [androidx.constraintlayout.core.motion.key.MotionKey](https://developer.android.com/reference/androidx/constraintlayout/core/motion/key/MotionKey) ||
|   | ↳ | [androidx.constraintlayout.core.motion.key.MotionKeyCycle](https://developer.android.com/reference/androidx/constraintlayout/core/motion/key/MotionKeyCycle) |

*** ** * ** ***

## Summary

| ### Constants |
|---|---|
| `static final int` | `https://developer.android.com/reference/androidx/constraintlayout/core/motion/key/MotionKeyCycle#KEY_TYPE() = 4` |
| `static final int` | `https://developer.android.com/reference/androidx/constraintlayout/core/motion/key/MotionKeyCycle#SHAPE_BOUNCE() = 6` |
| `static final int` | `https://developer.android.com/reference/androidx/constraintlayout/core/motion/key/MotionKeyCycle#SHAPE_COS_WAVE() = 5` |
| `static final int` | `https://developer.android.com/reference/androidx/constraintlayout/core/motion/key/MotionKeyCycle#SHAPE_REVERSE_SAW_WAVE() = 4` |
| `static final int` | `https://developer.android.com/reference/androidx/constraintlayout/core/motion/key/MotionKeyCycle#SHAPE_SAW_WAVE() = 3` |
| `static final int` | `https://developer.android.com/reference/androidx/constraintlayout/core/motion/key/MotionKeyCycle#SHAPE_SIN_WAVE() = 0` |
| `static final int` | `https://developer.android.com/reference/androidx/constraintlayout/core/motion/key/MotionKeyCycle#SHAPE_SQUARE_WAVE() = 1` |
| `static final int` | `https://developer.android.com/reference/androidx/constraintlayout/core/motion/key/MotionKeyCycle#SHAPE_TRIANGLE_WAVE() = 2` |
| `static final https://developer.android.com/reference/java/lang/String.html` | `https://developer.android.com/reference/androidx/constraintlayout/core/motion/key/MotionKeyCycle#WAVE_OFFSET() = "waveOffset"` |
| `static final https://developer.android.com/reference/java/lang/String.html` | `https://developer.android.com/reference/androidx/constraintlayout/core/motion/key/MotionKeyCycle#WAVE_PERIOD() = "wavePeriod"` |
| `static final https://developer.android.com/reference/java/lang/String.html` | `https://developer.android.com/reference/androidx/constraintlayout/core/motion/key/MotionKeyCycle#WAVE_PHASE() = "wavePhase"` |
| `static final https://developer.android.com/reference/java/lang/String.html` | `https://developer.android.com/reference/androidx/constraintlayout/core/motion/key/MotionKeyCycle#WAVE_SHAPE() = "waveShape"` |

| ### Public constructors |
|---|
| `https://developer.android.com/reference/androidx/constraintlayout/core/motion/key/MotionKeyCycle#MotionKeyCycle()()` |

| ### Public methods |
|---|---|
| `void` | `https://developer.android.com/reference/androidx/constraintlayout/core/motion/key/MotionKeyCycle#addCycleValues(java.util.HashMap<java.lang.String,androidx.constraintlayout.core.motion.utils.KeyCycleOscillator>)(https://developer.android.com/reference/java/util/HashMap.html<https://developer.android.com/reference/java/lang/String.html, https://developer.android.com/reference/androidx/constraintlayout/core/motion/utils/KeyCycleOscillator> oscSet)` |
| `void` | `https://developer.android.com/reference/androidx/constraintlayout/core/motion/key/MotionKeyCycle#addValues(java.util.HashMap<java.lang.String,androidx.constraintlayout.core.motion.utils.SplineSet>)(https://developer.android.com/reference/java/util/HashMap.html<https://developer.android.com/reference/java/lang/String.html, https://developer.android.com/reference/androidx/constraintlayout/core/motion/utils/SplineSet> splines)` Defines method to add a a view to splines derived form this key frame. |
| `https://developer.android.com/reference/androidx/constraintlayout/core/motion/key/MotionKey` | `https://developer.android.com/reference/androidx/constraintlayout/core/motion/key/MotionKeyCycle#clone()()` |
| `void` | `https://developer.android.com/reference/androidx/constraintlayout/core/motion/key/MotionKeyCycle#dump()()` |
| `void` | `https://developer.android.com/reference/androidx/constraintlayout/core/motion/key/MotionKeyCycle#getAttributeNames(java.util.HashSet<java.lang.String>)(https://developer.android.com/reference/java/util/HashSet.html<https://developer.android.com/reference/java/lang/String.html> attributes)` |
| `int` | `https://developer.android.com/reference/androidx/constraintlayout/core/motion/key/MotionKeyCycle#getId(java.lang.String)(https://developer.android.com/reference/java/lang/String.html name)` |
| `float` | `https://developer.android.com/reference/androidx/constraintlayout/core/motion/key/MotionKeyCycle#getValue(java.lang.String)(https://developer.android.com/reference/java/lang/String.html key)` |
| `void` | `https://developer.android.com/reference/androidx/constraintlayout/core/motion/key/MotionKeyCycle#printAttributes()()` |
| `boolean` | `https://developer.android.com/reference/androidx/constraintlayout/core/motion/key/MotionKeyCycle#setValue(int,float)(int type, float value)` Used to set float values |
| `boolean` | `https://developer.android.com/reference/androidx/constraintlayout/core/motion/key/MotionKeyCycle#setValue(int,int)(int type, int value)` Used to set integer values |
| `boolean` | `https://developer.android.com/reference/androidx/constraintlayout/core/motion/key/MotionKeyCycle#setValue(int,java.lang.String)(int type, https://developer.android.com/reference/java/lang/String.html value)` Used to set String values |

| ### Inherited Constants |
|---|
| From [androidx.constraintlayout.core.motion.key.MotionKey](https://developer.android.com/reference/androidx/constraintlayout/core/motion/key/MotionKey) |---|---| | `static final https://developer.android.com/reference/java/lang/String.html` | `https://developer.android.com/reference/androidx/constraintlayout/core/motion/key/MotionKey#ALPHA() = "alpha"` | | `static final https://developer.android.com/reference/java/lang/String.html` | `https://developer.android.com/reference/androidx/constraintlayout/core/motion/key/MotionKey#CUSTOM() = "CUSTOM"` | | `static final https://developer.android.com/reference/java/lang/String.html` | `https://developer.android.com/reference/androidx/constraintlayout/core/motion/key/MotionKey#ELEVATION() = "elevation"` | | `static final https://developer.android.com/reference/java/lang/String.html` | `https://developer.android.com/reference/androidx/constraintlayout/core/motion/key/MotionKey#ROTATION() = "rotationZ"` | | `static final https://developer.android.com/reference/java/lang/String.html` | `https://developer.android.com/reference/androidx/constraintlayout/core/motion/key/MotionKey#ROTATION_X() = "rotationX"` | | `static final https://developer.android.com/reference/java/lang/String.html` | `https://developer.android.com/reference/androidx/constraintlayout/core/motion/key/MotionKey#SCALE_X() = "scaleX"` | | `static final https://developer.android.com/reference/java/lang/String.html` | `https://developer.android.com/reference/androidx/constraintlayout/core/motion/key/MotionKey#SCALE_Y() = "scaleY"` | | `static final https://developer.android.com/reference/java/lang/String.html` | `https://developer.android.com/reference/androidx/constraintlayout/core/motion/key/MotionKey#TRANSITION_PATH_ROTATE() = "transitionPathRotate"` | | `static final https://developer.android.com/reference/java/lang/String.html` | `https://developer.android.com/reference/androidx/constraintlayout/core/motion/key/MotionKey#TRANSLATION_X() = "translationX"` | | `static final https://developer.android.com/reference/java/lang/String.html` | `https://developer.android.com/reference/androidx/constraintlayout/core/motion/key/MotionKey#TRANSLATION_Y() = "translationY"` | | `static final https://developer.android.com/reference/java/lang/String.html` | `https://developer.android.com/reference/androidx/constraintlayout/core/motion/key/MotionKey#VISIBILITY() = "visibility"` | |
| From [androidx.constraintlayout.core.motion.utils.TypedValues](https://developer.android.com/reference/androidx/constraintlayout/core/motion/utils/TypedValues) |---|---| | `static final int` | `https://developer.android.com/reference/androidx/constraintlayout/core/motion/utils/TypedValues#BOOLEAN_MASK() = 1` | | `static final int` | `https://developer.android.com/reference/androidx/constraintlayout/core/motion/utils/TypedValues#FLOAT_MASK() = 4` | | `static final int` | `https://developer.android.com/reference/androidx/constraintlayout/core/motion/utils/TypedValues#INT_MASK() = 2` | | `static final int` | `https://developer.android.com/reference/androidx/constraintlayout/core/motion/utils/TypedValues#STRING_MASK() = 8` | | `static final https://developer.android.com/reference/java/lang/String.html` | `https://developer.android.com/reference/androidx/constraintlayout/core/motion/utils/TypedValues#S_CUSTOM() = "CUSTOM"` | | `static final int` | `https://developer.android.com/reference/androidx/constraintlayout/core/motion/utils/TypedValues#TYPE_FRAME_POSITION() = 100` | | `static final int` | `https://developer.android.com/reference/androidx/constraintlayout/core/motion/utils/TypedValues#TYPE_TARGET() = 101` | |

| ### Inherited fields |
|---|
| From [androidx.constraintlayout.core.motion.key.MotionKey](https://developer.android.com/reference/androidx/constraintlayout/core/motion/key/MotionKey) |---|---| | `static int` | `https://developer.android.com/reference/androidx/constraintlayout/core/motion/key/MotionKey#UNSET()` | | `https://developer.android.com/reference/java/util/HashMap.html<https://developer.android.com/reference/java/lang/String.html, https://developer.android.com/reference/androidx/constraintlayout/core/motion/CustomVariable>` | `https://developer.android.com/reference/androidx/constraintlayout/core/motion/key/MotionKey#mCustom()` | | `int` | `https://developer.android.com/reference/androidx/constraintlayout/core/motion/key/MotionKey#mFramePosition()` | | `int` | `https://developer.android.com/reference/androidx/constraintlayout/core/motion/key/MotionKey#mType()` | |

| ### Inherited methods |
|---|
| From [androidx.constraintlayout.core.motion.key.MotionKey](https://developer.android.com/reference/androidx/constraintlayout/core/motion/key/MotionKey) |---|---| | `https://developer.android.com/reference/androidx/constraintlayout/core/motion/key/MotionKey` | `https://developer.android.com/reference/androidx/constraintlayout/core/motion/key/MotionKey#copy(androidx.constraintlayout.core.motion.key.MotionKey)(https://developer.android.com/reference/androidx/constraintlayout/core/motion/key/MotionKey src)` | | `int` | `https://developer.android.com/reference/androidx/constraintlayout/core/motion/key/MotionKey#getFramePosition()()` Gets the current frame position | | `void` | `https://developer.android.com/reference/androidx/constraintlayout/core/motion/key/MotionKey#setCustomAttribute(java.lang.String,int,boolean)(https://developer.android.com/reference/java/lang/String.html name, int type, boolean value)` | | `void` | `https://developer.android.com/reference/androidx/constraintlayout/core/motion/key/MotionKey#setCustomAttribute(java.lang.String,int,float)(https://developer.android.com/reference/java/lang/String.html name, int type, float value)` | | `void` | `https://developer.android.com/reference/androidx/constraintlayout/core/motion/key/MotionKey#setCustomAttribute(java.lang.String,int,int)(https://developer.android.com/reference/java/lang/String.html name, int type, int value)` | | `void` | `https://developer.android.com/reference/androidx/constraintlayout/core/motion/key/MotionKey#setCustomAttribute(java.lang.String,int,java.lang.String)(https://developer.android.com/reference/java/lang/String.html name, int type, https://developer.android.com/reference/java/lang/String.html value)` | | `void` | `https://developer.android.com/reference/androidx/constraintlayout/core/motion/key/MotionKey#setFramePosition(int)(int pos)` sets the frame position | | `void` | `https://developer.android.com/reference/androidx/constraintlayout/core/motion/key/MotionKey#setInterpolation(java.util.HashMap<java.lang.String,java.lang.Integer>)(https://developer.android.com/reference/java/util/HashMap.html<https://developer.android.com/reference/java/lang/String.html, https://developer.android.com/reference/java/lang/Integer.html> 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 | | `boolean` | `https://developer.android.com/reference/androidx/constraintlayout/core/motion/key/MotionKey#setValue(int,boolean)(int type, boolean value)` Used to set boolean values | | `https://developer.android.com/reference/androidx/constraintlayout/core/motion/key/MotionKey` | `https://developer.android.com/reference/androidx/constraintlayout/core/motion/key/MotionKey#setViewId(int)(int id)` | |
| From [androidx.constraintlayout.core.motion.utils.TypedValues](https://developer.android.com/reference/androidx/constraintlayout/core/motion/utils/TypedValues) |---|---| | `abstract boolean` | `https://developer.android.com/reference/androidx/constraintlayout/core/motion/utils/TypedValues#setValue(int,boolean)(int id, boolean value)` Used to set boolean values | | `abstract boolean` | `https://developer.android.com/reference/androidx/constraintlayout/core/motion/utils/TypedValues#setValue(int,float)(int id, float value)` Used to set float values | | `abstract boolean` | `https://developer.android.com/reference/androidx/constraintlayout/core/motion/utils/TypedValues#setValue(int,int)(int id, int value)` Used to set integer values | | `abstract boolean` | `https://developer.android.com/reference/androidx/constraintlayout/core/motion/utils/TypedValues#setValue(int,java.lang.String)(int id, https://developer.android.com/reference/java/lang/String.html value)` Used to set String values | |

## Constants

### KEY_TYPE

Added in [1.1.2](https://developer.android.com/jetpack/androidx/releases/constraintlayout#1.1.2)

```
public static final int KEY_TYPE = 4
```

### SHAPE_BOUNCE

Added in [1.1.2](https://developer.android.com/jetpack/androidx/releases/constraintlayout#1.1.2)

```
public static final int SHAPE_BOUNCE = 6
```

### SHAPE_COS_WAVE

Added in [1.1.2](https://developer.android.com/jetpack/androidx/releases/constraintlayout#1.1.2)

```
public static final int SHAPE_COS_WAVE = 5
```

### SHAPE_REVERSE_SAW_WAVE

Added in [1.1.2](https://developer.android.com/jetpack/androidx/releases/constraintlayout#1.1.2)

```
public static final int SHAPE_REVERSE_SAW_WAVE = 4
```

### SHAPE_SAW_WAVE

Added in [1.1.2](https://developer.android.com/jetpack/androidx/releases/constraintlayout#1.1.2)

```
public static final int SHAPE_SAW_WAVE = 3
```

### SHAPE_SIN_WAVE

Added in [1.1.2](https://developer.android.com/jetpack/androidx/releases/constraintlayout#1.1.2)

```
public static final int SHAPE_SIN_WAVE = 0
```

### SHAPE_SQUARE_WAVE

Added in [1.1.2](https://developer.android.com/jetpack/androidx/releases/constraintlayout#1.1.2)

```
public static final int SHAPE_SQUARE_WAVE = 1
```

### SHAPE_TRIANGLE_WAVE

Added in [1.1.2](https://developer.android.com/jetpack/androidx/releases/constraintlayout#1.1.2)

```
public static final int SHAPE_TRIANGLE_WAVE = 2
```

### WAVE_OFFSET

Added in [1.1.2](https://developer.android.com/jetpack/androidx/releases/constraintlayout#1.1.2)

```
public static final String WAVE_OFFSET = "waveOffset"
```

### WAVE_PERIOD

Added in [1.1.2](https://developer.android.com/jetpack/androidx/releases/constraintlayout#1.1.2)

```
public static final String WAVE_PERIOD = "wavePeriod"
```

### WAVE_PHASE

Added in [1.1.2](https://developer.android.com/jetpack/androidx/releases/constraintlayout#1.1.2)

```
public static final String WAVE_PHASE = "wavePhase"
```

### WAVE_SHAPE

Added in [1.1.2](https://developer.android.com/jetpack/androidx/releases/constraintlayout#1.1.2)

```
public static final String WAVE_SHAPE = "waveShape"
```

## Public constructors

### MotionKeyCycle

Added in 1.1.2

```
public MotionKeyCycle()
```

## Public methods

### addCycleValues

Added in [1.1.2](https://developer.android.com/jetpack/androidx/releases/constraintlayout#1.1.2)

```
public void addCycleValues(HashMap<String, KeyCycleOscillator> oscSet)
```

### addValues

Added in [1.1.2](https://developer.android.com/jetpack/androidx/releases/constraintlayout#1.1.2)

```
public void addValues(HashMap<String, SplineSet> splines)
```

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

| Parameters |
|---|---|
| `https://developer.android.com/reference/java/util/HashMap.html<https://developer.android.com/reference/java/lang/String.html, https://developer.android.com/reference/androidx/constraintlayout/core/motion/utils/SplineSet> splines` | splines to write values to |

### clone

Added in [1.1.2](https://developer.android.com/jetpack/androidx/releases/constraintlayout#1.1.2)

```
public MotionKey clone()
```

### dump

Added in [1.1.2](https://developer.android.com/jetpack/androidx/releases/constraintlayout#1.1.2)

```
public void dump()
```

### getAttributeNames

Added in [1.1.2](https://developer.android.com/jetpack/androidx/releases/constraintlayout#1.1.2)

```
public void getAttributeNames(HashSet<String> attributes)
```

### getId

Added in [1.1.2](https://developer.android.com/jetpack/androidx/releases/constraintlayout#1.1.2)

```
public int getId(String name)
```

### getValue

Added in [1.1.2](https://developer.android.com/jetpack/androidx/releases/constraintlayout#1.1.2)

```
public float getValue(String key)
```

### printAttributes

Added in [1.1.2](https://developer.android.com/jetpack/androidx/releases/constraintlayout#1.1.2)

```
public void printAttributes()
```

### setValue

```
public boolean setValue(int type, float value)
```

Used to set float values

| Returns |
|---|---|
| `boolean` | true if it accepted the value |

### setValue

```
public boolean setValue(int type, int value)
```

Used to set integer values

| Returns |
|---|---|
| `boolean` | true if it accepted the value |

### setValue

```
public boolean setValue(int type, String value)
```

Used to set String values

| Returns |
|---|---|
| `boolean` | true if it accepted the value |