SpatialAlignment
interface SpatialAlignment
SpatialBiasAbsoluteAlignment |
Positions content in 3D space using horizontal, vertical, and depth bias. |
SpatialBiasAlignment |
Positions content in 3D space using horizontal, vertical, and depth bias. |
An interface to calculate the position of a sized box inside an available 3D space. SpatialAlignment is often used to define the alignment of a layout inside a parent layout.
Summary
Nested types |
|---|
interface SpatialAlignment.DepthAn interface to calculate the position of a box of a certain depth inside an available depth. |
interface SpatialAlignment.HorizontalAn interface to calculate the position of a box of a certain width inside an available width. |
interface SpatialAlignment.VerticalAn interface to calculate the position of a box of a certain height inside an available height. |
Public functions |
|
|---|---|
Int |
depthOffset(depth: Int, space: Int)Provides the depth offset from the origin of the space to the origin of the content. |
Int |
horizontalOffset(width: Int, space: Int, layoutDirection: LayoutDirection)Provides the horizontal offset from the origin of the space to the origin of the content. |
Vector3 |
position(Provides the origin-based position of the content in the available space. |
Int |
verticalOffset(height: Int, space: Int)Provides the vertical offset from the origin of the space to the origin of the content. |
Public companion properties
Public functions
depthOffset
fun depthOffset(depth: Int, space: Int): Int
Provides the depth offset from the origin of the space to the origin of the content.
horizontalOffset
fun horizontalOffset(width: Int, space: Int, layoutDirection: LayoutDirection): Int
Provides the horizontal offset from the origin of the space to the origin of the content.
| Parameters | |
|---|---|
width: Int |
The content width in pixels. |
space: Int |
The available space in pixels. |
layoutDirection: LayoutDirection |
LTR or RTL. |
position
fun position(
size: IntVolumeSize,
space: IntVolumeSize,
layoutDirection: LayoutDirection
): Vector3
Provides the origin-based position of the content in the available space.
| Parameters | |
|---|---|
size: IntVolumeSize |
The content size in pixels. |
space: IntVolumeSize |
The available space in pixels. |
layoutDirection: LayoutDirection |
LTR or RTL. |
verticalOffset
fun verticalOffset(height: Int, space: Int): Int
Provides the vertical offset from the origin of the space to the origin of the content.