Class MapViewEntity

地图对象实体

Hierarchy (view full)

Constructors

constructor

Properties

_app? _bloomRef _boxHelperObject _boxHelperRef _childrens _destroyed _isDisposed? _matrixRef _matrixWorldRef _node _outlineRef _ownerScene? _pointerEventsRef _positionRef _quaternionRef _rayIntersectRecursive? _rayQueryType? _rotationRef _scaleRef _sceneData? _selectedRef _visualRef addEdges clearEdges clearHighlight data entityType extData getEdges highlightMaterial instanceId isEntity isHighlight map material mesh moduleManager nativeMaterial onSetApp opacityMaterial options rayIntersectObject? replaceMaterial resetMaterial setHeatmapDataMaterial setHighlight setOpacity signal useMaterial uuid defaultModules

Accessors

app bloom bloomRef boxHelper boxHelperRef castShadow childrens destroyed frustumCulled isDisposed matrix matrixWorld modules node outline outlineRef parent pointerEvents pointerEventsRef position quaternion rayIntersectRecursive rayQueryType receiveShadow rotation scale selected selectedRef uiConfig visible visibleRef

Methods

add addAction addChildEntity addDispose addModule addObjects addTo applyMixinsTo callModules clear clip destroy dispatch effectScope eventNames getBoundingBox getEntitiesByModule getEntitiesByName getEntitiesByProperty getEntityById getEntityByName getEntityByProperty getEntityByUuid getLeafEntities getMapBounds getMeshEntities getMeshEntityById getMeshEntityByName getMeshEntityByProperty getMeshEntityByUuid getModule getObjectById getObjectByName getObjectByProperty getObjectByUuid getObjectPropertyValueCount getObjectsByName getObjectsByProperty getPointerEventsEntities hasEvent isFireEventsByIntersect isLikeMeshEntity isWebBaseMap listenerCount lngLatToLocal lngLatToNormalize lngLatToWorld localToLngLat localToMap mapToLocal mapToWorld maxZoom minZoom off on onEntityAwake once preSubdivide remove removeAction removeAllEventListeners removeAllModules removeChildEntity removeDispose removeModule removeObjects setHeightProvider setProvider setRoot setupUiConfig toJSON traverse traverseVisible tween worldResolution worldToLngLat worldToMap attchObject create fromJSON fromModule fromObject3d fromObjectModule getOwerEntity

Constructors

constructor

Properties

Optional _app

_app?: App

_bloomRef

_bloomRef: Ref<boolean>

是否辉光

_boxHelperObject

_boxHelperObject: BoxHelper

_boxHelperRef

_boxHelperRef: Ref<boolean>

是否显示包围盒

_childrens

_childrens: Entity[] = []

Protected _destroyed

_destroyed: boolean = false

Optional _isDisposed

_isDisposed?: boolean

是否已销毁

_matrixRef

_matrixRef: Matrix4

本地矩阵响应式对象

_matrixWorldRef

_matrixWorldRef: Matrix4

世界矩阵响应式对象

_node

_node: Object3D<Object3DEventMap>

_outlineRef

_outlineRef: Ref<boolean>

是否描边效果

Optional _ownerScene

_ownerScene?: Scene

_pointerEventsRef

_pointerEventsRef: Ref<boolean>

_positionRef

_positionRef: Vector3

位置响应式对象

_quaternionRef

_quaternionRef: Quaternion

四元数响应式对象

Optional _rayIntersectRecursive

_rayIntersectRecursive?: boolean

拾取时是否遍历子对象 默认为true

Optional _rayQueryType

_rayQueryType?: RayQueryType

射线查询类型 默认为1

_rotationRef

_rotationRef: Euler

旋转响应式对象

_scaleRef

_scaleRef: Vector3

缩放响应式对象

Optional _sceneData

_sceneData?: Record<string, any> = {}

_selectedRef

_selectedRef: Ref<boolean>

是否选中

