HorizontalOrbiterProperties

Artifact: androidx.xr.compose.material3:material3

View Source

Added in 1.0.0-alpha02

@ExperimentalMaterial3XrApi
class HorizontalOrbiterProperties

---

XR-specific properties for components that use horizontally-aligned Orbiters.

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

The component should also define a publicly-visible default instance of HorizontalOrbiterProperties and use it if the CompositionLocal is not set.

Summary

Public constructors
HorizontalOrbiterProperties(     offset: EdgeOffset,     position: OrbiterEdge.Horizontal,     alignment: Alignment.Horizontal,     settings: OrbiterSettings,     shape: SpatialShape )

Public functions
HorizontalOrbiterProperties	copy(     offset: EdgeOffset?,     position: OrbiterEdge.Horizontal?,     alignment: Alignment.Horizontal?,     settings: OrbiterSettings?,     shape: SpatialShape? ) Returns a new HorizontalOrbiterProperties with one or more properties changed.
open operator Boolean	equals(other: Any?)
open Int	hashCode()
open String	toString()

Public properties
Alignment.Horizontal	alignment
EdgeOffset	offset
OrbiterEdge.Horizontal	position
OrbiterSettings	settings
SpatialShape	shape

Public constructors

HorizontalOrbiterProperties

HorizontalOrbiterProperties(
    offset: EdgeOffset,
    position: OrbiterEdge.Horizontal,
    alignment: Alignment.Horizontal,
    settings: OrbiterSettings,
    shape: SpatialShape
)

Public functions

copy

Added in 1.0.0-alpha02

fun copy(
    offset: EdgeOffset? = null,
    position: OrbiterEdge.Horizontal? = null,
    alignment: Alignment.Horizontal? = null,
    settings: OrbiterSettings? = null,
    shape: SpatialShape? = null
): HorizontalOrbiterProperties

Returns a new HorizontalOrbiterProperties 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

alignment

Added in 1.0.0-alpha02

val alignment: Alignment.Horizontal

offset

Added in 1.0.0-alpha02

val offset: EdgeOffset

position

Added in 1.0.0-alpha02

val position: OrbiterEdge.Horizontal

settings

Added in 1.0.0-alpha02

val settings: OrbiterSettings

shape

Added in 1.0.0-alpha02

val shape: SpatialShape