API reference

Every public class, method, and event in @codexo/exojs. Generated from source.

C

classOrbitalForce

@codexo/exojs-particles / particles / stable

Applies a tangential acceleration around a center point - perpendicular to the radial vector `(particle − center)`. Combined with an attract / repel module that controls the radial distance, this produces orbital, spiral, or vortex motion. `angularSpeed` is the target angular velocity in radians/second. The effective tangential acceleration scales with `radius * angularSpeed`, so distant particles get pushed harder (matching uniform circular motion). Positive values orbit counter-clockwise, negative clockwise. Use cases: galactic spirals, smoke vortices around an attractor, wind eddies. Layer with AttractToPoint for stable orbits. GPU-eligible.

3
props
5
methods
0
events
Import
import { OrbitalForce } from '@codexo/exojs-particles'

Applies a tangential acceleration around a center point - perpendicular to the radial vector `(particle − center)`. Combined with an attract / repel module that controls the radial distance, this produces orbital, spiral, or vortex motion.

`angularSpeed` is the target angular velocity in radians/second. The effective tangential acceleration scales with `radius * angularSpeed`, so distant particles get pushed harder (matching uniform circular motion). Positive values orbit counter-clockwise, negative clockwise.

Use cases: galactic spirals, smoke vortices around an attractor, wind eddies. Layer with AttractToPoint for stable orbits.

GPU-eligible.

Constructors1
new(x: number, y: number, angularSpeed: number): OrbitalForce
Methods5
apply(particles: ParticleBatchThe live particles of one system, addressed by semantic channel. This is the bulk surface an UpdateModule and a ParticleRenderMode operate on. Channels are nam…, dt: number): void
Mutates the live particles for one frame. Runs only on the CPU path: a system whose modules are all GPU-eligible executes wgsl bodies inside its compute shader instead, and never calls this.
destroy(): void
Optional cleanup hook called from ParticleSystem.destroy.
uploadTextures?(device: GPUDevice, textures: ReadonlyMap<string, GPUTexture>): void
Upload texture data (Curve/ColorGradient lookup tables) to the GPU at compile time. Receives the GPUDevice and a map of texture bindings keyed by the name in WgslContribution.textures. Called once after pipeline creation. Required when wgsl declares textures.
wgsl(): WgslContributionWhat an UpdateModule contributes to the system's composite compute shader. `body` runs once per particle in the inner main function, with these locals in scope…
Override to declare a GPU contribution. Returning a WgslContribution makes this module GPU-eligible; omitting (or returning undefined) forces CPU mode for any system that uses this module.
writeUniforms(view: DataView, offset: number): void
Write this module's current uniform values into the shared uniform buffer at byteOffset. Layout must match the field declarations returned by wgsl (in the same order). Receives the current frame dt (seconds). Modules tracking accumulated time (e.g. noise/turbulence) should advance their internal counter here to stay in sync when running in GPU mode (where apply is not called). Required when wgsl declares uniforms. Called every frame by the system before dispatching compute.
Properties3
angularSpeed: number
x: number
y: number
Source
packages/exojs-particles/src/modules/OrbitalForce.ts