Interstellar Tools

Appearance

Documentation / @interstellar-tools/types / CometInterface

Interface: CometInterface ​

Defined in: celestial-bodies/comets.ts:24

Represents a comet in the solar system simulation.

Cometary Orbital Parameters, all in orbit:

  • Semi-major axis (a): Defines the size of the comet’s orbit in Astronomical Units (AU).
  • Orbital eccentricity (e): Determines how elliptical the orbit is ($0 = $ circular, closer to 1 = highly elliptical).
  • Inclination (i): The tilt of the orbit relative to the ecliptic plane, measured in degrees.
  • Argument of perihelion (w): The angle from the ascending node to the perihelion.
  • Longitude of the ascending node (om): Defines where the orbit crosses the ecliptic.
  • Perihelion distance (q): The closest approach to the Sun, as a distance.
  • Direction (retrograde): true when i > 90°, like Halley's comet.
  • Angle (angle): The true anomaly at J2000, as for every other body.

Drawing (display): colour and a scaled drawing size (not the physical radius), and state a renderer computes; see DisplayInterface.

Properties ​

category ​

ts
category: 'halley-type comet' | 'long-period comet' | 'jupiter-family comet';

Defined in: celestial-bodies/comets.ts:32

Category classification of the comet.

display? ​

ts
optional display?: DisplayInterface;

Defined in: celestial-bodies/comets.ts:46

How to draw the comet: its colour and drawn size, and state a renderer computes.

id ​

ts
id: string;

Defined in: celestial-bodies/comets.ts:26

Stable identifier, used by parent references. Never translated.

name ​

ts
name: string;

Defined in: celestial-bodies/comets.ts:28

Name of the comet (e.g., "Halley", "Hale-Bopp").

orbit ​

ts
orbit: FullOrbitInterface;

Defined in: celestial-bodies/comets.ts:36

Orbit around the parent, with all elements including i, w, om and q.

parent ​

ts
parent: string;

Defined in: celestial-bodies/comets.ts:34

Id of the star the comet orbits (e.g., 'sun').

radius ​

ts
radius: DistanceInterface;

Defined in: celestial-bodies/comets.ts:44

Radius of the comet (for visualization purposes).

type ​

ts
type: 'periodic comet' | 'oort cloud comet' | 'short-period comet';

Defined in: celestial-bodies/comets.ts:30

Type of comet based on its orbital characteristics.

x? ​

ts
optional x?: DistanceInterface;

Defined in: celestial-bodies/comets.ts:38

X-coordinate in a distance-based system (optional).

y? ​

ts
optional y?: DistanceInterface;

Defined in: celestial-bodies/comets.ts:40

Y-coordinate in a distance-based system (optional).

z? ​

ts
optional z?: DistanceInterface;

Defined in: celestial-bodies/comets.ts:42

Z-coordinate in a distance-based system (optional).