VortexForceEffect

parameterTypes

get parameterTypes(): PhysicsBodyParameterTypes

var parameterTypes: PhysicsBodyParameterTypes { get }

The input rigid body parameters.

axis

get axis(): SDKHandle

let axis: SIMD3<Float>

The vortex's rotational axis centered at the origin of the effect.

update

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

func update(parameters: inout ForceEffectParameters)

Calculates the vortex 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, axis: SDKHandle): VortexForceEffect

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

Creates a vortex force effect. - Parameters: - strength: The magnitude of the force. - axis: The vortex's rotational axis centered at the effect origin.

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.