ThreePipe
    Preparing search index...

    Class LoadingScreenPlugin

    Loading Screen Plugin

    Shows a configurable loading screen overlay over the canvas.

    Hierarchy (View Summary)

    Index

    Constructors

    constructor

    Properties

    _contentDiv _dirty _mainDiv _viewer? _viewerListeners background backgroundBlur backgroundOpacity constructor container? enabled errorTextHeader filesElement hideDelay hideOnFilesLoad hideOnOnlyErrors hideOnSceneObjectLoad isEditor isViewerPluginSync loader loadingElement loadingTextHeader logoElement logoImage minimizeOnSceneObjectLoad showFileNames showOnFilesLoading showOnSceneEmpty showProcessStates showProgress spinners styles stylesheet? stylesheetLoader? textColor uiConfig? LS_DEFAULT_LOGO OldPluginType? PluginType

    Accessors

    dirty visible

    Methods

    _onProcessStateUpdate _onViewerEvent _showMainDiv _storeKey _updateMainDiv _updateVisibility disable dispose enable exportState fromJSON hide hideWithDelay importState isDisabled maximize minimize onAdded onRemove refresh setDirty? show togglePreview toJSON

    Constructors

    Properties

    Protected_contentDiv

    _contentDiv: undefined | HTMLDivElement

    Protected_dirty

    _dirty: boolean = false

    Protected_mainDiv

    _mainDiv: HTMLDivElement

    Protected Optional_viewer

    _viewer?: ThreeViewer

    Protected_viewerListeners

    _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
    isViewerPluginSync: true = ...
    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

    Protected_onProcessStateUpdate

    Protected_onViewerEvent

    Protected_showMainDiv

    Protected_storeKey

    Protected_updateMainDiv

    Protected_updateVisibility

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

      Parameters

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

      Returns boolean

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    Accessors
    Methods