类 ESObjectsManager

constructor

• new ESObjectsManager(...args: any[]): ESObjectsManager

  ESObjectsManager 类的构造函数。

  参数

  • ...args: any[]

    构造函数参数。

  返回 ESObjectsManager

_lastActiveViewerJson

_lastCameraInfo

静态getEnv

静态getSceneObjById

静态setEnv

$refs

• get $refs(): { [k: string]: undefined | ESSceneObject }

  获取场景对象的引用。

  返回 { [k: string]: undefined | ESSceneObject }

activeViewer

• get activeViewer(): undefined | ESViewer

  获取当前活动的视口。

  返回 undefined | ESViewer
• set activeViewer(value: undefined | ESViewer): void

  设置当前活动的视口。

  参数

  • value: undefined | ESViewer

    要设置的视口。

  返回 void

activeViewerChanged

• get activeViewerChanged(): Listener<
      [undefined | ESViewer, undefined | ESViewer],
  >

  获取活动视口改变事件。

  返回 Listener<[undefined | ESViewer, undefined | ESViewer]>

cameraViewsManager

• get cameraViewsManager(): ESCameraViewCollection

  获取相机视角集合管理器。

  返回 ESCameraViewCollection

completeJson

• get completeJson(): {
      asset: {
          createdTime: string;
          modifiedTime: string;
          name: string;
          type: string;
          version: string;
      };
      lastView: undefined
      | { position: ESJVector3D; rotation: ESJVector3D };
      sceneTree: { root: { children: SceneTreeItemJsonValue[] } };
      viewCollection: ESJViewInfo[];
      viewers: JsonValue[];
  }

  获取对象的 JSON 表示，包含所有属性。包括默认值

  返回 {
      asset: {
          createdTime: string;
          modifiedTime: string;
          name: string;
          type: string;
          version: string;
      };
      lastView: undefined
      | { position: ESJVector3D; rotation: ESJVector3D };
      sceneTree: { root: { children: SceneTreeItemJsonValue[] } };
      viewCollection: ESJViewInfo[];
      viewers: JsonValue[];
  }

dragstartDataMananger

• get dragstartDataMananger(): DragStartDataManager

  获取拖动开始数据管理器。

  返回 DragStartDataManager

esPlyarAndPathTime

• get esPlyarAndPathTime(): ESPlyarAndPathTime

  获取播放器和路径时间管理器。

  返回 ESPlyarAndPathTime

json

• get json(): ESObjectsManagerJsonType

  获取 ESObjectsManager 的 JSON 表示。

  返回 ESObjectsManagerJsonType

  包含资产信息、视口信息、场景树信息、视角集合信息和最后一个视口的相机信息的 JSON 对象。
• set json(value: ESObjectsManagerJsonType): void

  设置 ESObjectsManager 的 JSON 数据。

  参数

  • value: ESObjectsManagerJsonType

    包含资产信息、视口信息、场景树信息、视角集合信息和最后一个视口的相机信息的 JSON 对象。

  返回 void

jsonLoadingEvent

• get jsonLoadingEvent(): Event<
      [
          | { type: "init"
          | "loading"
          | "loaded" }
          | { error?: string; type: "error" },
      ],
  >

  获取 JSON 加载事件。

  返回 Event<
      [
          | { type: "init"
          | "loading"
          | "loaded" }
          | { error?: string; type: "error" },
      ],
  >

pathAnimationManager

• get pathAnimationManager(): PathAnimationManager

  路径动画管理器 1.channels : { pathId: string, sceneObjectIds: string[] }[]； 2.player : ESPlayer； 3.指定的id的sceneObject必须拥有position和rotation属性,path类型为 ESPath；

  返回 PathAnimationManager

player

• get player(): ESPlayer

  获取播放器。

  返回 ESPlayer

propUiTreeManager

• get propUiTreeManager(): PropUiTreeManager

  获取属性 UI 树管理器。

  返回 PropUiTreeManager

sceneObjectEditingManager

• get sceneObjectEditingManager(): SceneObjectEditingManager

  获取场景对象编辑管理器。

  返回 SceneObjectEditingManager

sceneObjectsManager

• get sceneObjectsManager(): SceneObjectsManager

  获取场景对象管理器。

  返回 SceneObjectsManager

sceneTree

• get sceneTree(): SceneTree

  获取默认场景树。

  返回 SceneTree

syncOtherViewersToActived

• get syncOtherViewersToActived(): boolean

  获取是否将其他视口同步到活动视口的状态。

  返回 boolean
