Taos API Reference
    Preparing search index...

    Interface SatellitePackOptions

    Options for SatelliteCatalog.pack.

    interface SatellitePackOptions {
        toWorld: (
            x: number,
            y: number,
            z: number,
            out: { x: number; y: number; z: number },
        ) => void;
        colors: { "0": Rgb; "1": Rgb; "2": Rgb };
        sizes: { "0": number; "1": number; "2": number };
        starlinkOnly?: boolean;
        sunlitOnly?: boolean;
        hidden?: ReadonlySet<number>;
        eclipsedDim?: number;
    }
    Index

    Properties

    toWorld colors sizes starlinkOnly? sunlitOnly? hidden? eclipsedDim?

    Properties

    toWorld: (
        x: number,
        y: number,
        z: number,
        out: { x: number; y: number; z: number },
    ) => void

    Maps an ECEF point (metres) to floating-origin world space (usually geoFrame), writing into out — allocation-free so packing thousands of objects per frame produces no garbage.

    colors: { "0": Rgb; "1": Rgb; "2": Rgb }

    Per-group glow colours (0..1).

    sizes: { "0": number; "1": number; "2": number }

    Per-group base size scale in [0,1] (packed into instance alpha → ×4 px in-shader).

    starlinkOnly?: boolean

    When true, only Starlink + stations are packed (the curated view).

    sunlitOnly?: boolean

    When true, only sunlit objects are packed (the dusk satellite-spotting look).

    hidden?: ReadonlySet<number>

    Catalogue indices to omit from the point layer — e.g. the whole ISS cluster (its many co-orbiting module/segment TLEs), once it's drawn as a real model instead of points.

    eclipsedDim?: number

    Dim factor applied to an eclipsed object's colour when sunlitOnly is false (0 hides, 1 = full). Default 0.25.

    Settings

    Member Visibility

    On This Page

    Properties