CollisionCastHit

struct · iOS 13.0+ · SDK 27.1

struct CollisionCastHit

A hit result of a collision cast. You get a collection of collision cast hits from either the ``Scene/raycast(origin:direction:length:query:mask:relativeTo:)`` method, or the ``Scene/convexCast(convexShape:fromPosition:fromOrientation:toPosition:toOrientation:query:mask:relativeTo:)`` method. Each hit indicates where the ray or the convex shape, starting at a given point and traveling in a given direction, hit a particular entity in the scene. The frame of reference for the position and normal of the hit depends on the reference entity parameter passed to the method that generated the hit. Pass `nil` as the reference to use world space.

Members (6)

get triangleHit(): (CollisionCastHit_TriangleHit) | null

var triangleHit: CollisionCastHit.TriangleHit? { get }

get shapeIndex(): number

var shapeIndex: Int { get }

get entity(): Entity

var entity: Entity { get }

get normal(): SDKHandle

var normal: SIMD3<Float> { get }

get distance(): number

var distance: Float { get }

get position(): SDKHandle

var position: SIMD3<Float> { get }

All RealityFoundation types →