# KeyCycle

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/dsl/KeyCycle.java+class:androidx.constraintlayout.core.dsl.KeyCycle) Added in [1.1.2](https://developer.android.com/jetpack/androidx/releases/constraintlayout#1.1.2)

*** ** * ** ***


```
public class KeyCycle extends KeyAttribute
```

<br />

|---|---|---|---|
| [java.lang.Object](https://developer.android.com/reference/java/lang/Object.html) ||||
| ↳ | [androidx.constraintlayout.core.dsl.Keys](https://developer.android.com/reference/androidx/constraintlayout/core/dsl/Keys) |||
|   | ↳ | [androidx.constraintlayout.core.dsl.KeyAttribute](https://developer.android.com/reference/androidx/constraintlayout/core/dsl/KeyAttribute) ||
|   |   | ↳ | [androidx.constraintlayout.core.dsl.KeyCycle](https://developer.android.com/reference/androidx/constraintlayout/core/dsl/KeyCycle) |

*** ** * ** ***

## Summary

| ### Nested types |
|---|
| `public enum https://developer.android.com/reference/androidx/constraintlayout/core/dsl/KeyCycle.Wave` |

| ### Public methods |
|---|---|
| `float` | `https://developer.android.com/reference/androidx/constraintlayout/core/dsl/KeyCycle#getOffset()()` |
| `float` | `https://developer.android.com/reference/androidx/constraintlayout/core/dsl/KeyCycle#getPeriod()()` |
| `float` | `https://developer.android.com/reference/androidx/constraintlayout/core/dsl/KeyCycle#getPhase()()` |
| `https://developer.android.com/reference/androidx/constraintlayout/core/dsl/KeyCycle.Wave` | `https://developer.android.com/reference/androidx/constraintlayout/core/dsl/KeyCycle#getShape()()` |
| `void` | `https://developer.android.com/reference/androidx/constraintlayout/core/dsl/KeyCycle#setOffset(float)(float waveOffset)` |
| `void` | `https://developer.android.com/reference/androidx/constraintlayout/core/dsl/KeyCycle#setPeriod(float)(float wavePeriod)` |
| `void` | `https://developer.android.com/reference/androidx/constraintlayout/core/dsl/KeyCycle#setPhase(float)(float wavePhase)` |
| `void` | `https://developer.android.com/reference/androidx/constraintlayout/core/dsl/KeyCycle#setShape(androidx.constraintlayout.core.dsl.KeyCycle.Wave)(https://developer.android.com/reference/androidx/constraintlayout/core/dsl/KeyCycle.Wave waveShape)` |

| ### Protected methods |
|---|---|
| `void` | `https://developer.android.com/reference/androidx/constraintlayout/core/dsl/KeyCycle#attributesToString(java.lang.StringBuilder)(https://developer.android.com/reference/java/lang/StringBuilder.html builder)` |

| ### Inherited fields |
|---|
| From [androidx.constraintlayout.core.dsl.KeyAttribute](https://developer.android.com/reference/androidx/constraintlayout/core/dsl/KeyAttribute) |---|---| | `https://developer.android.com/reference/java/lang/String.html` | `https://developer.android.com/reference/androidx/constraintlayout/core/dsl/KeyAttribute#TYPE()` | |

| ### Inherited methods |
|---|
| From [androidx.constraintlayout.core.dsl.KeyAttribute](https://developer.android.com/reference/androidx/constraintlayout/core/dsl/KeyAttribute) |---|---| | `float` | `https://developer.android.com/reference/androidx/constraintlayout/core/dsl/KeyAttribute#getAlpha()()` | | `https://developer.android.com/reference/androidx/constraintlayout/core/dsl/KeyAttribute.Fit` | `https://developer.android.com/reference/androidx/constraintlayout/core/dsl/KeyAttribute#getCurveFit()()` | | `float` | `https://developer.android.com/reference/androidx/constraintlayout/core/dsl/KeyAttribute#getPivotX()()` | | `float` | `https://developer.android.com/reference/androidx/constraintlayout/core/dsl/KeyAttribute#getPivotY()()` | | `float` | `https://developer.android.com/reference/androidx/constraintlayout/core/dsl/KeyAttribute#getRotation()()` | | `float` | `https://developer.android.com/reference/androidx/constraintlayout/core/dsl/KeyAttribute#getRotationX()()` | | `float` | `https://developer.android.com/reference/androidx/constraintlayout/core/dsl/KeyAttribute#getRotationY()()` | | `float` | `https://developer.android.com/reference/androidx/constraintlayout/core/dsl/KeyAttribute#getScaleX()()` | | `float` | `https://developer.android.com/reference/androidx/constraintlayout/core/dsl/KeyAttribute#getScaleY()()` | | `https://developer.android.com/reference/java/lang/String.html` | `https://developer.android.com/reference/androidx/constraintlayout/core/dsl/KeyAttribute#getTarget()()` | | `https://developer.android.com/reference/java/lang/String.html` | `https://developer.android.com/reference/androidx/constraintlayout/core/dsl/KeyAttribute#getTransitionEasing()()` | | `float` | `https://developer.android.com/reference/androidx/constraintlayout/core/dsl/KeyAttribute#getTransitionPathRotate()()` | | `float` | `https://developer.android.com/reference/androidx/constraintlayout/core/dsl/KeyAttribute#getTranslationX()()` | | `float` | `https://developer.android.com/reference/androidx/constraintlayout/core/dsl/KeyAttribute#getTranslationY()()` | | `float` | `https://developer.android.com/reference/androidx/constraintlayout/core/dsl/KeyAttribute#getTranslationZ()()` | | `https://developer.android.com/reference/androidx/constraintlayout/core/dsl/KeyAttribute.Visibility` | `https://developer.android.com/reference/androidx/constraintlayout/core/dsl/KeyAttribute#getVisibility()()` | | `void` | `https://developer.android.com/reference/androidx/constraintlayout/core/dsl/KeyAttribute#setAlpha(float)(float alpha)` | | `void` | `https://developer.android.com/reference/androidx/constraintlayout/core/dsl/KeyAttribute#setCurveFit(androidx.constraintlayout.core.dsl.KeyAttribute.Fit)(https://developer.android.com/reference/androidx/constraintlayout/core/dsl/KeyAttribute.Fit curveFit)` | | `void` | `https://developer.android.com/reference/androidx/constraintlayout/core/dsl/KeyAttribute#setPivotX(float)(float pivotX)` | | `void` | `https://developer.android.com/reference/androidx/constraintlayout/core/dsl/KeyAttribute#setPivotY(float)(float pivotY)` | | `void` | `https://developer.android.com/reference/androidx/constraintlayout/core/dsl/KeyAttribute#setRotation(float)(float rotation)` | | `void` | `https://developer.android.com/reference/androidx/constraintlayout/core/dsl/KeyAttribute#setRotationX(float)(float rotationX)` | | `void` | `https://developer.android.com/reference/androidx/constraintlayout/core/dsl/KeyAttribute#setRotationY(float)(float rotationY)` | | `void` | `https://developer.android.com/reference/androidx/constraintlayout/core/dsl/KeyAttribute#setScaleX(float)(float scaleX)` | | `void` | `https://developer.android.com/reference/androidx/constraintlayout/core/dsl/KeyAttribute#setScaleY(float)(float scaleY)` | | `void` | `https://developer.android.com/reference/androidx/constraintlayout/core/dsl/KeyAttribute#setTarget(java.lang.String)(https://developer.android.com/reference/java/lang/String.html target)` | | `void` | `https://developer.android.com/reference/androidx/constraintlayout/core/dsl/KeyAttribute#setTransitionEasing(java.lang.String)(https://developer.android.com/reference/java/lang/String.html transitionEasing)` | | `void` | `https://developer.android.com/reference/androidx/constraintlayout/core/dsl/KeyAttribute#setTransitionPathRotate(float)(float transitionPathRotate)` | | `void` | `https://developer.android.com/reference/androidx/constraintlayout/core/dsl/KeyAttribute#setTranslationX(float)(float translationX)` | | `void` | `https://developer.android.com/reference/androidx/constraintlayout/core/dsl/KeyAttribute#setTranslationY(float)(float translationY)` | | `void` | `https://developer.android.com/reference/androidx/constraintlayout/core/dsl/KeyAttribute#setTranslationZ(float)(float translationZ)` | | `void` | `https://developer.android.com/reference/androidx/constraintlayout/core/dsl/KeyAttribute#setVisibility(androidx.constraintlayout.core.dsl.KeyAttribute.Visibility)(https://developer.android.com/reference/androidx/constraintlayout/core/dsl/KeyAttribute.Visibility visibility)` | | `https://developer.android.com/reference/java/lang/String.html` | `https://developer.android.com/reference/androidx/constraintlayout/core/dsl/KeyAttribute#toString()()` | |
| From [androidx.constraintlayout.core.dsl.Keys](https://developer.android.com/reference/androidx/constraintlayout/core/dsl/Keys) |---|---| | `void` | `https://developer.android.com/reference/androidx/constraintlayout/core/dsl/Keys#append(java.lang.StringBuilder,java.lang.String,java.lang.String[])(https://developer.android.com/reference/java/lang/StringBuilder.html builder, https://developer.android.com/reference/java/lang/String.html name, String[] array)` | | `void` | `https://developer.android.com/reference/androidx/constraintlayout/core/dsl/Keys#append(java.lang.StringBuilder,java.lang.String,float[])(https://developer.android.com/reference/java/lang/StringBuilder.html builder, https://developer.android.com/reference/java/lang/String.html name, float[] array)` | | `void` | `https://developer.android.com/reference/androidx/constraintlayout/core/dsl/Keys#append(java.lang.StringBuilder,java.lang.String,float)(https://developer.android.com/reference/java/lang/StringBuilder.html builder, https://developer.android.com/reference/java/lang/String.html name, float value)` | | `void` | `https://developer.android.com/reference/androidx/constraintlayout/core/dsl/Keys#append(java.lang.StringBuilder,java.lang.String,int)(https://developer.android.com/reference/java/lang/StringBuilder.html builder, https://developer.android.com/reference/java/lang/String.html name, int value)` | | `void` | `https://developer.android.com/reference/androidx/constraintlayout/core/dsl/Keys#append(java.lang.StringBuilder,java.lang.String,java.lang.String)(https://developer.android.com/reference/java/lang/StringBuilder.html builder, https://developer.android.com/reference/java/lang/String.html name, https://developer.android.com/reference/java/lang/String.html value)` | | `https://developer.android.com/reference/java/lang/String.html` | `https://developer.android.com/reference/androidx/constraintlayout/core/dsl/Keys#unpack(java.lang.String[])(String[] str)` | |

## Public methods

### getOffset

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

```
public float getOffset()
```

### getPeriod

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

```
public float getPeriod()
```

### getPhase

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

```
public float getPhase()
```

### getShape

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

```
public KeyCycle.Wave getShape()
```

### setOffset

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

```
public void setOffset(float waveOffset)
```

### setPeriod

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

```
public void setPeriod(float wavePeriod)
```

### setPhase

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

```
public void setPhase(float wavePhase)
```

### setShape

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

```
public void setShape(KeyCycle.Wave waveShape)
```

## Protected methods

### attributesToString

```
protected void attributesToString(StringBuilder builder)
```