@juun-roh/cesium-utils 0.4.2 → 0.4.4

package/dist/highlight/index.d.cts

@@ -1,245 +0,0 @@
-import { Color, Viewer, Entity, Primitive, GroundPrimitive, Model, Cesium3DTileset, Cesium3DTileFeature } from 'cesium';
-
-/**
- * @class
- * Lightweight multiton highlight manager for Cesium using flyweight pattern.
- *
- * @example
- * ```
- * // Setup
- * const viewer1 = new Viewer('cesiumContainer1');
- * const viewer2 = new Viewer('cesiumContainer2');
- *
- * const highlighter1 = Highlight.getInstance(viewer1);
- * const highlighter2 = Highlight.getInstance(viewer2);
- *
- * // This highlight only affects viewer1
- * highlighter1.show(someEntity, { color: Color.RED });
- *
- * // This highlight only affects viewer2
- * highlighter2.show(someEntity, { color: Color.BLUE });
- *
- * // When done with viewers
- * Highlight.releaseInstance(viewer1);
- * Highlight.releaseInstance(viewer2);
- * viewer1.destroy();
- * viewer2.destroy();
- * ```
- */
-declare class Highlight {
-    private static instances;
-    private _surface;
-    private _silhouette;
-    private _color;
-    /**
-     * Creates a new `Highlight` instance.
-     * @private Use {@link getInstance `Highlight.getInstance()`}
-     * @param viewer A viewer to create highlight entity in
-     */
-    private constructor();
-    /** Gets the highlight color. */
-    get color(): Color;
-    /**
-     * Sets the highlight color.
-     * @param color The new color for highlights
-     */
-    set color(color: Color);
-    /**
-     * Gets or creates highlight instance from a viewer.
-     * @param viewer The viewer to get or create a new instance from.
-     */
-    static getInstance(viewer: Viewer): Highlight;
-    /**
-     * Releases the highlight instance associated with a viewer.
-     * @param viewer The viewer whose highlight instance should be released.
-     */
-    static releaseInstance(viewer: Viewer): void;
-    /**
-     * Highlights a picked object or a direct instance.
-     * @param picked The result of `Scene.pick()` or direct instance to be highlighted.
-     * @param options Optional style for the highlight.
-     * @see {@link Highlight.Options}
-     */
-    show(picked: Highlight.Picked, options?: Highlight.Options): void | Entity;
-    private _getObject;
-    /**
-     * Clears the current highlight effects.
-     */
-    hide(): void;
-}
-declare namespace Highlight {
-    export interface Base {
-        show(object: any, options?: Highlight.Options): void;
-        hide(): void;
-        destroy(): void;
-        color: Color;
-    }
-    export interface Options {
-        /** Color of the highlight */
-        color?: Color;
-        /** To apply outline style for the highlight */
-        outline?: boolean;
-        /** Outline width */
-        width?: number;
-    }
-    type PickedObject = {
-        id?: Entity;
-        primitive?: Primitive | GroundPrimitive | Model | Cesium3DTileset;
-        tileset?: Cesium3DTileset;
-        detail?: {
-            model?: Model;
-        };
-    };
-    export type Picked = Entity | Cesium3DTileFeature | GroundPrimitive | PickedObject;
-    export {  };
-}
-
-/**
- * @class
- * An implementation for highlighting 3D objects in Cesium.
- *
- * **Supported Object Types:**
- * - `Entity` with model graphics. (adjustable outline width)
- * - `Cesium3DTileset` instances. (fixed outline width)
- *
- * Currently supports outline style only.
- *
- * @example
- * ```typescript
- * const viewer = new Viewer("cesiumContainer");
- * const silhouetteHighlight = new SilhouetteHighlight(viewer);
- *
- * // Highlight an object
- * const entity = viewer.entities.add(new Entity({
- *   model: new ModelGraphics(),
- * }));
- * silhouetteHighlight.show(entity);
- * ```
- */
-declare class SilhouetteHighlight implements Highlight.Base {
-    private _color;
-    private _silhouette;
-    private _composite;
-    private _stages;
-    private _entity?;
-    private _currentObject;
-    private _currentOptions;
-    /**
-     * Creates a new `Silhouette` instance.
-     * @param viewer A viewer to create highlight silhouette in
-     */
-    constructor(viewer: Viewer);
-    /** Gets the highlight color. */
-    get color(): Color;
-    /** Sets the highlight color. */
-    set color(color: Color);
-    /** Gets the currently highlighted object */
-    get currentObject(): Cesium3DTileFeature | Entity | undefined;
-    /**
-     * Highlights a picked `Cesium3DTileset` by updating silhouette composite.
-     * @param object The object to be highlighted.
-     * @param options Optional style for the highlight.
-     */
-    show(object: Cesium3DTileFeature, options?: Highlight.Options): void;
-    /**
-     * Highlights a picked `Entity` by updating the model properties.
-     * @param object The object to be highlighted.
-     * @param options Optional style for the highlight.
-     */
-    show(object: Entity, options?: Highlight.Options): void;
-    /** Clears the current highlight */
-    hide(): void;
-    /** Clean up the instances */
-    destroy(): void;
-    /**
-     * Compares two Highlight.Options objects for equality
-     * @private
-     */
-    private _optionsEqual;
-    /**
-     * Clears all current highlights
-     * @private
-     */
-    private _clearHighlights;
-}
-
-/**
- * @class
- * A flyweight implementation for highlighting 2D surface objects in Cesium.
- *
- * This class provides highlighting for ground-clamped geometries (polygons, polylines, rectangles)
- *
- * **Supported Geometry Types:**
- * - `Entity` with polygon, polyline, or rectangle graphics
- * - `GroundPrimitive` instances
- *
- * **Highlighting Modes:**
- * - **Fill mode** (default): Creates a filled geometry using the original shape
- * - **Outline mode**: Creates a polyline outline of the original geometry
- *
- * @example
- * ```typescript
- * // Basic usage
- * const viewer = new Viewer('cesiumContainer');
- * const surfaceHighlight = new SurfaceHighlight(viewer);
- *
- * // Highlight an entity with default red fill
- * const entity = viewer.entities.add(new Entity({
- *   polygon: {
- *     hierarchy: Cartesian3.fromDegreesArray([-75, 35, -74, 35, -74, 36, -75, 36]),
- *     material: Color.BLUE
- *   }
- * }));
- * surfaceHighlight.show(entity);
- * ```
- */
-declare class SurfaceHighlight implements Highlight.Base {
-    private _color;
-    private _entity;
-    private _entities;
-    private _currentObject;
-    private _currentOptions;
-    /**
-     * Creates a new `SurfaceHighlight` instance.
-     * @param viewer A viewer to create highlight entity in
-     */
-    constructor(viewer: Viewer);
-    /** Gets the highlight color. */
-    get color(): Color;
-    /** Sets the highlight color. */
-    set color(color: Color);
-    /** Gets the highlight entity */
-    get entity(): Entity;
-    /** Gets the currently highlighted object */
-    get currentObject(): Entity | GroundPrimitive | undefined;
-    /**
-     * Highlights a picked object by updating the reusable entity
-     * @param object The object to be highlighted.
-     * @param options Optional style for the highlight.
-     * @see {@link Highlight.Options}
-     */
-    show(object: Entity | GroundPrimitive, options?: Highlight.Options): Entity | undefined;
-    /**
-     * Clears the current highlight
-     */
-    hide(): void;
-    /** Clean up the instances */
-    destroy(): void;
-    /**
-     * Compares two Highlight.Options objects for equality
-     * @private
-     */
-    private _optionsEqual;
-    /**
-     * Removes all geometry properties from the highlight entity
-     * @private
-     */
-    private _clearGeometries;
-    /**
-     * Updates the highlight entity from an Entity object
-     * @private
-     */
-    private _update;
-}
-
-export { Highlight, SilhouetteHighlight, SurfaceHighlight };

