@juun-roh/cesium-utils 0.4.2 → 0.4.4

package/dist/dev/index.d.cts

@@ -1,222 +0,0 @@
-import { Viewer, Color, Rectangle } from 'cesium';
-import { H as HybridTerrainProvider } from '../hybrid-terrain-provider-Th8n2hZ1.cjs';
-
-/**
- * Utility for managing deprecation warnings in the cesium-utils library.
- * Provides runtime warnings to help developers identify deprecated API usage.
- */
-declare namespace Deprecate {
-    /**
-     * Configuration options for deprecation warnings.
-     */
-    interface Options {
-        /**
-         * Whether to show the warning only once per deprecation message.
-         * @default true
-         */
-        once?: boolean;
-        /**
-         * Custom prefix for the warning message.
-         * @default "[DEPRECATED]"
-         */
-        prefix?: string;
-        /**
-         * Whether to include a stack trace in the warning.
-         * @default true
-         */
-        includeStack?: boolean;
-        /**
-         * Version when the feature will be removed.
-         */
-        removeInVersion?: string;
-    }
-    /**
-     * Displays a deprecation warning message.
-     *
-     * @param message - The deprecation message to display
-     * @param options - Configuration options for the warning
-     *
-     * @example
-     * ```typescript
-     * // Basic usage
-     * deprecationWarning("oldFunction() is deprecated. Use newFunction() instead.");
-     *
-     * // With removal version
-     * deprecationWarning("TerrainArea is deprecated.", {
-     *   removeInVersion: "v0.3.0"
-     * });
-     *
-     * // Allow multiple warnings
-     * deprecationWarning("Repeated warning", { once: false });
-     * ```
-     */
-    function warn(message: string, options?: Options): void;
-    /**
-     * Creates a deprecation wrapper function that shows a warning when called.
-     *
-     * @param fn - The function to wrap
-     * @param message - The deprecation message
-     * @param options - Configuration options for the warning
-     * @returns A wrapped function that shows a deprecation warning when called
-     *
-     * @example
-     * ```typescript
-     * const oldFunction = deprecate(
-     *   () => console.log("old implementation"),
-     *   "oldFunction() is deprecated. Use newFunction() instead."
-     * );
-     *
-     * oldFunction(); // Shows warning and executes function
-     * ```
-     */
-    function deprecate<T extends (...args: any[]) => any>(fn: T, message: string, options?: Options): T;
-    /**
-     * Clears all shown warning messages.
-     * Useful for testing or when you want to reset the warning state.
-     *
-     * @example
-     * ```typescript
-     * clearDeprecationWarnings();
-     * deprecationWarning("This will show again");
-     * ```
-     */
-    function clear(): void;
-    /**
-     * Gets the count of unique deprecation warnings that have been shown.
-     *
-     * @returns The number of unique deprecation warnings shown
-     */
-    function getWarningCount(): number;
-    /**
-     * Checks if a specific deprecation warning has been shown.
-     *
-     * @param message - The deprecation message to check
-     * @returns True if the warning has been shown, false otherwise
-     */
-    function hasShown(message: string): boolean;
-}
-
-/**
- * @class
- * Utility class for visualizing terrain provider boundaries and debugging terrain loading.
- */
-declare class TerrainVisualizer {
-    private _viewer;
-    private _terrainProvider;
-    private _visible;
-    private _tileCoordinatesLayer;
-    private _hybridImageryLayer;
-    private _colors;
-    /**
-     * Creates a new `TerrainVisualizer`.
-     * @param viewer The Cesium viewer instance
-     * @param options {@link TerrainVisualizer.ConstructorOptions}
-     */
-    constructor(viewer: Viewer, options: TerrainVisualizer.ConstructorOptions);
-    /**
-     * Sets the terrain provider to visualize.
-     * @param terrainProvider The terrain provider to visualize.
-     */
-    setTerrainProvider(terrainProvider: HybridTerrainProvider): void;
-    /**
-     * Updates all active visualizations.
-     */
-    update(): void;
-    /**
-     * Clears all visualizations.
-     */
-    clear(): void;
-    /**
-     * Shows terrain visualization using HybridImageryProvider.
-     * Optionally adds tile coordinate grid overlay.
-     * @param options Visualization options
-     */
-    show(options?: {
-        /** Show tile coordinate labels. Default: true */
-        showTileCoordinates?: boolean;
-        /** Transparency level (0-1). Default: 0.5 */
-        alpha?: number;
-    }): void;
-    private _ensureTileCoordinatesLayer;
-    /**
-     * Hides the terrain visualization.
-     */
-    hide(): void;
-    /**
-     * Sets the colors used for visualization.
-     * @param colors Map of role names to colors
-     */
-    setColors(colors: Record<string, Color>): void;
-    /**
-     * Shows terrain regions using HybridImageryProvider (performant, global coverage).
-     * This replaces the entity-based approach with an imagery layer.
-     * @param alpha Transparency level (0-1), default 0.5
-     */
-    showImageryOverlay(alpha?: number): void;
-    /**
-     * Hides the imagery overlay.
-     */
-    hideImageryOverlay(): void;
-    /**
-     * Shows tile coordinate grid overlay.
-     */
-    showTileCoordinates(): void;
-    /**
-     * Hides tile coordinate grid overlay.
-     */
-    hideTileCoordinates(): void;
-    /**
-     * Sets the transparency of the imagery overlay.
-     * @param alpha Transparency level (0-1), where 0 is fully transparent and 1 is fully opaque
-     */
-    setAlpha(alpha: number): void;
-    /**
-     * Flies the camera to focus on a rectangle.
-     * @param rectangle The rectangle to focus on.
-     * @param options {@link Viewer.flyTo}
-     */
-    flyTo(rectangle: Rectangle, options?: {
-        duration?: number;
-    }): void;
-    /** Whether tile coordinates are currently visible. */
-    get tileCoordinatesVisible(): boolean;
-    /** Whether the grid is currently visible. */
-    get visible(): boolean;
-    /** The viewer used in the visualizer */
-    get viewer(): Viewer;
-    /** The colors used in the visualizer */
-    get colors(): Map<string, Color>;
-    /** The hybrid terrain instance used in the visualizer */
-    get terrainProvider(): HybridTerrainProvider;
-}
-/**
- * @namespace
- * Contains types, utility functions, and constants for terrain visualization.
- */
-declare namespace TerrainVisualizer {
-    /** Initialization options for `TerrainVisualizer` constructor. */
-    interface ConstructorOptions {
-        /** Colors to use for different visualization elements */
-        colors?: Record<string, Color>;
-        /** Whether to show tile grid initially. */
-        tile?: boolean;
-        /** Initial zoom level to use for visualizations. */
-        activeLevel?: number;
-        /** Terrain provider to visualize. */
-        terrainProvider: HybridTerrainProvider;
-    }
-    /** Options for {@link TerrainVisualizer.visualize} */
-    interface Options {
-        color?: Color;
-        show?: boolean;
-        maxTilesToShow?: number;
-        levels?: number[];
-        tag?: string;
-        alpha?: number;
-        tileAlpha?: number;
-    }
-}
-
-declare const deprecate: typeof Deprecate.deprecate;
-
-export { Deprecate, TerrainVisualizer, deprecate };

