RealityFoundation · IOS API REFERENCE

GeometricPinsComponent

struct · iOS 18.0+ · SDK 27.1

struct GeometricPinsComponent

A component that stores a sequence of geometric pins. Add, inspect, and remove geometric pins that belong to the entity that owns an instance of `GeometricPinsComponent` by accessing its ``Entity/pins`` property.

Members (5)

method · iOS 18.0+

set

TypeScript

set(pin: GeometricPin): void

Swift declaration

mutating func set(pin: GeometricPin)

Adds a pin to the collection. If the pin's name already exists in the collection, the new value replaces the existing one. - Parameter geometricPin: The pin to add or update.

get · iOS 18.0+

pins

TypeScript

get pins(): Array<GeometricPin>

Swift declaration

var pins: Set<GeometricPin> { get }

The sequence of geometric pins the component owns.

method · iOS 18.0+

removePin

TypeScript

removePin(name: string): (GeometricPin) | null

Swift declaration

@discardableResult mutating func removePin(named name: String) -> GeometricPin?

Removes the pin associated with the name. - Parameter name: The name of the pin to remove.

init · iOS 18.0+

init

TypeScript

static init(): GeometricPinsComponent

Swift declaration

init()

Creates a geometric pins component with an empty sequence of pins.

subscript · iOS 18.0+

subscript

TypeScript

subscript(name: string): (GeometricPin) | null

Swift declaration

subscript(name: String) -> GeometricPin? { get }

Retrieves the pin by its name. - Parameter name: The name of the pin to look up.

Skipped declarations

No declarations were skipped in this snapshot.

All RealityFoundation types →