Interface MeshApiInterface

The Mesh API encapsulates object that concerns mesh loading.

Hierarchy

MeshApiInterface

Index

Methods

Methods

loadScene

loadScene(path: string, onLoad: (groups: Group[]) => void): void

Given URL path the method will recursively load the .gltf file content.

Parameters
- path: string
  
  URL with .gltf root file.
- onLoad: (groups: Group[]) => void
  
  Called when the mesh is loaded with groups argument.
  - - (groups: Group[]): void
    - Parameters
      - groups: Group[]
      Returns void
Returns void

setRequestHeader

setRequestHeader(requestHeader: {}): void

This method sets request headers for instance the authorization token etc.

Parameters
- requestHeader: {}
  
  dictionary with headers to set.
  - [header: string]: string
Returns void

setUrlModifier

setUrlModifier(callback?: (url: string) => string): void

If provided, the callback will be passed to each resource URL before a request is sent. The callback may return the original URL, or a new URL to override loading behavior. This behavior can be used to load assets from .ZIP files, drag-and-drop APIs, and Data URIs.

Parameters
- Optional callback: (url: string) => string
  
  URL modifier callback. Called with url argument, and must return resolved URL.
  - - (url: string): string
    - Parameters
      - url: string
      Returns string
Returns void

Generated using TypeDoc