VerticalOrbiterProperties

Artifact: androidx.xr.compose.material3:material3

View Source

Added in 1.0.0-alpha10

@ExperimentalMaterial3XrApi
class VerticalOrbiterProperties

---

XR-specific properties for components that use vertically-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 VerticalOrbiterProperties and use it if the CompositionLocal is not set.

Summary

Public constructors
VerticalOrbiterProperties(     offset: Dp,     offsetType: OrbiterOffsetType,     position: ContentEdge.Vertical,     alignment: Alignment.Vertical,     shape: SpatialShape )

Public functions
VerticalOrbiterProperties	copy(     offset: Dp?,     offsetType: OrbiterOffsetType?,     position: ContentEdge.Vertical?,     alignment: Alignment.Vertical?,     shape: SpatialShape? ) Returns a new VerticalOrbiterProperties with one or more properties changed.
open operator Boolean	equals(other: Any?)
open Int	hashCode()
open String	toString()

Public properties
Alignment.Vertical	alignment
Dp	offset
OrbiterOffsetType	offsetType
ContentEdge.Vertical	position
SpatialShape	shape

Public constructors

VerticalOrbiterProperties

Added in 1.0.0-alpha10

VerticalOrbiterProperties(
    offset: Dp,
    offsetType: OrbiterOffsetType,
    position: ContentEdge.Vertical,
    alignment: Alignment.Vertical,
    shape: SpatialShape
)

Public functions

copy

Added in 1.0.0-alpha10

fun copy(
    offset: Dp? = null,
    offsetType: OrbiterOffsetType? = null,
    position: ContentEdge.Vertical? = null,
    alignment: Alignment.Vertical? = null,
    shape: SpatialShape? = null
): VerticalOrbiterProperties

Returns a new VerticalOrbiterProperties 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-alpha10

val alignment: Alignment.Vertical

offset

val offset: Dp

offsetType

val offsetType: OrbiterOffsetType

position

Added in 1.0.0-alpha10

val position: ContentEdge.Vertical

shape

Added in 1.0.0-alpha10

val shape: SpatialShape