PortalComponent.Volume

struct · iOS 27.0+ · SDK 27.1

struct Volume

A box-shaped region in portal-local space that defines a volumetric portal boundary. Pair this type with ``ClippingMode-swift.enum/volume(_:)`` to clip portal world content to a box, or with ``CrossingMode-swift.enum/volume(_:)`` to allow crossing entities to pass through the box's faces. ``Volume`` describes an axis-aligned box in the portal entity's local coordinate space. The box is centered at ``position`` and spans the full lengths given by ``extents`` along each axis. ``extents`` are full extents, not half-extents — a volume with `extents = [1, 1, 1]` is a one-cubic-meter box. For typical room-sized portals where the box should enclose the portal surface, prefer ``BoundaryStyle/enclosingBox(depth:)``, which derives the X and Y extents from the portal's ``SurfaceStyle`` for you.

Members (5)

get extents(): SDKHandle

var extents: SIMD3<Float>

set extents(value: SDKHandle)

var extents: SIMD3<Float>

static init(position: SDKHandle, extents: SDKHandle): PortalComponent_Volume

init(position: SIMD3<Float> = .zero, extents: SIMD3<Float>)

get position(): SDKHandle

var position: SIMD3<Float>

set position(value: SDKHandle)

var position: SIMD3<Float>

All RealityFoundation types →