Class InputModule

EntityBase.

Hierarchy (view full)

AppModuleBase
- InputModule

Implements

IAppModuleBase

Constructors

constructor

new InputModule(app?, options?): InputModule
Parameters
- Optional app: App
- Optional options: InputModuleOptions
Returns InputModule
Overrides AppModuleBase.constructor

Properties

`Optional` _app

_app?: App

`Protected` _destroyed

_destroyed: boolean = false

appRenderIndex

appRenderIndex: number = 0

data

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

Type declaration

[key: string]: any

extData

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

Type declaration

[key: string]: any

`Readonly` instanceId

instanceId: number = ++AppObject._instanceIdCounter

manager

manager: InteractionManager

onSetApp

onSetApp: Signal = ...

options

options: InputModuleOptions

`Static` moduleName

moduleName: string = "InputModule"

Accessors

Input

get Input(): InputImpl
Returns InputImpl

app

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

destroyed

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

Returns boolean
Inherited from AppModuleBase.destroyed

enabled

get enabled(): boolean
Indicates whether the component is enabled.

Returns boolean
Inherited from AppModuleBase.enabled
set enabled(value): void
Parameters
- value: boolean
Returns void
Inherited from AppModuleBase.enabled

uiConfig

get uiConfig(): UiObjectConfig<any, string, any>
Returns UiObjectConfig<any, string, any>
Inherited from AppModuleBase.uiConfig

Methods

_onAwake

_onAwake(): void
Internal
Returns void
Inherited from AppModuleBase._onAwake

_onDestroy

_onDestroy(): void
Internal
Returns void
Inherited from AppModuleBase._onDestroy

_onDisable

_onDisable(): void
Internal
Returns void
Inherited from AppModuleBase._onDisable

_onEnable

_onEnable(): void
Internal
Returns void
Inherited from AppModuleBase._onEnable

_setActive

_setActive(value): void
Internal
Parameters
- value: boolean
Returns void
Inherited from AppModuleBase._setActive

addDispose

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

addPointerEventsObject

addPointerEventsObject(entity): void
Parameters
- entity: Entity
Returns void

applyMixinsTo

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

destroy

destroy(): void
Destroy self.

Returns void
Inherited from AppModuleBase.destroy

dispatch

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

effectScope

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

eventNames

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

Returns string[]
所有事件名

Inherited from AppModuleBase.eventNames

hasEvent

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

Inherited from AppModuleBase.hasEvent

listenerCount

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

Inherited from AppModuleBase.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 AppModuleBase.off

on

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

Inherited from AppModuleBase.on

onAppAddEntity

onAppAddEntity(ent): void
Parameters
- ent: Entity
Returns void
Implementation of IAppModuleBase.onAppAddEntity

onAppAfterRender

onAppAfterRender(): void
Returns void
Implementation of IAppModuleBase.onAppAfterRender

onAppRemoveEntity

onAppRemoveEntity(ent): void
Parameters
- ent: Entity
Returns void
Implementation of IAppModuleBase.onAppRemoveEntity

onAwake

onAwake(): void
Returns void
Implementation of IAppModuleBase.onAwake

once

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

Inherited from AppModuleBase.once

removeAllEventListeners

removeAllEventListeners(event?): void
通过事件名移除所有监听.
Parameters
- Optional event: string
  Event name, delete all events if not passed
Returns void
Inherited from AppModuleBase.removeAllEventListeners

removeDispose

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

removePointerEventsObject

removePointerEventsObject(entity): void
Parameters
- entity: Entity
Returns void

setMenu

setMenu(menu?, key?): void
设置地图右键上下文菜单，运行时将触发上下文菜单将要打开contextMenuPreOpen, 上下文菜单已打开contextMenuOpened, 上下文菜单打开无内容contextMenuNoContent事件
Parameters
- Optional menu: ((event, object?) => ContextMenu)
  获取菜单的函数
  - - (event, object?): ContextMenu
    - Parameters
      event: InteractiveEvent
      Optional object: InteractiveObject
      Returns ContextMenu
- Optional key: string
  多次调用setMenu时，同样的key会覆盖之前的事件函数；有多个key时，调用次序为key的字母次序倒序；多次调用时，直到函数返回一个非null的ContextMenu为止
Returns void

setupUiConfig

setupUiConfig(): UiObjectConfig<any, string, any>
Returns UiObjectConfig<any, string, any>