_visualRef

_visualRef: Ref<boolean>

可视响应式对象

addEdges

addEdges: ((option?, isHideMesh?) => void)

增加模型边框线

Type declaration

    • (option?, isHideMesh?): void

    • 增加模型边框线

      Parameters

      • Optional option: LineBasicMaterialParameters
      • Optional isHideMesh: boolean

        是否隐藏mesh本身（默认false)

      Returns void

Param: option

Param: isHideMesh

是否隐藏mesh本身（默认false)

clearEdges

clearEdges: (() => void)

移除模型边框线

Type declaration

    • (): void

    • 移除模型边框线

      Returns void

clearHighlight

clearHighlight: (() => void)

清除高亮

Type declaration

    • (): void

    • 清除高亮

      Returns void

data

data: ShallowReactive<{
    [key: string]: any;
}> = ...

Type declaration

  • [key: string]: any

entityType

entityType: string = "Entity"

实体类型

extData

extData: {
    [key: string]: any;
} = {}

Type declaration

  • [key: string]: any

getEdges

getEdges: (() => any)

获取模型边框线

Type declaration

    • (): any

    • 获取模型边框线

      Returns any

highlightMaterial

highlightMaterial: (() => Material | Material[])

获取高亮材质

Type declaration

    • (): Material | Material[]

    • 获取高亮材质

      Returns Material | Material[]

Readonly instanceId

instanceId: number = ++AppObject._instanceIdCounter

isEntity

isEntity: boolean = true

isHighlight

isHighlight: (() => boolean)

是否高亮

Type declaration

    • (): boolean

    • 是否高亮

      Returns boolean

map

map: MapView

Readonly material

material: Material | Material[]

获取可修改的材质对象

mesh

mesh: Mesh<BufferGeometry<NormalBufferAttributes>, Material | Material[], Object3DEventMap>

mesh对象

Readonly moduleManager

moduleManager: ModuleManager = ...

nativeMaterial

nativeMaterial: (() => Material | Material[])

获取最开始的原生材质，为空表示没有修改过

Type declaration

    • (): Material | Material[]

    • 获取最开始的原生材质，为空表示没有修改过

      Returns Material | Material[]

onSetApp

onSetApp: Signal = ...

opacityMaterial

opacityMaterial: (() => Material | Material[])

获取透明度材质

Type declaration

    • (): Material | Material[]

    • 获取透明度材质

      Returns Material | Material[]

options

options: EntityOptions

Optional rayIntersectObject

rayIntersectObject?: Object3D<Object3DEventMap>

拾取时实体对象，默认为entity.node

replaceMaterial

replaceMaterial: ((material) => void)

替换材质

Type declaration

    • (material): void

    • 替换材质

      Parameters

      • material: Material | Material[]

      Returns void

resetMaterial

resetMaterial: (() => void)

恢复材质

Type declaration

    • (): void

    • 恢复材质

      Returns void

setHeatmapDataMaterial

setHeatmapDataMaterial: ((options) => Promise<{
    lut: Lut;
    material: ShaderMaterial;
    reset: (() => void);
}>)

设置热力图数据分析材质

