# OrbiterProperties

> XR-specific properties for components that use aligned [androidx.xr.compose.spatial.Orbiter]s.

## API Reference

> Source set: Android

```kotlin
public class OrbiterProperties(
    public val position: OrbiterPosition,
    public val shape: SpatialShape,
)
```

XR-specific properties for components that use aligned `androidx.xr.compose.spatial.Orbiter`s.

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

The component should also define a publicly-visible default instance of [OrbiterProperties](https://composables.com/jetpack-compose/androidx.xr.compose.material3/material3/classes/OrbiterProperties/api.md) and
use it if the `CompositionLocal` is not set.

## Functions

### copy

> Source set: Android

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

Returns a new [OrbiterProperties](https://composables.com/jetpack-compose/androidx.xr.compose.material3/material3/classes/OrbiterProperties/api.md) with one or more properties changed.

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

### equals

> Source set: Android

```kotlin
override fun equals(other: Any?): Boolean
```

### hashCode

> Source set: Android

```kotlin
override fun hashCode(): Int
```

### toString

> Source set: Android

```kotlin
override fun toString(): String
```
