# OrbiterProperties

Artifact: [androidx.xr.compose.material3:material3](https://developer.android.com/jetpack/androidx/releases/xr-compose-material3) [View Source](https://cs.android.com/search?q=file:androidx/xr/compose/material3/OrbiterProperties.kt+class:androidx.xr.compose.material3.OrbiterProperties) Added in [1.0.0-alpha17](https://developer.android.com/jetpack/androidx/releases/xr-compose-material3#1.0.0-alpha17)


```
@ExperimentalMaterial3XrApi
class OrbiterProperties
```

<br />

*** ** * ** ***

XR-specific properties for components that use aligned `https://developer.android.com/reference/kotlin/androidx/xr/compose/spatial/Orbiter.composable#Orbiter(androidx.xr.compose.spatial.ContentEdge.Horizontal,androidx.compose.ui.unit.Dp,androidx.xr.compose.spatial.OrbiterOffsetType,androidx.compose.ui.Alignment.Horizontal,androidx.xr.compose.subspace.layout.SpatialShape,androidx.compose.ui.unit.Dp,kotlin.Boolean,kotlin.Function0)`s.

These properties should be provided via a `CompositionLocal` for the given component.

The component should also define a publicly-visible default instance of `https://developer.android.com/reference/kotlin/androidx/xr/compose/material3/OrbiterProperties` and use it if the `CompositionLocal` is not set.

## Summary

| ### Public constructors |
|---|
| `https://developer.android.com/reference/kotlin/androidx/xr/compose/material3/OrbiterProperties#OrbiterProperties(androidx.xr.compose.spatial.OrbiterPosition,androidx.xr.compose.subspace.layout.SpatialShape)(position: https://developer.android.com/reference/kotlin/androidx/xr/compose/spatial/OrbiterPosition, shape: https://developer.android.com/reference/kotlin/androidx/xr/compose/subspace/layout/SpatialShape)` |

| ### Public functions |
|---|---|
| `https://developer.android.com/reference/kotlin/androidx/xr/compose/material3/OrbiterProperties` | `https://developer.android.com/reference/kotlin/androidx/xr/compose/material3/OrbiterProperties#copy(androidx.xr.compose.spatial.OrbiterPosition,androidx.xr.compose.subspace.layout.SpatialShape)(position: https://developer.android.com/reference/kotlin/androidx/xr/compose/spatial/OrbiterPosition?, shape: https://developer.android.com/reference/kotlin/androidx/xr/compose/subspace/layout/SpatialShape?)` Returns a new `https://developer.android.com/reference/kotlin/androidx/xr/compose/material3/OrbiterProperties` with one or more properties changed. |
| `open operator https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-boolean/index.html` | `https://developer.android.com/reference/kotlin/androidx/xr/compose/material3/OrbiterProperties#equals(kotlin.Any)(other: https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-any/index.html?)` |
| `open https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-int/index.html` | `https://developer.android.com/reference/kotlin/androidx/xr/compose/material3/OrbiterProperties#hashCode()()` |
| `open https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-string/index.html` | `https://developer.android.com/reference/kotlin/androidx/xr/compose/material3/OrbiterProperties#toString()()` |

| ### Public properties |
|---|---|
| `https://developer.android.com/reference/kotlin/androidx/xr/compose/spatial/OrbiterPosition` | `https://developer.android.com/reference/kotlin/androidx/xr/compose/material3/OrbiterProperties#position()` |
| `https://developer.android.com/reference/kotlin/androidx/xr/compose/subspace/layout/SpatialShape` | `https://developer.android.com/reference/kotlin/androidx/xr/compose/material3/OrbiterProperties#shape()` |

## Public constructors

### OrbiterProperties

Added in [1.0.0-alpha17](https://developer.android.com/jetpack/androidx/releases/xr-compose-material3#1.0.0-alpha17)

```
OrbiterProperties(position: OrbiterPosition, shape: SpatialShape)
```

## Public functions

### copy

Added in [1.0.0-alpha17](https://developer.android.com/jetpack/androidx/releases/xr-compose-material3#1.0.0-alpha17)

```
fun copy(position: OrbiterPosition? = null, shape: SpatialShape? = null): OrbiterProperties
```

Returns a new `https://developer.android.com/reference/kotlin/androidx/xr/compose/material3/OrbiterProperties` with one or more properties changed.

If `null` is provided for any value, the existing value will be used.

### equals

```
open operator fun equals(other: Any?): Boolean
```

### hashCode

```
open fun hashCode(): Int
```

### toString

```
open fun toString(): String
```

## Public properties

### position

Added in [1.0.0-alpha17](https://developer.android.com/jetpack/androidx/releases/xr-compose-material3#1.0.0-alpha17)

```
val position: OrbiterPosition
```

### shape

Added in [1.0.0-alpha17](https://developer.android.com/jetpack/androidx/releases/xr-compose-material3#1.0.0-alpha17)

```
val shape: SpatialShape
```