<!--
{
  "availability" : [
    "iOS: 18.0.0 -",
    "iPadOS: 18.0.0 -",
    "macCatalyst: 18.0.0 -",
    "macOS: 15.0.0 -",
    "tvOS: 26.0.0 -",
    "visionOS: 2.0.0 -"
  ],
  "documentType" : "symbol",
  "framework" : "RealityKit",
  "identifier" : "/documentation/RealityKit/VortexForceEffect",
  "metadataVersion" : "0.1.0",
  "role" : "Structure",
  "symbol" : {
    "kind" : "Structure",
    "modules" : [
      "RealityKit"
    ],
    "preciseIdentifier" : "s:17RealityFoundation17VortexForceEffectV"
  },
  "title" : "VortexForceEffect"
}
-->

# VortexForceEffect

A force effect whose forces circulate around an axis centered at the origin of the effect.

```
struct VortexForceEffect
```

## Topics

### Initializers

[`init(strength: Double, axis: SIMD3<Float>)`](/documentation/RealityKit/VortexForceEffect/init(strength:axis:))

Creates a vortex force effect.

### Instance Properties

[`let axis: SIMD3<Float>`](/documentation/RealityKit/VortexForceEffect/axis)

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

[`var forceMode: ForceMode`](/documentation/RealityKit/VortexForceEffect/forceMode)

The type of force this effect applies.

[`var parameterTypes: PhysicsBodyParameterTypes`](/documentation/RealityKit/VortexForceEffect/parameterTypes)

The input rigid body parameters.

[`let strength: Float`](/documentation/RealityKit/VortexForceEffect/strength)

The magnitude of the force.

### Instance Methods

[`func update(parameters: inout ForceEffectParameters)`](/documentation/RealityKit/VortexForceEffect/update(parameters:))

Calculates the vortex forces for rigid bodies from the force effect.

## Relationships

### Conforms To

[`Encodable`](/documentation/Swift/Encodable)

[`ForceEffectProtocol`](/documentation/RealityKit/ForceEffectProtocol)

[`Decodable`](/documentation/Swift/Decodable)

---

Copyright &copy; 2026 Apple Inc. All rights reserved. | [Terms of Use](https://www.apple.com/legal/internet-services/terms/site.html) | [Privacy Policy](https://www.apple.com/privacy/privacy-policy)