RealityFoundation · IOS API REFERENCE

CharacterControllerComponent.Collision

struct · iOS 15.0+ · SDK 27.1

struct Collision

A container that holds collision state for the character controller. All coordinates are in _physics space_, the coordinate system of the physics simulation.

Members (13)

get · iOS 15.0+

hitPosition

TypeScript

get hitPosition(): SDKHandle

Swift declaration

var hitPosition: SIMD3<Float>

Hit position relative to physics origin. In physics space.

set · iOS 15.0+

hitPosition

TypeScript

set hitPosition(value: SDKHandle)

Swift declaration

var hitPosition: SIMD3<Float>

Hit position relative to physics origin. In physics space.

get · iOS 15.0+

moveDistance

TypeScript

get moveDistance(): number

Swift declaration

var moveDistance: Float

Move distance controller was attempting to move. In physics space.

set · iOS 15.0+

moveDistance

TypeScript

set moveDistance(value: number)

Swift declaration

var moveDistance: Float

Move distance controller was attempting to move. In physics space.

get · iOS 15.0+

moveDirection

TypeScript

get moveDirection(): SDKHandle

Swift declaration

var moveDirection: SIMD3<Float>

Move direction controller was moving (unit vector). In physics space.

set · iOS 15.0+

moveDirection

TypeScript

set moveDirection(value: SDKHandle)

Swift declaration

var moveDirection: SIMD3<Float>

Move direction controller was moving (unit vector). In physics space.

init · iOS 15.0+

init

TypeScript

static init(characterEntity: Entity, hitEntity: Entity, hitPosition: SDKHandle, hitNormal: SDKHandle, moveDirection: SDKHandle, moveDistance: number): CharacterControllerComponent_Collision

Swift declaration

init(characterEntity: Entity, hitEntity: Entity, hitPosition: SIMD3<Float>, hitNormal: SIMD3<Float>, moveDirection: SIMD3<Float>, moveDistance: Float)

Create Collision and initialize all fields.

get · iOS 15.0+

characterEntity

TypeScript

get characterEntity(): Entity

Swift declaration

var characterEntity: Entity

Entity owning the character controller component.

set · iOS 15.0+

characterEntity

TypeScript

set characterEntity(value: Entity)

Swift declaration

var characterEntity: Entity

Entity owning the character controller component.

get · iOS 15.0+

hitEntity

TypeScript

get hitEntity(): Entity

Swift declaration

var hitEntity: Entity

The entity that was hit by the character controller.

set · iOS 15.0+

hitEntity

TypeScript

set hitEntity(value: Entity)

Swift declaration

var hitEntity: Entity

The entity that was hit by the character controller.

get · iOS 15.0+

hitNormal

TypeScript

get hitNormal(): SDKHandle

Swift declaration

var hitNormal: SIMD3<Float>

Hit normal relative to physics origin. In physics space.

set · iOS 15.0+

hitNormal

TypeScript

set hitNormal(value: SDKHandle)

Swift declaration

var hitNormal: SIMD3<Float>

Hit normal relative to physics origin. In physics space.

Skipped declarations

No declarations were skipped in this snapshot.

All RealityFoundation types →