W-CF Documentation - v11.0.0
    Preparing search index...

    Class Application

    Index
    applicationName: string

    Name of the host application. (e.g. used as meta data for saved documents).

    applicationVersion: string

    Version of the host application. (e.g. used as meta data for saved documents).

    eventAnimate: ListenableEvent<void, Application> = ...

    Will be triggered periodically from the applications main loop. Can be used for custom animations.

    • get buildInfo(): string

      Returns string

    • get engine(): Engine

      Returns Engine

    • get initOptions(): Readonly<AppInitOptions>

      The options used to initialize the application. If the aplication was not initialized yet these options represent the default options.

      Returns Readonly<AppInitOptions>

    • get modules(): readonly AppModule[]

      The list of registered modules.

      Returns readonly AppModule[]

    • get scene(): Scene

      Returns Scene

    • get version(): string

      Returns string

    • Dispose application and free used resources.

      Returns void

    • Returns the module with the given id or null if the module was not found.

      Parameters

      • pModuleId: string

      Returns AppModule | null

    • Has to be called once to intialize the application. The 3d rendering canvas will be created as a children of pViewerContainer. Returns false if initialization failed.

      Parameters

      • pViewerContainer: HTMLDivElement
      • OptionalpOptions: Partial<AppInitOptions>

      Returns boolean

    • Registers a new application module.

      Parameters

      Returns void