threejs-worldgen
    Preparing search index...

    Interface SolarSystemProps

    Props of <SolarSystem>: every SolarSystemInput setting plus the ones below.

    interface SolarSystemProps {
        ambient?: number;
        apsides?: boolean;
        apsisColors?: [string, string];
        apsisSize?: number;
        camera?: Camera;
        children?: ReactNode;
        clock?: Partial<ClockOptions>;
        exaggerateSizes?: number;
        exaggerateStar?: number;
        hidden?: string[];
        materials?: Record<string, Material<MaterialEventMap>>;
        maxDistance?: number;
        orbitColor?: string;
        orbitLines?: boolean;
        orbitOpacity?: number;
        origin?: string;
        originOffset?: [number, number, number];
        ref?: Ref<SolarSystem | null>;
        scale?: number;
        segments?: number;
        starGlow?: number;
        starLight?: number;
        system?: SystemInput;
    }

    Hierarchy (View Summary)

    Index
    ambient? apsides? apsisColors? apsisSize? camera? children? clock? exaggerateSizes? exaggerateStar? hidden? materials? maxDistance? orbitColor? orbitLines? orbitOpacity? origin? originOffset? ref? scale? segments? starGlow? starLight? system?
    ambient?: number

    Light on the night sides of bodies, 0..1.

    apsides?: boolean

    Mark each orbit's periapsis and apoapsis (perigee/apogee, perihelion/aphelion).

    apsisColors?: [string, string]

    Marker colours for [periapsis, apoapsis] (#rrggbb).

    apsisSize?: number

    Marker size, as a fraction of the distance to the camera.

    camera?: Camera

    Camera for distance compression. Defaults to the R3F default camera.

    children?: ReactNode

    Children see the clock through useSkyTime().

    clock?: Partial<ClockOptions>

    Clock settings when used outside <Sky> (inside, the sky's clock and star system are used).

    exaggerateSizes?: number

    Radius multiplier for planets and moons, so they're visible at system scale. Moon orbits widen by its square root.

    exaggerateStar?: number

    Radius multiplier for the star.

    hidden?: string[]

    Names of bodies not to draw (e.g. 'home' when a planet World draws it).

    materials?: Record<string, Material<MaterialEventMap>>

    Your own materials per body name.

    maxDistance?: number

    Beyond this distance from the camera (render units), bodies are pulled in, keeping their apparent size.

    orbitColor?: string

    Orbit line colour (#rrggbb).

    orbitLines?: boolean

    Draw orbit lines.

    orbitOpacity?: number

    Orbit line opacity.

    origin?: string

    Body at the floating origin (render-space 0,0,0).

    originOffset?: [number, number, number]

    Extra offset of the origin from that body, metres (e.g. a spacecraft's position).

    ref?: Ref<SolarSystem | null>

    Receives the underlying SolarSystem instance.

    scale?: number

    Render units per metre (1e-6 = one unit per 1000 km).

    segments?: number

    Sphere segments for bodies.

    starGlow?: number

    Star glow strength.

    starLight?: number

    Starlight intensity on bodies (and on your own materials, through light).

    system?: SystemInput

    The star system (ignored when a StarSystem instance is passed in).

    Settings
    Member Visibility

    On This Page
    Properties