One Logo Pool Ball
RealityFoundation · IOS API REFERENCE

PhysicsSimulationComponent.CollisionOptions

struct · iOS 18.0+ · SDK 27.1

struct CollisionOptions

The options set that defines how a physics simulation reports collisions.

Members (6)

get · iOS 18.0+

reportKinematicVsKinematic

TypeScript
get reportKinematicVsKinematic(): PhysicsSimulationComponent_CollisionOptions
Swift declaration
static let reportKinematicVsKinematic: PhysicsSimulationComponent.CollisionOptions

Reports collisions between kinematic objects.

get · iOS 18.0+

reportKinematicVsStatic

TypeScript
get reportKinematicVsStatic(): PhysicsSimulationComponent_CollisionOptions
Swift declaration
static let reportKinematicVsStatic: PhysicsSimulationComponent.CollisionOptions

Reports collisions between kinematic objects and static objects.

get · iOS 18.0+

all

TypeScript
get all(): PhysicsSimulationComponent_CollisionOptions
Swift declaration
static let all: PhysicsSimulationComponent.CollisionOptions

Reports collisions between kinematic objects and both static and kinematic objects.

get · iOS 18.0+

none

TypeScript
get none(): PhysicsSimulationComponent_CollisionOptions
Swift declaration
static let none: PhysicsSimulationComponent.CollisionOptions

Opts out of reporting collisions.

init · iOS 18.0+

init

TypeScript
init(rawValue: number): PhysicsSimulationComponent_CollisionOptions
Swift declaration
init(rawValue: UInt8)

Creates a new option set from the given raw value. This initializer always succeeds, even if the value passed as `rawValue` exceeds the static properties declared as part of the option set. This example creates an instance of `ShippingOptions` with a raw value beyond the highest element, with a bit mask that effectively contains all the declared static members. let extraOptions = ShippingOptions(rawValue: 255) print(extraOptions.isStrictSuperset(of: .all)) // Prints "true" - Parameter rawValue: The raw value of the option set to create. Each bit of `rawValue` potentially represents an element of the option set, though raw values may include bits that are not defined as distinct values of the `OptionSet` type.

get · iOS 18.0+

rawValue

TypeScript
getRawValue($self: PhysicsSimulationComponent_CollisionOptions): number
Swift declaration
let rawValue: UInt8

The corresponding value of the raw type. A new instance initialized with `rawValue` will be equivalent to this instance. For example: enum PaperSize: String { case A4, A5, Letter, Legal } let selectedSize = PaperSize.Letter print(selectedSize.rawValue) // Prints "Letter" print(selectedSize == PaperSize(rawValue: selectedSize.rawValue)!) // Prints "true"

Skipped declarations

No declarations were skipped in this snapshot.

All RealityFoundation types →