@vesium/plot 1.0.1-beta.34 → 1.0.1-beta.37

package/dist/index.d.ts

@@ -2,11 +2,12 @@ import { Cartesian3 } from 'cesium';
 import { ComputedRef } from 'vue';
 import { CSSProperties } from 'vue';
 import { Entity } from 'cesium';
+import { EntityCollection } from 'cesium';
 import { Event as Event_2 } from 'cesium';
 import { JulianDate } from 'cesium';
-import { MaybeRef } from '@vueuse/core';
-import { MaybeRef as MaybeRef_2 } from 'vue';
+import { MaybeRef } from 'vue';
 import { Nullable } from '@vesium/shared';
+import { PrimitiveCollection } from 'cesium';
 import { Property } from 'cesium';
 import { ScreenSpaceEventHandler } from 'cesium';
 import { ShallowRef } from 'vue';
@@ -14,7 +15,27 @@ import { TimeInterval } from 'cesium';
 import { Viewer } from 'cesium';
 import { VNode } from 'vue';
 
-declare interface OnKeyPressedOptions {
+/**
+ * 绘制控制的框架点，拖拽时，将更新该控制点的实时位置
+ */
+export declare function control(): PlotSkeleton;
+
+/**
+ * 绘制封闭的间隔框架点，如多边形。拖拽时，会在两点之间插入一个控制点，并持续拖拽该点。
+ */
+export declare function interval(): PlotSkeleton;
+
+/**
+ * 绘制非封闭的间隔框架点，如线段。拖拽时，会在两点之间插入一个控制点，并持续拖拽该点。
+ */
+export declare function intervalNonclosed(): PlotSkeleton;
+
+/**
+ * 绘制非封闭的间隔框架点，如线段。拖拽时，会在两点之间插入一个控制点，并持续拖拽该点。
+ */
+export declare function moved(): PlotSkeleton;
+
+export declare interface OnKeyPressedOptions {
     viewer: Viewer;
     /**
      * 当前标绘属性数据
@@ -34,7 +55,7 @@ declare interface OnKeyPressedOptions {
     keyEvent: KeyboardEvent;
 }
 
-declare interface OnSkeletonClickOptions {
+export declare interface OnSkeletonClickOptions {
     viewer: Viewer;
     /**
      * 当前标绘属性数据
@@ -59,10 +80,10 @@ declare interface OnSkeletonClickOptions {
     /**
      * 鼠标点击事件上下文信息
      */
-    context: ScreenSpaceEventHandler.PositionedEvent;
+    event: ScreenSpaceEventHandler.PositionedEvent;
 }
 
-declare interface OnSkeletonDragOptions {
+export declare interface OnSkeletonDragOptions {
     viewer: Viewer;
     /***
      * 当前标绘属性数据
@@ -83,7 +104,7 @@ declare interface OnSkeletonDragOptions {
     /**
      * 鼠标拖拽事件上下文信息
      */
-    context: ScreenSpaceEventHandler.MotionEvent;
+    event: ScreenSpaceEventHandler.MotionEvent;
     /**
      * 当前的拖拽状态
      */
@@ -94,104 +115,63 @@ declare interface OnSkeletonDragOptions {
     lockCamera: () => void;
 }
 
-export declare class Plot {
-    constructor(options: PlotConstructorOptions);
-    /**
-     * An event that is raised when a property is changed.
-     */
-    get definitionChanged(): Event_2<(scope: Plot, key: keyof Plot, newValue: Plot[typeof key], oldValue: Plot[typeof key]) => void>;
-    time?: JulianDate;
-    /**
-     * A unique identifier for the plot.
-     */
-    id: string;
-    /**
-     * Whether the plot is disabled.
-     */
-    disabled: boolean;
-    /**
-     * The scheme for the plot.
-     */
-    readonly scheme: PlotScheme;
-    /**
-     * Sampled plot property.
-     */
-    sampled: SampledPlotProperty;
-    /**
-     * 当前标绘是否处于定义态
-     */
-    isDefining(): boolean;
-    /**
-     * 获取当前标绘的entity数组
-     */
-    getEntities(): Entity[];
-    /**
-     * 获取当前标绘的primitive数组
-     */
-    getPrimitives(): any[];
-    /**
-     * 获取当前标绘的贴地primitive数组
-     */
-    getGroundPrimitives(): any[];
-    /**
-     * 获取当前标绘标绘的骨架点entity数组
-     */
-    getSkeletonEntities(): PlotSkeletonEntity[];
-}
-
-/**
- *  广告牌标绘方案
- */
-export declare const PLOT_BILLBOARD_SCHEME: PlotConstructorOptions;
-
-/**
- *  标签文字标绘方案
- */
-export declare const PLOT_LABEL_SCHEME: PlotConstructorOptions;
-
-/**
- * 内置的线段标绘方案
- */
-export declare const PLOT_LINE_STRING_SCHEME: PlotConstructorOptions;
-
-/**
- * 内置的多边形标绘方案
- */
-export declare const PLOT_POLYGON_SCHEME: PlotConstructorOptions;
-
 /**
  * 框架点执行状态枚举
  * - IDLE 空闲状态
  * - HOVER 悬停状态
  * - ACTIVE 激活状态
  */
-declare enum PlotAction {
+export declare enum PlotAction {
     IDLE = 0,
     HOVER = 1,
     ACTIVE = 2
 }
 
-/**
- * Options for constructing a Plot instance.
- */
-export declare interface PlotConstructorOptions {
-    /**
-     * A unique identifier for the plot.
-     */
+export declare type PlotCollectionChanged = (scope: PlotFeatureCollection, added: PlotFeature[], removed: PlotFeature[]) => void;
+
+export declare interface PlotCollectionConstructorOptions {
+    id?: string;
+}
+
+export declare type PlotDefinitionChangedCallback = (scope: PlotFeature, key: keyof PlotFeature, newValue: PlotFeature[typeof key], oldValue: PlotFeature[typeof key]) => void;
+
+export declare class PlotFeature {
+    constructor(options: PlotFeatureConstructorOptions);
+    get id(): string;
+    get scheme(): PlotScheme;
+    get definitionChanged(): Event_2<PlotDefinitionChangedCallback>;
+    get defining(): boolean;
+    private _disabled;
+    get disabled(): boolean;
+    set disabled(value: string);
+    get sampled(): SampledPlotProperty;
+    get entities(): Entity[];
+    set entities(value: Entity[]);
+    get primitives(): any[];
+    get groundPrimitives(): any[];
+    get skeletons(): PlotSkeletonEntity[];
+}
+
+export declare class PlotFeatureCollection {
+    constructor(options?: PlotCollectionConstructorOptions);
+    get id(): string;
+    get collectionChanged(): Event_2<PlotCollectionChanged>;
+    get values(): PlotFeature[];
+    add(value: PlotFeature): boolean;
+    remove(value: PlotFeature): boolean;
+    get entities(): EntityCollection;
+    get primitives(): PrimitiveCollection;
+    get groundPrimitives(): PrimitiveCollection;
+    get skeletons(): EntityCollection;
+    isDestroyed(): boolean;
+    destroy(): void;
+}
+
+export declare interface PlotFeatureConstructorOptions {
     id?: string;
-    /**
-     * Whether the plot is disabled.
-     */
-    disabled?: boolean;
-    /**
-     * The scheme for the plot.
-     * If it is a string, it will attempt to retrieve the corresponding `PlotScheme.type` object from the cache internally.
-     */
     scheme: string | PlotScheme | PlotSchemeConstructorOptions;
-    /**
-     * Sampled plot property.
-     */
     sampled?: SampledPlotProperty | SampledPlotPropertyConstructorOptions;
+    disabled?: boolean;
 }
 
 export declare interface PlotRenderOptions<D = any> {
@@ -221,60 +201,40 @@ export declare class PlotScheme {
      */
     forceComplete?: (packable: SampledPlotPackable) => boolean;
     /**
-     * 处于定义态时的鼠标样式
      * @default 'crosshair'
      */
-    definingCursor?: MaybeRef<Nullable<CSSProperties['cursor']>> | ((packable: SampledPlotPackable) => Nullable<CSSProperties['cursor']>);
-    /**
-     * 框架点渲染配置
-     */
+    definingCursor?: Nullable<CSSProperties['cursor']> | ((packable: SampledPlotPackable) => Nullable<CSSProperties['cursor']>);
     skeletons: PlotSkeleton[];
-    /**
-     */
+    initEntites?: () => (Entity[] | undefined);
+    initPrimitives?: () => (any[] | undefined);
+    initGroundPrimitives?: () => (any[] | undefined);
     render?: (options: PlotRenderOptions) => PlotRenderResult | Promise<PlotRenderResult>;
+    private static _record;
     static getCacheTypes(): string[];
     static getCache(type: string): PlotScheme | undefined;
-    /**
-     * 设置标绘方案
-     * @param scheme
-     */
     static setCache(scheme: PlotScheme): void;
-    /**
-     * 解析传入的 scheme，并返回 PlotScheme 实例
-     */
     static resolve(maybeScheme: string | PlotScheme | PlotSchemeConstructorOptions): PlotScheme;
 }
 
 export declare interface PlotSchemeConstructorOptions {
     type: string;
-    /**
-     * 是否立即执行完成标绘操作
-     * 每次控制点发生变变化时，执行该回调函数，如果返回`true`则标绘完成
-     */
     complete?: (packable: SampledPlotPackable) => boolean;
-    /**
-     * 双击时，是否执行完成标绘操作
-     * 每次控制点发生变变化时，执行该回调函数，如果返回 true 则下一次双击事件执行完成
-     */
     forceComplete?: (packable: SampledPlotPackable) => boolean;
     /**
-     * 处于定义态时的鼠标样式
      * @default 'crosshair'
      */
-    definingCursor?: MaybeRef<Nullable<CSSProperties['cursor']>> | ((packable: SampledPlotPackable) => Nullable<CSSProperties['cursor']>);
-    /**
-     * 框架点渲染配置
-     */
+    definingCursor?: Nullable<CSSProperties['cursor']> | ((packable: SampledPlotPackable) => Nullable<CSSProperties['cursor']>);
     skeletons?: (() => PlotSkeleton)[];
-    /**
-     */
+    initEntites?: () => (Entity[] | undefined);
+    initPrimitives?: () => (any[] | undefined);
+    initGroundPrimitives?: () => (any[] | undefined);
     render?: (options: PlotRenderOptions) => PlotRenderResult | Promise<PlotRenderResult>;
 }
 
 /**
  * 控制点配置项
  */
-declare interface PlotSkeleton {
+export declare interface PlotSkeleton {
     /**
      * 是否禁用控制点
      */
@@ -291,11 +251,11 @@ declare interface PlotSkeleton {
     /**
      *  Cursor style when hovering.
      */
-    cursor?: MaybeRef_2<Nullable<CSSProperties['cursor']>> | ((pick: any) => Nullable<CSSProperties['cursor']>);
+    cursor?: MaybeRef<Nullable<CSSProperties['cursor']>> | ((pick: any) => Nullable<CSSProperties['cursor']>);
     /**
      *  Cursor style when dragging.
      */
-    dragCursor?: MaybeRef_2<Nullable<CSSProperties['cursor']>> | ((pick: any) => Nullable<CSSProperties['cursor']>);
+    dragCursor?: MaybeRef<Nullable<CSSProperties['cursor']>> | ((pick: any) => Nullable<CSSProperties['cursor']>);
     /**
      * 鼠标悬停在框架点时显示的提示信息
      */
@@ -317,7 +277,7 @@ declare interface PlotSkeleton {
 /**
  * 标绘框架点 Entity
  */
-declare class PlotSkeletonEntity extends Entity {
+export declare class PlotSkeletonEntity extends Entity {
     constructor(options: Entity.ConstructorOptions);
 }
 
@@ -397,7 +357,29 @@ export declare enum SampledPlotStrategy {
     STRICT = 2
 }
 
-declare interface SkeletonDisabledOptions {
+/**
+ *  广告牌标绘方案
+ */
+export declare const schemeBillboard: PlotScheme;
+
+/**
+ *  标签文字标绘方案
+ */
+export declare const schemeLabel: PlotScheme;
+
+export declare const schemeMeasureArea: PlotScheme;
+
+/**
+ * 内置的多边形标绘方案
+ */
+export declare const schemePolygon: PlotScheme;
+
+/**
+ * 内置的线段标绘方案
+ */
+export declare const schemePolyline: PlotScheme;
+
+export declare interface SkeletonDisabledOptions {
     /**
      * 当前标绘是否是否正在激活，即正在编辑状态
      */
@@ -408,7 +390,7 @@ declare interface SkeletonDisabledOptions {
     defining: boolean;
 }
 
-declare interface SkeletonRenderOptions {
+export declare interface SkeletonRenderOptions {
     /**
      * 标绘采集到的数据，通过该数据可以获取到当前标绘的所有点位信息
      */
@@ -440,14 +422,14 @@ declare interface SkeletonRenderOptions {
 }
 
 export declare function usePlot(options?: UsePlotOptions): {
-    plots: ComputedRef<Plot[]>;
+    plots: ComputedRef<PlotFeature[]>;
     time: ShallowRef<JulianDate | undefined>;
     operate: UsePlotOperate;
-    remove: (plot: Plot) => boolean;
+    remove: (plot: PlotFeature) => boolean;
     cancel: (() => void) | undefined;
 };
 
-export declare type UsePlotOperate = (plot: Plot | PlotConstructorOptions) => Promise<Plot>;
+export declare type UsePlotOperate = (plot: PlotFeature | PlotFeatureConstructorOptions) => Promise<PlotFeature>;
 
 export declare interface UsePlotOptions {
     time?: ShallowRef<JulianDate | undefined>;
@@ -455,8 +437,8 @@ export declare interface UsePlotOptions {
 
 export declare interface UsePlotRetrun {
     time: ShallowRef<JulianDate | undefined>;
-    data?: ShallowRef<Plot[]>;
-    current?: ShallowRef<Plot | undefined>;
+    data?: ShallowRef<PlotFeature[]>;
+    current?: ShallowRef<PlotFeature | undefined>;
     /**
      * 触发标绘
      */