Class ShootingStars

Meteors drawn as tapered, fading streaks on the far dome. Created by Sky; use it on its own by calling update(dt, state) every frame.

Index

Constructors

Properties

active elapsed object settings

Methods

dispose reset set update

Constructors

constructor

new ShootingStars(input?: ShootingStarsInput): ShootingStars
Creates the meteor layer; anything not given uses DEFAULT_SHOOTING_STARS.
Parameters
- input: ShootingStarsInput = {}
Returns ShootingStars
- Defined in sky/src/shooting-stars.ts:180

Properties

`Readonly`active

active: Meteor[] = []

Meteors in flight after the last update.

elapsed

elapsed: number = 0

Elapsed seconds driving the schedule. Advanced by ShootingStars.update; set it to scrub.

`Readonly`object

object: Mesh<InstancedBufferGeometry, NodeMaterial>

The streak mesh. Add it to your scene.

settings

settings: ShootingStarsOptions = ...

Resolved settings. Change them with ShootingStars.set / ShootingStars.reset.

Methods

dispose

dispose(): void
Frees GPU resources.

Returns void
- Defined in sky/src/shooting-stars.ts:270

reset

reset(input?: ShootingStarsInput): this
Replaces all settings; anything not given goes back to DEFAULT_SHOOTING_STARS.
Parameters
- input: ShootingStarsInput = {}
Returns this
- Defined in sky/src/shooting-stars.ts:220

set

set(input: ShootingStarsInput): this
Merges settings.
Parameters
- input: ShootingStarsInput
Returns this
- Defined in sky/src/shooting-stars.ts:214

update

update(dt: number, state?: SkyState): void
Advances the schedule and refreshes the streaks.
Parameters
- dt: number
  Real seconds since the last frame (0 while paused).
- state: SkyState = DEFAULT_STATE
  Sky state: provides the horizon frame and night (meteors fade out by day).
Returns void
- Defined in sky/src/shooting-stars.ts:237