Type declaration

    • (options): Promise<{
          lut: Lut;
          material: ShaderMaterial;
          reset: (() => void);
      }>

    • 设置热力图数据分析材质

      Parameters

      • options: {
            colorCount?: number;
            colorMap?: [number, number][];
            data: {
                value: number;
                x: number;
                y: number;
                z: number;
            }[];
            dataMax?: number;
            dataMin?: number;
            interpolation?: {
                alpha?: number;
                model?: "circle" | "linear" | "gaussian" | "exponential" | "spherical";
                power?: number;
                sigma2?: number;
                useInvDistWeight?: boolean;
            };
            segmentX?: number;
            segmentY?: number;
            segmentZ?: number;
        }
        • Optional colorCount?: number

          颜色表分的总数 默认100

        • Optional colorMap?: [number, number][]

          颜色表[值(0-1),颜色]，默认为 [[ 0.0, 0x0000FF ], [ 0.2, 0x00FFFF ], [ 0.5, 0x00FF00 ], [ 0.8, 0xFFFF00 ], [ 1.0, 0xFF0000 ]]

        • data: {
              value: number;
              x: number;
              y: number;
              z: number;
          }[]

          数据

        • Optional dataMax?: number

          数据最大值

        • Optional dataMin?: number

          数据最小值

        • Optional interpolation?: {
              alpha?: number;
              model?: "circle" | "linear" | "gaussian" | "exponential" | "spherical";
              power?: number;
              sigma2?: number;
              useInvDistWeight?: boolean;
          }

          插值选项

          • Optional alpha?: number

            Alpha α对应方差函数的先验值，此参数可能控制钻孔扩散范围,越小范围越大,少量点效果明显，但点多了且分布均匀以后改变该数字即基本无效果了，默认设置为100

          • Optional model?: "circle" | "linear" | "gaussian" | "exponential" | "spherical"

            模型 默认 exponential

          • Optional power?: number

            反距离幂指数，用于控制距离和权重之间的关系 缺省值2

          • Optional sigma2?: number

            sigma2是σ²，对应高斯过程的方差参数，也就是这组数据z的距离，方差参数σ²的似然性反映了高斯过程中的误差，并应手动设置。一般设置为 0 ，其他数值设了可能会出空白图

          • Optional useInvDistWeight?: boolean

            使用反距离权重插值法

        • Optional segmentX?: number

          x轴分段数 默认20

        • Optional segmentY?: number

          y轴分段数 默认20

        • Optional segmentZ?: number

          z轴分段数 默认20

      Returns Promise<{
          lut: Lut;
          material: ShaderMaterial;
          reset: (() => void);
      }>

setHighlight

setHighlight: ((color, opacity) => {})

设置高亮