package/dist/dev/index.d.ts

@@ -1,222 +0,0 @@
-import { Viewer, Color, Rectangle } from 'cesium';
-import { H as HybridTerrainProvider } from '../hybrid-terrain-provider-Th8n2hZ1.js';
-
-/**
- * Utility for managing deprecation warnings in the cesium-utils library.
- * Provides runtime warnings to help developers identify deprecated API usage.
- */
-declare namespace Deprecate {
-    /**
-     * Configuration options for deprecation warnings.
-     */
-    interface Options {
-        /**
-         * Whether to show the warning only once per deprecation message.
-         * @default true
-         */
-        once?: boolean;
-        /**
-         * Custom prefix for the warning message.
-         * @default "[DEPRECATED]"
-         */
-        prefix?: string;
-        /**
-         * Whether to include a stack trace in the warning.
-         * @default true
-         */
-        includeStack?: boolean;
-        /**
-         * Version when the feature will be removed.
-         */
-        removeInVersion?: string;
-    }
-    /**
-     * Displays a deprecation warning message.
-     *
-     * @param message - The deprecation message to display
-     * @param options - Configuration options for the warning
-     *
-     * @example
-     * ```typescript
-     * // Basic usage
-     * deprecationWarning("oldFunction() is deprecated. Use newFunction() instead.");
-     *
-     * // With removal version
-     * deprecationWarning("TerrainArea is deprecated.", {
-     *   removeInVersion: "v0.3.0"
-     * });
-     *
-     * // Allow multiple warnings
-     * deprecationWarning("Repeated warning", { once: false });
-     * ```
-     */
-    function warn(message: string, options?: Options): void;
-    /**
-     * Creates a deprecation wrapper function that shows a warning when called.
-     *
-     * @param fn - The function to wrap
-     * @param message - The deprecation message
-     * @param options - Configuration options for the warning
-     * @returns A wrapped function that shows a deprecation warning when called
-     *
-     * @example
-     * ```typescript
-     * const oldFunction = deprecate(
-     *   () => console.log("old implementation"),
-     *   "oldFunction() is deprecated. Use newFunction() instead."
-     * );
-     *
-     * oldFunction(); // Shows warning and executes function
-     * ```
-     */
-    function deprecate<T extends (...args: any[]) => any>(fn: T, message: string, options?: Options): T;
-    /**
-     * Clears all shown warning messages.
-     * Useful for testing or when you want to reset the warning state.
-     *
-     * @example
-     * ```typescript
-     * clearDeprecationWarnings();
-     * deprecationWarning("This will show again");
-     * ```
-     */
-    function clear(): void;
-    /**
-     * Gets the count of unique deprecation warnings that have been shown.
-     *
-     * @returns The number of unique deprecation warnings shown
-     */
-    function getWarningCount(): number;
-    /**
-     * Checks if a specific deprecation warning has been shown.
-     *
-     * @param message - The deprecation message to check
-     * @returns True if the warning has been shown, false otherwise
-     */
-    function hasShown(message: string): boolean;
-}
-
-/**
- * @class
- * Utility class for visualizing terrain provider boundaries and debugging terrain loading.
- */
-declare class TerrainVisualizer {
-    private _viewer;
-    private _terrainProvider;
-    private _visible;
-    private _tileCoordinatesLayer;
-    private _hybridImageryLayer;
-    private _colors;
-    /**
-     * Creates a new `TerrainVisualizer`.
-     * @param viewer The Cesium viewer instance
-     * @param options {@link TerrainVisualizer.ConstructorOptions}
-     */
-    constructor(viewer: Viewer, options: TerrainVisualizer.ConstructorOptions);
-    /**
-     * Sets the terrain provider to visualize.
-     * @param terrainProvider The terrain provider to visualize.
-     */
-    setTerrainProvider(terrainProvider: HybridTerrainProvider): void;
-    /**
-     * Updates all active visualizations.
-     */
-    update(): void;
-    /**
-     * Clears all visualizations.
-     */
-    clear(): void;
-    /**
-     * Shows terrain visualization using HybridImageryProvider.
-     * Optionally adds tile coordinate grid overlay.
-     * @param options Visualization options
-     */
-    show(options?: {
-        /** Show tile coordinate labels. Default: true */
-        showTileCoordinates?: boolean;
-        /** Transparency level (0-1). Default: 0.5 */
-        alpha?: number;
-    }): void;
-    private _ensureTileCoordinatesLayer;
-    /**
-     * Hides the terrain visualization.
-     */
-    hide(): void;
-    /**
-     * Sets the colors used for visualization.
-     * @param colors Map of role names to colors
-     */
-    setColors(colors: Record<string, Color>): void;
-    /**
-     * Shows terrain regions using HybridImageryProvider (performant, global coverage).
-     * This replaces the entity-based approach with an imagery layer.
-     * @param alpha Transparency level (0-1), default 0.5
-     */
-    showImageryOverlay(alpha?: number): void;
-    /**
-     * Hides the imagery overlay.
-     */
-    hideImageryOverlay(): void;
-    /**
-     * Shows tile coordinate grid overlay.
-     */
-    showTileCoordinates(): void;
-    /**
-     * Hides tile coordinate grid overlay.
-     */
-    hideTileCoordinates(): void;
-    /**
-     * Sets the transparency of the imagery overlay.
-     * @param alpha Transparency level (0-1), where 0 is fully transparent and 1 is fully opaque
-     */
-    setAlpha(alpha: number): void;
-    /**
-     * Flies the camera to focus on a rectangle.
-     * @param rectangle The rectangle to focus on.
-     * @param options {@link Viewer.flyTo}
-     */
-    flyTo(rectangle: Rectangle, options?: {
-        duration?: number;
-    }): void;
-    /** Whether tile coordinates are currently visible. */
-    get tileCoordinatesVisible(): boolean;
-    /** Whether the grid is currently visible. */
-    get visible(): boolean;
-    /** The viewer used in the visualizer */
-    get viewer(): Viewer;
-    /** The colors used in the visualizer */
-    get colors(): Map<string, Color>;
-    /** The hybrid terrain instance used in the visualizer */
-    get terrainProvider(): HybridTerrainProvider;
-}
-/**
- * @namespace
- * Contains types, utility functions, and constants for terrain visualization.
- */
-declare namespace TerrainVisualizer {
-    /** Initialization options for `TerrainVisualizer` constructor. */
-    interface ConstructorOptions {
-        /** Colors to use for different visualization elements */
-        colors?: Record<string, Color>;
-        /** Whether to show tile grid initially. */
-        tile?: boolean;
-        /** Initial zoom level to use for visualizations. */
-        activeLevel?: number;
-        /** Terrain provider to visualize. */
-        terrainProvider: HybridTerrainProvider;
-    }
-    /** Options for {@link TerrainVisualizer.visualize} */
-    interface Options {
-        color?: Color;
-        show?: boolean;
-        maxTilesToShow?: number;
-        levels?: number[];
-        tag?: string;
-        alpha?: number;
-        tileAlpha?: number;
-    }
-}
-
-declare const deprecate: typeof Deprecate.deprecate;
-
-export { Deprecate, TerrainVisualizer, deprecate };

