resium/src/Sun/Sun.ts

React components for Cesium

import { Sun as CesiumSun } from "cesium";
import { createCesiumComponent, PickCesiumProps } from "../core";

/*
@summary
`Sun` can operate the sun in the scene.
All properties are applied to single sun in the scene.
*/

/*
@scope
Sun can be mounted inside[Viewer](/components/Viewer) or [CesiumWidget](/components/CesiumWidget) components.
It can not be mounted more than once for each Viewer or CesiumWidget.
*/

export type SunCesiumProps = PickCesiumProps<CesiumSun, typeof cesiumProps>;

export type SunProps = SunCesiumProps;

const cesiumProps = ["glowFactor", "show"] as const;

const Sun = createCesiumComponent<CesiumSun, SunProps>({
  name: "Sun",
  create(context) {
    if (!context.scene) return;
    const element = new CesiumSun();
    context.scene.sun = element;
    return element;
  },
  destroy(_element, context) {
    if (context.scene && !context.scene.isDestroyed()) {
      context.scene.sun = new CesiumSun();
    }
  },
  cesiumProps,
  setCesiumPropsAfterCreate: true,
});

export default Sun;