Class FxManager

Hierarchy

  • default
    • FxManager

Constructors

constructor

Properties

core guid viewer

Methods

add attach attachMany clearAll create createAndAttach createAndAttachMany createMany detach getById isExists pauseAllBindings pauseBinding removeById resumeAllBindings resumeBinding updateBinding

Constructors

constructor

  • new FxManager(core): FxManager

  • Parameters

    • core: any

    Returns FxManager

Properties

Protected Readonly core

core: default<any>

Protected Readonly guid

guid: string

Protected Readonly viewer

viewer: Viewer

Methods

add

  • add(specialEffect): boolean

  • Parameters

    • specialEffect: default

    Returns boolean

attach

  • attach(fxId, target, options?): boolean

  • 绑定特效到目标（实体/模型/图元），使其随目标更新。

    Parameters

    • fxId: string
    • target: Entity | Model | Primitive
    • Optional options: FxBindingOptions

    Returns boolean

attachMany

  • attachMany(items): number

  • 批量绑定：按输入列表绑定现有 FX 到目标，返回成功计数

    Parameters

    • items: {
          fxId: string;
          options?: FxBindingOptions;
          target: Entity | Model | Primitive;
      }[]

    Returns number

clearAll

  • clearAll(): void

  • Returns void

create

  • create(type, options): default

  • 工厂：创建并注册 FX（不绑定目标）

    Parameters

    • type: any
    • options: any

    Returns default

createAndAttach

  • createAndAttach(type, options, target, bindingOptions?): default

  • 工厂：创建并绑定到目标

    Parameters

    • type: any
    • options: any
    • target: Entity | Model | Primitive
    • Optional bindingOptions: FxBindingOptions

    Returns default

createAndAttachMany

  • createAndAttachMany(items): default[]

  • 批量创建并绑定，返回成功创建且绑定的 FX 列表

    Parameters

    • items: {
          bindingOptions?: FxBindingOptions;
          options: any;
          target: Entity | Model | Primitive;
          type: any;
      }[]

    Returns default[]

createMany

  • createMany(items): default[]

  • 批量创建 FX（不绑定目标），返回成功创建的列表

    Parameters

    • items: {
          options: any;
          type: any;
      }[]

    Returns default[]

detach

  • detach(fxId): boolean

  • 解除绑定

    Parameters

    • fxId: string

    Returns boolean

getById

  • getById(id): default

  • Parameters

    • id: string

    Returns default

isExists

  • isExists(id): boolean

  • Parameters

    • id: string

    Returns boolean

pauseAllBindings

  • pauseAllBindings(): void

  • 暂停所有绑定的位姿更新

    Returns void

pauseBinding

  • pauseBinding(fxId): boolean

  • 暂停指定 FX 的绑定更新

    Parameters

    • fxId: string

    Returns boolean

removeById

  • removeById(id): boolean

  • Parameters

    • id: string

    Returns boolean

resumeAllBindings

  • resumeAllBindings(): void

  • 恢复所有绑定的位姿更新

    Returns void

resumeBinding

  • resumeBinding(fxId): boolean

  • 恢复指定 FX 的绑定更新

    Parameters

    • fxId: string

    Returns boolean

updateBinding

  • updateBinding(fxId, options): boolean

  • 更新绑定配置

    Parameters

    • fxId: string
    • options: Partial<FxBindingOptions>

    Returns boolean

Settings

Member Visibility

Theme

On This Page

constructorcoreguidvieweraddattachattachManyclearAllcreatecreateAndAttachcreateAndAttachManycreateManydetachgetByIdisExistspauseAllBindingspauseBindingremoveByIdresumeAllBindingsresumeBindingupdateBinding