ForceEffectComponent

struct · iOS 18.0+ · SDK 27.1

struct ForceEffectComponent

A component that defines the forces that affect an entity, including custom forces that you define. After you assign a `ForceEffectComponent` to an entity, the force effects in the component apply each physics update for as long as the component and force effects exist. Each ``ForceEffect`` updates sequentially while the physics system accumulates its forces. The center frame of each ``ForceEffect`` coincides with and moves alongside the entity’s position and orientation. To offset this center frame, set the position and orientation. - Note: You can set the ``ForceEffectComponent/simulationState-swift.property`` parameter to ``ForceEffectComponent/SimulationState/pause`` if you want to apply forces later. ### Create forces Use ``ConstantForceEffect`` to apply a constant force in a direction: ```swift let constantForceEffect = ForceEffect(effect: ConstantForceEffect(strength: 1, direction: [1, 0, 0])) ``` RealityKit provides a set of useful forces you can use with `ForceEffectComponent`: - ``ConstantForceEffect`` - ``ConstantRadialForceEffect`` - ``DragForceEffect`` - ``RadialForceEffect`` - ``TurbulenceForceEffect`` - ``VortexForceEffect`` ### Create custom forces To create a custom force effect, define a structure that implements ``ForceEffectProtocol``, then create an instance of ``ForceEffectBase`` with your custom `ForceEffectProtocol` implementation: ```swift // CustomForce implements ForceEffectProtocol, and has a custom parameter, thrustersActive, that determines how the system applies your force to a physics body. let thrusterForce = CustomForce(thrustersActive: true) // Create an instance of ForceEffectBase using your custom force. let thursterForceEffect = ForceEffect(effect: thrusterForce) ``` - Note: To apply force to a physics body with a custom `ForceEffectProtocol`, you must implement and apply forces in ``ForceEffectProtocol/update(parameters:)``. ### Apply forces You can apply multiple forces to your entity at once by including them in `ForceEffectComponent`: ```swift let forceEffectComponent = ForceEffectComponent(effects: [constantForceEffect, thrusterForceEffect]) entity.components.set(forceEffectComponent) ```

Members (6)

get simulationState(): (ForceEffectComponent_SimulationState) | null

var simulationState: ForceEffectComponent.SimulationState?

set simulationState(value: (ForceEffectComponent_SimulationState) | null)

var simulationState: ForceEffectComponent.SimulationState?

static initEffect(effect: SDKHandle): ForceEffectComponent

init(effect: any ForceEffectBase)

static initEffectsSimulationState(effects: Array<SDKHandle>, simulationState?: ForceEffectComponent_SimulationState): ForceEffectComponent

init(effects: [any ForceEffectBase], simulationState: ForceEffectComponent.SimulationState = .start)

get effects(): Array<SDKHandle>

var effects: [any ForceEffectBase]

set effects(value: Array<SDKHandle>)

var effects: [any ForceEffectBase]

All RealityFoundation types →