SceneLoader

Hierarchy

  • SceneLoader

Index

Properties

Static CleanBoneMatrixWeights

CleanBoneMatrixWeights: boolean

Static DETAILED_LOGGING

DETAILED_LOGGING: number

Static ForceFullSceneLoadingForIncremental

ForceFullSceneLoadingForIncremental: boolean

Static MINIMAL_LOGGING

MINIMAL_LOGGING: number

Static NO_LOGGING

NO_LOGGING: number

Static OnPluginActivatedObservable

OnPluginActivatedObservable: Observable<ISceneLoaderPlugin | ISceneLoaderPluginAsync>

Static SUMMARY_LOGGING

SUMMARY_LOGGING: number

Static ShowLoadingScreen

ShowLoadingScreen: boolean

Static loggingLevel

loggingLevel: number

Methods

Static Append

  • Append a scene

    Parameters

    • rootUrl: string

      a string that defines the root url for scene and resources

    • sceneFilename: any

      a string that defines the name of the scene file. can start with "data:" following by the stringified version of the scene

    • scene: Scene

      is the instance of BABYLON.Scene to append to

    • Optional onSuccess: Nullable<function>

      a callback with the scene when import succeeds

    • Optional onProgress: Nullable<function>

      a callback with a progress event for each file being loaded

    • Optional onError: Nullable<function>

      a callback with the scene, a message, and possibly an exception when import fails

    • Optional pluginExtension: Nullable<string>

      the extension used to determine the plugin

    Returns Nullable<ISceneLoaderPlugin | ISceneLoaderPluginAsync>

    The loaded plugin

Static AppendAsync

  • AppendAsync(rootUrl: string, sceneFilename: any, scene: Scene, onProgress?: Nullable<function>, pluginExtension?: Nullable<string>): Promise<Scene>
  • Append a scene

    Parameters

    • rootUrl: string

      a string that defines the root url for scene and resources

    • sceneFilename: any

      a string that defines the name of the scene file. can start with "data:" following by the stringified version of the scene

    • scene: Scene

      is the instance of BABYLON.Scene to append to

    • Optional onProgress: Nullable<function>

      a callback with a progress event for each file being loaded

    • Optional pluginExtension: Nullable<string>

      the extension used to determine the plugin

    Returns Promise<Scene>

    The given scene

Static GetPluginForExtension

Static ImportMesh

  • Import meshes into a scene

    Parameters

    • meshNames: any

      an array of mesh names, a single mesh name, or empty string for all meshes that filter what meshes are imported

    • rootUrl: string

      a string that defines the root url for scene and resources

    • sceneFilename: string

      a string that defines the name of the scene file. can start with "data:" following by the stringified version of the scene

    • scene: Scene

      the instance of BABYLON.Scene to append to

    • Optional onSuccess: Nullable<function>

      a callback with a list of imported meshes, particleSystems, and skeletons when import succeeds

    • Optional onProgress: Nullable<function>

      a callback with a progress event for each file being loaded

    • Optional onError: Nullable<function>

      a callback with the scene, a message, and possibly an exception when import fails

    • Optional pluginExtension: Nullable<string>

      the extension used to determine the plugin

    Returns Nullable<ISceneLoaderPlugin | ISceneLoaderPluginAsync>

    The loaded plugin

Static ImportMeshAsync

  • ImportMeshAsync(meshNames: any, rootUrl: string, sceneFilename: string, scene: Scene, onProgress?: Nullable<function>, pluginExtension?: Nullable<string>): Promise<object>
  • Import meshes into a scene

    Parameters

    • meshNames: any

      an array of mesh names, a single mesh name, or empty string for all meshes that filter what meshes are imported

    • rootUrl: string

      a string that defines the root url for scene and resources

    • sceneFilename: string

      a string that defines the name of the scene file. can start with "data:" following by the stringified version of the scene

    • scene: Scene

      the instance of BABYLON.Scene to append to

    • Optional onProgress: Nullable<function>

      a callback with a progress event for each file being loaded

    • Optional pluginExtension: Nullable<string>

      the extension used to determine the plugin

    Returns Promise<object>

    The loaded list of imported meshes, particle systems, skeletons, and animation groups

Static IsPluginForExtensionAvailable

  • IsPluginForExtensionAvailable(extension: string): boolean
  • Parameters

    • extension: string

    Returns boolean

Static Load

  • Load a scene

    Parameters

    • rootUrl: string

      a string that defines the root url for scene and resources

    • sceneFilename: any

      a string that defines the name of the scene file. can start with "data:" following by the stringified version of the scene

    • engine: Engine

      is the instance of BABYLON.Engine to use to create the scene

    • Optional onSuccess: Nullable<function>

      a callback with the scene when import succeeds

    • Optional onProgress: Nullable<function>

      a callback with a progress event for each file being loaded

    • Optional onError: Nullable<function>

      a callback with the scene, a message, and possibly an exception when import fails

    • Optional pluginExtension: Nullable<string>

      the extension used to determine the plugin

    Returns Nullable<ISceneLoaderPlugin | ISceneLoaderPluginAsync>

    The loaded plugin

Static LoadAssetContainer

  • Load a scene into an asset container

    Parameters

    • rootUrl: string

      a string that defines the root url for scene and resources

    • sceneFilename: any

      a string that defines the name of the scene file. can start with "data:" following by the stringified version of the scene

    • scene: Scene

      is the instance of BABYLON.Scene to append to

    • Optional onSuccess: Nullable<function>

      a callback with the scene when import succeeds

    • Optional onProgress: Nullable<function>

      a callback with a progress event for each file being loaded

    • Optional onError: Nullable<function>

      a callback with the scene, a message, and possibly an exception when import fails

    • Optional pluginExtension: Nullable<string>

      the extension used to determine the plugin

    Returns Nullable<ISceneLoaderPlugin | ISceneLoaderPluginAsync>

    The loaded plugin

Static LoadAssetContainerAsync

  • Load a scene into an asset container

    Parameters

    • rootUrl: string

      a string that defines the root url for scene and resources

    • sceneFilename: any

      a string that defines the name of the scene file. can start with "data:" following by the stringified version of the scene

    • scene: Scene

      is the instance of BABYLON.Scene to append to

    • Optional onProgress: Nullable<function>

      a callback with a progress event for each file being loaded

    • Optional pluginExtension: Nullable<string>

      the extension used to determine the plugin

    Returns Promise<AssetContainer>

    The loaded asset container

Static LoadAsync

  • LoadAsync(rootUrl: string, sceneFilename: any, engine: Engine, onProgress?: Nullable<function>, pluginExtension?: Nullable<string>): Promise<Scene>
  • Load a scene

    Parameters

    • rootUrl: string

      a string that defines the root url for scene and resources

    • sceneFilename: any

      a string that defines the name of the scene file. can start with "data:" following by the stringified version of the scene

    • engine: Engine

      is the instance of BABYLON.Engine to use to create the scene

    • Optional onProgress: Nullable<function>

      a callback with a progress event for each file being loaded

    • Optional pluginExtension: Nullable<string>

      the extension used to determine the plugin

    Returns Promise<Scene>

    The loaded scene

Static RegisterPlugin

Generated using TypeDoc