• set syncOtherViewersToActived(value: boolean): void

  设置是否将其他视口同步到活动视口。

  参数

  • value: boolean

    布尔值，指示是否同步。

  返回 void

syncOtherViewersToActivedChanged

• get syncOtherViewersToActivedChanged(): Listener<[boolean, boolean]>

  获取同步状态改变事件。

  返回 Listener<[boolean, boolean]>

viewerCreatedEvent

• get viewerCreatedEvent(): Event<[ESViewer]>

  获取视口创建事件。

  返回 Event<[ESViewer]>

viewers

• get viewers(): Readonly<Set<ESViewer>>

  获取所有视口。

  返回 Readonly<Set<ESViewer>>

静态envs

• get envs(): { [k: string]: undefined | string }

  获取所有环境变量的静态属性。

  返回 { [k: string]: undefined | string }

createCesiumViewer

• createCesiumViewer<T extends ESViewer>(params: ESVOptionCzm): T

  创建 Cesium 视口。

  类型参数

  • T extends ESViewer

  参数

  • params: ESVOptionCzm

    创建选项，可以是对象或具体参数。

  返回 T

  创建的视口。
• createCesiumViewer<T extends ESViewer>(
      container: string | HTMLDivElement,
      options?: JsonValue,
      id?: string,
  ): T

  创建 Cesium 视口。

  类型参数

  • T extends ESViewer

  参数

  • container: string | HTMLDivElement

    视口容器，可以是 HTML 元素或字符串。
  • 可选options: JsonValue

    视口选项，可选。
  • 可选id: string

    视口的 ID，可选。

  返回 T

  创建的视口。

createOpenLayersViewer

• createOpenLayersViewer<T extends ESViewer>(params: ESVOptionOl): T

  创建 OpenLayers 视口。

  类型参数

  • T extends ESViewer

  参数

  • params: ESVOptionOl

    创建选项，可以是对象或具体参数。

  返回 T

  创建的视口。
• createOpenLayersViewer<T extends ESViewer>(
      container: string | HTMLDivElement,
      options?: JsonValue,
      id?: string,
  ): T

  创建 Cesium 视口。

  类型参数

  • T extends ESViewer

  参数

  • container: string | HTMLDivElement

    视口容器，可以是 HTML 元素或字符串。
  • 可选options: JsonValue

    视口选项，可选。
  • 可选id: string

    视口的 ID，可选。

  返回 T

  创建的视口。

createSceneObject

• createSceneObject<T extends ESSceneObject>(
      sceneObjectType: string | (new (id?: string) => T),
      id?: string,
  ): undefined | T

  创建场景对象。

  类型参数

  • T extends ESSceneObject

  参数

  • sceneObjectType: string | (new (id?: string) => T)

    场景对象类型，可以是字符串或构造函数。
  • 可选id: string

    场景对象的 ID，可选。

  返回 undefined | T

  创建的场景对象。

createSceneObjectFromClass

• createSceneObjectFromClass<T extends ESSceneObject>(
      sceneObjConstructor: new (id?: string) => T,
      id?: string,
  ): T

  根据类构造函数创建场景对象。

  类型参数

  • T extends ESSceneObject

  参数

  • sceneObjConstructor: new (id?: string) => T

    场景对象的构造函数。
  • 可选id: string

    场景对象的 ID，可选。

  返回 T

  创建的场景对象。

createSceneObjectFromJson

• createSceneObjectFromJson<T extends ESSceneObject>(
      sceneObjectJson: JsonValue & { type: string; [k: string]: any },
  ): undefined | T

  根据 JSON 数据创建场景对象。

  类型参数

  • T extends ESSceneObject

  参数

  • sceneObjectJson: JsonValue & { type: string; [k: string]: any }

    包含场景对象类型和其他属性的 JSON 数据。

  返回 undefined | T

  创建的场景对象，如果解析失败则返回 undefined。

createSceneObjectFromUrl

• createSceneObjectFromUrl(url: string, id?: string): undefined | ESSceneObject

  根据 URL 创建场景对象。

  参数

  • url: string

    场景对象的 URL。
  • 可选id: string

    场景对象的 ID，可选。

  返回 undefined | ESSceneObject

  创建的场景对象。

createSceneTree

• createSceneTree(id: string, itemDivHeight?: number): undefined | SceneTree

  创建新的场景树。

  参数

  • id: string

    场景树的 ID。
  • itemDivHeight: number = 24

    场景树项的高度，默认为 24。

  返回 undefined | SceneTree

  创建的场景树，如果 ID 已存在则返回已有的场景树。

