Class NEEDLE_progressive

The NEEDLE_progressive extension for the GLTFLoader is responsible for loading progressive LODs for meshes and textures.
This extension can be used to load different resolutions of a mesh or texture at runtime (e.g. for LODs or progressive textures).

Example

const loader = new GLTFLoader();
loader.register(new NEEDLE_progressive());
loader.load("model.glb", (gltf) => {
   const mesh = gltf.scene.children[0] as Mesh;
  NEEDLE_progressive.assignMeshLOD(context, sourceId, mesh, 1).then(mesh => {
    console.log("Mesh with LOD level 1 loaded", mesh);
 });
});

Implements

  • unknown

Constructors

constructor

Accessors

name

Methods

afterRoot assignMeshLOD assignTextureLOD beginListenEnd beginListenStart getMeshLODInformation hasLODLevelAvailable stopListenEnd stopListenStart

Constructors

constructor

Accessors

name

  • get name(): string

  • The name of the extension

    Returns string

Methods

afterRoot

  • afterRoot(gltf): null

  • Parameters

    • gltf: GLTF

    Returns null

Static assignMeshLOD

  • assignMeshLOD(context, source, mesh, level): Promise<any>

  • Load a different resolution of a mesh (if available)

    Parameters

    • context: Context

      the context

    • source: string

      the sourceid of the file from which the mesh is loaded (this is usually the component's sourceId)

    • mesh: Mesh

      the mesh to load the LOD for

    • level: number

      the level of detail to load (0 is the highest resolution)

    Returns Promise<any>

    a promise that resolves to the mesh with the requested LOD level

    Example

    const mesh = this.gameObject as Mesh;
    NEEDLE_progressive.assignMeshLOD(context, sourceId, mesh, 1).then(mesh => {
       console.log("Mesh with LOD level 1 loaded", mesh);
    });

Static assignTextureLOD

  • assignTextureLOD(context, source, materialOrTexture, level?): Promise<any>

  • Load a different resolution of a texture (if available)

    Parameters

    • context: Context

      the context

    • source: string

      the sourceid of the file from which the texture is loaded (this is usually the component's sourceId)

    • materialOrTexture: any

      the material or texture to load the LOD for (if passing in a material all textures in the material will be loaded)

    • level: number = 0

      the level of detail to load (0 is the highest resolution) - currently only 0 is supported

    Returns Promise<any>

    a promise that resolves to the material or texture with the requested LOD level

Static beginListenEnd

  • beginListenEnd(context, evt): void

  • subscribe to loading event ended event

    Parameters

    • context: Context
    • evt: ProgressiveLoadingEvent

    Returns void

Static beginListenStart

  • beginListenStart(context, evt): void

  • subscribe to events whenever a loading event starts, invoked for every single loading process that starts

    Parameters

    • context: Context
    • evt: ProgressiveLoadingEvent

    Returns void

Static getMeshLODInformation

  • getMeshLODInformation(geo): NEEDLE_progressive_mesh_model

  • Parameters

    Returns NEEDLE_progressive_mesh_model

Static hasLODLevelAvailable

  • hasLODLevelAvailable(obj, level?): boolean

  • Check if a LOD level is available for a mesh or a texture

    Parameters

    • obj: any

      the mesh or texture to check

    • Optional level: number

      the level of detail to check for (0 is the highest resolution). If undefined, the function checks if any LOD level is available

    Returns boolean

    true if the LOD level is available (or if any LOD level is available if level is undefined)

Static stopListenEnd

  • stopListenEnd(context, evt): void

  • Parameters

    • context: Context
    • evt: ProgressiveLoadingEvent

    Returns void

Static stopListenStart

  • stopListenStart(context, evt): void

  • Parameters

    • context: Context
    • evt: ProgressiveLoadingEvent

    Returns void

Settings

Member Visibility

Theme

On This Page

constructornameafterRootassignMeshLODassignTextureLODbeginListenEndbeginListenStartgetMeshLODInformationhasLODLevelAvailablestopListenEndstopListenStart

Generated using TypeDoc