Type declaration

    • (color, opacity): {}

    • 设置高亮

      Parameters

      • color: ColorRepresentation
      • opacity: number

      Returns {}

    setOpacity

    setOpacity: ((opacity, isAccOpacity?) => void)

    设置透明度

    Type declaration

      • (opacity, isAccOpacity?): void

      • 设置透明度

        Parameters

        • opacity: number

          透明度0(完全透明)-1(不透明)

        • Optional isAccOpacity: boolean

          是否累加透明度(ture和之前透明度相乘，false直接设置透明度)

        Returns void

    Param: opacity

    透明度0(完全透明)-1(不透明)

    Param: isAccOpacity

    是否累加透明度(ture和之前透明度相乘，false直接设置透明度)

    signal

    signal: {
        onAdd: Signal;
        onBeforeAdd: Signal;
        onBeforeRemove: Signal;
        onKeyDown: Signal;
        onKeyUp: Signal;
        onMouseClick: Signal;
        onMouseDblClick: Signal;
        onMouseDown: Signal;
        onMouseEnter: Signal;
        onMouseLeave: Signal;
        onMouseMove: Signal;
        onMouseOut: Signal;
        onMouseOver: Signal;
        onMouseUp: Signal;
        onMouseWheel: Signal;
        onPointerDown: Signal;
        onPointerMove: Signal;
        onPointerUp: Signal;
        onRayIntersect: Signal;
        onRemove: Signal;
    } = ...

    Type declaration

    useMaterial

    useMaterial: (() => Material | Material[])

    获取替换后的正使用的材质，为空表示没有修改过

    Type declaration

      • (): Material | Material[]

      • 获取替换后的正使用的材质，为空表示没有修改过

        Returns Material | Material[]

    uuid

    uuid: string = ...

    Static defaultModules

    defaultModules: (EntityModuleConstructor | [EntityModuleConstructor, any])[] = []

    Accessors

    app

    • get app(): App

    • Returns App

    • set app(value): void

    • Parameters

      Returns void

    bloom

    • get bloom(): boolean

    • Returns boolean

    • set bloom(val): void

    • Parameters

      • val: boolean

      Returns void

    bloomRef

    • get bloomRef(): Ref<boolean>

    • Returns Ref<boolean>

    boxHelper

    boxHelperRef

    • get boxHelperRef(): Ref<boolean>

    • Returns Ref<boolean>

    castShadow

    • get castShadow(): boolean

    • Returns boolean

    • set castShadow(val): void

    • Parameters

      • val: boolean

      Returns void

    childrens

    • get childrens(): Entity[]

    • Returns Entity[]

    • set childrens(child): void

    • Parameters

      Returns void

    destroyed

    • get destroyed(): boolean

    • Whether it has been destroyed.

      Returns boolean

    frustumCulled

    • get frustumCulled(): boolean

    • Returns boolean

    • set frustumCulled(val): void

    • Parameters

      • val: boolean

      Returns void

    isDisposed

    • get isDisposed(): boolean

    • Returns boolean

    matrix

    • get matrix(): Matrix4

    • Returns Matrix4

    matrixWorld

    • get matrixWorld(): Matrix4

    • Returns Matrix4

    modules

    node

    • get node(): Object3D<Object3DEventMap>

    • Returns Object3D<Object3DEventMap>

    • set node(obj): void

    • Parameters

      • obj: Object3D<Object3DEventMap>

      Returns void

    outline

    • get outline(): boolean

    • Returns boolean

    • set outline(val): void

    • Parameters

      • val: boolean

      Returns void

    outlineRef

    • get outlineRef(): Ref<boolean>

    • Returns Ref<boolean>

    parent

    • get parent(): Entity

    • Returns Entity

    • set parent(val): void

    • Parameters

      Returns void

    pointerEvents

    • get pointerEvents(): boolean

    • Returns boolean

    • set pointerEvents(b): void

    • Parameters

      • b: boolean

      Returns void

    pointerEventsRef

    • get pointerEventsRef(): Ref<boolean>

    • Returns Ref<boolean>

    position

    • get position(): Vector3

    • Returns Vector3

    quaternion

    • get quaternion(): Quaternion

    • Returns Quaternion

    rayIntersectRecursive

    • get rayIntersectRecursive(): boolean

    • Returns boolean

    • set rayIntersectRecursive(b): void

    • Parameters

      • b: boolean

      Returns void

    rayQueryType

    • get rayQueryType(): RayQueryType

    • Returns RayQueryType

    • set rayQueryType(b): void

    • Parameters

      Returns void

    receiveShadow

    • get receiveShadow(): boolean

    • Returns boolean

    • set receiveShadow(val): void

    • Parameters

      • val: boolean

      Returns void

    rotation

    • get rotation(): Euler

    • Returns Euler

    scale

    • get scale(): Vector3

    • Returns Vector3

    selected

    • get selected(): boolean

    • Returns boolean

    • set selected(val): void

    • Parameters

      • val: boolean

      Returns void

    selectedRef

    • get selectedRef(): Ref<boolean>

    • Returns Ref<boolean>

    uiConfig

    visible

    • get visible(): boolean

    • Returns boolean

    • set visible(val): void

    • Parameters

      • val: boolean

      Returns void

    visibleRef

    • get visibleRef(): Ref<boolean>

    • Returns Ref<boolean>

    Methods

    add

    • add<T, U>(type, params?): T

    • 增加模块,如果模块已存在，则返回之前的模型，等同于this.addModule(xxx)

      Type Parameters

      Parameters

      • type: (new (entity?, obj?) => T)
          • new (entity?, obj?): T

          • Parameters

            • Optional entity: any
            • Optional obj: U

            Returns T

      • Optional params: U

      Returns T

    addAction

    • addAction(func, id?): (() => void)

    • 增加一个自定义动作脚本

      Parameters

      • func: ((context) => void | BehaviorStatus)

        脚本函数

          • (context): void | BehaviorStatus

          • Parameters

            • context: {
                  elapsed: number;
                  entity: Entity;
                  timeDelta: number;
                  [key: string]: any;
              }
              • [key: string]: any
              • elapsed: number
              • entity: Entity
              • timeDelta: number

            Returns void | BehaviorStatus

      • Optional id: string

        脚本id

      Returns (() => void)

        • (): void

        • Returns void

    addChildEntity

    addDispose

    addModule

    • addModule<T, U>(type, params?): T

    • 增加模块,如果模块已存在，则返回之前的模型，等同于this.add(xxx)

      Type Parameters

      Parameters

      • type: (new (entity?, obj?) => T)

        模块类

          • new (entity?, obj?): T

          • Parameters

            • Optional entity: any
            • Optional obj: U

            Returns T

      • Optional params: U

        参数

      Returns T

    addObjects

    • addObjects(objs): void

    • Parameters

      • objs: Object3D<Object3DEventMap> | Object3D<Object3DEventMap>[]

      Returns void

    addTo

    applyMixinsTo

    • applyMixinsTo(toClassInst, methodNames?, addMethods?, filterName?): void

    • Parameters

      • toClassInst: any
      • Optional methodNames: string[]
      • Optional addMethods: string[]
      • Optional filterName: string[]

      Returns void

    callModules

    • callModules(methodName, ...args): void

    • 调用模块中的函数

      Parameters

      • methodName: string
      • Rest ...args: any

      Returns void

    clear

    • clear(): any

    • Clears all tiles from memory and reloads data. Used when changing the provider.

      Should be called manually if any changed to the provider are made without setting the provider.

      Returns any

    clip

    • clip(): void

    • Returns void

    destroy

    dispatch

    • dispatch(event, ...data): boolean

    • 触发指定事件名称.

      Parameters

      • event: string

        Event name

      • Rest ...data: any

        Data

      Returns boolean

      • Whether the dispatching is successful

    effectScope

    • effectScope(fn): void

    • Parameters

      • fn: (() => any)
          • (): any

          • Returns any

      Returns void

    eventNames

    • eventNames(): string[]

    • 返回注册的所有事件名.

      Returns string[]

      所有事件名

    getBoundingBox

    • getBoundingBox(inLocalSpace?, mapModeSceneSpace?): Box3

    • 获取物体的外包盒

      Parameters

      • Optional inLocalSpace: boolean

        局部空间

      • Optional mapModeSceneSpace: boolean

        地图模式下返回场景空间坐标

      Returns Box3

    getEntitiesByModule

    getEntitiesByName

    getEntitiesByProperty

    getEntityById

    getEntityByName

    getEntityByProperty

    getEntityByUuid

    getLeafEntities

    getMapBounds

    • getMapBounds(): [number, number, number, number]

    • Returns [number, number, number, number]

    getMeshEntities

    getMeshEntityById

    getMeshEntityByName

    getMeshEntityByProperty

    getMeshEntityByUuid

    getModule

    • getModule<T, U>(type): T

    • 获取模块

      Type Parameters

      Parameters

      • type: (new (entity?, obj?) => T)

        模型类型

          • new (entity?, obj?): T

          • Parameters

            • Optional entity: any
            • Optional obj: U

            Returns T

      Returns T

    getObjectById

    • getObjectById(id): Object3D<Object3DEventMap>

    • Parameters

      • id: string

      Returns Object3D<Object3DEventMap>

    getObjectByName

    • getObjectByName(name): Object3D<Object3DEventMap>

    • Parameters

      • name: string

      Returns Object3D<Object3DEventMap>

    getObjectByProperty

    • getObjectByProperty(name, value): Object3D<Object3DEventMap>

    • Parameters

      • name: string
      • value: string

      Returns Object3D<Object3DEventMap>

    getObjectByUuid

    • getObjectByUuid(uuid): Object3D<Object3DEventMap>

    • Parameters

      • uuid: string

      Returns Object3D<Object3DEventMap>

    getObjectPropertyValueCount

    getObjectsByName

    • getObjectsByName(name): Object3D<Object3DEventMap>[]

    • Parameters

      • name: string

      Returns Object3D<Object3DEventMap>[]

    getObjectsByProperty

    • getObjectsByProperty(name, value): Object3D<Object3DEventMap>[]

    • Parameters

      • name: string
      • value: string

      Returns Object3D<Object3DEventMap>[]

    getPointerEventsEntities

    hasEvent

    • hasEvent(event): boolean

    • 确定是否存在事件侦听

      Parameters

      • event: string

        事件名

      Returns boolean

      返回是否存在相应的事件

    isFireEventsByIntersect

    isLikeMeshEntity

    • isLikeMeshEntity(): boolean

    • 判断实体是否是mesh实体或包含mesh实体模块

      Returns boolean

    isWebBaseMap

    • isWebBaseMap(): boolean

    • 是否为互联网地图底图 (选项中设置了mapBounds的为cad底图，没设置mapBounds的为互联网底图)

      Returns boolean

    listenerCount

    • listenerCount(event): number

    • 返回具有指定事件名称的侦听总数.

      Parameters

      • event: string

        Event name

      Returns number

      The count of listeners

    lngLatToLocal

    • lngLatToLocal(lngLat): Vector3

    • 经纬度转局部世界坐标

      Parameters

      • lngLat: [number, number]

      Returns Vector3

    lngLatToNormalize

    • lngLatToNormalize(lngLat): [number, number]

    • 经纬度转归一化的坐标, 先会把经纬度转墨卡托，然后根据最开始的[瓦片缩级别，行，列]rootTile的范围，归一化到0-1范围区间

      Parameters

      • lngLat: [number, number]

      Returns [number, number]

    lngLatToWorld

    • lngLatToWorld(lngLat): Vector3

    • 经纬度转世界坐标

      Parameters

      • lngLat: [number, number]

      Returns Vector3

    localToLngLat

    • localToLngLat(world): [number, number]

    • 局部世界坐标转经纬度

      Parameters

      • world: [number, number, number] | Vector3 | [number, number]

      Returns [number, number]

    localToMap

    • localToMap(world): [number, number]

    • 局部世界坐标转地图坐标

      Parameters

      • world: [number, number, number] | Vector3 | [number, number]

      Returns [number, number]

    mapToLocal

    • mapToLocal(point): Vector3

    • 地图坐标转局部世界坐标

      Parameters

      • point: [number, number]

      Returns Vector3

    mapToWorld

    • mapToWorld(lngLat): Vector3

    • 地图坐标转世界坐标

      Parameters

      • lngLat: [number, number]

      Returns Vector3

    maxZoom

    • maxZoom(): number

    • Get the maximum zoom level available in the providers attached to the map view.

      Returns number

      Maximum zoom level available.

    minZoom

    • minZoom(): number

    • Get the minimum zoom level available in the providers attached to the map view.

      Returns number

      Minimum zoom level available.

    off

    • off(event, fn?): EventDispatcher

    • 移除监听.

      Parameters

      • event: string

        Event name

      • Optional fn: Function

        Function, If is undefined, delete all corresponding event listeners.

      Returns EventDispatcher

    on

    onEntityAwake

    • onEntityAwake(callback): void

    • Parameters

      • callback: ((app) => void)
          • (app): void

          • Parameters

            Returns void

      Returns void

    once

    preSubdivide

    • preSubdivide(): void

    • Pre-subdivide map tree to create nodes of levels not available in the provider.

      Checks for the minimum zoom level in the providers attached to the map view.

      Returns void

    remove

    removeAction

    • removeAction(id): void

    • 移除一个自定义动作脚本

      Parameters

      • id: string

        脚本id

      Returns void

    removeAllEventListeners

    • removeAllEventListeners(event?): void

    • 通过事件名移除所有监听.

      Parameters

      • Optional event: string

        Event name, delete all events if not passed

      Returns void

    removeAllModules

    removeChildEntity

    removeDispose

    removeModule

    • removeModule<T, U>(type): void

    • 移除模块

      Type Parameters

      Parameters

      • type: (new (entity?, obj?) => T)

        模型类型

          • new (entity?, obj?): T

          • Parameters

            • Optional entity: any
            • Optional obj: U

            Returns T

      Returns void

    removeObjects

    • removeObjects(objs): void

    • Parameters

      • objs: Object3D<Object3DEventMap> | Object3D<Object3DEventMap>[]

      Returns void

    setHeightProvider

    • setHeightProvider(heightProvider): void

    • Change the map height provider of this map view.

      Will discard all the tiles already loaded using the old provider.

      Parameters

      Returns void

    setProvider

    • setProvider(provider): void

    • Change the map provider of this map view.

      Will discard all the tiles already loaded using the old provider.

      Parameters

      Returns void

    setRoot

    • setRoot(root): void

    • Set the root of the map view.

      Is set by the constructor by default, can be changed in runtime.

      Parameters

      • root: number | MapNode

        Map node to be used as root.

      Returns void

    setupUiConfig

    toJSON

    traverse

    • traverse(callback, filter?): void

    • Parameters

      • callback: ((ent) => any)
          • (ent): any

          • Parameters

            Returns any

      • Optional filter: ((ent) => boolean)
          • (ent): boolean

          • Parameters

            Returns boolean

      Returns void

    traverseVisible

    • traverseVisible(callback, filter?): void

    • Parameters

      • callback: ((ent) => any)
          • (ent): any

          • Parameters

            Returns any

      • Optional filter: ((ent) => boolean)
          • (ent): boolean

          • Parameters

            Returns boolean

      Returns void

    tween

    worldResolution

    • worldResolution(): number

    • Returns number

    worldToLngLat

    • worldToLngLat(world): [number, number]

    • 世界坐标转经纬度

      Parameters

      • world: [number, number, number] | Vector3 | [number, number]

      Returns [number, number]

    worldToMap

    • worldToMap(world): [number, number]

    • 世界坐标转地图坐标

      Parameters

      • world: [number, number, number] | Vector3 | [number, number]

      Returns [number, number]

    Static attchObject

    • attchObject(obj, splitSubEntity?, overwriteEntity?, app?): Entity

    • 给一个已加入场景中的对象关联一个实体

      Parameters

      • obj: Object3D<Object3DEventMap>

        已加入场景中的对象

      • Optional splitSubEntity: boolean

        是否把子对象拆成子实体 （默认false)

      • Optional overwriteEntity: boolean

        当有关联的实体时，重新再生成一个实体相关联 （默认false)

      • Optional app: App

        应用对象，默认用当前的

      Returns Entity

    Static create

    Static fromJSON

    • fromJSON(json, objects): Entity

    • Parameters

      • json: Record<string, any>
      • objects: Map<string, Object3D<Object3DEventMap>>

      Returns Entity

    Static fromModule

    Static fromObject3d

    • fromObject3d(objs): Entity

    • 通过一个或多个object3d对象创建一个实体

      Parameters

      • objs: Object3D<Object3DEventMap> | Object3D<Object3DEventMap>[]

      Returns Entity

    Static fromObjectModule

    Static getOwerEntity

    • getOwerEntity(object, canChildEntity?): Entity

    • 通过一个obejct获取所属的实体

      Parameters

      • object: Object3D<Object3DEventMap>

        物体对象

      • Optional canChildEntity: boolean

        是否获取到子实体。默认false. false的话表示获取的是最上级的实体对象。true获取的是所属的子实体对象

      Returns Entity

    Settings

    Member Visibility

    Theme

    On This Page