createUeViewer

• createUeViewer<T extends ESViewer>(params: ESVOptionUe): T

  创建 UE 视口。

  类型参数

  • T extends ESViewer

  参数

  • params: ESVOptionUe

    创建选项，可以是对象或具体参数。

  返回 T

  创建的视口。
• createUeViewer<T extends ESViewer>(
      container: string | HTMLDivElement,
      uri: string,
      app: string,
      token?: string,
      id?: string,
  ): T

  创建 UE 视口。

  类型参数

  • T extends ESViewer

  参数

  • container: string | HTMLDivElement

    视口容器，可以是 HTML 元素或字符串。
  • uri: string

    视口的 URI。
  • app: string

    应用程序名称。
  • 可选token: string

    令牌，可选。
  • 可选id: string

    视口的 ID，可选。

  返回 T

  创建的视口。
• createUeViewer<T extends ESViewer>(
      container: string | HTMLDivElement,
      ws: string,
      esmsg?: string,
      id?: string,
  ): T

  创建 UE 视口。

  类型参数

  • T extends ESViewer

  参数

  • container: string | HTMLDivElement

    视口容器，可以是 HTML 元素或字符串。
  • ws: string

    WebSocket 地址。
  • 可选esmsg: string

    消息，可选。
  • 可选id: string

    视口的 ID，可选。

  返回 T

  创建的视口。
• createUeViewer<T extends ESViewer>(
      container: string | HTMLDivElement,
      project: string,
      baseUrl?: string,
      id?: string,
  ): T

  创建 UE 视口。

  类型参数

  • T extends ESViewer

  参数

  • container: string | HTMLDivElement

    视口容器，可以是 HTML 元素或字符串。
  • project: string

    项目名称。
  • 可选baseUrl: string

    基础 URL，可选。
  • 可选id: string

    视口的 ID，可选。

  返回 T

  创建的视口。

createViewer

• createViewer(option: ESVOption): ESViewer

  创建新的视口。

  参数

  • option: ESVOption

    视口创建选项。

  返回 ESViewer

  创建的视口。

destroyAllSceneObjects

• destroyAllSceneObjects(): void

  销毁所有场景对象，但跳过内置对象（如视角集合和内置播放器）。

  返回 void

destroySceneObject

• destroySceneObject<T extends ESSceneObject>(sceneObject: T): boolean

  销毁指定的场景对象。

  类型参数

  • T extends ESSceneObject

  参数

  • sceneObject: T

    要销毁的场景对象。

  返回 boolean

  销毁操作的结果。

destroyViewer

• destroyViewer<T extends ESViewer>(viewer: T): boolean

  销毁指定的视口。

  类型参数

  • T extends ESViewer

  参数

  • viewer: T

    要销毁的视口。

  返回 boolean

  销毁操作的结果。

getSceneObject

• getSceneObject(option?: string): undefined | ESSceneObject | ESSceneObject[]

  获取场景对象。

  参数

  • 可选option: string

    可以是对象 ID 或者对象类型，为空则返回所有对象。

  返回 undefined | ESSceneObject | ESSceneObject[]

  单个场景对象、场景对象数组或undefined。

getSceneObjectById

• getSceneObjectById(id: string): undefined | ESSceneObject

  根据对象 ID 获取场景对象。

  参数

  • id: string

    对象的 ID。

  返回 undefined | ESSceneObject

  对应的场景对象或者undefined。

getSceneTree

• getSceneTree(id?: string): undefined | SceneTree

  根据 ID 获取场景树。

  参数

  • id: string = 'default'

    场景树的 ID，默认为 'default'。

  返回 undefined | SceneTree

  对应的场景树，如果不存在则返回 undefined。

getSceneTrees

• getSceneTrees(): SceneTree[]

  获取所有场景树。

  返回 SceneTree[]

  场景树数组。

getViewers

• getViewers(): readonly ESViewer[]

  获取所有视口的方法。

  返回 readonly ESViewer[]

  视口数组。

propTreeCallback

• propTreeCallback(params: propTreeCallbackParamsType): void

  属性树回调方法。

  参数

  • params: propTreeCallbackParamsType

    属性树回调参数。

  返回 void

  回调结果。

switchToCesiumViewer

