The vortex field applies an vortex force to the agents.
Attributes
| Attributes | Type | Overridable | Description |
|---|---|---|---|
| weight | double | yes | Weight |
| referencePosition | vector3 | no | The position of the source vortex field |
| referenceAxis | vector3 | no | The axis of the source vortex field |
| distance | double | no | The min distance to the reference position that triggers the vortex force |
| direction | int | no | The angular velocity direction: Clockwise (0), Counterclockwise (1) |
| noiseHeight | double | no | The sin noise height |
| noiseFrequency | double | no | The sin noise frequency |
| maxTurnAngle | double | no | The max turn angle |
| velocityThreshold | double | no | The velocity threshold. If the agent velocity magnitude is lower than this value the agent is not evaluated |
| alignAtInitSimulation | bool | no | If true, the agents will be aligned by the vortex force at the init simulation event if they start the simulation inside the volume of influence |
| alignAtInitFrame | bool | no | If true, the agents will be aligned by the vortex force at the init frame event if they are inside the volume of influence at the current frame |
| debug | bool | no | Activate the debugging mode |
| ignoreNextDirectionalModules | bool | yes | If enabled, all next directional modules in the stack will be ignored. |