Class CoordSystemModule

EntityBase.

Hierarchy (view full)

AppModuleBase
- CoordSystemModule

Implements

IAppModuleBase

Constructors

constructor

new CoordSystemModule(app?, options?): CoordSystemModule
Parameters
- Optional app: App
- Optional options: CoordSystemOption
Returns CoordSystemModule
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

onSetApp

onSetApp: Signal = ...

options

options: CoordSystemOption

`Static` moduleName

moduleName: string = "CoordSystemModule"

Accessors

app

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

centerOrigin

get centerOrigin(): Vector3
Returns Vector3
set centerOrigin(v): void
Parameters
- v: Vector3
Returns void

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

scaleOrigin

get scaleOrigin(): number
Returns number
set scaleOrigin(v): void
Parameters
- v: number
Returns void

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

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

ndcToScreen

ndcToScreen(x, y?): Vector2
NDC坐标转屏幕坐标
Parameters
- x: number | Vector2
- Optional y: number
Returns Vector2

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

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

project

project(x, y?, z?): Vector2
世界坐标转屏幕坐标
Parameters
- x: number | Vector3
- Optional y: number
- Optional z: number
Returns Vector2

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

screenToNdc

screenToNdc(x, y?): Vector2
屏幕坐标转NDC坐标
Parameters
- x: number | Vector2
- Optional y: number
Returns Vector2

setupUiConfig

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

unproject

unproject(x, y?, opts?, retIntersectObject?): any
屏幕坐标转世界坐标
Parameters
- x: number | Vector2
  屏幕坐标x
- Optional y: number
  屏幕坐标y
- Optional opts: UnProjectOpts
  (false 不用场景数据, true用场景数据) 深度 (-1近裁剪面到 1 远裁剪面) 或者输入平面(默认xz平面) 或者由一个点所在的屏幕平面或者使用当前场景实体或指定实体数组或同时指定包含或过滤的实体
- Optional retIntersectObject: {}
  如果需要返回与哪个实体相交而转化的世界坐标，可传入一个object对象
Returns any

unprojectAsync

unprojectAsync(x, y, opts?, retIntersectObject?): Promise<Vector3>
屏幕坐标转世界坐标（同 unproject 函数，不同的地方是他支持通过后期处理的深度进行转换，是异步执行的）
Parameters
- x: number
  屏幕坐标x
- y: number
  屏幕坐标y
- Optional opts: "depth" | UnProjectOpts
  (false 不用场景数据, true用场景数据) "depth" 后期处理的深度进行转换，深度值 (-1近裁剪面到 1 远裁剪面) 或者输入平面(默认xz平面) 或者由一个点所在的屏幕平面或者使用当前场景实体或指定实体数组或同时指定包含或过滤的实体
- Optional retIntersectObject: {}
  如果需要返回与哪个实体相交而转化的世界坐标，可传入一个object对象
Returns Promise<Vector3>