Class SolarSystem

constructor

• new SolarSystem(__namedParameters?: SolarSystemOptions): SolarSystem

  Creates the view; anything not given uses DEFAULT_SOLAR_SYSTEM.

  Parameters

  • __namedParameters: SolarSystemOptions = {}

  Returns SolarSystem

Readonlylight

Readonlyobject

settings

system

time

originPosition

• get originPosition(): Vec3

  Floating-origin position of the origin body (plus offset) at the last update, star frame, metres.

  Returns Vec3

bodyMatrix

• bodyMatrix(name: string, target?: Matrix4): Matrix4

  Matrix placing a body's frame in render space at true scale (settings.scale, no exaggeration): body-frame metres → render units. Use it as the matrix of a planet World terrain so it sits on (and spins with) the home planet: terrain.matrixAutoUpdate = false; solar.bodyMatrix('home', terrain.matrix).

  Parameters

  • name: string
  • target: Matrix4 = ...

  Returns Matrix4

bodyTransform

• bodyTransform(name: string): BodyTransform

  Where a body is drawn after the last update.

  Parameters

  • name: string

  Returns BodyTransform

  Throws

  If there is no such body.

dispose

• dispose(): void

  Frees GPU resources (your own materials are left alone).

  Returns void

reset

• reset(input?: SolarSystemInput): this

  Replaces all settings; anything not given goes back to DEFAULT_SOLAR_SYSTEM.

  Parameters

  • input: SolarSystemInput = {}

  Returns this

set

• set(input: SolarSystemInput): this

  Merges settings.

  Parameters

  • input: SolarSystemInput

  Returns this

setModel

• setModel(model: StarSystem): this

  Swaps the system model (e.g. after sky.system was rebuilt).

  Parameters

  • model: StarSystem

  Returns this

toRender

• toRender(p: Vec3, out?: Vector3): Vector3

  Converts a star-frame position (metres) to render space (no distance compression).

  Parameters

  • p: Vec3
  • out: Vector3 = ...

  Returns Vector3

update

• update(time: number, camera?: Camera): void

  Moves everything to time (seconds since J2000).

  Parameters

  • time: number
  • Optionalcamera: Camera

    Used for distance compression; omit to draw everything at true distance.

  Returns void