EarthSDK
    正在准备搜索索引...

    类 CzmESEntityCluster

    EngineObject 类表示一个与场景对象和视口关联的引擎对象。 该类提供了注册引擎对象到全局上下文的方法，并管理引擎对象的创建、组件更新等。

    核心功能包括：

    • 注册非编辑模式下的引擎对象到全局上下文。
    • 注册编辑模式下的引擎对象到全局上下文。
    • 获取引擎对象的唯一 ID。
    • 获取与引擎对象关联的场景对象和视口。
    • 管理引擎对象的组件更新。

    使用示例：

    构造函数参数：

    • _sceneObject：与引擎对象关联的场景对象。
    • _viewer：与引擎对象关联的视口。
    • isEditing：指示是否处于编辑模式，默认为 false。

    特殊使用限制或潜在的副作用：

    • 在编辑模式下，构造函数不会进行初始化。
    • 构造函数会自动设置场景对象的视口，并触发视口变更事件。
    • 构造函数会处理场景对象组件的添加和删除，确保组件正确关联到视口。

    层级 (查看层级一览)

    索引

    构造函数

    constructor

    属性

    _lastMemId clusterImageAttribute clusterImages clusterImageUrl context contextEditing register registerEditing scaleByDistance scaleFactor type

    访问器

    createdEvent czmViewer dataSource dataSourceChanged disposers id memId pointFeatures pointFeaturesChanged sceneObject toDestroyEvent viewer

    方法

    ad autoDispose d destroy destroyImp dispose disposeVar dv flyIn flyTo getNthValue isDestroyed tdv tryDestory tryDisposeVar

    构造函数

    属性

    静态_lastMemId

    _lastMemId: number = -1
    clusterImageAttribute: undefined | { [xx: string]: any } = undefined
    clusterImages: undefined | { [xx: string]: any } = undefined
    clusterImageUrl: string = ...
    context: EngineObjectsContext = ...

    引擎对象的全局上下文实例，用于注册非编辑模式下的引擎对象。

    contextEditing: EditingObjectContext = ...

    编辑模式下引擎对象的全局上下文实例，用于注册编辑模式下的引擎对象。

    register: <R extends ESSceneObject, V extends ESViewer>(
        viewerType: string,
        sceneObjectTypeName: string,
        objConstructor: new (sceneObject: R, viewer: V) => EngineObject<R>,
    ) => string = ...

    注册非编辑模式下的引擎对象到全局上下文的方法。

    类型声明

      • <R extends ESSceneObject, V extends ESViewer>(
            viewerType: string,
            sceneObjectTypeName: string,
            objConstructor: new (sceneObject: R, viewer: V) => EngineObject<R>,
        ): string

      • 注册一个引擎对象构造函数。

        类型参数

        • R extends ESSceneObject

          场景对象的类型，必须是 ESSceneObject 的子类。

        • V extends ESViewer

          查看器的类型，必须是 ESViewer 的子类。

        参数

        • viewerType: string

          查看器的类型名称。

        • sceneObjectTypeName: string

          场景对象的类型名称。

        • objConstructor: new (sceneObject: R, viewer: V) => EngineObject<R>

          引擎对象的构造函数，接受场景对象和查看器作为参数。

        返回 string

        如果相同的查看器类型和场景对象类型名称已经注册过，会发出警告并覆盖原有的构造函数。

    registerEditing: <R extends ESSceneObject, V extends ESViewer>(
        viewerType: string,
        sceneObjectTypeName: string,
        objConstructor: new (sceneObject: R, viewer: V) => EngineObject<R>,
    ) => void = ...

    注册编辑模式下的引擎对象到全局上下文的方法。

    类型声明

      • <R extends ESSceneObject, V extends ESViewer>(
            viewerType: string,
            sceneObjectTypeName: string,
            objConstructor: new (sceneObject: R, viewer: V) => EngineObject<R>,
        ): void

      • 注册引擎对象的构造函数。

        类型参数

        • R extends ESSceneObject

          场景对象的类型，必须是 ESSceneObject 的子类。

        • V extends ESViewer

          查看器的类型，必须是 ESViewer 的子类。

        参数

        • viewerType: string

          查看器的类型名称。

        • sceneObjectTypeName: string

          场景对象的类型名称。

        • objConstructor: new (sceneObject: R, viewer: V) => EngineObject<R>

          引擎对象的构造函数，接受场景对象和查看器作为参数。

        返回 void

        如果指定的查看器类型和场景对象类型已经注册过，会在控制台输出警告信息，再次注册会覆盖之前的注册。

    scaleByDistance: NearFarScalar = ...
    scaleFactor: number = 0.6
    type: string = ...

    访问器

    • get createdEvent(): Event<[]>

      获取对象创建完成的事件。

      返回 Event<[]>

    • get czmViewer(): ESCesiumViewer

      返回 ESCesiumViewer

    • get dataSource(): undefined | GeoJsonDataSource

      返回 undefined | GeoJsonDataSource

    • set dataSource(value: undefined | GeoJsonDataSource): void

      参数

      • value: undefined | GeoJsonDataSource

      返回 void

    • get dataSourceChanged(): Listener<
          [undefined | GeoJsonDataSource, undefined | GeoJsonDataSource],
      >

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

    • get disposers(): (() => void)[]

      返回 (() => void)[]

    • get id(): number

      获取引擎对象的唯一 ID。

      返回 number

    • get memId(): number

      返回 number

    • get pointFeatures(): undefined | { [xx: string]: any }

      返回 undefined | { [xx: string]: any }

    • set pointFeatures(value: undefined | { [xx: string]: any }): void

      参数

      • value: undefined | { [xx: string]: any }

      返回 void

    • get pointFeaturesChanged(): Listener<
          [undefined | { [xx: string]: any }, undefined | { [xx: string]: any }],
      >

      返回 Listener<[undefined | { [xx: string]: any }, undefined | { [xx: string]: any }]>

    • get sceneObject(): T

      获取与引擎对象关联的场景对象。

      返回 T

    • get toDestroyEvent(): Listener

      返回 Listener

    • get viewer(): V

      获取与引擎对象关联的视口。

      返回 V

    方法

    • 参数

      • disposeFunc: () => void

      返回 () => void

    • 类型参数

      • T extends { destroy(): void }

      参数

      • obj: T

      返回 T

    • 参数

      • disposeFunc: () => void

      返回 () => void

    • 类型参数

      • T extends { destroy(): void }

      参数

      • obj: T

      返回 T

    • 参数

      • disposeFunc: () => void

      返回 () => void

    • 返回 undefined

    • 请不要重写destroy，请使用destroyImp来重写！

      返回 undefined

    • 返回 void

    • 参数

      • disposeFunc: () => void

      返回 () => void

    • 类型参数

      • T extends { destroy(): void }

      参数

      • obj: T

      返回 T

    • 类型参数

      • T extends { destroy(): void }

      参数

      • obj: T

      返回 T

    • 参数

      • duration: undefined | number

        注意ES对象的时间单位都是秒

      • id: number
      • flyMode: "default" | "uniform" = 'default'

      返回 boolean

    • 参数

      • duration: undefined | number

        注意ES对象的时间单位都是秒

      • id: number
      • flyMode: "default" | "uniform" = 'default'

      返回 boolean

    • 参数

      • targetIndex: number

      返回 any

    • 返回 boolean

    • 返回 boolean

    • 类型参数

      • T extends { tryDestroy(): void }

      参数

      • obj: T

      返回 T

    • 返回 undefined

    • 类型参数

      • T extends { tryDestroy(): void }

      参数

      • obj: T

      返回 T

    显示设置

    成员可见性

    目录

    构造函数
    属性
    访问器
    方法