Class Entity

EntityBase.

Hierarchy (view full)

EntityBase
- Entity

Index

Constructors

Methods

add addAction addChildEntity addDispose addEdges addModule addObjects addTo applyMixinsTo callModules clearEdges clearHighlight destroy dispatch effectScope eventNames getBoundingBox getEntitiesByModule getEntitiesByName getEntitiesByProperty getEntityById getEntityByName getEntityByProperty getEntityByUuid getLeafEntities getMeshEntities getMeshEntityById getMeshEntityByName getMeshEntityByProperty getMeshEntityByUuid getModule getObjectById getObjectByName getObjectByProperty getObjectByUuid getObjectPropertyValueCount getObjectsByName getObjectsByProperty getPointerEventsEntities hasEvent isFireEventsByIntersect isHighlight isLikeMeshEntity listenerCount off on onEntityAwake once remove removeAction removeAllEventListeners removeAllModules removeChildEntity removeDispose removeModule removeObjects replaceMaterial resetMaterial setHighlight setOpacity setupUiConfig toJSON traverse traverseVisible tween attchObject create fromJSON fromModule fromObject3d fromObjectModule getOwerEntity

Constructors

constructor

new Entity(options?): Entity
Parameters
- Optional options: EntityOptions
Returns Entity
Overrides EntityBase.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>

可视响应式对象

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

`Readonly` instanceId

instanceId: number = ++AppObject._instanceIdCounter

isEntity

isEntity: boolean = true

`Readonly` moduleManager

moduleManager: ModuleManager = ...

onSetApp

onSetApp: Signal = ...

options

options: EntityOptions

`Optional` rayIntersectObject

rayIntersectObject?: Object3D<Object3DEventMap>

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

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

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

uuid

uuid: string = ...

`Static` defaultModules

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

Accessors

app

get app(): App
Returns App
Inherited from EntityBase.app
set app(value): void
Parameters
- value: App
Returns void
Inherited from EntityBase.app

bloom

get bloom(): boolean
Returns boolean
set bloom(val): void
Parameters
- val: boolean
Returns void

bloomRef

get bloomRef(): Ref<boolean>
Returns Ref<boolean>

boxHelper

get boxHelper(): boolean | BoxHelperOptions
Returns boolean | BoxHelperOptions
set boxHelper(val): void
Parameters
- val: boolean | BoxHelperOptions
Returns void

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
- child: Entity[]
Returns void

destroyed

get destroyed(): boolean
Whether it has been destroyed.

Returns boolean
Inherited from EntityBase.destroyed

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

get modules(): EntityModuleBase[]
Returns EntityModuleBase[]
Inherited from EntityBase.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
- val: Entity
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
- b: RayQueryType
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

get uiConfig(): UiObjectConfig<any, string, any>
Returns UiObjectConfig<any, string, any>
Inherited from EntityBase.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
- T extends EntityModuleBase
- U
Parameters
- type: (new (entity?, obj?) => T)
  - - new (entity?, obj?): T
    - Parameters
      Optional entity: any
      Optional obj: U
      Returns T
- Optional params: U
Returns T
Inherited from EntityBase.add

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

addChildEntity(ent): void
Parameters
- ent: Entity
Returns void

addDispose

addDispose(cb): void
Parameters
- cb: Function
Returns void
Inherited from EntityBase.addDispose

addEdges

addEdges(option?, isHideMesh?): void
增加模型边框线
Parameters
- Optional option: LineBasicMaterialParameters
- Optional isHideMesh: boolean
  是否隐藏mesh本身（默认false)
Returns void

addModule

addModule<T, U>(type, params?): T
增加模块,如果模块已存在，则返回之前的模型，等同于this.add(xxx)
Type Parameters
- T extends EntityModuleBase
- U
Parameters
- type: (new (entity?, obj?) => T)
  模块类
  - - new (entity?, obj?): T
    - Parameters
      Optional entity: any
      Optional obj: U
      Returns T
- Optional params: U
  参数
Returns T
Inherited from EntityBase.addModule

addObjects

addObjects(objs): void
Parameters
- objs: Object3D<Object3DEventMap> | Object3D<Object3DEventMap>[]
Returns void

addTo

addTo(target?, app?): Entity
Parameters
- Optional target: App | Object3D<Object3DEventMap> | Entity
- Optional app: App
Returns Entity

applyMixinsTo

applyMixinsTo(toClassInst, methodNames?, addMethods?, filterName?): void
Parameters
- toClassInst: any
- Optional methodNames: string[]
- Optional addMethods: string[]
- Optional filterName: string[]
Returns void
Inherited from EntityBase.applyMixinsTo

callModules

callModules(methodName, ...args): void
调用模块中的函数
Parameters
- methodName: string
- Rest ...args: any
Returns void
Inherited from EntityBase.callModules

clearEdges

clearEdges(): void
移除模型边框线

Returns void

clearHighlight

clearHighlight(): void
清除高亮

Returns void

destroy

destroy(): void
Destroy self.

Returns void
Inherited from EntityBase.destroy