• switchToCesiumViewer<T extends ESViewer>(
      option: ESJSwitchToCesiumViewerOptionType,
  ): T

  切换到 Cesium 视口。

  类型参数

  • T extends ESViewer

  参数

  • option: ESJSwitchToCesiumViewerOptionType

    切换选项，可以是对象或具体参数。

  返回 T

  切换后的视口。
• switchToCesiumViewer<T extends ESViewer>(
      container: string | HTMLDivElement,
      viewSync?: boolean,
      attributeSync?: boolean,
      destroy?: boolean,
      id?: string,
  ): T

  切换到 Cesium 视口。

  类型参数

  • T extends ESViewer

  参数

  • container: string | HTMLDivElement

    视口容器，可以是 HTML 元素或字符串。
  • 可选viewSync: boolean

    是否同步视角，默认为 true。
  • 可选attributeSync: boolean

    是否同步属性，默认为 true。
  • 可选destroy: boolean

    是否销毁当前活动视口，默认为 true。
  • 可选id: string

    视口的 ID。

  返回 T

  切换后的视口。

switchToUEViewer

• switchToUEViewer<T extends ESViewer>(options: ESJSwitchToUEViewerOptionType): T

  切换到 UE 视口。

  类型参数

  • T extends ESViewer

  参数

  • options: ESJSwitchToUEViewerOptionType

    切换选项，可以是对象或具体参数。

  返回 T

  切换后的视口。
• switchToUEViewer<T extends ESViewer>(
      container: string | HTMLDivElement,
      uri: string,
      app: string,
      token?: string,
      viewSync?: boolean,
      attributeSync?: boolean,
      destroy?: boolean,
      id?: string,
  ): T

  切换到 UE 视口。

  类型参数

  • T extends ESViewer

  参数

  • container: string | HTMLDivElement

    视口容器，可以是 HTML 元素或字符串。
  • uri: string

    视口的 URI。
  • app: string

    应用程序名称。
  • 可选token: string

    令牌，可选。
  • 可选viewSync: boolean

    是否同步视角，默认为 true。
  • 可选attributeSync: boolean

    是否同步属性，默认为 true。
  • 可选destroy: boolean

    是否销毁当前活动视口，默认为 true。
  • 可选id: string

    视口的 ID，可选。

  返回 T

  切换后的视口。
• switchToUEViewer<T extends ESViewer>(
      container: string | HTMLDivElement,
      ws: string,
      esmsg?: string,
      viewSync?: boolean,
      attributeSync?: boolean,
      destroy?: boolean,
      id?: string,
  ): T

  切换到 UE 视口。

  类型参数

  • T extends ESViewer

  参数

  • container: string | HTMLDivElement

    视口容器，可以是 HTML 元素或字符串。
  • ws: string

    WebSocket 地址。
  • 可选esmsg: string

    消息，可选。
  • 可选viewSync: boolean

    是否同步视角，默认为 true。
  • 可选attributeSync: boolean

    是否同步属性，默认为 true。
  • 可选destroy: boolean

    是否销毁当前活动视口，默认为 true。
  • 可选id: string

    视口的 ID，可选。

  返回 T

  切换后的视口。
• switchToUEViewer<T extends ESViewer>(
      container: string | HTMLDivElement,
      project: string,
      baseUrl?: string,
      viewSync?: boolean,
      attributeSync?: boolean,
      destroy?: boolean,
      id?: string,
  ): T

  切换到 UE 视口。

  类型参数

  • T extends ESViewer

  参数

  • container: string | HTMLDivElement

    视口容器，可以是 HTML 元素或字符串。
  • project: string

    项目名称。
  • 可选baseUrl: string

    基础 URL，可选。
  • 可选viewSync: boolean

    是否同步视角，默认为 true。
  • 可选attributeSync: boolean

    是否同步属性，默认为 true。
  • 可选destroy: boolean

    是否销毁当前活动视口，默认为 true。
  • 可选id: string

    视口的 ID，可选。

  返回 T

  切换后的视口。

switchViewer

• switchViewer<T extends ESViewer>(
      option: ESVOption,
      viewSync?: boolean,
      attributeSync?: boolean,
      destroy?: boolean,
  ): T

  切换视口。

  类型参数

  • T extends ESViewer

  参数

  • option: ESVOption

    视口切换选项。
  • viewSync: boolean = true

    是否同步视角，默认为 true。
  • attributeSync: boolean = true

    是否同步属性，默认为 true。
  • destroy: boolean = true

    是否销毁当前活动视口，默认为 true。

  返回 T

  切换后的视口。