OrbiterAnchorPoint

public sealed class OrbiterAnchorPoint private constructor()

Represents an anchor point for an Orbiter relative to its target.

Each anchor point defines a specific location on the boundary of the target where the orbiter can be attached. The anchor points are sensitive to LayoutDirection, ensuring that concepts like "start" and "end" are correctly interpreted in both LTR and RTL contexts.

For layout direction-agnostic positioning, use the Absolute variants.

Members

TopStart

public object TopStart : OrbiterAnchorPoint()

Attach the Orbiter at the start of the top edge of the content. Start is Left if the layout direction is LTR and Right if the layout direction is RTL.

Functions

calculateAnchorVector

override fun calculateAnchorVector(
            anchorHalfSize: FloatSize2d,
            layoutDirection: LayoutDirection,
            orbiterHalfSize: FloatSize2d,
        ): Vector3

Top

public object Top : OrbiterAnchorPoint()

Attach the Orbiter at the center of the top edge of the content.

Functions

calculateAnchorVector

override fun calculateAnchorVector(
            anchorHalfSize: FloatSize2d,
            layoutDirection: LayoutDirection,
            orbiterHalfSize: FloatSize2d,
        ): Vector3

TopEnd

public object TopEnd : OrbiterAnchorPoint()

Attach the Orbiter at the end of the top edge of the content. End is Right if the layout direction is LTR and Left if the layout direction is RTL.

Functions

calculateAnchorVector

override fun calculateAnchorVector(
            anchorHalfSize: FloatSize2d,
            layoutDirection: LayoutDirection,
            orbiterHalfSize: FloatSize2d,
        ): Vector3

EndTop

public object EndTop : OrbiterAnchorPoint()

Attach the Orbiter at the top of the end edge of the content. End is Right if the layout direction is LTR and Left if the layout direction is RTL.

Functions

calculateAnchorVector

override fun calculateAnchorVector(
            anchorHalfSize: FloatSize2d,
            layoutDirection: LayoutDirection,
            orbiterHalfSize: FloatSize2d,
        ): Vector3

End

public object End : OrbiterAnchorPoint()

Attach the Orbiter at the center of the end edge of the content. End is Right if the layout direction is LTR and Left if the layout direction is RTL.

Functions

calculateAnchorVector

override fun calculateAnchorVector(
            anchorHalfSize: FloatSize2d,
            layoutDirection: LayoutDirection,
            orbiterHalfSize: FloatSize2d,
        ): Vector3

EndBottom

public object EndBottom : OrbiterAnchorPoint()

Attach the Orbiter at the bottom of the end edge of the content. End is Right if the layout direction is LTR and Left if the layout direction is RTL.

Functions

calculateAnchorVector

override fun calculateAnchorVector(
            anchorHalfSize: FloatSize2d,
            layoutDirection: LayoutDirection,
            orbiterHalfSize: FloatSize2d,
        ): Vector3

BottomStart

public object BottomStart : OrbiterAnchorPoint()

Attach the Orbiter at the start of the bottom edge of the content. Start is Left if the layout direction is LTR and Right if the layout direction is RTL.

Functions

calculateAnchorVector

override fun calculateAnchorVector(
            anchorHalfSize: FloatSize2d,
            layoutDirection: LayoutDirection,
            orbiterHalfSize: FloatSize2d,
        ): Vector3

Bottom

public object Bottom : OrbiterAnchorPoint()

Attach the Orbiter at the center of the bottom edge of the content.

Functions

calculateAnchorVector

override fun calculateAnchorVector(
            anchorHalfSize: FloatSize2d,
            layoutDirection: LayoutDirection,
            orbiterHalfSize: FloatSize2d,
        ): Vector3

BottomEnd

public object BottomEnd : OrbiterAnchorPoint()

Attach the Orbiter at the end of the bottom edge of the content. End is Right if the layout direction is LTR and Left if the layout direction is RTL.

Functions

calculateAnchorVector

override fun calculateAnchorVector(
            anchorHalfSize: FloatSize2d,
            layoutDirection: LayoutDirection,
            orbiterHalfSize: FloatSize2d,
        ): Vector3

StartTop

public object StartTop : OrbiterAnchorPoint()

Attach the Orbiter at the top of the start edge of the content. Start is Left if the layout direction is LTR and Right if the layout direction is RTL.

Functions

calculateAnchorVector

