# ClosureDimensionTrait.TranslationDirectionEnum

# ClosureDimensionTrait.TranslationDirectionEnum


```
enum ClosureDimensionTrait.TranslationDirectionEnum : Enum, ClusterEnum
```

<br />

|---|---|---|
| [kotlin.Any](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-any/index.html) |||
| ↳ | [kotlin.Enum](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-enum/index.html) ||
|   | ↳ | [com.google.home.matter.standard.ClosureDimensionTrait.TranslationDirectionEnum](https://developers.home.google.com/reference/kotlin/com/google/home/matter/standard/ClosureDimensionTrait.TranslationDirectionEnum) |

*** ** * ** ***

Describes the direction of translation for a composed closure.

## Summary

| ### Enum Values |
|---|---|
| `https://developers.home.google.com/reference/kotlin/com/google/home/matter/standard/ClosureDimensionTrait.TranslationDirectionEnum#Backward` | Backward translation. |
| `https://developers.home.google.com/reference/kotlin/com/google/home/matter/standard/ClosureDimensionTrait.TranslationDirectionEnum#DepthMask` | Depth mask translation. |
| `https://developers.home.google.com/reference/kotlin/com/google/home/matter/standard/ClosureDimensionTrait.TranslationDirectionEnum#DepthSymmetry` | Depth symmetry translation. |
| `https://developers.home.google.com/reference/kotlin/com/google/home/matter/standard/ClosureDimensionTrait.TranslationDirectionEnum#Downward` | Downward translation. |
| `https://developers.home.google.com/reference/kotlin/com/google/home/matter/standard/ClosureDimensionTrait.TranslationDirectionEnum#Forward` | Forward translation. |
| `https://developers.home.google.com/reference/kotlin/com/google/home/matter/standard/ClosureDimensionTrait.TranslationDirectionEnum#HorizontalMask` | Horizontal mask translation. |
| `https://developers.home.google.com/reference/kotlin/com/google/home/matter/standard/ClosureDimensionTrait.TranslationDirectionEnum#HorizontalSymmetry` | Horizontal symmetry translation. |
| `https://developers.home.google.com/reference/kotlin/com/google/home/matter/standard/ClosureDimensionTrait.TranslationDirectionEnum#Leftward` | Leftward translation. |
| `https://developers.home.google.com/reference/kotlin/com/google/home/matter/standard/ClosureDimensionTrait.TranslationDirectionEnum#Rightward` | Rightward translation. |
| `https://developers.home.google.com/reference/kotlin/com/google/home/matter/standard/ClosureDimensionTrait.TranslationDirectionEnum#UnknownValue` | The enum value is out of range. |
| `https://developers.home.google.com/reference/kotlin/com/google/home/matter/standard/ClosureDimensionTrait.TranslationDirectionEnum#Upward` | Upward translation. |
| `https://developers.home.google.com/reference/kotlin/com/google/home/matter/standard/ClosureDimensionTrait.TranslationDirectionEnum#VerticalMask` | Vertical mask translation. |
| `https://developers.home.google.com/reference/kotlin/com/google/home/matter/standard/ClosureDimensionTrait.TranslationDirectionEnum#VerticalSymmetry` | Vertical symmetry translation. |

| ### Public functions |
|---|---|
| `https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html` | `@https://developers.home.google.com/reference/kotlin/com/google/home/annotation/HomeExperimentalGenericApi https://developers.home.google.com/reference/kotlin/com/google/home/matter/standard/ClosureDimensionTrait.TranslationDirectionEnum#toDescription()()` |
| `https://developers.home.google.com/reference/kotlin/com/google/home/matter/standard/ClosureDimensionTrait.TranslationDirectionEnum` | `https://developers.home.google.com/reference/kotlin/com/google/home/matter/standard/ClosureDimensionTrait.TranslationDirectionEnum#valueOf(kotlin.String)(value: https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)` Returns the enum constant of this type with the specified name. |
| `https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-array/index.html<https://developers.home.google.com/reference/kotlin/com/google/home/matter/standard/ClosureDimensionTrait.TranslationDirectionEnum>` | `https://developers.home.google.com/reference/kotlin/com/google/home/matter/standard/ClosureDimensionTrait.TranslationDirectionEnum#values()()` Returns an array containing the constants of this enum type, in the order they're declared. |

| ### Public properties |
|---|---|
| `https://developers.home.google.com/reference/kotlin/kotlin/enums/EnumEntries<https://developers.home.google.com/reference/kotlin/com/google/home/matter/standard/ClosureDimensionTrait.TranslationDirectionEnum>` | `https://developers.home.google.com/reference/kotlin/com/google/home/matter/standard/ClosureDimensionTrait.TranslationDirectionEnum#entries()` Returns a representation of an immutable list of all enum entries, in the order they're declared. |
| `open https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html` | `https://developers.home.google.com/reference/kotlin/com/google/home/matter/standard/ClosureDimensionTrait.TranslationDirectionEnum#traitId()` Trait identifier of the Matter Cluster that defines the enum Data Type. |
| `open https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html` | `https://developers.home.google.com/reference/kotlin/com/google/home/matter/standard/ClosureDimensionTrait.TranslationDirectionEnum#typeName()` Name of the Matter Data Type that the enum belongs to, in UpperCamelCase, e.g. "AlarmCodeEnum" from Door Lock Cluster. |
| `open https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-u-long/index.html` | `https://developers.home.google.com/reference/kotlin/com/google/home/matter/standard/ClosureDimensionTrait.TranslationDirectionEnum#value()` Integer identifier of the enum value per the Matter Application Clusters spec, e.g. 1 for Door Lock Cluster AlarmCodeEnum.LockFactoryReset. |

## Enum Values

### Backward

```
val ClosureDimensionTrait.TranslationDirectionEnum.Backward: ClosureDimensionTrait.TranslationDirectionEnum
```

Backward translation.

### DepthMask

```
val ClosureDimensionTrait.TranslationDirectionEnum.DepthMask: ClosureDimensionTrait.TranslationDirectionEnum
```

Depth mask translation.

### DepthSymmetry

```
val ClosureDimensionTrait.TranslationDirectionEnum.DepthSymmetry: ClosureDimensionTrait.TranslationDirectionEnum
```

Depth symmetry translation.

### Downward

```
val ClosureDimensionTrait.TranslationDirectionEnum.Downward: ClosureDimensionTrait.TranslationDirectionEnum
```

Downward translation.

### Forward

```
val ClosureDimensionTrait.TranslationDirectionEnum.Forward: ClosureDimensionTrait.TranslationDirectionEnum
```

Forward translation.

### HorizontalMask

```
val ClosureDimensionTrait.TranslationDirectionEnum.HorizontalMask: ClosureDimensionTrait.TranslationDirectionEnum
```

Horizontal mask translation.

### HorizontalSymmetry

```
val ClosureDimensionTrait.TranslationDirectionEnum.HorizontalSymmetry: ClosureDimensionTrait.TranslationDirectionEnum
```

Horizontal symmetry translation.

### Leftward

```
val ClosureDimensionTrait.TranslationDirectionEnum.Leftward: ClosureDimensionTrait.TranslationDirectionEnum
```

Leftward translation.

### Rightward

```
val ClosureDimensionTrait.TranslationDirectionEnum.Rightward: ClosureDimensionTrait.TranslationDirectionEnum
```

Rightward translation.

### UnknownValue

```
val ClosureDimensionTrait.TranslationDirectionEnum.UnknownValue: ClosureDimensionTrait.TranslationDirectionEnum
```

The enum value is out of range. For example, a newer Matter cluster definition may support enum values not yet supported by the Home APIs.

### Upward

```
val ClosureDimensionTrait.TranslationDirectionEnum.Upward: ClosureDimensionTrait.TranslationDirectionEnum
```

Upward translation.

### VerticalMask

```
val ClosureDimensionTrait.TranslationDirectionEnum.VerticalMask: ClosureDimensionTrait.TranslationDirectionEnum
```

Vertical mask translation.

### VerticalSymmetry

```
val ClosureDimensionTrait.TranslationDirectionEnum.VerticalSymmetry: ClosureDimensionTrait.TranslationDirectionEnum
```

Vertical symmetry translation.

## Public functions

### toDescription

```
@HomeExperimentalGenericApi
fun toDescription(): String
```

### valueOf

```
fun valueOf(value: String): ClosureDimensionTrait.TranslationDirectionEnum
```

Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)

| Throws |
|---|---|
| `https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-illegal-argument-exception/index.html` | if this enum type has no constant with the specified name |

### values

```
fun values(): Array<ClosureDimensionTrait.TranslationDirectionEnum>
```

Returns an array containing the constants of this enum type, in the order they're declared.

This method may be used to iterate over the constants.

## Public properties

### entries

```
val entries: EnumEntries<ClosureDimensionTrait.TranslationDirectionEnum>
```

Returns a representation of an immutable list of all enum entries, in the order they're declared.

This method may be used to iterate over the enum entries.

### traitId

```
open val traitId: String
```

Trait identifier of the Matter Cluster that defines the enum Data Type. Refer to `https://developers.home.google.com/reference/kotlin/com/google/home/matter/serialization/ClusterId#traitId()` for the format.

### typeName

```
open val typeName: String
```

Name of the Matter Data Type that the enum belongs to, in UpperCamelCase, e.g. "AlarmCodeEnum" from Door Lock Cluster.

### value

```
open val value: ULong
```

Integer identifier of the enum value per the Matter Application Clusters spec, e.g. 1 for Door Lock Cluster AlarmCodeEnum.LockFactoryReset.