dispatch

dispatch(event, ...data): boolean
触发指定事件名称.
Parameters
- event: string
  Event name
- Rest ...data: any
  Data
Returns boolean
- Whether the dispatching is successful
Inherited from EntityBase.dispatch

effectScope

effectScope(fn): void
Parameters
- fn: (() => any)
  - - (): any
    - Returns any
Returns void
Inherited from EntityBase.effectScope

eventNames

eventNames(): string[]
返回注册的所有事件名.

Returns string[]
所有事件名

Inherited from EntityBase.eventNames

getBoundingBox

getBoundingBox(inLocalSpace?, mapModeSceneSpace?): Box3
获取物体的外包盒
Parameters
- Optional inLocalSpace: boolean
  局部空间
- Optional mapModeSceneSpace: boolean
  地图模式下返回场景空间坐标
Returns Box3

getEntitiesByModule

getEntitiesByModule(module): Entity[]
Parameters
- module: EntityModuleConstructor | EntityModuleConstructor[]
Returns Entity[]

getEntitiesByName

getEntitiesByName(name): Entity[]
Parameters
- name: string
Returns Entity[]

getEntitiesByProperty

getEntitiesByProperty(name, value): Entity[]
Parameters
- name: string
- value: string
Returns Entity[]

getEntityById

getEntityById(id): Entity
Parameters
- id: string
Returns Entity

getEntityByName

getEntityByName(name): Entity
Parameters
- name: string
Returns Entity

getEntityByProperty

getEntityByProperty(name, value): Entity
Parameters
- name: string
- value: string
Returns Entity

getEntityByUuid

getEntityByUuid(uuid): Entity
Parameters
- uuid: string
Returns Entity

getLeafEntities

getLeafEntities(): Entity[]
获取所有叶子实体

Returns Entity[]

getMeshEntities

getMeshEntities(): MeshEntity[]
获取所有Mesh实体

Returns MeshEntity[]

getMeshEntityById

getMeshEntityById(id): MeshEntity
Parameters
- id: string
Returns MeshEntity

getMeshEntityByName

getMeshEntityByName(name): MeshEntity
Parameters
- name: string
Returns MeshEntity

getMeshEntityByProperty

getMeshEntityByProperty(name, value): MeshEntity
Parameters
- name: string
- value: string
Returns MeshEntity

getMeshEntityByUuid

getMeshEntityByUuid(uuid): MeshEntity
Parameters
- uuid: string
Returns MeshEntity

getModule

getModule<T, U>(type): T
获取模块
Type Parameters
- T extends EntityModuleBase
- U
Parameters
- type: (new (entity?, obj?) => T)
  模型类型
  - - new (entity?, obj?): T
    - Parameters
      Optional entity: any
      Optional obj: U
      Returns T
Returns T
Inherited from EntityBase.getModule

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

getObjectPropertyValueCount(name): Map<any, number>
Parameters
- name: string
Returns Map<any, number>

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

getPointerEventsEntities(leafEventNode?): Entity[]
获取有事件的所有字实体
Parameters
- Optional leafEventNode: boolean
Returns Entity[]

hasEvent

hasEvent(event): boolean
确定是否存在事件侦听
Parameters
- event: string
  事件名
Returns boolean
返回是否存在相应的事件

Inherited from EntityBase.hasEvent

isFireEventsByIntersect

isFireEventsByIntersect(closestObject, newClosestObject): boolean
根据同一个实体上的两个射线的交点信息，来决定是否是不同的事件。默认false不再触发
Parameters
- closestObject: InteractiveObject
- newClosestObject: InteractiveObject
Returns boolean

isHighlight

isHighlight(): boolean
是否高亮

Returns boolean

isLikeMeshEntity

isLikeMeshEntity(): boolean
判断实体是否是mesh实体或包含mesh实体模块

Returns boolean

listenerCount

listenerCount(event): number
返回具有指定事件名称的侦听总数.
Parameters
- event: string
  Event name
Returns number
The count of listeners

Inherited from EntityBase.listenerCount

off

off(event, fn?): EventDispatcher
移除监听.
Parameters
- event: string
  Event name
- Optional fn: Function
  Function, If is undefined, delete all corresponding event listeners.
Returns EventDispatcher
Inherited from EntityBase.off

on

on(event, fn): EventDispatcher
增加监听
Parameters
- event: string
  Event name
- fn: Function
  Function
Returns EventDispatcher
This

Inherited from EntityBase.on

onEntityAwake

onEntityAwake(callback): void
Parameters
- callback: ((app) => void)
  - - (app): void
    - Parameters
      app: App
      Returns void
Returns void

once

once(event, fn): EventDispatcher
只监听一次.
Parameters
- event: string
  Event name
- fn: Function
  Function
Returns EventDispatcher
This

Inherited from EntityBase.once

remove

remove(): void
Returns void

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
Inherited from EntityBase.removeAllEventListeners

removeAllModules

removeAllModules(): void
移除所有模块

Returns void
Inherited from EntityBase.removeAllModules