override fun calculateAnchorVector(
            anchorHalfSize: FloatSize2d,
            layoutDirection: LayoutDirection,
            orbiterHalfSize: FloatSize2d,
        ): Vector3

Start

public object Start : OrbiterAnchorPoint()

Attach the Orbiter at the center of the start edge of the content. Start is Left if the layout direction is LTR and Right if the layout direction is RTL.

Functions

calculateAnchorVector

override fun calculateAnchorVector(
            anchorHalfSize: FloatSize2d,
            layoutDirection: LayoutDirection,
            orbiterHalfSize: FloatSize2d,
        ): Vector3

StartBottom

public object StartBottom : OrbiterAnchorPoint()

Attach the Orbiter at the bottom of the start edge of the content. Start is Left if the layout direction is LTR and Right if the layout direction is RTL.

Functions

calculateAnchorVector

override fun calculateAnchorVector(
            anchorHalfSize: FloatSize2d,
            layoutDirection: LayoutDirection,
            orbiterHalfSize: FloatSize2d,
        ): Vector3

Absolute

public sealed class Absolute : OrbiterAnchorPoint()

Provides anchor points that are not affected by LayoutDirection.

Members

TopLeft

public object TopLeft : Absolute()

Attach the Orbiter at the left of the top edge of the content.

Functions

calculateAnchorVector

override fun calculateAnchorVector(
                anchorHalfSize: FloatSize2d,
                layoutDirection: LayoutDirection,
                orbiterHalfSize: FloatSize2d,
            ): Vector3

TopRight

public object TopRight : Absolute()

Attach the Orbiter at the right of the top edge of the content.

Functions

calculateAnchorVector

override fun calculateAnchorVector(
                anchorHalfSize: FloatSize2d,
                layoutDirection: LayoutDirection,
                orbiterHalfSize: FloatSize2d,
            ): Vector3

RightTop

public object RightTop : Absolute()

Attach the Orbiter at the top of the right edge of the content.

Functions

calculateAnchorVector

override fun calculateAnchorVector(
                anchorHalfSize: FloatSize2d,
                layoutDirection: LayoutDirection,
                orbiterHalfSize: FloatSize2d,
            ): Vector3

Right

public object Right : Absolute()

Attach the Orbiter at the center of the right edge of the content.

Functions

calculateAnchorVector

override fun calculateAnchorVector(
                anchorHalfSize: FloatSize2d,
                layoutDirection: LayoutDirection,
                orbiterHalfSize: FloatSize2d,
            ): Vector3

RightBottom

public object RightBottom : Absolute()

Attach the Orbiter at the bottom of the right edge of the content.

Functions

calculateAnchorVector

override fun calculateAnchorVector(
                anchorHalfSize: FloatSize2d,
                layoutDirection: LayoutDirection,
                orbiterHalfSize: FloatSize2d,
            ): Vector3

BottomLeft

public object BottomLeft : Absolute()

Attach the Orbiter at the left of the bottom edge of the content.

Functions

calculateAnchorVector

override fun calculateAnchorVector(
                anchorHalfSize: FloatSize2d,
                layoutDirection: LayoutDirection,
                orbiterHalfSize: FloatSize2d,
            ): Vector3

BottomRight

public object BottomRight : Absolute()

Attach the Orbiter at the right of the bottom edge of the content.

Functions

calculateAnchorVector

override fun calculateAnchorVector(
                anchorHalfSize: FloatSize2d,
                layoutDirection: LayoutDirection,
                orbiterHalfSize: FloatSize2d,
            ): Vector3

LeftTop

public object LeftTop : Absolute()

Attach the Orbiter at the top of the left edge of the content.

Functions

calculateAnchorVector

override fun calculateAnchorVector(
                anchorHalfSize: FloatSize2d,
                layoutDirection: LayoutDirection,
                orbiterHalfSize: FloatSize2d,
            ): Vector3

Left

public object Left : Absolute()

Attach the Orbiter at the center of the left edge of the content.

Functions

calculateAnchorVector

override fun calculateAnchorVector(
                anchorHalfSize: FloatSize2d,
                layoutDirection: LayoutDirection,
                orbiterHalfSize: FloatSize2d,
            ): Vector3

LeftBottom

public object LeftBottom : Absolute()

Attach the Orbiter at the bottom of the left edge of the content.

Functions

calculateAnchorVector

override fun calculateAnchorVector(
                anchorHalfSize: FloatSize2d,
                layoutDirection: LayoutDirection,
                orbiterHalfSize: FloatSize2d,
            ): Vector3