resium/src/SkyBox/SkyBox.ts

React components for Cesium

import { SkyBox as CesiumSkyBox } from "cesium";

import { createCesiumComponent, PickCesiumProps } from "../core";

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

/*
@scope
SkyBox 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 SkyBoxCesiumProps = PickCesiumProps<CesiumSkyBox, typeof cesiumProps>;

export type SkyBoxProps = SkyBoxCesiumProps;

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

const SkyBox = createCesiumComponent<CesiumSkyBox, SkyBoxProps>({
  name: "SkyBox",
  create: context => context.scene?.skyBox,
  cesiumProps,
  setCesiumPropsAfterCreate: true,
});

export default SkyBox;