One Logo Pool Ball
X
Github
Discord

System

RealityFoundation · IOS API REFERENCE

ClippingComponent

struct · iOS 27.0+ · SDK 27.1

struct ClippingComponent

A component that clips entities and their children to a customizable bounding box volume with feathered edges. The `ClippingComponent` provides a powerful and performant way to clip content in RealityKit. It's particularly useful for: - Creating soft-edge effects with feathered boundaries instead of hard cuts - Creating polished spatial experiences with hierarchical clipping control Add a `ClippingComponent` to an entity by passing it to an entity's ``Entity/ComponentSet/set()`` method. ```swift let windowEntity = Entity() let bounds = BoundingBox(min: SIMD3<Float>(-10, -10, -10), max: SIMD3<Float>(10, 10, 10)) var clipping = ClippingComponent(bounds: bounds) clipping.featheredEdge.falloff = .linear clipping.featheredEdge.positiveEdgeInset = [2, 2, 0.0] // 2-unit feather zone on +X & +Y edges clipping.featheredEdge.negativeEdgeInset = [0.0, 0.0, 0.0] // no feathering on negative edges clipping.shouldClipSelf = true clipping.shouldClipChildren = true windowEntity.components.set(clipping) ```

Members (9)

get · iOS 27.0+

featheredEdge

TypeScript
get featheredEdge(): ClippingComponent_FeatheredEdge
Swift declaration
var featheredEdge: ClippingComponent.FeatheredEdge

The feathering configuration for the clipping boundaries.

set · iOS 27.0+

featheredEdge

TypeScript
set featheredEdge(value: ClippingComponent_FeatheredEdge)
Swift declaration
var featheredEdge: ClippingComponent.FeatheredEdge

The feathering configuration for the clipping boundaries.

get · iOS 27.0+

shouldClipSelf

TypeScript
get shouldClipSelf(): boolean
Swift declaration
var shouldClipSelf: Bool

Controls whether the entity itself is clipped by this component's bounds. When `true`, the entity's own geometry is clipped by the bounding volume. When `false`, only child entities are affected (if `shouldClipChildren` is `true`).

set · iOS 27.0+

shouldClipSelf

TypeScript
set shouldClipSelf(value: boolean)
Swift declaration
var shouldClipSelf: Bool

Controls whether the entity itself is clipped by this component's bounds. When `true`, the entity's own geometry is clipped by the bounding volume. When `false`, only child entities are affected (if `shouldClipChildren` is `true`).

get · iOS 27.0+

shouldClipChildren

TypeScript
get shouldClipChildren(): boolean
Swift declaration
var shouldClipChildren: Bool

Controls whether child entities are clipped by this component's bounds. When `true`, all descendant entities in the hierarchy will be clipped to this entity's clipping bounds. When `false`, only the entity with this component is affected (if `shouldClipSelf` is `true`).

set · iOS 27.0+

shouldClipChildren

TypeScript
set shouldClipChildren(value: boolean)
Swift declaration
var shouldClipChildren: Bool

Controls whether child entities are clipped by this component's bounds. When `true`, all descendant entities in the hierarchy will be clipped to this entity's clipping bounds. When `false`, only the entity with this component is affected (if `shouldClipSelf` is `true`).

get · iOS 27.0+

bounds

TypeScript
get bounds(): BoundingBox
Swift declaration
var bounds: BoundingBox

The bounding box that defines the clipping region in the entity's local coordinate space. Content outside this bounding box will be clipped (hard edge or faded out based on feathering). The bounds are defined relative to the entity's origin and are affected by the entity's transform.

set · iOS 27.0+

bounds

TypeScript
set bounds(value: BoundingBox)
Swift declaration
var bounds: BoundingBox

The bounding box that defines the clipping region in the entity's local coordinate space. Content outside this bounding box will be clipped (hard edge or faded out based on feathering). The bounds are defined relative to the entity's origin and are affected by the entity's transform.

init · iOS 27.0+

init

TypeScript
static init(bounds: BoundingBox): ClippingComponent
Swift declaration
init(bounds: BoundingBox)

Skipped declarations

No declarations were skipped in this snapshot.

All RealityFoundation types →