package/dist/experimental/index.d.cts

@@ -1,105 +0,0 @@
-import { Viewer, Cartesian3, JulianDate, Color, Entity } from 'cesium';
-
-/**
- * @since Cesium 1.132.0
- * @experimental
- * Point sunlight analysis utility for shadow calculations.
- *
- * ⚠️ **Warning**: This is an experimental feature that uses Cesium's internal APIs.
- * The API may change or break in future versions of Cesium or cesium-utils.
- *
- * @example
- * ```typescript
- * const sunlight = new Sunlight(viewer);
- * sunlight.analyze(point, JulianDate.now());
- * ```
- */
-declare class Sunlight {
-    private _uniformState;
-    private _viewer;
-    private _analyzing;
-    private _pointEntityId?;
-    private _objectsToExclude;
-    private _polylines;
-    private _points;
-    constructor(viewer: Viewer);
-    /** The sun position in 3D world coordinates at the current scene time. */
-    get sunPositionWC(): Cartesian3;
-    /** A normalized vector to the sun in 3D world coordinates at the current scene time. */
-    get sunDirectionWC(): Cartesian3;
-    /** Whether sunlight analysis is currently in progress. */
-    get isAnalyzing(): boolean;
-    /**
-     * Gets virtual position and direction of the sun to reduce calculation overhead.
-     *
-     * @param from target point to start from
-     * @param radius virtual distance between target point and the sun. Defaults to 10000 (10km)
-     */
-    virtualSun(from: Cartesian3, radius?: number): {
-        position: Cartesian3;
-        direction: Cartesian3;
-    };
-    /**
-     * Analyze the sunlight acceptance from a given point at a given time.
-     * @param from target point to analyze
-     * @param at time to analyze
-     * @param options {@link Sunlight.AnalyzeOptions}
-     */
-    analyze(from: Cartesian3, at: JulianDate, options?: Sunlight.AnalyzeOptions): Promise<Sunlight.AnalysisResult>;
-    /**
-     * Analyze the sunlight acceptance from a given point at a given time range.
-     * @param from target point to analyze
-     * @param range time range to analyze
-     * @param options {@link Sunlight.AnalyzeOptions}
-     */
-    analyze(from: Cartesian3, range: Sunlight.TimeRange, options?: Sunlight.AnalyzeOptions): Promise<Sunlight.AnalysisResult[]>;
-    /**
-     * Remove all instances created for debug purpose
-     */
-    clear(): void;
-    /**
-     * Create an ellipsoid entity for ray collision detection to complement cesium's native click event accuracy
-     * @param at where to create the entity
-     * @param show whether to show point entity
-     * @param errorBoundary size of the point entity for error tolerance
-     */
-    setTargetPoint(at: Cartesian3, show?: boolean, errorBoundary?: number, color?: Color): Entity;
-    private _analyzeSingleTime;
-    private _analyzeTimeRange;
-    /**
-     * @returns A promise tht resolves to an object containing the object and position of the first intersection.
-     * @see https://github.com/CesiumGS/cesium/blob/1.136/packages/engine/Source/Scene/Scene.js#L4868
-     */
-    private _pick;
-    private _getExcludedObjects;
-}
-declare namespace Sunlight {
-    const DETECTION_ELLIPSOID_ID = "sunlight-detection-ellipsoid";
-    /** for time-range analysis */
-    interface TimeRange {
-        /** When to start analysis */
-        start: JulianDate;
-        /** When to end analysis */
-        end: JulianDate;
-        /** Step interval (seconds) inside the range */
-        step: number;
-    }
-    interface AnalyzeOptions {
-        /** List of objects to exclude from ray pick */
-        objectsToExclude?: any[];
-        /** size of the point entity for error tolerance */
-        errorBoundary?: number;
-        /** Whether to show sunlight paths */
-        debugShowRays?: boolean;
-        /** Whether to show points */
-        debugShowPoints?: boolean;
-    }
-    interface AnalysisResult {
-        /** ISO time string */
-        timestamp: string;
-        /** Whether the sunlight has reached */
-        result: boolean | any;
-    }
-}
-
-export { Sunlight };