package/dist/highlight/index.d.ts

@@ -1,245 +0,0 @@
-import { Color, Viewer, Entity, Primitive, GroundPrimitive, Model, Cesium3DTileset, Cesium3DTileFeature } from 'cesium';
-
-/**
- * @class
- * Lightweight multiton highlight manager for Cesium using flyweight pattern.
- *
- * @example
- * ```
- * // Setup
- * const viewer1 = new Viewer('cesiumContainer1');
- * const viewer2 = new Viewer('cesiumContainer2');
- *
- * const highlighter1 = Highlight.getInstance(viewer1);
- * const highlighter2 = Highlight.getInstance(viewer2);
- *
- * // This highlight only affects viewer1
- * highlighter1.show(someEntity, { color: Color.RED });
- *
- * // This highlight only affects viewer2
- * highlighter2.show(someEntity, { color: Color.BLUE });
- *
- * // When done with viewers
- * Highlight.releaseInstance(viewer1);
- * Highlight.releaseInstance(viewer2);
- * viewer1.destroy();
- * viewer2.destroy();
- * ```
- */
-declare class Highlight {
-    private static instances;
-    private _surface;
-    private _silhouette;
-    private _color;
-    /**
-     * Creates a new `Highlight` instance.
-     * @private Use {@link getInstance `Highlight.getInstance()`}
-     * @param viewer A viewer to create highlight entity in
-     */
-    private constructor();
-    /** Gets the highlight color. */
-    get color(): Color;
-    /**
-     * Sets the highlight color.
-     * @param color The new color for highlights
-     */
-    set color(color: Color);
-    /**
-     * Gets or creates highlight instance from a viewer.
-     * @param viewer The viewer to get or create a new instance from.
-     */
-    static getInstance(viewer: Viewer): Highlight;
-    /**
-     * Releases the highlight instance associated with a viewer.
-     * @param viewer The viewer whose highlight instance should be released.
-     */
-    static releaseInstance(viewer: Viewer): void;
-    /**
-     * Highlights a picked object or a direct instance.
-     * @param picked The result of `Scene.pick()` or direct instance to be highlighted.
-     * @param options Optional style for the highlight.
-     * @see {@link Highlight.Options}
-     */
-    show(picked: Highlight.Picked, options?: Highlight.Options): void | Entity;
-    private _getObject;
-    /**
-     * Clears the current highlight effects.
-     */
-    hide(): void;
-}
-declare namespace Highlight {
-    export interface Base {
-        show(object: any, options?: Highlight.Options): void;
-        hide(): void;
-        destroy(): void;
-        color: Color;
-    }
-    export interface Options {
-        /** Color of the highlight */
-        color?: Color;
-        /** To apply outline style for the highlight */
-        outline?: boolean;
-        /** Outline width */
-        width?: number;
-    }
-    type PickedObject = {
-        id?: Entity;
-        primitive?: Primitive | GroundPrimitive | Model | Cesium3DTileset;
-        tileset?: Cesium3DTileset;
-        detail?: {
-            model?: Model;
-        };
-    };
-    export type Picked = Entity | Cesium3DTileFeature | GroundPrimitive | PickedObject;
-    export {  };
-}
-
-/**
- * @class
- * An implementation for highlighting 3D objects in Cesium.
- *
- * **Supported Object Types:**
- * - `Entity` with model graphics. (adjustable outline width)
- * - `Cesium3DTileset` instances. (fixed outline width)
- *
- * Currently supports outline style only.
- *
- * @example
- * ```typescript
- * const viewer = new Viewer("cesiumContainer");
- * const silhouetteHighlight = new SilhouetteHighlight(viewer);
- *
- * // Highlight an object
- * const entity = viewer.entities.add(new Entity({
- *   model: new ModelGraphics(),
- * }));
- * silhouetteHighlight.show(entity);
- * ```
- */
-declare class SilhouetteHighlight implements Highlight.Base {
-    private _color;
-    private _silhouette;
-    private _composite;
-    private _stages;
-    private _entity?;
-    private _currentObject;
-    private _currentOptions;
-    /**
-     * Creates a new `Silhouette` instance.
-     * @param viewer A viewer to create highlight silhouette in
-     */
-    constructor(viewer: Viewer);
-    /** Gets the highlight color. */
-    get color(): Color;
-    /** Sets the highlight color. */
-    set color(color: Color);
-    /** Gets the currently highlighted object */
-    get currentObject(): Cesium3DTileFeature | Entity | undefined;
-    /**
-     * Highlights a picked `Cesium3DTileset` by updating silhouette composite.
-     * @param object The object to be highlighted.
-     * @param options Optional style for the highlight.
-     */
-    show(object: Cesium3DTileFeature, options?: Highlight.Options): void;
-    /**
-     * Highlights a picked `Entity` by updating the model properties.
-     * @param object The object to be highlighted.
-     * @param options Optional style for the highlight.
-     */
-    show(object: Entity, options?: Highlight.Options): void;
-    /** Clears the current highlight */
-    hide(): void;
-    /** Clean up the instances */
-    destroy(): void;
-    /**
-     * Compares two Highlight.Options objects for equality
-     * @private
-     */
-    private _optionsEqual;
-    /**
-     * Clears all current highlights
-     * @private
-     */
-    private _clearHighlights;
-}
-
-/**
- * @class
- * A flyweight implementation for highlighting 2D surface objects in Cesium.
- *
- * This class provides highlighting for ground-clamped geometries (polygons, polylines, rectangles)
- *
- * **Supported Geometry Types:**
- * - `Entity` with polygon, polyline, or rectangle graphics
- * - `GroundPrimitive` instances
- *
- * **Highlighting Modes:**
- * - **Fill mode** (default): Creates a filled geometry using the original shape
- * - **Outline mode**: Creates a polyline outline of the original geometry
- *
- * @example
- * ```typescript
- * // Basic usage
- * const viewer = new Viewer('cesiumContainer');
- * const surfaceHighlight = new SurfaceHighlight(viewer);
- *
- * // Highlight an entity with default red fill
- * const entity = viewer.entities.add(new Entity({
- *   polygon: {
- *     hierarchy: Cartesian3.fromDegreesArray([-75, 35, -74, 35, -74, 36, -75, 36]),
- *     material: Color.BLUE
- *   }
- * }));
- * surfaceHighlight.show(entity);
- * ```
- */
-declare class SurfaceHighlight implements Highlight.Base {
-    private _color;
-    private _entity;
-    private _entities;
-    private _currentObject;
-    private _currentOptions;
-    /**
-     * Creates a new `SurfaceHighlight` instance.
-     * @param viewer A viewer to create highlight entity in
-     */
-    constructor(viewer: Viewer);
-    /** Gets the highlight color. */
-    get color(): Color;
-    /** Sets the highlight color. */
-    set color(color: Color);
-    /** Gets the highlight entity */
-    get entity(): Entity;
-    /** Gets the currently highlighted object */
-    get currentObject(): Entity | GroundPrimitive | undefined;
-    /**
-     * Highlights a picked object by updating the reusable entity
-     * @param object The object to be highlighted.
-     * @param options Optional style for the highlight.
-     * @see {@link Highlight.Options}
-     */
-    show(object: Entity | GroundPrimitive, options?: Highlight.Options): Entity | undefined;
-    /**
-     * Clears the current highlight
-     */
-    hide(): void;
-    /** Clean up the instances */
-    destroy(): void;
-    /**
-     * Compares two Highlight.Options objects for equality
-     * @private
-     */
-    private _optionsEqual;
-    /**
-     * Removes all geometry properties from the highlight entity
-     * @private
-     */
-    private _clearGeometries;
-    /**
-     * Updates the highlight entity from an Entity object
-     * @private
-     */
-    private _update;
-}
-
-export { Highlight, SilhouetteHighlight, SurfaceHighlight };

