RealityFoundation · IOS API REFERENCE

ConstantForceEffect

struct · iOS 18.0+ · SDK 27.1

struct ConstantForceEffect

A force effect that exerts a constant force in a direction relative to the effect's transform.

Members (7)

get · iOS 18.0+

parameterTypes

TypeScript

get parameterTypes(): PhysicsBodyParameterTypes

Swift declaration

var parameterTypes: PhysicsBodyParameterTypes { get }

The input rigid body parameters.

method · iOS 18.0+

update

TypeScript

update(parameters: ForceEffectParameters): { $ret: null; $out: { "parameters": ForceEffectParameters } }

Swift declaration

func update(parameters: inout ForceEffectParameters)

Calculates the constant forces for rigid bodies from the force effect. - Parameter parameters: On input, the parameters that calculate forces to the affected physics bodies; on output, the updates to those forces. The framework automatically calls this method for you at each physics simulation step, so you don't need to call it yourself.

Omit the output parameters from the call. The result contains $ret and $out, with parameters inside $out.

init · iOS 18.0+

init

TypeScript

static init(strength: number, direction: SDKHandle): ConstantForceEffect

Swift declaration

init(strength: Double, direction: SIMD3<Float>)

Creates a constant force effect. - Parameters: - strength: The magnitude of the force. - direction: The direction of the force relative to the effect's transform.

get · iOS 18.0+

strength

TypeScript

get strength(): number

Swift declaration

let strength: Float

The magnitude of the force.

get · iOS 18.0+

direction

TypeScript

get direction(): SDKHandle

Swift declaration

let direction: SIMD3<Float>

The direction of the force relative to the effect's transform.

get · iOS 18.0+

forceMode

TypeScript

get forceMode(): ForceMode

Swift declaration

var forceMode: ForceMode

The type of force this effect applies.

set · iOS 18.0+

forceMode

TypeScript

set forceMode(value: ForceMode)

Swift declaration

var forceMode: ForceMode

The type of force this effect applies.

Skipped declarations

No declarations were skipped in this snapshot.

All RealityFoundation types →