package/dist/experimental/index.d.ts

@@ -1,105 +0,0 @@
-import { Viewer, Cartesian3, JulianDate, Color, Entity } from 'cesium';
-
-/**
- * @since Cesium 1.132.0
- * @experimental
- * Point sunlight analysis utility for shadow calculations.
- *
- * ⚠️ **Warning**: This is an experimental feature that uses Cesium's internal APIs.
- * The API may change or break in future versions of Cesium or cesium-utils.
- *
- * @example
- * ```typescript
- * const sunlight = new Sunlight(viewer);
- * sunlight.analyze(point, JulianDate.now());
- * ```
- */
-declare class Sunlight {
-    private _uniformState;
-    private _viewer;
-    private _analyzing;
-    private _pointEntityId?;
-    private _objectsToExclude;
-    private _polylines;
-    private _points;
-    constructor(viewer: Viewer);
-    /** The sun position in 3D world coordinates at the current scene time. */
-    get sunPositionWC(): Cartesian3;
-    /** A normalized vector to the sun in 3D world coordinates at the current scene time. */
-    get sunDirectionWC(): Cartesian3;
-    /** Whether sunlight analysis is currently in progress. */
-    get isAnalyzing(): boolean;
-    /**
-     * Gets virtual position and direction of the sun to reduce calculation overhead.
-     *
-     * @param from target point to start from
-     * @param radius virtual distance between target point and the sun. Defaults to 10000 (10km)
-     */
-    virtualSun(from: Cartesian3, radius?: number): {
-        position: Cartesian3;
-        direction: Cartesian3;
-    };
-    /**
-     * Analyze the sunlight acceptance from a given point at a given time.
-     * @param from target point to analyze
-     * @param at time to analyze
-     * @param options {@link Sunlight.AnalyzeOptions}
-     */
-    analyze(from: Cartesian3, at: JulianDate, options?: Sunlight.AnalyzeOptions): Promise<Sunlight.AnalysisResult>;
-    /**
-     * Analyze the sunlight acceptance from a given point at a given time range.
-     * @param from target point to analyze
-     * @param range time range to analyze
-     * @param options {@link Sunlight.AnalyzeOptions}
-     */
-    analyze(from: Cartesian3, range: Sunlight.TimeRange, options?: Sunlight.AnalyzeOptions): Promise<Sunlight.AnalysisResult[]>;
-    /**
-     * Remove all instances created for debug purpose
-     */
-    clear(): void;
-    /**
-     * Create an ellipsoid entity for ray collision detection to complement cesium's native click event accuracy
-     * @param at where to create the entity
-     * @param show whether to show point entity
-     * @param errorBoundary size of the point entity for error tolerance
-     */
-    setTargetPoint(at: Cartesian3, show?: boolean, errorBoundary?: number, color?: Color): Entity;
-    private _analyzeSingleTime;
-    private _analyzeTimeRange;
-    /**
-     * @returns A promise tht resolves to an object containing the object and position of the first intersection.
-     * @see https://github.com/CesiumGS/cesium/blob/1.136/packages/engine/Source/Scene/Scene.js#L4868
-     */
-    private _pick;
-    private _getExcludedObjects;
-}
-declare namespace Sunlight {
-    const DETECTION_ELLIPSOID_ID = "sunlight-detection-ellipsoid";
-    /** for time-range analysis */
-    interface TimeRange {
-        /** When to start analysis */
-        start: JulianDate;
-        /** When to end analysis */
-        end: JulianDate;
-        /** Step interval (seconds) inside the range */
-        step: number;
-    }
-    interface AnalyzeOptions {
-        /** List of objects to exclude from ray pick */
-        objectsToExclude?: any[];
-        /** size of the point entity for error tolerance */
-        errorBoundary?: number;
-        /** Whether to show sunlight paths */
-        debugShowRays?: boolean;
-        /** Whether to show points */
-        debugShowPoints?: boolean;
-    }
-    interface AnalysisResult {
-        /** ISO time string */
-        timestamp: string;
-        /** Whether the sunlight has reached */
-        result: boolean | any;
-    }
-}
-
-export { Sunlight };