ThreePipe
    Preparing search index...

    Class LoadingScreenPlugin

    Loading Screen Plugin

    Shows a configurable loading screen overlay over the canvas.

    Hierarchy (View Summary)

    Index

    Constructors

    Properties

    _contentDiv: undefined | HTMLDivElement
    _dirty: boolean = false
    _mainDiv: HTMLDivElement
    _viewer?: ThreeViewer
    _viewerListeners: PartialRecord<IViewerEventTypes, (e: IViewerEvent) => void> = {}
    background: string = '#ffffff'
    backgroundBlur: number = 24
    backgroundOpacity: number = 0.5
    constructor: typeof AViewerPluginSync & typeof AViewerPlugin
    container?: HTMLElement
    enabled: boolean = true
    errorTextHeader: string = 'Error Loading Files'
    filesElement: HTMLDivElement = ...
    hideDelay: number = 500
    hideOnFilesLoad: boolean = true
    hideOnOnlyErrors: boolean = true
    hideOnSceneObjectLoad: boolean = false
    isEditor: boolean = false
    loader: number = 0
    loadingElement: HTMLDivElement = ...
    loadingTextHeader: string = 'Loading Files'
    logoElement: HTMLDivElement = ...
    logoImage: string = LoadingScreenPlugin.LS_DEFAULT_LOGO
    minimizeOnSceneObjectLoad: boolean = true

    Minimize when scene has objects Note: also checks for scene.environment and doesnt minimize when environment is null or undefined

    true
    
    showFileNames: boolean = true
    showOnFilesLoading: boolean = true
    showOnSceneEmpty: boolean = true
    showProcessStates: boolean = true
    showProgress: boolean = true
    spinners: { html: string; styles: string }[] = ...
    styles: string = styles
    stylesheet?: HTMLStyleElement
    stylesheetLoader?: HTMLStyleElement[]
    textColor: string = '#222222'
    uiConfig?: UiObjectConfig<any, string, any> = undefined
    LS_DEFAULT_LOGO: string = 'https://threepipe.org/logo.svg'

    Default logo image shown during loading

    'https://threepipe.org/logo.svg'
    
    OldPluginType?: string
    PluginType: "LoadingScreenPlugin" = 'LoadingScreenPlugin'

    Accessors

    Methods

    • Parameters

      • processState: Map<string, { progress?: number; state: string }>
      • errors: number

      Returns boolean