RealityFoundation · IOS API REFERENCE

PortalComponent.Plane

struct · iOS 18.0+ · SDK 27.1

struct Plane

A representation of a portal as an infinite plane. Enable the corresponding clipping and crossing features by passing this value in ``ClippingMode-swift.enum/plane(_:)`` or ``CrossingMode-swift.enum/plane(_:)``. RealityKit defines the ``position`` and ``normal`` properties in entity local space. The following default values are available: - ``positiveX`` - ``negativeX`` - ``positiveY`` - ``negativeY`` - ``positiveZ`` - ``negativeZ`` See ``PortalComponent`` for example usage.

Members (11)

get · iOS 18.0+

normal

TypeScript

get normal(): SDKHandle

Swift declaration

var normal: SIMD3<Float>

The normal of the portal plane, in entity local space.

set · iOS 18.0+

normal

TypeScript

set normal(value: SDKHandle)

Swift declaration

var normal: SIMD3<Float>

The normal of the portal plane, in entity local space.

init · iOS 18.0+

init

TypeScript

static init(position: SDKHandle, normal: SDKHandle): PortalComponent_Plane

Swift declaration

init(position: SIMD3<Float>, normal: SIMD3<Float>)

Creates a portal plane with position and normal.

get · iOS 18.0+

position

TypeScript

get position(): SDKHandle

Swift declaration

var position: SIMD3<Float>

The position of the portal plane, in entity local space.

set · iOS 18.0+

position

TypeScript

set position(value: SDKHandle)

Swift declaration

var position: SIMD3<Float>

The position of the portal plane, in entity local space.

get · iOS 18.0+

negativeX

TypeScript

static get negativeX(): PortalComponent_Plane

Swift declaration

static let negativeX: PortalComponent.Plane

A portal plane sitting at the origin facing the negative x direction.

get · iOS 18.0+

negativeY

TypeScript

static get negativeY(): PortalComponent_Plane

Swift declaration

static let negativeY: PortalComponent.Plane

A portal plane sitting at the origin facing the negative y direction.

get · iOS 18.0+

negativeZ

TypeScript

static get negativeZ(): PortalComponent_Plane

Swift declaration

static let negativeZ: PortalComponent.Plane

A portal plane sitting at the origin facing the negative z direction.

get · iOS 18.0+

positiveX

TypeScript

static get positiveX(): PortalComponent_Plane

Swift declaration

static let positiveX: PortalComponent.Plane

A portal plane sitting at the origin facing the positive x direction.

get · iOS 18.0+

positiveY

TypeScript

static get positiveY(): PortalComponent_Plane

Swift declaration

static let positiveY: PortalComponent.Plane

A portal plane sitting at the origin facing the positive y direction.

get · iOS 18.0+

positiveZ

TypeScript

static get positiveZ(): PortalComponent_Plane

Swift declaration

static let positiveZ: PortalComponent.Plane

A portal plane sitting at the origin facing the positive z direction.

Skipped declarations

No declarations were skipped in this snapshot.

All RealityFoundation types →