cesium-xs-sdk 1.0.0

package/src/vue.d.ts

@@ -0,0 +1,18 @@
+import type { ModuleManager, SceneModule, GraphicModule, EventModule, EditorModule } from './index.js';
+
+export interface UseXs3dResult {
+  sdk: any;
+  viewer: any;
+  sceneModule: any;
+  graphicModule: any;
+  eventModule: any;
+  editorModule: any;
+  isReady: any;
+}
+
+export function useXs3d(
+  container: string | { value?: string; element?: { value?: string | HTMLElement } },
+  options?: Record<string, any>
+): UseXs3dResult;
+
+export default useXs3d;

package/src/vue.js

@@ -0,0 +1,76 @@
+/**
+ * Vue 3 适配器
+ * 提供 useXs3d 组合式函数，管理 SDK 初始化与销毁生命周期
+ */
+import { ref, shallowRef, onMounted, onUnmounted } from 'vue';
+import xs3d from './index.js';
+
+/**
+ * 在 Vue 组件中使用 XS 3D SDK
+ * @param {string|Ref<string>} container 容器元素 ID，或传 { element: ref } 直接使用 DOM 引用
+ * @param {Object} options 初始化配置（同 xs3d.init）
+ * @returns {Object}
+ *   - sdk: SDK 根实例（shallowRef）
+ *   - viewer: Cesium Viewer（shallowRef）
+ *   - sceneModule, graphicModule, eventModule, editorModule: 各模块（shallowRef）
+ *   - isReady: 是否初始化完成（ref）
+ */
+export function useXs3d(container, options = {}) {
+  const sdk = shallowRef(null);
+  const viewer = shallowRef(null);
+  const sceneModule = shallowRef(null);
+  const graphicModule = shallowRef(null);
+  const eventModule = shallowRef(null);
+  const editorModule = shallowRef(null);
+  const isReady = ref(false);
+
+  let instance = null;
+
+  onMounted(() => {
+    // 支持传入 ref 或直接传 id
+    const target = typeof container === 'string'
+      ? container
+      : container?.value ?? container?.element?.value;
+
+    if (!target) {
+      console.warn('useXs3d: container 未定义，跳过初始化');
+      return;
+    }
+
+    instance = xs3d.init(target, options);
+
+    sdk.value = instance;
+    viewer.value = instance.viewer;
+    sceneModule.value = instance.sceneModule;
+    graphicModule.value = instance.graphicModule;
+    eventModule.value = instance.eventModule;
+    editorModule.value = instance.editorModule;
+    isReady.value = true;
+  });
+
+  onUnmounted(() => {
+    if (instance) {
+      xs3d.destroy();
+      instance = null;
+      sdk.value = null;
+      viewer.value = null;
+      sceneModule.value = null;
+      graphicModule.value = null;
+      eventModule.value = null;
+      editorModule.value = null;
+      isReady.value = false;
+    }
+  });
+
+  return {
+    sdk,
+    viewer,
+    sceneModule,
+    graphicModule,
+    eventModule,
+    editorModule,
+    isReady
+  };
+}
+
+export default useXs3d;

package/src/vue2.d.ts

@@ -0,0 +1,20 @@
+/// <reference types="cesium" />
+
+import type { ModuleManager, SceneModule, GraphicModule, EventModule, EditorModule } from './index.js';
+
+export interface UseXs3dResult {
+  sdk: any;
+  viewer: any;
+  sceneModule: any;
+  graphicModule: any;
+  eventModule: any;
+  editorModule: any;
+  isReady: any;
+}
+
+export function useXs3d(
+  container: string | { value?: string; element?: { value?: string | HTMLElement } },
+  options?: Record<string, any>
+): UseXs3dResult;
+
+export default useXs3d;

package/src/vue2.js

@@ -0,0 +1,75 @@
+/**
+ * Vue 2 适配器（需配合 @vue/composition-api 或 Vue 2.7 使用）
+ * 提供 useXs3d 组合式函数，管理 SDK 初始化与销毁生命周期
+ */
+import { ref, shallowRef, onMounted, onUnmounted } from '@vue/composition-api';
+import xs3d from './index.js';
+
+/**
+ * 在 Vue 2 组件中使用 XS 3D SDK
+ * @param {string|Ref<string>} container 容器元素 ID，或包含 element ref 的对象
+ * @param {Object} options 初始化配置（同 xs3d.init）
+ * @returns {Object}
+ *   - sdk: SDK 根实例（shallowRef）
+ *   - viewer: Cesium Viewer（shallowRef）
+ *   - sceneModule, graphicModule, eventModule, editorModule: 各模块（shallowRef）
+ *   - isReady: 是否初始化完成（ref）
+ */
+export function useXs3d(container, options = {}) {
+  const sdk = shallowRef(null);
+  const viewer = shallowRef(null);
+  const sceneModule = shallowRef(null);
+  const graphicModule = shallowRef(null);
+  const eventModule = shallowRef(null);
+  const editorModule = shallowRef(null);
+  const isReady = ref(false);
+
+  let instance = null;
+
+  onMounted(() => {
+    const target = typeof container === 'string'
+      ? container
+      : container?.value ?? container?.element?.value;
+
+    if (!target) {
+      console.warn('useXs3d (Vue 2): container 未定义，跳过初始化');
+      return;
+    }
+
+    instance = xs3d.init(target, options);
+
+    sdk.value = instance;
+    viewer.value = instance.viewer;
+    sceneModule.value = instance.sceneModule;
+    graphicModule.value = instance.graphicModule;
+    eventModule.value = instance.eventModule;
+    editorModule.value = instance.editorModule;
+    isReady.value = true;
+  });
+
+  onUnmounted(() => {
+    if (instance) {
+      xs3d.destroy();
+      instance = null;
+      sdk.value = null;
+      viewer.value = null;
+      sceneModule.value = null;
+      graphicModule.value = null;
+      eventModule.value = null;
+      editorModule.value = null;
+      isReady.value = false;
+    }
+  });
+
+  return {
+    sdk,
+    viewer,
+    sceneModule,
+    graphicModule,
+    eventModule,
+    editorModule,
+    isReady
+  };
+}
+
+export default useXs3d;