SpatialBiasAlignment

class SpatialBiasAlignment : SpatialAlignment

Creates a weighted alignment that specifies a horizontal, vertical, and depth bias.

Summary

Nested types

Creates a weighted alignment that specifies a depth bias.

Creates a weighted alignment that specifies a horizontal bias.

Creates a weighted alignment that specifies a vertical bias.

Public constructors
SpatialBiasAlignment(
    horizontalBias: Float,
    verticalBias: Float,
    depthBias: Float
)

Public functions
SpatialBiasAlignment
copy(horizontalBias: Float, verticalBias: Float, depthBias: Float)
open Int
depthOffset(depth: Int, space: Int)

Provides the depth offset from the origin of the space to the origin of the content.
open operator Boolean
equals(other: Any?)
open Int
open Int
horizontalOffset(width: Int, space: Int)

Provides the horizontal offset from the origin of the space to the origin of the content.
open Vector3

Provides the origin-based position of the content in the available space.
open String
open Int
verticalOffset(height: Int, space: Int)

Provides the vertical offset from the origin of the space to the origin of the content.

Public properties
Float

Must be within the range of -1, 1 with -1 being back and 1 being front.
Float

Must be within the range of -1, 1 with -1 being left and 1 being right.
Float

Must be within the range of -1, 1 with -1 being bottom and 1 being top.

Public constructors

SpatialBiasAlignment

Added in 1.0.0-alpha01
SpatialBiasAlignment(
    horizontalBias: Float,
    verticalBias: Float,
    depthBias: Float
)
Parameters
horizontalBias: Float

Must be within the range of -1, 1 with -1 being left and 1 being right.
verticalBias: Float

Must be within the range of -1, 1 with -1 being bottom and 1 being top.
depthBias: Float

Must be within the range of -1, 1 with -1 being back and 1 being front.

Public functions

copy

Added in 1.0.0-alpha01
fun copy(
    horizontalBias: Float = this.horizontalBias,
    verticalBias: Float = this.verticalBias,
    depthBias: Float = this.depthBias
): SpatialBiasAlignment

depthOffset

Added in 1.0.0-alpha01
open fun depthOffset(depth: Int, space: Int): Int

Provides the depth offset from the origin of the space to the origin of the content.

Parameters
depth: Int

The content depth in pixels.
space: Int

The available space in pixels.

equals

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

hashCode

open fun hashCode(): Int

horizontalOffset

Added in 1.0.0-alpha01
open fun horizontalOffset(width: Int, space: Int): 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.

position

Added in 1.0.0-alpha01
open fun position(size: IntVolumeSize, space: IntVolumeSize): 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.

toString

open fun toString(): String

verticalOffset

Added in 1.0.0-alpha01
open fun verticalOffset(height: Int, space: Int): Int

Provides the vertical offset from the origin of the space to the origin of the content.

Parameters
height: Int

The content height in pixels.
space: Int

The available space in pixels.

Public properties

depthBias

Added in 1.0.0-alpha01
val depthBias: Float

Must be within the range of -1, 1 with -1 being back and 1 being front.

horizontalBias

Added in 1.0.0-alpha01
val horizontalBias: Float

Must be within the range of -1, 1 with -1 being left and 1 being right.

verticalBias

Added in 1.0.0-alpha01
val verticalBias: Float

Must be within the range of -1, 1 with -1 being bottom and 1 being top.