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

    类 ESXYZLayer

    ESVisualObject 类是一个抽象类，用于表示场景中的可视化对象。 该类继承自 ESSceneObject 类，并提供了编辑模式、飞行事件、拾取事件等核心功能。 https://c0yh9tnn0na.feishu.cn/wiki/DpH6wv6rTiKQnakg8n8cdAKMnVd 核心功能包括：

    • 支持编辑模式的管理和获取
    • 编辑状态的管理和事件触发
    • 飞行事件（飞入、飞向、飞行结束）的触发和监听
    • 拾取事件的触发和监听
    • 计算飞行参数事件
    • 获取对象的边界球
    • 管理和获取对象的属性

    使用示例：

    构造函数参数：

    • id：对象的唯一标识，类型为 string | undefined

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

    • _deprecated 属性用于管理弃用的变量，当这些变量发生变化时会输出警告信息。

    层级 (查看层级一览)

    索引

    构造函数

    constructor

    属性

    _deprecated allowPicking allowPickingChanged allowPickingReact attributions attributionsChanged attributionsCollapsible attributionsCollapsibleChanged attributionsCollapsibleReact attributionsReact cacheSize cacheSizeChanged cacheSizeReact collision collisionChanged collisionReact crossOrigin crossOriginChanged crossOriginReact devTags devTagsChanged devTagsReact editingBindMode editingID execOnceFuncStr execOnceFuncStrChanged execOnceFuncStrReact extras extrasChanged extrasReact flyInParam flyInParamChanged flyInParamReact flyToParam flyToParamChanged flyToParamReact gutter gutterChanged gutterReact interpolate interpolateChanged interpolateReact maxResolution maxResolutionChanged maxResolutionReact maxZoom maxZoomChanged maxZoomReact minZoom minZoomChanged minZoomReact name nameChanged nameReact opaque opaqueChanged opaqueReact projection projectionChanged projectionReact ref refChanged refReact reprojectionErrorThreshold reprojectionErrorThresholdChanged reprojectionErrorThresholdReact show showChanged showReact tileGrid tileGridChanged tileGridReact tileLoadFunction tileLoadFunctionChanged tileLoadFunctionReact tilePixelRatio tilePixelRatioChanged tilePixelRatioReact tileSize tileSizeChanged tileSizeReact tileUrlFunction tileUrlFunctionChanged tileUrlFunctionReact toDestroyFuncStr toDestroyFuncStrChanged toDestroyFuncStrReact transition transitionChanged transitionReact updateFuncStr updateFuncStrChanged updateFuncStrReact url urlChanged urlReact urls urlsChanged urlsReact useCalcFlyToParamInESObjectWithLocation wrapX wrapXChanged wrapXReact zDirection zDirectionChanged zDirectionReact zIndex zIndexChanged zIndexReact _lastFlyInId _lastFlyToId _lastMemId context create createFromClass createFromJson createFromUrl defaultFlyInParam defaultFlyToParam defaults destroySceneObject getEnv getSceneObj getSceneObjById getSceneObject getSceneObjectById getStrFromEnv innerRegister setEnv supportEditingModes type

    访问器

    _jsonStr activeViewer activeViewerChanged attachedViewers calcFlyInParamEvent calcFlyToParamEvent completeJson components createdEvent defaultProps disposers editing editingChanged flushEvent flyInEvent flyOverEvent flyToDistance flyToDistanceChanged flyToEvent flyToFlyDuration flyToFlyDurationChanged flyToHDelta flyToHDeltaChanged flyToHeading flyToHeadingChanged flyToPDelta flyToPDeltaChanged flyToPitch flyToPitchChanged id json memId parentID pickedEvent toDestroyEvent toDestroyFunc toDestroyFuncChanged typeName updateFunc updateFuncChanged viewerAttached viewerDetached $refs envs

    方法

    _deprecatedWarning ad addToViewer autoDispose calcFlyInParam calcFlyToParam createAttachedObject d destroy destroyImp dispose disposeVar dv emptyFlyInParam emptyFlyToParam flush flyIn flyTo getBoundSphere getESProperties getProperties isDestroyed registerAttachedObject registerAttachedObjectForContainer removefromViewer supportEditingModes tdv tryDestory tryDisposeVar updateEditing createDefaultProps getParentClass register

    构造函数

    属性

    _deprecated

    _deprecated: (string | { [k: string]: any })[] = []

    弃用变量管理器 请勿使用该属性

    allowPicking: boolean = false

    是否允许拾取 默认false

    allowPickingChanged: Listener<[boolean, boolean]>
    allowPickingReact: ReactiveVariable<false> | ReactiveVariable<true>
    attributions: undefined | string[] = ...
    attributionsChanged: Listener<[undefined | string[], undefined | string[]]>
    attributionsCollapsible: undefined | boolean = ...
    attributionsCollapsibleChanged: Listener<
        [undefined | boolean, undefined | boolean],
    >
    attributionsCollapsibleReact:
        | ReactiveVariable<undefined>
        | ReactiveVariable<false>
        | ReactiveVariable<true>
    attributionsReact: ReactiveVariable<undefined | string[]>
    cacheSize: undefined | number = ...
    cacheSizeChanged: Listener<[undefined | number, undefined | number]>
    cacheSizeReact: ReactiveVariable<number> | ReactiveVariable<undefined>
    collision: boolean = true

    是否开启碰撞监测 默认true ,主要是UE使用

    collisionChanged: Listener<[boolean, boolean]>
    collisionReact: ReactiveVariable<false> | ReactiveVariable<true>
    crossOrigin: undefined | string = ...
    crossOriginChanged: Listener<[undefined | string, undefined | string]>
    crossOriginReact: ReactiveVariable<string> | ReactiveVariable<undefined>
    devTags: undefined | string[] = ...

    对象类型名称相关的开发标签数组，使用 reactArrayWithUndefined 进行响应式处理，默认为 undefined。

    devTagsChanged: Listener<[undefined | string[], undefined | string[]]>
    devTagsReact: ReactiveVariable<undefined | string[]>
    editingBindMode: ESJEditingBindModeType = 'singlePoint'

    编辑绑定模式，默认为 'singlePoint'

    editingID: undefined | string = undefined

    编辑 ID，用于标识编辑操作

    execOnceFuncStr: undefined | string = ...

    一次性执行函数的字符串表示，默认为 undefined。

    execOnceFuncStrChanged: Listener<[undefined | string, undefined | string]>
    execOnceFuncStrReact: ReactiveVariable<string> | ReactiveVariable<undefined>
    extras: JsonValue = ...

    扩展属性 JSON，必须整体赋值，使用 reactJson 进行响应式处理，默认为 undefined。

    extrasChanged: Listener<[JsonValue, JsonValue]>
    extrasReact: ReactiveVariable<JsonValue>
    flyInParam: undefined | ESJFlyInParam = ...

    飞入参数

    flyInParamChanged: Listener<
        [undefined | ESJFlyInParam, undefined | ESJFlyInParam],
    >
    flyInParamReact: ReactiveVariable<undefined | ESJFlyInParam>
    flyToParam: undefined | ESJFlyToParam = ...

    飞向参数

    flyToParamChanged: Listener<
        [undefined | ESJFlyToParam, undefined | ESJFlyToParam],
    >
    flyToParamReact: ReactiveVariable<undefined | ESJFlyToParam>
    gutter: undefined | number = ...
    gutterChanged: Listener<[undefined | number, undefined | number]>
    gutterReact: ReactiveVariable<number> | ReactiveVariable<undefined>
    interpolate: undefined | boolean = ...
    interpolateChanged: Listener<[undefined | boolean, undefined | boolean]>
    interpolateReact:
        | ReactiveVariable<undefined>
        | ReactiveVariable<false>
        | ReactiveVariable<true>
    maxResolution: undefined | number = ...
    maxResolutionChanged: Listener<[undefined | number, undefined | number]>
    maxResolutionReact: ReactiveVariable<number> | ReactiveVariable<undefined>
    maxZoom: undefined | number = ...
    maxZoomChanged: Listener<[undefined | number, undefined | number]>
    maxZoomReact: ReactiveVariable<number> | ReactiveVariable<undefined>
    minZoom: undefined | number = ...
    minZoomChanged: Listener<[undefined | number, undefined | number]>
    minZoomReact: ReactiveVariable<number> | ReactiveVariable<undefined>
    name: string = '未命名场景对象'

    对象名称，默认为 '未命名场景对象'。

    nameChanged: Listener<[string, string]>
    nameReact: ReactiveVariable<string>
    opaque: undefined | boolean = ...
    opaqueChanged: Listener<[undefined | boolean, undefined | boolean]>
    opaqueReact:
        | ReactiveVariable<undefined>
        | ReactiveVariable<false>
        | ReactiveVariable<true>
    projection: JsonValue = ...
    projectionChanged: Listener<[JsonValue, JsonValue]>
    projectionReact: ReactiveVariable<JsonValue>
    ref: undefined | string = ...

    对象引用，设置后可通过对象管理器 objm.$refs.xxx 快速获取到对象，默认为 undefined。

    refChanged: Listener<[undefined | string, undefined | string]>
    refReact: ReactiveVariable<string> | ReactiveVariable<undefined>
    reprojectionErrorThreshold: undefined | number = ...
    reprojectionErrorThresholdChanged: Listener<
        [undefined | number, undefined | number],
    >
    reprojectionErrorThresholdReact:
        | ReactiveVariable<number>
        | ReactiveVariable<undefined>
    show: boolean = true

    是否显示 默认true

    showChanged: Listener<[boolean, boolean]>
    showReact: ReactiveVariable<false> | ReactiveVariable<true>
    tileGrid: JsonValue = ...
    tileGridChanged: Listener<[JsonValue, JsonValue]>
    tileGridReact: ReactiveVariable<JsonValue>
    tileLoadFunction: undefined | string = ...
    tileLoadFunctionChanged: Listener<[undefined | string, undefined | string]>
    tileLoadFunctionReact: ReactiveVariable<string> | ReactiveVariable<undefined>
    tilePixelRatio: undefined | number = ...
    tilePixelRatioChanged: Listener<[undefined | number, undefined | number]>
    tilePixelRatioReact: ReactiveVariable<number> | ReactiveVariable<undefined>
    tileSize: undefined | number = ...
    tileSizeChanged: Listener<[undefined | number, undefined | number]>
    tileSizeReact: ReactiveVariable<number> | ReactiveVariable<undefined>
    tileUrlFunction: undefined | string = ...
    tileUrlFunctionChanged: Listener<[undefined | string, undefined | string]>
    tileUrlFunctionReact: ReactiveVariable<string> | ReactiveVariable<undefined>
    toDestroyFuncStr: undefined | string = ...

    销毁函数的字符串表示，默认为 undefined。

    toDestroyFuncStrChanged: Listener<[undefined | string, undefined | string]>
    toDestroyFuncStrReact: ReactiveVariable<string> | ReactiveVariable<undefined>
    transition: undefined | number = ...
    transitionChanged: Listener<[undefined | number, undefined | number]>
    transitionReact: ReactiveVariable<number> | ReactiveVariable<undefined>
    updateFuncStr: undefined | string = ...

    更新函数的字符串表示，默认为 undefined。

    updateFuncStrChanged: Listener<[undefined | string, undefined | string]>
    updateFuncStrReact: ReactiveVariable<string> | ReactiveVariable<undefined>
    url: undefined | string = ...
    urlChanged: Listener<[undefined | string, undefined | string]>
    urlReact: ReactiveVariable<string> | ReactiveVariable<undefined>
    urls: undefined | string[] = ...
    urlsChanged: Listener<[undefined | string[], undefined | string[]]>
    urlsReact: ReactiveVariable<undefined | string[]>
    useCalcFlyToParamInESObjectWithLocation: boolean = false

    是否使用 ESObjectWithLocation 类中的 calcFlyToParam 方法

    wrapX: undefined | boolean = ...
    wrapXChanged: Listener<[undefined | boolean, undefined | boolean]>
    wrapXReact:
        | ReactiveVariable<undefined>
        | ReactiveVariable<false>
        | ReactiveVariable<true>
    zDirection: undefined | number = ...
    zDirectionChanged: Listener<[undefined | number, undefined | number]>
    zDirectionReact: ReactiveVariable<number> | ReactiveVariable<undefined>
    zIndex: undefined | number = ...
    zIndexChanged: Listener<[undefined | number, undefined | number]>
    zIndexReact: ReactiveVariable<number> | ReactiveVariable<undefined>

    静态_lastFlyInId

    _lastFlyInId: number = 0

    最后一次飞入操作的 ID

    静态_lastFlyToId

    _lastFlyToId: number = 0

    最后一次飞向操作的 ID

    静态_lastMemId

    _lastMemId: number = -1
    context: ESObjectsContext = ...

    对象上下文，用于管理场景对象的创建、销毁、查找等操作。

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

    创建场景对象的方法。

    类型声明

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

      • 根据场景对象类型名或构造函数创建场景对象实例

        类型参数

        参数

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

          场景对象类型名或构造函数

        • 可选id: string

          可选的场景对象ID

        返回 undefined | T

        创建的场景对象实例，如果未找到对应的构造函数则返回 undefined

    createFromClass: <T extends ESSceneObject>(
        sceneObjConstructor: new (id?: string) => T,
        id?: string,
    ) => T = ...

    根据类创建场景对象的方法。

    类型声明

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

      • 根据场景对象的构造函数创建场景对象实例

        类型参数

        参数

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

          场景对象的构造函数

        • 可选id: string

          可选的场景对象ID，如果未提供或已存在相同ID的对象，将自动生成新的ID

        返回 T

        创建的场景对象实例

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

    根据 JSON 数据创建场景对象的方法。

    类型声明

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

      • 根据 JSON 对象创建场景对象实例，并将 JSON 数据赋值给场景对象

        类型参数

        参数

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

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

        返回 undefined | T

        创建的场景对象实例，如果未找到对应的构造函数则返回 undefined

    createFromUrl: (url: string, id?: string) => undefined | ESSceneObject = ...

    根据 URL 创建场景对象的方法。

    defaultFlyInParam: {
        flyDuration: number;
        position: number[];
        rotation: number[];
    } = ...
    defaultFlyToParam: {
        distance: number;
        flyDuration: number;
        hDelta: number;
        heading: number;
        pDelta: number;
        pitch: number;
    } = ...
    defaults: Record<string, any> = {}
    destroySceneObject: (sceneObject: ESSceneObject) => boolean = ...

    销毁场景对象的方法。

    类型声明

      • (sceneObject: ESSceneObject): boolean

      • 销毁指定的场景对象实例

        参数

        返回 boolean

        场景对象是否已被销毁

    getEnv: (varName: string) => undefined | string = ...

    获取环境变量的方法。

    类型声明

      • (varName: string): undefined | string

      • 获取环境变量

        参数

        • varName: string

          环境变量名

        返回 undefined | string

        环境变量值

    环境变量的键。

    对应的环境变量值，如果未找到则返回 undefined。

    getSceneObj: (option?: string) => undefined | ESSceneObject | ESSceneObject[] = ...

    根据对象 ID 获取场景对象的方法。

    类型声明

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

      • 根据不同的条件获取场景对象实例

        参数

        • 可选option: string

          可选的条件，如果未提供则返回所有场景对象；如果以 'ES' 开头，则返回指定类型的所有场景对象；否则返回指定ID的场景对象

        返回 undefined | ESSceneObject | ESSceneObject[]

        符合条件的场景对象实例数组或单个实例，如果未找到则返回 undefined

    对象的唯一标识符。

    对应的场景对象，如果未找到则返回 undefined。

    getSceneObjById: (id: string) => undefined | ESSceneObject = ...

    根据对象 ID 获取场景对象的方法。

    类型声明

      • (id: string): undefined | ESSceneObject

      • 根据场景对象的ID获取场景对象实例

        参数

        • id: string

          场景对象的ID

        返回 undefined | ESSceneObject

        对应的场景对象实例，如果未找到则返回 undefined

    对象的唯一标识符。

    对应的场景对象，如果未找到则返回 undefined。

    getSceneObject: (option?: string) => undefined | ESSceneObject | ESSceneObject[] = ...

    根据对象 ID 获取场景对象的方法。

    类型声明

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

      • 根据不同的条件获取场景对象实例

        参数

        • 可选option: string

          可选的条件，如果未提供则返回所有场景对象；如果以 'ES' 开头，则返回指定类型的所有场景对象；否则返回指定ID的场景对象

        返回 undefined | ESSceneObject | ESSceneObject[]

        符合条件的场景对象实例数组或单个实例，如果未找到则返回 undefined

    对象的唯一标识符。

    对应的场景对象，如果未找到则返回 undefined。

    getSceneObjectById: (id: string) => undefined | ESSceneObject = ...

    根据对象 ID 获取场景对象的方法。

    类型声明

      • (id: string): undefined | ESSceneObject

      • 根据场景对象的ID获取场景对象实例

        参数

        • id: string

          场景对象的ID

        返回 undefined | ESSceneObject

        对应的场景对象实例，如果未找到则返回 undefined

    对象的唯一标识符。

    对应的场景对象，如果未找到则返回 undefined。

    getStrFromEnv: (str: string) => string = ...

    从环境变量中获取字符串值的方法。

    类型声明

      • (str: string): string

      • 根据含有环境变量的字符串获取真实路径

        参数

        • str: string

          包含环境变量的字符串，环境变量格式为 ${xxx-xxx}

        返回 string

        替换环境变量后的真实路径字符串

    环境变量的键。

    对应的字符串值，如果未找到则返回 undefined。

    innerRegister: <T extends ESSceneObject>(
        sceneObjectType: string,
        sceneObjConstructor: new () => T,
        extraInfo?: { [k: string]: any },
    ) => string = ...

    注册对象到上下文的方法。

    类型声明

      • <T extends ESSceneObject>(
            sceneObjectType: string,
            sceneObjConstructor: new () => T,
            extraInfo?: { [k: string]: any },
        ): string

      • 注册场景对象类型及其构造函数

        类型参数

        参数

        • sceneObjectType: string

          场景对象类型名

        • sceneObjConstructor: new () => T

          场景对象的构造函数

        • 可选extraInfo: { [k: string]: any }

          可选的额外信息，将存储在构造函数的扩展属性中

        返回 string

        注册的场景对象类型名

    setEnv: (varName: string, value: undefined | string) => void = ...

    设置环境变量的方法。

    类型声明

      • (varName: string, value: undefined | string): void

      • 设置环境变量

        参数

        • varName: string

          环境变量名

        • value: undefined | string

          环境变量值

        返回 void

    环境变量的键。

    环境变量的值。

    supportEditingModes: string[] = []

    用于记录支持的编辑类型

    type: any = ...

    访问器

    _jsonStr

    • get _jsonStr(): string

      获取对象的 JSON 字符串表示。

      返回 string

    • set _jsonStr(value: string): void

      根据 JSON 字符串设置对象的属性。

      参数

      • value: string

        JSON 字符串。

      返回 void

    • get activeViewer(): undefined | ESViewer

      返回 undefined | ESViewer

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

      参数

      返回 void

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

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

    • get attachedViewers(): Set<ESViewer>

      获取对象当前存在于哪些视口上的集合。

      返回 Set<ESViewer>

    • get calcFlyInParamEvent(): Listener

      获取计算飞入参数事件

      返回 Listener

      计算飞入参数事件

    • get calcFlyToParamEvent(): Listener

      获取计算飞向参数事件

      返回 Listener

      计算飞向参数事件

    • get completeJson(): JsonValue

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

      返回 JsonValue

    • get createdEvent(): Event<[]>

      获取对象创建事件。

      返回 Event<[]>

    • get defaultProps(): {
          devTags: ReactiveVariable<undefined | string[]>;
          execOnceFuncStr: undefined | string;
          extras: ReactiveVariable<JsonValue>;
          name: string;
          ref: undefined | string;
          toDestroyFuncStr: undefined | string;
          updateFuncStr: undefined | string;
      }

      获取对象的默认属性。

      返回 {
          devTags: ReactiveVariable<undefined | string[]>;
          execOnceFuncStr: undefined | string;
          extras: ReactiveVariable<JsonValue>;
          name: string;
          ref: undefined | string;
          toDestroyFuncStr: undefined | string;
          updateFuncStr: undefined | string;
      }

      • devTags: ReactiveVariable<undefined | string[]>

        对象类型名称相关的开发标签数组，使用 reactArrayWithUndefined 进行响应式处理，默认为 undefined。

      • execOnceFuncStr: undefined | string

        一次性执行函数的字符串表示，默认为 undefined。

      • extras: ReactiveVariable<JsonValue>

        扩展属性 JSON，必须整体赋值，使用 reactJson 进行响应式处理，默认为 undefined。

      • name: string

        对象名称，默认为 '未命名场景对象'。

      • ref: undefined | string

        对象引用，设置后可通过对象管理器 objm.$refs.xxx 快速获取到对象，默认为 undefined。

      • toDestroyFuncStr: undefined | string

        销毁函数的字符串表示，默认为 undefined。

      • updateFuncStr: undefined | string

        更新函数的字符串表示，默认为 undefined。

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

      返回 (() => void)[]

    • get editing(): boolean

      获取对象的编辑状态

      返回 boolean

      编辑状态

    • set editing(value: boolean): void

      设置对象的编辑状态

      参数

      • value: boolean

        编辑状态

      返回 void

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

      获取编辑状态改变事件

      返回 Listener<[boolean, boolean]>

      编辑状态改变事件

    • get flushEvent(): Event<[]>

      获取刷新对象事件。

      返回 Event<[]>

    • get flyInEvent(): Event<
          [duration: number, id: number, flyMode?: "default" | "uniform"],
      >

      获取飞入事件

      返回 Event<[duration: number, id: number, flyMode?: "default" | "uniform"]>

      飞入事件

    • get flyOverEvent(): Event<
          [id: number, mode: "error" | "cancelled" | "over", viewer: ESViewer],
      >

      获取飞行结束事件

      返回 Event<[id: number, mode: "error" | "cancelled" | "over", viewer: ESViewer]>

      飞行结束事件

    • get flyToDistance(): undefined | number

      获取飞向距离

      返回 undefined | number

      飞向距离

    • set flyToDistance(value: undefined | number): void

      设置飞向距离

      参数

      • value: undefined | number

        飞向距离

      返回 void

    • get flyToDistanceChanged(): Listener<
          [undefined | ESJFlyToParam, undefined | ESJFlyToParam],
      >

      获取飞向距离改变事件

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

      飞向距离改变事件

    • get flyToEvent(): Listener<
          [duration: number, id: number, flyMode?: "default" | "uniform"],
      >

      获取飞向事件

      返回 Listener<[duration: number, id: number, flyMode?: "default" | "uniform"]>

      飞向事件

    • get flyToFlyDuration(): undefined | number

      获取飞向持续时间

      返回 undefined | number

      飞向持续时间

    • set flyToFlyDuration(value: undefined | number): void

      设置飞向持续时间

      参数

      • value: undefined | number

        飞向持续时间

      返回 void

    • get flyToFlyDurationChanged(): Listener<
          [undefined | ESJFlyToParam, undefined | ESJFlyToParam],
      >

      获取飞向持续时间改变事件

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

      飞向持续时间改变事件

    • get flyToHDelta(): undefined | number

      获取飞向水平偏移量

      返回 undefined | number

      飞向水平偏移量

    • set flyToHDelta(value: undefined | number): void

      设置飞向水平偏移量

      参数

      • value: undefined | number

        飞向水平偏移量

      返回 void

    • get flyToHDeltaChanged(): Listener<
          [undefined | ESJFlyToParam, undefined | ESJFlyToParam],
      >

      获取飞向水平偏移量改变事件

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

      飞向水平偏移量改变事件

    • get flyToHeading(): undefined | number

      获取飞向航向

      返回 undefined | number

      飞向航向

    • set flyToHeading(value: undefined | number): void

      设置飞向航向

      参数

      • value: undefined | number

        飞向航向

      返回 void

    • get flyToHeadingChanged(): Listener<
          [undefined | ESJFlyToParam, undefined | ESJFlyToParam],
      >

      获取飞向航向改变事件

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

      飞向航向改变事件

    • get flyToPDelta(): undefined | number

      获取飞向垂直偏移量

      返回 undefined | number

      飞向垂直偏移量

    • set flyToPDelta(value: undefined | number): void

      设置飞向垂直偏移量

      参数

      • value: undefined | number

        飞向垂直偏移量

      返回 void

    • get flyToPDeltaChanged(): Listener<
          [undefined | ESJFlyToParam, undefined | ESJFlyToParam],
      >

      获取飞向垂直偏移量改变事件

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

      飞向垂直偏移量改变事件

    • get flyToPitch(): undefined | number

      获取飞向俯仰角

      返回 undefined | number

      飞向俯仰角

    • set flyToPitch(value: undefined | number): void

      设置飞向俯仰角

      参数

      • value: undefined | number

        飞向俯仰角

      返回 void

    • get flyToPitchChanged(): Listener<
          [undefined | ESJFlyToParam, undefined | ESJFlyToParam],
      >

      获取飞向俯仰角改变事件

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

      飞向俯仰角改变事件

    • get id(): string

      获取对象的唯一标识符。

      返回 string

    • get json(): JsonValue

      获取对象的 JSON 表示。省略默认值属性，精简json

      返回 JsonValue

    • set json(value: JsonValue): void

      根据 JSON 数据设置对象的属性。

      参数

      返回 void

    • get memId(): number

      返回 number

    • get parentID(): string

      获取当前对象指定父级对象,未指定返回自身。

      返回 string

    • set parentID(value: undefined | string): void

      参数

      • value: undefined | string

      返回 void

    • get pickedEvent(): Event<[ESJPickedResult]>

      获取拾取事件

      返回 Event<[ESJPickedResult]>

      拾取事件

    • get toDestroyEvent(): Listener

      返回 Listener

    • get toDestroyFunc(): undefined | ((sceneObject: ESSceneObject) => void)

      获取对象的销毁函数。

      返回 undefined | ((sceneObject: ESSceneObject) => void)

    • set toDestroyFunc(
          value: undefined | ((sceneObject: ESSceneObject) => void),
      ): void

      设置对象的销毁函数。

      参数

      • value: undefined | ((sceneObject: ESSceneObject) => void)

        销毁函数。

      返回 void

    • get toDestroyFuncChanged(): Listener<
          [
              undefined
              | ((sceneObject: ESSceneObject) => void),
              undefined | ((sceneObject: ESSceneObject) => void),
          ],
      >

      获取销毁函数改变事件。

      返回 Listener<
          [
              undefined
              | ((sceneObject: ESSceneObject) => void),
              undefined | ((sceneObject: ESSceneObject) => void),
          ],
      >

    • get typeName(): string

      获取对象的类型名称，由子类实现。

      返回 string

    • get updateFunc(): | undefined
      | ((sceneObject: ESSceneObject, timeStamp: number) => void)

      获取对象的更新函数。

      返回 undefined | ((sceneObject: ESSceneObject, timeStamp: number) => void)

    • set updateFunc(
          value:
              | undefined
              | ((sceneObject: ESSceneObject, timeStamp: number) => void),
      ): void

      设置对象的更新函数。

      参数

      • value: undefined | ((sceneObject: ESSceneObject, timeStamp: number) => void)

        更新函数。

      返回 void

    • get updateFuncChanged(): Listener<
          [
              undefined
              | ((sceneObject: ESSceneObject, timeStamp: number) => void),
              undefined | ((sceneObject: ESSceneObject, timeStamp: number) => void),
          ],
      >

      获取更新函数改变事件。

      返回 Listener<
          [
              undefined
              | ((sceneObject: ESSceneObject, timeStamp: number) => void),
              undefined | ((sceneObject: ESSceneObject, timeStamp: number) => void),
          ],
      >

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

      获取对象创建在视口上的事件。

      返回 Event<[ESViewer]>

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

      获取对象从视口移除的事件。

      返回 Event<[ESViewer]>

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

      获取所有引用对象的集合。

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

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

      获取所有环境变量的集合。

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

    方法

    _deprecatedWarning

    • _deprecatedWarning(): void

      弃用变量管理器 当弃用的属性发生变化时，会在控制台输出警告信息

      返回 void

    • 参数

      • disposeFunc: () => void

      返回 () => void

    • 类型参数

      • T extends { destroy(): void }

      参数

      • obj: T

      返回 T

    • 将对象添加到指定视口中。

      参数

      • viewer: ESViewer

        要添加对象的视口。

      返回 void

    • 参数

      • disposeFunc: () => void

      返回 () => void

    • 类型参数

      • T extends { destroy(): void }

      参数

      • obj: T

      返回 T

    • 触发计算飞入参数事件

      返回 void

    • 触发计算飞向参数事件

      返回 void

    • 创建与视口关联的对象，并返回一个销毁函数，用于手动销毁关联对象。

      参数

      • createViewerPropSceneObject: (viewer: ESViewer) => undefined | Destroyable

        一个函数，用于创建与视口关联的对象。

      返回 () => void

      一个销毁函数，调用该函数可以销毁所有关联对象。

    • 参数

      • 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

    • 清空飞入参数

      返回 void

    • 清空飞向参数

      返回 void

    • 刷新对象，触发刷新事件。

      返回 void

    • 触发飞入事件

      参数

      • duration: number = 1

        飞入持续时间，默认为 1

      返回 void

    • 触发飞向事件

      参数

      • duration: number = 1

        飞向持续时间，默认为 1

      返回 void

    • 获取对象的边界球

      参数

      返回 Promise<
          | undefined
          | { center?: [number, number, number]; radius?: number; tips?: string },
      >

      包含边界球信息的 Promise

    • 获取对象的属性列表，用于展示和编辑对象的属性。

      参数

      • 可选language: string

        语言代码，可选参数，用于国际化。

      返回 Property[]

      属性列表。

    • 返回 boolean

    • 返回 boolean

    • 注册与视口关联的对象，当对象被添加到视口或从视口移除时，会自动创建或销毁关联对象。

      参数

      • createViewerPropSceneObject: (viewer: ESViewer) => undefined | Destroyable

        一个函数，用于创建与视口关联的对象。

      返回 void

    • 注册与视口容器关联的对象，当对象被添加到视口或从视口移除时，会自动创建或销毁关联对象。

      参数

      • createContainerPropSceneObject: (viewer: ESViewer, container: HTMLDivElement) => undefined | Destroyable

        一个函数，用于创建与视口容器关联的对象。

      返回 void

    • 将对象从指定视口中移除。

      参数

      • viewer: ESViewer

        要移除对象的视口。

      返回 void

    • 获取当前对象支持的编辑模式

      返回 any

      支持的编辑模式数组

    • 类型参数

      • T extends { tryDestroy(): void }

      参数

      • obj: T

      返回 T

    • 返回 undefined

    • 类型参数

      • T extends { tryDestroy(): void }

      参数

      • obj: T

      返回 T

    • 更新编辑状态的方法，具体实现由子类完成

      返回 void

    • 返回 {
          allowPicking: boolean;
          attributions: ReactiveVariable<undefined | string[]>;
          attributionsCollapsible: undefined | boolean;
          cacheSize: undefined | number;
          collision: boolean;
          crossOrigin: undefined | string;
          devTags: ReactiveVariable<undefined | string[]>;
          execOnceFuncStr: undefined | string;
          extras: ReactiveVariable<JsonValue>;
          flyInParam: ReactiveVariable<undefined | ESJFlyInParam>;
          flyToParam: ReactiveVariable<undefined | ESJFlyToParam>;
          gutter: undefined | number;
          interpolate: undefined | boolean;
          maxResolution: undefined | number;
          maxZoom: undefined | number;
          minZoom: undefined | number;
          name: string;
          opaque: undefined | boolean;
          projection: ReactiveVariable<JsonValue>;
          ref: undefined | string;
          reprojectionErrorThreshold: undefined | number;
          show: boolean;
          tileGrid: ReactiveVariable<JsonValue>;
          tileLoadFunction: undefined | string;
          tilePixelRatio: undefined | number;
          tileSize: undefined | number;
          tileUrlFunction: undefined | string;
          toDestroyFuncStr: undefined | string;
          transition: undefined | number;
          updateFuncStr: undefined | string;
          url: undefined | string;
          urls: ReactiveVariable<undefined | string[]>;
          wrapX: undefined | boolean;
          zDirection: undefined | number;
          zIndex: undefined | number;
      }

      • allowPicking: boolean

        是否允许拾取 默认false

      • attributions: ReactiveVariable<undefined | string[]>
      • attributionsCollapsible: undefined | boolean
      • cacheSize: undefined | number
      • collision: boolean

        是否开启碰撞监测 默认true ,主要是UE使用

      • crossOrigin: undefined | string
      • devTags: ReactiveVariable<undefined | string[]>

        对象类型名称相关的开发标签数组，使用 reactArrayWithUndefined 进行响应式处理，默认为 undefined。

      • execOnceFuncStr: undefined | string

        一次性执行函数的字符串表示，默认为 undefined。

      • extras: ReactiveVariable<JsonValue>

        扩展属性 JSON，必须整体赋值，使用 reactJson 进行响应式处理，默认为 undefined。

      • flyInParam: ReactiveVariable<undefined | ESJFlyInParam>

        飞入参数

      • flyToParam: ReactiveVariable<undefined | ESJFlyToParam>

        飞向参数

      • gutter: undefined | number
      • interpolate: undefined | boolean
      • maxResolution: undefined | number
      • maxZoom: undefined | number
      • minZoom: undefined | number
      • name: string

        对象名称，默认为 '未命名场景对象'。

      • opaque: undefined | boolean
      • projection: ReactiveVariable<JsonValue>
      • ref: undefined | string

        对象引用，设置后可通过对象管理器 objm.$refs.xxx 快速获取到对象，默认为 undefined。

      • reprojectionErrorThreshold: undefined | number
      • show: boolean

        是否显示 默认true

      • tileGrid: ReactiveVariable<JsonValue>
      • tileLoadFunction: undefined | string
      • tilePixelRatio: undefined | number
      • tileSize: undefined | number
      • tileUrlFunction: undefined | string
      • toDestroyFuncStr: undefined | string

        销毁函数的字符串表示，默认为 undefined。

      • transition: undefined | number
      • updateFuncStr: undefined | string

        更新函数的字符串表示，默认为 undefined。

      • url: undefined | string
      • urls: ReactiveVariable<undefined | string[]>
      • wrapX: undefined | boolean
      • zDirection: undefined | number
      • zIndex: undefined | number

    • 获取父类的类型，用于创建对象时对象本身没有实现类，则使用父类的实现类，一直向上寻找，直到ESSceneObject的实现类

      类型参数

      返回 T

      父类的类型

    • 完善版注册方法

      类型参数

      参数

      • className: string
      • ctor: T & new (id?: string) => ESSceneObject
      • 可选meta: Partial<{ chsName: string; description: string; tags: string[] }>

      返回 string

    显示设置

    成员可见性

    目录

    构造函数
    属性
    _deprecatedallowPickingallowPickingChangedallowPickingReactattributionsattributionsChangedattributionsCollapsibleattributionsCollapsibleChangedattributionsCollapsibleReactattributionsReactcacheSizecacheSizeChangedcacheSizeReactcollisioncollisionChangedcollisionReactcrossOrigincrossOriginChangedcrossOriginReactdevTagsdevTagsChangeddevTagsReacteditingBindModeeditingIDexecOnceFuncStrexecOnceFuncStrChangedexecOnceFuncStrReactextrasextrasChangedextrasReactflyInParamflyInParamChangedflyInParamReactflyToParamflyToParamChangedflyToParamReactguttergutterChangedgutterReactinterpolateinterpolateChangedinterpolateReactmaxResolutionmaxResolutionChangedmaxResolutionReactmaxZoommaxZoomChangedmaxZoomReactminZoomminZoomChangedminZoomReactnamenameChangednameReactopaqueopaqueChangedopaqueReactprojectionprojectionChangedprojectionReactrefrefChangedrefReactreprojectionErrorThresholdreprojectionErrorThresholdChangedreprojectionErrorThresholdReactshowshowChangedshowReacttileGridtileGridChangedtileGridReacttileLoadFunctiontileLoadFunctionChangedtileLoadFunctionReacttilePixelRatiotilePixelRatioChangedtilePixelRatioReacttileSizetileSizeChangedtileSizeReacttileUrlFunctiontileUrlFunctionChangedtileUrlFunctionReacttoDestroyFuncStrtoDestroyFuncStrChangedtoDestroyFuncStrReacttransitiontransitionChangedtransitionReactupdateFuncStrupdateFuncStrChangedupdateFuncStrReacturlurlChangedurlReacturlsurlsChangedurlsReactuseCalcFlyToParamInESObjectWithLocationwrapXwrapXChangedwrapXReactzDirectionzDirectionChangedzDirectionReactzIndexzIndexChangedzIndexReact_lastFlyInId_lastFlyToId_lastMemIdcontextcreatecreateFromClasscreateFromJsoncreateFromUrldefaultFlyInParamdefaultFlyToParamdefaultsdestroySceneObjectgetEnvgetSceneObjgetSceneObjByIdgetSceneObjectgetSceneObjectByIdgetStrFromEnvinnerRegistersetEnvsupportEditingModestype
    访问器
    方法