Class PathAnimateModule

路径动画模块

Hierarchy (view full)

EntityModuleBase
- PathAnimateModule

Implements

IEntityModuleBase

Index

Constructors

constructor

new PathAnimateModule(entity, options?): PathAnimateModule
Parameters
- entity: Entity
- Optional options: PathAnimateModuleOptions
Returns PathAnimateModule
Overrides EntityModuleBase.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

entity

entity: Entity

extData

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

Type declaration

[key: string]: any

`Readonly` instanceId

instanceId: number = ++AppObject._instanceIdCounter

onSetApp

onSetApp: Signal = ...

options

options: PathAnimateModuleOptions

tween

tween: Tween<any>

`Static` moduleName

moduleName: string = "PathAnimateModule"

Accessors

app

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

destroyed

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

Returns boolean
Inherited from EntityModuleBase.destroyed

enabled

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

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

uiConfig

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

Methods

_onAwake

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

_onDestroy

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

_onDisable

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

_onEnable

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

_setActive

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

addDispose

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

applyMixinsTo

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

destroy

destroy(): void
Destroy self.

Returns void
Inherited from EntityModuleBase.destroy

dispatch

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

effectScope

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

eventNames

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

Returns string[]
所有事件名

Inherited from EntityModuleBase.eventNames

hasEvent

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

Inherited from EntityModuleBase.hasEvent

listenerCount

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

Inherited from EntityModuleBase.listenerCount

lookAt

lookAt(point, pointNext, model?, opts?): void
Parameters
- point: Vector3
- pointNext: Vector3
- Optional model: Object3D<Object3DEventMap>
- Optional opts: {
      cameraFollow?: boolean;
      euler?: Euler;
      followAngle?: number;
      followDist?: number;
      offsetAngle?: number;
      tPosition?: number;
      tQuat?: number;
  }
  - Optional cameraFollow?: boolean
  - Optional euler?: Euler
  - Optional followAngle?: number
  - Optional followDist?: number
  - Optional offsetAngle?: number
  - Optional tPosition?: number
  - Optional tQuat?: number
Returns void

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 EntityModuleBase.off

on

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

Inherited from EntityModuleBase.on

once

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

Inherited from EntityModuleBase.once

removeAllEventListeners

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

removeDispose

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

setupUiConfig

setupUiConfig(): {
    children: UiObjectConfig<any, string, any>[];
    expanded: boolean;
    label: string;
    type: string;
}
Returns {
    children: UiObjectConfig<any, string, any>[];
    expanded: boolean;
    label: string;
    type: string;
}
- children: UiObjectConfig<any, string, any>[]
- expanded: boolean
- label: string
- type: string
Implementation of IEntityModuleBase.setupUiConfig

start

start(options?): Promise<{
    error: boolean;
    isEnd: boolean;
    isStop: boolean;
    target: any;
}>
开始动画
Parameters
- Optional options: PathAnimateModuleOptions
Returns Promise<{
    error: boolean;
    isEnd: boolean;
    isStop: boolean;
    target: any;
}>