Contents

clippingPlane

The clipping plane of the portal, in the entity’s local coordinates.

Declaration

var clippingPlane: PortalComponent.ClippingPlane? { get set }

Discussion

When you set this property to a non-nil value, the portal clips meshes inside the portal world that are in front of the clipping plane.

This property is a convenience that maps onto the more general clippingMode. Reading it returns a value only when clippingMode is PortalComponent.ClippingMode.plane(_:); for PortalComponent.ClippingMode.disabled or PortalComponent.ClippingMode.volume(_:), it returns nil.

For new code, prefer clippingMode directly. It supports PortalComponent.ClippingMode.volume(_:) for box-shaped clipping boundaries and pairs naturally with crossingMode.