package/dist/hybrid-terrain-provider-Th8n2hZ1.d.cts

@@ -1,180 +0,0 @@
-import { TerrainProvider, TilingScheme, TileAvailability, Credit, Request, TerrainData } from 'cesium';
-
-/**
- * @class
- * Provides terrain by delegating requests to different terrain providers
- * based on geographic regions and zoom levels. This allows combining
- * multiple terrain sources into a single seamless terrain.
- *
- * @example
- * ``` typescript
- * // Tile-coordinate based for precise control (multiple levels)
- * const customTiles: TerrainTiles = new Map();
- * customTiles.set(15, { x: [55852, 55871], y: [9556, 9575] });
- * customTiles.set(16, { x: [111704, 111742], y: [19112, 19150] });
- *
- * const hybridTerrain = new HybridTerrainProvider({
- *   regions: [
- *     {
- *       provider: customProvider,
- *       tiles: customTiles,
- *     }
- *   ],
- *   defaultProvider: worldTerrain
- * });
- *
- * viewer.terrainProvider = hybridTerrain;
- * ```
- */
-declare class HybridTerrainProvider implements TerrainProvider {
-    private _regions;
-    private _defaultProvider;
-    private _fallbackProvider;
-    private _tilingScheme;
-    private _ready;
-    private _availability?;
-    /**
-     * Creates a new `HybridTerrainProvider` instance.
-     * @param options {@link HybridTerrainProvider.ConstructorOptions}
-     * @returns A new `HybridTerrainProvider` instance.
-     */
-    constructor(options: HybridTerrainProvider.ConstructorOptions);
-    /**
-     * Gets a value indicating whether or not the provider is ready for use,
-     * or a promise that resolves when the provider becomes ready.
-     */
-    get ready(): boolean;
-    /**
-     * Gets the tiling scheme used by this provider.
-     */
-    get tilingScheme(): TilingScheme;
-    /**
-     * Gets an object that can be used to determine availability of terrain from this provider.
-     */
-    get availability(): TileAvailability | undefined;
-    /**
-     * Gets the list of terrain regions managed by this provider.
-     */
-    get regions(): readonly HybridTerrainProvider.TerrainRegion[];
-    /**
-     * Gets the default terrain provider.
-     */
-    get defaultProvider(): TerrainProvider;
-    /**
-     * Gets the fallback terrain provider.
-     */
-    get fallbackProvider(): TerrainProvider;
-    /**
-     * Gets the credit to display when this terrain provider is active.  Typically this is used to credit
-     * the source of the terrain.
-     */
-    get credit(): Credit;
-    /**
-     * Gets an event that is raised when the terrain provider encounters an asynchronous error.  By subscribing
-     * to the event, you will be notified of the error and can potentially recover from it.  Event listeners
-     * are passed an instance of `TileProviderError`.
-     */
-    get errorEvent(): any;
-    /**
-     * Gets a value indicating whether or not the provider includes a water mask.  The water mask
-     * indicates which areas of the globe are water rather than land, so they can be rendered
-     * as a reflective surface with animated waves.
-     */
-    get hasWaterMask(): boolean;
-    /** Gets a value indicating whether or not the requested tiles include vertex normals. */
-    get hasVertexNormals(): boolean;
-    /**
-     * Makes sure we load availability data for a tile
-     * @param x - The X coordinate of the tile for which to request geometry.
-     * @param y - The Y coordinate of the tile for which to request geometry.
-     * @param level - The level of the tile for which to request geometry.
-     * @returns Undefined if nothing need to be loaded or a Promise that resolves when all required tiles are loaded
-     */
-    loadTileDataAvailability(x: number, y: number, level: number): Promise<void> | undefined;
-    /**
-     * Gets the maximum geometric error allowed in a tile at a given level.
-     * @param level - The tile level for which to get the maximum geometric error.
-     * @returns The maximum geometric error.
-     */
-    getLevelMaximumGeometricError(level: number): number;
-    /**
-     * Requests the terrain for a given tile coordinate.
-     * @param x The X coordinate of the tile.
-     * @param y The Y coordinate of the tile.
-     * @param level The zoom level of the tile.
-     * @param request The request.
-     * @returns A promise for the requested terrain.
-     */
-    requestTileGeometry(x: number, y: number, level: number, request?: Request): Promise<TerrainData> | undefined;
-    /**
-     * Determines whether data for a tile is available to be loaded. Checks the specified terrain regions first.
-     * @param x - The X coordinate of the tile for which to request geometry.
-     * @param y - The Y coordinate of the tile for which to request geometry.
-     * @param level - The level of the tile for which to request geometry.
-     * @returns Undefined if not supported by the terrain provider, otherwise true or false.
-     */
-    getTileDataAvailable(x: number, y: number, level: number): boolean | undefined;
-}
-/**
- * @namespace
- * Contains types and factory methods for `HybridTerrainProvider` instance.
- */
-declare namespace HybridTerrainProvider {
-    /** Initialization options for `HybridTerrainProvider` constructor. */
-    interface ConstructorOptions {
-        /** An array of terrain regions to include in the hybrid terrain. */
-        regions?: TerrainRegion[];
-        /** Default provider to use outside of specified terrain regions. */
-        defaultProvider: TerrainProvider;
-        /** Optional fallback provider when data is not available from default provider. @default EllipsoidTerrainProvider */
-        fallbackProvider?: TerrainProvider;
-    }
-    /**
-     * A factory function which creates a HybridTerrainProvider from tile-coordinate based regions.
-     * @param regions Array of regions with tile-coordinate bounds
-     * @param defaultProvider Default terrain provider
-     * @param fallbackProvider Optional fallback provider
-     */
-    function fromTileRanges(regions: Array<{
-        provider: TerrainProvider;
-        tiles: Map<number, {
-            x: number | [number, number];
-            y: number | [number, number];
-        }>;
-        levels?: number[];
-    }>, defaultProvider: TerrainProvider, fallbackProvider?: TerrainProvider): HybridTerrainProvider;
-    /** Represents a terrain region with provider and geographic bounds. */
-    interface TerrainRegion {
-        /** The terrain provider for this region. */
-        provider: TerrainProvider;
-        /**
-         * Tile-coordinate based bounds (precise control).
-         * Map of level to tile coordinate ranges for that level.
-         */
-        tiles?: Map<number, {
-            /** X tile coordinate range [min, max] or single value. */
-            x: number | [number, number];
-            /** Y tile coordinate range [min, max] or single value. */
-            y: number | [number, number];
-        }>;
-        /** Optional level constraints. If specified, region only applies to these levels. */
-        levels?: number[];
-    }
-    /**
-     * @namespace
-     * Utility functions for working with TerrainRegion objects.
-     */
-    namespace TerrainRegion {
-        /**
-         * Checks if a terrain region contains the specified tile.
-         * @param region The terrain region to check
-         * @param x The X coordinate of the tile
-         * @param y The Y coordinate of the tile
-         * @param level The zoom level of the tile
-         * @returns True if the region contains the tile, false otherwise
-         */
-        function contains(region: HybridTerrainProvider.TerrainRegion, x: number, y: number, level: number): boolean;
-    }
-}
-
-export { HybridTerrainProvider as H };