removeChildEntity

removeChildEntity(ent): void
Parameters
- ent: Entity
Returns void

removeDispose

removeDispose(cb): void
Parameters
- cb: Function
Returns void
Inherited from EntityBase.removeDispose

removeModule

removeModule<T, U>(type): void
移除模块
Type Parameters
- T extends EntityModuleBase
- U
Parameters
- type: (new (entity?, obj?) => T)
  模型类型
  - - new (entity?, obj?): T
    - Parameters
      Optional entity: any
      Optional obj: U
      Returns T
Returns void
Inherited from EntityBase.removeModule

removeObjects

removeObjects(objs): void
Parameters
- objs: Object3D<Object3DEventMap> | Object3D<Object3DEventMap>[]
Returns void

replaceMaterial

replaceMaterial(material): void
替换材质
Parameters
- material: Material | Material[]
Returns void

resetMaterial

resetMaterial(): void
恢复材质

Returns void

setHighlight

setHighlight(color?, opacity?): void
设置高亮
Parameters
- Optional color: ColorRepresentation
- Optional opacity: number
Returns void

setOpacity

setOpacity(opacity, isAccOpacity?): void
设置透明度
Parameters
- opacity: number
  透明度0(完全透明)-1(不透明)
- Optional isAccOpacity: boolean
  是否累加透明度(ture和之前透明度相乘，false直接设置透明度)
Returns void

setupUiConfig

setupUiConfig(): any
Returns any

toJSON

toJSON(): any
Returns any

traverse

traverse(callback, filter?): void
Parameters
- callback: ((ent) => any)
  - - (ent): any
    - Parameters
      ent: Entity
      Returns any
- Optional filter: ((ent) => boolean)
  - - (ent): boolean
    - Parameters
      ent: Entity
      Returns boolean
Returns void

traverseVisible

traverseVisible(callback, filter?): void
Parameters
- callback: ((ent) => any)
  - - (ent): any
    - Parameters
      ent: Entity
      Returns any
- Optional filter: ((ent) => boolean)
  - - (ent): boolean
    - Parameters
      ent: Entity
      Returns boolean
Returns void

tween

tween(id?): Tween<Entity>
Parameters
- Optional id: string
Returns Tween<Entity>

`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

create(options?): Entity
创建一个新的实体对象
Parameters
- Optional options: EntityOptions
Returns Entity

`Static` fromJSON

fromJSON(json, objects): Entity
Parameters
- json: Record<string, any>
- objects: Map<string, Object3D<Object3DEventMap>>
Returns Entity

`Static` fromModule

fromModule(mod, options?): Entity
基于模块创建一个新的实体对象
Parameters
- mod: EntityModuleConstructor | (EntityModuleConstructor | [EntityModuleConstructor, any])[]
- Optional options: any
Returns Entity

`Static` fromObject3d

fromObject3d(objs): Entity
通过一个或多个object3d对象创建一个实体
Parameters
- objs: Object3D<Object3DEventMap> | Object3D<Object3DEventMap>[]
Returns Entity

`Static` fromObjectModule

fromObjectModule(objs, mod, options?): Entity
通过一个或多个object3d对象和模块创建一个实体
Parameters
- objs: Object3D<Object3DEventMap> | Object3D<Object3DEventMap>[]
- mod: EntityModuleConstructor | (EntityModuleConstructor | [EntityModuleConstructor, any])[]
- Optional options: any
Returns Entity

`Static` getOwerEntity

getOwerEntity(object, canChildEntity?): Entity
通过一个obejct获取所属的实体
Parameters
- object: Object3D<Object3DEventMap>
  物体对象
- Optional canChildEntity: boolean
  是否获取到子实体。默认false. false的话表示获取的是最上级的实体对象。true获取的是所属的子实体对象
Returns Entity

Class Entity

Hierarchy (view full)

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

Optional options: EntityOptions

Returns Entity

Properties

Optional _app

_bloomRef

_boxHelperObject

_boxHelperRef

_childrens

Protected _destroyed

Optional _isDisposed

_matrixRef

_matrixWorldRef

_node

_outlineRef

Optional _ownerScene

_pointerEventsRef

_positionRef

_quaternionRef

Optional _rayIntersectRecursive

Optional _rayQueryType

_rotationRef

_scaleRef

Optional _sceneData

_selectedRef

_visualRef

data

Type declaration

[key: string]: any

entityType

extData

Type declaration

[key: string]: any

Readonly instanceId

isEntity

Readonly moduleManager

onSetApp

options

Optional rayIntersectObject

signal

Type declaration

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

uuid

Static defaultModules

Accessors

app

Returns App

Parameters

value: App

Returns void

bloom

Returns boolean

`Optional` options: EntityOptions

`Optional` _app

`Protected` _destroyed

`Optional` _isDisposed

`Optional` _ownerScene

`Optional` _rayIntersectRecursive

`Optional` _rayQueryType

`Optional` _sceneData

`Readonly` instanceId

`Readonly` moduleManager

`Optional` rayIntersectObject

`Static` defaultModules