Cosmos Journeyer API Documentation - v1.10.1
    Preparing search index...

    Interface PlanetaryMassObjectBase<T>

    Describes all celestial bodies (a combination of OrbitalObject, CanHaveRings)

    interface PlanetaryMassObjectBase<T extends OrbitalObjectType> {
        asteroidField: null | AsteroidField;
        model:
            | Extract<DeepReadonly<DarkKnightModel>, { type: T }>
            | Extract<DeepReadonly<JuliaSetModel>, { type: T }>
            | Extract<DeepReadonly<MandelboxModel>, { type: T }>
            | Extract<DeepReadonly<MandelbulbModel>, { type: T }>
            | Extract<DeepReadonly<MengerSpongeModel>, { type: T }>
            | Extract<DeepReadonly<SierpinskiPyramidModel>, { type: T }>
            | Extract<DeepReadonly<GasPlanetModel>, { type: T }>
            | Extract<DeepReadonly<SpaceElevatorModel>, { type: T }>
            | Extract<DeepReadonly<SpaceStationModel>, { type: T }>
            | Extract<DeepReadonly<BlackHoleModel>, { type: T }>
            | Extract<DeepReadonly<NeutronStarModel>, { type: T }>
            | Extract<DeepReadonly<StarModel>, { type: T }>
            | Extract<DeepReadonly<TelluricPlanetModel>, { type: T }>
            | Extract<DeepReadonly<TelluricSatelliteModel>, { type: T }>
            | Extract<DeepReadonly<CustomObjectModel>, { type: T }>;
        ringsUniforms: null | RingsUniforms;
        targetInfo: TargetInfo;
        type: DeepReadonly<T>;
        getBoundingRadius(): number;
        getRadius(): number;
        getTransform(): TransformNode;
        getTypeName(): string;
        updateMaterial(
            stellarObjects: readonly PointLight[],
            deltaSeconds: number,
        ): void;
    }

    Type Parameters

    Hierarchy (View Summary)

    Implemented by

    Index

    Properties

    asteroidField model ringsUniforms targetInfo type

    Methods

    getBoundingRadius getRadius getTransform getTypeName updateMaterial

    Properties

    asteroidField: null | AsteroidField

    Returns the asteroid belt of the object's ring, or null if the object has no rings

    model:
        | Extract<DeepReadonly<DarkKnightModel>, { type: T }>
        | Extract<DeepReadonly<JuliaSetModel>, { type: T }>
        | Extract<DeepReadonly<MandelboxModel>, { type: T }>
        | Extract<DeepReadonly<MandelbulbModel>, { type: T }>
        | Extract<DeepReadonly<MengerSpongeModel>, { type: T }>
        | Extract<DeepReadonly<SierpinskiPyramidModel>, { type: T }>
        | Extract<DeepReadonly<GasPlanetModel>, { type: T }>
        | Extract<DeepReadonly<SpaceElevatorModel>, { type: T }>
        | Extract<DeepReadonly<SpaceStationModel>, { type: T }>
        | Extract<DeepReadonly<BlackHoleModel>, { type: T }>
        | Extract<DeepReadonly<NeutronStarModel>, { type: T }>
        | Extract<DeepReadonly<StarModel>, { type: T }>
        | Extract<DeepReadonly<TelluricPlanetModel>, { type: T }>
        | Extract<DeepReadonly<TelluricSatelliteModel>, { type: T }>
        | Extract<DeepReadonly<CustomObjectModel>, { type: T }>
    ringsUniforms: null | RingsUniforms

    Returns the uniforms used to render the rings, or null if the object has no rings

    targetInfo: TargetInfo
    type: DeepReadonly<T>

    Methods

    Settings

    Member Visibility

    On This Page

    Properties
    Methods