BIM.works SDKs - v3.0.0-b.115
    Preparing search index...

    Interface LoadProgressHandler

    Load progress of the models of a viewer's ModelManager. managerIndex is that ModelManager's index (@bimworks/viewercommon!ModelManagerSettings.index), so one handler can serve the viewers of several ModelManagers.

    interface LoadProgressHandler {
        dynamicLoadStarted?(version: Version): void;
        dynamicLoadStopped?(version: Version): void;
        versionLoaded?(version: Version, managerIndex: number): void;
        versionLoadProgress?(
            version: Version,
            progress: number,
            managerIndex: number,
        ): void;
        versionUnloaded?(version: Version, managerIndex: number): void;
    }
    Index

    Methods

    dynamicLoadStarted? dynamicLoadStopped? versionLoaded? versionLoadProgress? versionUnloaded?

    Methods

    • Called when the dynamic loading of a model has started. Dynamic loading currently only happens for point cloud models, where parts of the model are being loaded upon user interaction. Note: For some types of user interaction such as zooming this has the tendency of flickering on/off often, so it can be advised to implement some type of buffering.

      Parameters

      • version: Version

        The version for which dynamic loading has started

      Returns void

    • Called when the dynamic loading of a model has stopped.

      Parameters

      • version: Version

        The version for which dynamic loading has stopped

      Returns void

    • Called when a version has been completely loaded

      Parameters

      • version: Version
      • managerIndex: number

      Returns void

    • Parameters

      • version: Version

        The version for which progress is reported

      • progress: number

        How far along loading this Version is in a percentage (0-100)

      • managerIndex: number

      Returns void

    • Called when a version has been completely unloaded

      Parameters

      • version: Version
      • managerIndex: number

      Returns void

    Settings

    Member Visibility

    On This Page

    Methods