Reference
The Sun, Moon and planets: pure parts
import { … } from "@johnmorrisdotca/chikyu-earth/space";Exports
| Name | Kind | What it is |
|---|---|---|
AU_IN_EARTH_RADII | constant | Earth radii in one astronomical unit. |
blend | function | A frame between two others, t from 0 to 1. |
BodyDrawing | type | One body as drawn by a painter: an object of radius 1 at the origin, which the scene places, scales and (for the Sun) turns to face the camera. |
BodyMoon | type | One moon of a planet at a moment: its name, where it is from the planet's centre and how big it is, both in radii of the planet, in scene axes. |
BodyPainter | type | The seam for drawing the Sun, the planets and their moons. |
compress | function | The same direction at a compressed distance from the Earth: the Moon is 10 Earth radii away, and a body k times further than the Moon is k^0.25 times as far here. |
createTrack | function | Answers for any moment from two real ones: at(ms) asks astronomy-engine only when ms leaves the span the last two answers cover, and then looks stepMs ahead, so playing time at a steady rate costs one pair of lookups every stepMs and every draw in between is arithmetic. |
EARTH_RADIUS_KM | constant | The Earth's radius in kilometres, the unit of the scene's distances. |
Frame | type | Where everything is at one moment: positions in astronomical units from the Earth's centre, in scene axes (x to the vernal equinox, y north, z toward -y of the equator). |
frameAt | function | The state of the sky at ms: nine vectors and an angle, in a few tenths of a millisecond. |
MOON_COMPRESSED | constant | The Moon's distance in a compressed view, in Earth radii (the true one is about 60). |
orbitPath | function | The path a planet takes round the Sun, as count points around the orbit that starts where the planet is at ms, relative to the Sun (scene axes, AU). |
PaintContext | type | What the scene tells a painter when it makes a body. |
placeAround | function | A place helio astronomical units from the Sun (a planet, or a point on its orbit), round the Sun at sun. |
placeMoon | function | The Moon, from the Earth's centre. |
placeSun | function | The Sun, from the Earth's centre: in a compressed view always 44 Earth radii away, in its real direction. |
plainPainter | constant | The default look: a sphere in the planet's colour, lit by the Sun, and for the Sun a glowing disc. |
PlanetName | type | One of the planets drawn (Pluto too), by name. |
PLANETS | constant | The planets drawn, nearest the Sun first. |
RADIUS | constant | Radii in Earth radii: the real ones, and ones large enough to see in a compressed view. |
RIDE_FOV | constant | The field of view, in degrees, of a camera riding along at zoom 1 (the Earth's view from outside is 35). |
RideInput | type | What ridePose is asked: the camera's place and its way of travel (any length), where it looks, and the shared controls' yaw, tilt and zoom. |
RideLook | type | Where a riding camera looks: down straight at the Earth's centre (the ground goes by under the camera), or horizon tipped forward along the way it is going until the horizon is a little above the middle of the view. |
ridePose | function | The camera of a body-borne view: at position, looking at the Earth, with the way the body is going at the top of the picture. |
RidePose | type | The camera ridePose works out: where it is, which way it looks, which way is up in the picture, its field of view in degrees, and how big the Earth looks from there (its angular radius in degrees). |
ScaleMode | type | The scale the space view is drawn in: compressed squeezes the distances so the Moon, the Sun and Neptune fit one view, and true keeps the real ones. |
SUN_COMPRESSED | constant | The Sun's distance from the Earth in a compressed view, in Earth radii (the true one is about 23,500). |
truePosition | function | A place in astronomical units from the Earth's centre, at true distance, in Earth radii. |
Vec3 | type | A position or direction as [x, y, z], in the scene's axes (x toward the vernal equinox, y north). |