@vesium/shared 1.0.1-beta.25

package/dist/index.d.ts

@@ -0,0 +1,409 @@
+import { Cartesian2 } from 'cesium';
+import { Cartesian3 } from 'cesium';
+import { Cartographic } from 'cesium';
+import { Cesium3DTileset } from 'cesium';
+import { CustomDataSource } from 'cesium';
+import { CzmlDataSource } from 'cesium';
+import { DataSource } from 'cesium';
+import { Event as Event_2 } from 'cesium';
+import { GeoJsonDataSource } from 'cesium';
+import { GpxDataSource } from 'cesium';
+import { JulianDate } from 'cesium';
+import { KmlDataSource } from 'cesium';
+import { Material } from 'cesium';
+import { MaterialProperty } from 'cesium';
+import { Primitive } from 'cesium';
+import { PrimitiveCollection } from 'cesium';
+import { Property } from 'cesium';
+import { Scene } from 'cesium';
+import { TextureMagnificationFilter } from 'cesium';
+import { TextureMinificationFilter } from 'cesium';
+
+/**
+ * Add material to Cesium's material cache, alias of `Material._materialCache.addMaterial`
+ */
+export declare function addMaterialCache(type: string, material: CesiumMaterialConstructorOptions<any>): void;
+
+export declare type AnyFn = (...args: any[]) => any;
+
+export declare type ArgsFn<Args extends any[] = any[], Return = void> = (...args: Args) => Return;
+
+/**
+ * 计算两个数组的差异，返回新增和删除的元素
+ */
+export declare function arrayDifference<T>(list: T[], oldList: T[] | undefined): ArrayDifferenceRetrun<T>;
+
+export declare interface ArrayDifferenceRetrun<T> {
+    added: T[];
+    removed: T[];
+}
+
+export declare function assertError(condition: boolean, error: any): void;
+
+export declare type BasicType = number | string | boolean | symbol | bigint | null | undefined;
+
+/**
+ * Convert canvas coordinates to Cartesian coordinates
+ *
+ * @param canvasCoord Canvas coordinates
+ * @param scene Cesium.Scene instance
+ * @param mode optional values are 'pickPosition' | 'globePick' | 'auto' | 'noHeight'  @default 'auto'
+ *
+ * `pickPosition`: Use scene.pickPosition for conversion, which can be used for picking models, oblique photography, etc.
+ * However, if depth detection is not enabled (globe.depthTestAgainstTerrain=false), picking terrain or inaccurate issues may occur
+ *
+ * `globePick`: Use camera.getPickRay for conversion, which cannot be used for picking models or oblique photography,
+ * but can be used for picking terrain. If terrain does not exist, the picked elevation is 0
+ *
+ * `auto`: Automatically determine which picking content to return
+ *
+ * Calculation speed comparison: globePick > auto >= pickPosition
+ */
+export declare function canvasCoordToCartesian(canvasCoord: Cartesian2, scene: Scene, mode?: 'pickPosition' | 'globePick' | 'auto'): Cartesian3 | undefined;
+
+/**
+ * Convert Cartesian coordinates to canvas coordinates
+ *
+ * @param position Cartesian coordinates
+ * @param scene Cesium.Scene instance
+ */
+export declare function cartesianToCanvasCoord(position: Cartesian3, scene: Scene): Cartesian2;
+
+/**
+ * Common DataSource
+ */
+export declare type CesiumDataSource = DataSource | CustomDataSource | CzmlDataSource | GeoJsonDataSource | GpxDataSource | KmlDataSource;
+
+/**
+ * Determines if two Cesium objects are equal.
+ *
+ * This function not only judges whether the instances are equal,
+ * but also judges the equals method in the example.
+ *
+ * @param left The first Cesium object
+ * @param right The second Cesium object
+ * @returns Returns true if the two Cesium objects are equal, otherwise false
+ */
+export declare function cesiumEquals(left: any, right: any): boolean;
+
+/**
+ * 仅作为`Cesium.Material`的类型修复
+ */
+export declare class CesiumMaterial<U> extends Material {
+    constructor(options: CesiumMaterialConstructorOptions<U>);
+    /**
+     * 矩阵配置
+     */
+    fabric: CesiumMaterialFabricOptions<U>;
+}
+
+/**
+ * Cesium.Material参数
+ */
+export declare interface CesiumMaterialConstructorOptions<U> {
+    /**
+     * 严格模式
+     */
+    strict?: boolean;
+    /**
+     * translucent
+     */
+    translucent?: boolean | ((...params: any[]) => any);
+    /**
+     * 缩小滤镜
+     */
+    minificationFilter?: TextureMinificationFilter;
+    /**
+     * 放大滤镜
+     */
+    magnificationFilter?: TextureMagnificationFilter;
+    /**
+     * 矩阵配置
+     */
+    fabric: CesiumMaterialFabricOptions<U>;
+}
+
+/**
+ * Cesium.Material.fabric参数
+ */
+export declare interface CesiumMaterialFabricOptions<U> {
+    /**
+     * 用于声明 fabric 对象最终会生成什么材质，如果是官方内置的，直接用官方内置的，否则则创建自定义的材质并缓存。
+     */
+    type: string;
+    /**
+     * 可再塞进去一层子级的 fabric，构成复合材质
+     */
+    materials?: Material;
+    /**
+     * glsl代码
+     */
+    source?: string;
+    components?: {
+        diffuse?: string;
+        alpha?: string;
+    };
+    /**
+     * 传glsl代码的变量
+     */
+    uniforms?: U & Record<string, any>;
+}
+
+/**
+ * 仅作为`Cesium.MaterialProperty`的类型修复
+ */
+export declare interface CesiumMaterialProperty<V> extends MaterialProperty {
+    get isConstant(): boolean;
+    get definitionChanged(): Event_2<(scope: this, field: string, value: any, previous: any) => void>;
+    getType: (time: JulianDate) => string;
+    getValue: (time: JulianDate, result?: V) => V;
+    equals: (other?: any) => boolean;
+}
+
+export declare type CesiumPrimitive = Primitive | PrimitiveCollection | Cesium3DTileset | any;
+
+/**
+ * Common Coordinate
+ * Can be a Cartesian3 point, a Cartographic point, an array, or an object containing longitude, latitude, and optional height information
+ */
+export declare type CommonCoord = Cartesian3 | Cartographic | CoordArray | CoordArray_ALT | CoordObject | CoordObject_ALT;
+
+/**
+ * 2D Coordinate System
+ */
+export declare type CoordArray = [longitude: number, latitude: number];
+
+/**
+ * 3D Coordinate System
+ */
+export declare type CoordArray_ALT = [longitude: number, latitude: number, height?: number];
+
+/**
+ * 2D Coordinate System
+ */
+export declare interface CoordObject {
+    longitude: number;
+    latitude: number;
+}
+
+/**
+ * 3D Coordinate System
+ */
+export declare interface CoordObject_ALT {
+    longitude: number;
+    latitude: number;
+    height?: number;
+}
+
+export declare function createCesiumAttribute<Scope extends object>(scope: Scope, key: keyof Scope, value: any, options?: CreateCesiumAttributeOptions): void;
+
+export declare interface CreateCesiumAttributeOptions {
+    readonly?: boolean;
+    toProperty?: boolean;
+    /**
+     * The event name that triggers the change
+     * @default 'definitionChanged'
+     */
+    changedEventKey?: string;
+    shallowClone?: boolean;
+}
+
+export declare function createCesiumProperty<Scope extends object>(scope: Scope, key: keyof Scope, value: any, options?: CreateCesiumPropertyOptions): void;
+
+export declare interface CreateCesiumPropertyOptions {
+    readonly?: boolean;
+    /**
+     * The event name that triggers the change
+     * @default 'definitionChanged'
+     */
+    changedEventKey?: string;
+}
+
+/**
+ * Create a Cesium property key
+ *
+ * @param scope The host object
+ * @param field The property name
+ * @param maybeProperty Optional property or getter
+ * @param readonly Whether the property is read-only
+ */
+export declare function createPropertyField<T>(scope: any, field: string, maybeProperty?: MaybePropertyOrGetter<T>, readonly?: boolean): void;
+
+/**
+ * Convert latitude and longitude coordinates to degrees-minutes-seconds format
+ *
+ * @param position The latitude and longitude coordinates
+ * @param precision The number of decimal places to retain for 'seconds', default is 3
+ * @returns Returns the coordinates in degrees-minutes-seconds format, or undefined if the conversion fails
+ */
+export declare function degreesToDms(position: CommonCoord, precision?: number): DMSCoord | undefined;
+
+export declare type DMSCoord = [longitude: string, latitude: string, height?: number];
+
+/**
+ * Decode a DMS (Degrees Minutes Seconds) formatted string to a decimal angle value
+ *
+ * @param dmsCode DMS formatted string, e.g. "120°30′45″N"
+ * @returns The decoded decimal angle value, or 0 if decoding fails
+ */
+export declare function dmsDecode(dmsCode: string): number;
+
+/**
+ * Convert degrees to DMS (Degrees Minutes Seconds) format string
+ *
+ * @param degrees The angle value
+ * @param precision The number of decimal places to retain for the seconds, defaults to 3
+ * @returns A DMS formatted string in the format: degrees° minutes′ seconds″
+ */
+export declare function dmsEncode(degrees: number, precision?: number): string;
+
+/**
+ * Convert DMS (Degrees Minutes Seconds) format to decimal degrees for latitude and longitude coordinates
+ *
+ * @param dms The latitude or longitude coordinate in DMS format
+ * @returns Returns the coordinate in decimal degrees format, or undefined if the conversion fails
+ */
+export declare function dmsToDegrees(dms: DMSCoord): CoordArray_ALT | undefined;
+
+/**
+ * Get material from cache, alias of `Material._materialCache.getMaterial`
+ */
+export declare function getMaterialCache<T extends Material = CesiumMaterial<any>>(type: string): T | undefined;
+
+export declare const isArray: (arg: any) => arg is any[];
+
+export declare function isBase64(val: string): boolean;
+
+export declare function isBoolean(val: any): val is boolean;
+
+/**
+ * Determines if the Cesium property is a constant.
+ *
+ * @param value Cesium property
+ */
+export declare function isCesiumConstant(value: MaybeProperty): boolean;
+
+export declare function isDef<T = any>(val?: T): val is T;
+
+export declare function isElement<T extends Element>(val: any): val is T;
+
+export declare function isFunction<T extends AnyFn>(val: any): val is T;
+
+export declare function isNumber(val: any): val is number;
+
+export declare function isObject(val: any): val is object;
+
+export declare function isPromise<T extends Promise<any>>(val: any): val is T;
+
+/**
+ * Is Cesium.Property
+ * @param value - The target object
+ */
+export declare function isProperty(value: any): value is Property;
+
+export declare function isString(val: unknown): val is string;
+
+export declare function isWindow(val: any): val is Window;
+
+export declare type MaybePromise<T = any> = T | (() => T) | Promise<T> | (() => Promise<T>);
+
+export declare type MaybeProperty<T = any> = T | {
+    getValue: (time?: JulianDate) => T;
+};
+
+export declare type MaybePropertyOrGetter<T = any> = MaybeProperty<T> | (() => T);
+
+export declare type Nullable<T> = T | null | undefined;
+
+/**
+ * Determine if the given array of graphics is hit by Cesium's `scene.pick`
+ *
+ * @param pick The `scene.pick` object used for matching
+ * @param graphic An array of graphics to check for hits
+ */
+export declare function pickHitGraphic(pick: any, graphic: any | any[]): boolean;
+
+export declare type PropertyCallback<T = any> = (time: JulianDate, result?: T) => T;
+
+/**
+ * Analyze the result of Cesium's `scene.pick` and convert it to an array format
+ */
+export declare function resolvePick(pick?: any): any[];
+
+/**
+ * Throttle function, which limits the frequency of execution of the function
+ *
+ * @param callback raw function
+ * @param delay Throttled delay duration (ms)
+ * @param trailing Trigger callback function after last call @default true
+ * @param leading Trigger the callback function immediately on the first call @default false
+ * @returns Throttle function
+ */
+export declare function throttle<T extends any[]>(callback: ThrottleCallback<T>, delay?: number, trailing?: boolean, leading?: boolean): ThrottleCallback<T>;
+
+export declare type ThrottleCallback<T extends any[]> = (...rest: T) => void;
+
+/**
+ * Converts position to a coordinate point in the Cartesian coordinate system
+ *
+ * @param position Position information, which can be a Cartesian coordinate point (Cartesian3), a geographic coordinate point (Cartographic), an array, or an object containing WGS84 latitude, longitude, and height information
+ * @returns The converted Cartesian coordinate point. If the input parameter is invalid, undefined is returned
+ */
+export declare function toCartesian3(position?: CommonCoord): Cartesian3 | undefined;
+
+/**
+ * Converts a position to a Cartographic coordinate point
+ *
+ * @param position Position information, which can be a Cartesian3 coordinate point, a Cartographic coordinate point, an array, or an object containing WGS84 longitude, latitude, and height information
+ * @returns The converted Cartographic coordinate point, or undefined if the input parameter is invalid
+ */
+export declare function toCartographic(position?: CommonCoord): Cartographic | undefined;
+
+/**
+ * Converts coordinates to an array or object in the specified format.
+ *
+ * @param position The coordinate to be converted, which can be a Cartesian3, Cartographic, array, or object.
+ * @param options Conversion options, including conversion type and whether to include altitude information.
+ * @returns The converted coordinate, which may be an array or object. If the input position is empty, undefined is returned.
+ *
+ * @template T Conversion type, optional values are 'Array' or 'Object', @default 'Array'.
+ * @template Alt Whether to include altitude information, default is false
+ */
+export declare function toCoord<T extends 'Array' | 'Object' = 'Array', Alt extends boolean = false>(position?: CommonCoord, options?: ToCoordOptions<T, Alt>): ToCoordReturn<T, Alt> | undefined;
+
+declare interface ToCoordOptions<T extends 'Array' | 'Object', Alt extends boolean> {
+    /**
+     * Return type
+     * @default 'Array'
+     */
+    type?: T;
+    /**
+     * Whether to return altitude information
+     */
+    alt?: Alt;
+}
+
+export declare type ToCoordReturn<T extends 'Array' | 'Object', Alt extends boolean> = T extends 'Array' ? Alt extends true ? CoordArray_ALT : CoordArray : Alt extends true ? CoordObject_ALT : CoordObject;
+
+/**
+ * Converts a value that may be a Property into a Property object, @see {toPropertyValue} for the reverse operation
+ *
+ * @param value - The property value or getter to convert, can be undefined or null
+ * @param isConstant - The second parameter for converting to CallbackProperty
+ * @returns Returns the converted Property object, if value is undefined or null, returns undefined
+ */
+export declare function toProperty<T>(value?: MaybePropertyOrGetter<T>, isConstant?: boolean): Property;
+
+/**
+ * Converts a value that may be a Property into its target value, @see {toProperty} for the reverse operation
+ * ```typescript
+ * toPropertyValue('val') //=> 'val'
+ * toPropertyValue(new ConstantProperty('val')) //=> 'val'
+ * toPropertyValue(new CallbackProperty(()=>'val')) //=> 'val'
+ * ```
+ *
+ * @param value - The value to convert
+ */
+export declare function toPropertyValue<T = unknown>(value: MaybeProperty<T>, time?: JulianDate): T;
+
+export { }