@juun-roh/cesium-utils 0.4.3 → 0.4.4

package/dist/dev/index.d.ts

@@ -1,98 +0,0 @@
-/**
- * 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;
-}
-
-declare const deprecate: typeof Deprecate.deprecate;
-
-export { Deprecate, 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 };

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 };