RadialForceEffect

restDistance

get restDistance(): number

let restDistance: Float

A distance at which the rigid bodies receive zero radial force. Use a **non-negative** rate. The force field pulls rigid bodies to the effect's origin along the radial direction if this value is `0`.

parameterTypes

get parameterTypes(): PhysicsBodyParameterTypes

var parameterTypes: PhysicsBodyParameterTypes { get }

The input rigid body parameters.

update

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

func update(parameters: inout ForceEffectParameters)

Calculates the radial 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

static init(strength: number, restDistance: number): RadialForceEffect

init(strength: Double, restDistance: Double)

Creates a radial force effect. - Parameters: - strength: The magnitude of the spring effect—a larger strength simulates a stiffer spring. - restDistance: Objects at this distance will receive zero radial force. Otherwise they will gravitate toward this distance along the radial direction. Objects will be attracted to the origin directly if this property is set to zero.

strength

get strength(): number

let strength: Float

The magnitude of the force.

forceMode

get forceMode(): ForceMode

var forceMode: ForceMode

The type of force this effect applies.

forceMode

set forceMode(value: ForceMode)

var forceMode: ForceMode

The type of force this effect applies.