MMDLoader | ngx3js

Mmdloader See the ngx3js docs page for details.

Examples

webgl / loader / mmd / audio | webgl / loader / mmd / pose | webgl / loader / mmd

Hierarchy

I3JS.Loader
- MMDLoader

Constructors

constructor

new MMDLoader(manager?: I3JS.LoadingManager): I3JS.MMDLoader
new MMDLoader(manager?: I3JS.LoadingManager, options?: any): I3JS.MMDLoader

Inherited from Loader.constructor
- Defined in lib/threejs-library/types/three/examples/loaders.ts:1809
Creates a new Loader.

Parameters
- Optional manager: I3JS.LoadingManager
  
  The loadingManager for the loader to use. Default is THREE.DefaultLoadingManager.
Returns I3JS.MMDLoader
Inherited from Loader.constructor
- Defined in lib/threejs-library/types/three/loaders.ts:611
Creates a new Loader.

Parameters
- Optional manager: I3JS.LoadingManager
  
  The loadingManager for the loader to use. Default is THREE.DefaultLoadingManager.
- Optional options: any
Returns I3JS.MMDLoader

Properties

animationBuilder

animationBuilder: object

animationPath

animationPath: string

crossOrigin

crossOrigin: string

The crossOrigin string to implement CORS for loading the url from a different domain that allows CORS. Default is anonymous.

default: 'anonymous'

loader

loader: I3JS.FileLoader

manager

manager: I3JS.LoadingManager

The loadingManager the loader is using. Default is DefaultLoadingManager.

meshBuilder

meshBuilder: object

parser

parser: object

path

path: string

The base path from which the asset will be loaded. Default is the empty string.

default: ''

requestHeader

requestHeader: {}

The request header used in HTTP request. See .setRequestHeader. Default is empty object.

default: {}

Type declaration

[header: string]: string

resourcePath

resourcePath: string

The base path from which additional resources like textures will be loaded. Default is the empty string.

default: ''

withCredentials

withCredentials: boolean

Whether the XMLHttpRequest uses credentials. See .setWithCredentials. Default is false.

default:: false

Methods

load

load(url: string, onLoad: (mesh: I3JS.SkinnedMesh<I3JS.BufferGeometry, I3JS.Material | I3JS.Material[]>) => void, onProgress?: (event: ProgressEvent<EventTarget>) => void, onError?: (event: ErrorEvent) => void): void

- Defined in lib/threejs-library/types/three/examples/loaders.ts:1823
Begin loading from url.

Parameters
- url: string
  
  The path or URL to the file.
- onLoad: (mesh: I3JS.SkinnedMesh<I3JS.BufferGeometry, I3JS.Material | I3JS.Material[]>) => void
  
  Will be called when load completes.
  - - (mesh: I3JS.SkinnedMesh<I3JS.BufferGeometry, I3JS.Material | I3JS.Material[]>): void
    - Parameters
      - mesh: I3JS.SkinnedMesh<I3JS.BufferGeometry, I3JS.Material | I3JS.Material[]>
      Returns void
- Optional onProgress: (event: ProgressEvent<EventTarget>) => void
  
  Will be called while load progresses.
  - - (event: ProgressEvent<EventTarget>): void
    - Parameters
      - event: ProgressEvent<EventTarget>
      Returns void
- Optional onError: (event: ErrorEvent) => void
  
  Will be called when load errors.
  - - (event: ErrorEvent): void
    - Parameters
      - event: ErrorEvent
      Returns void
Returns void

loadAnimation

loadAnimation(url: string, object: I3JS.Camera | I3JS.SkinnedMesh<I3JS.BufferGeometry, I3JS.Material | I3JS.Material[]>, onLoad: (object: I3JS.AnimationClip | I3JS.SkinnedMesh<I3JS.BufferGeometry, I3JS.Material | I3JS.Material[]>) => void, onProgress?: (event: ProgressEvent<EventTarget>) => void, onError?: (event: ErrorEvent) => void): void

- Defined in lib/threejs-library/types/three/examples/loaders.ts:1836
Parameters
- url: string
- object: I3JS.Camera | I3JS.SkinnedMesh<I3JS.BufferGeometry, I3JS.Material | I3JS.Material[]>
- onLoad: (object: I3JS.AnimationClip | I3JS.SkinnedMesh<I3JS.BufferGeometry, I3JS.Material | I3JS.Material[]>) => void
  - - (object: I3JS.AnimationClip | I3JS.SkinnedMesh<I3JS.BufferGeometry, I3JS.Material | I3JS.Material[]>): void
    - Parameters
      - object: I3JS.AnimationClip | I3JS.SkinnedMesh<I3JS.BufferGeometry, I3JS.Material | I3JS.Material[]>
      Returns void
- Optional onProgress: (event: ProgressEvent<EventTarget>) => void
  - - (event: ProgressEvent<EventTarget>): void
    - Parameters
      - event: ProgressEvent<EventTarget>
      Returns void
- Optional onError: (event: ErrorEvent) => void
  - - (event: ErrorEvent): void
    - Parameters
      - event: ErrorEvent
      Returns void
Returns void

loadAsync

loadAsync(url: string, onProgress?: (event: ProgressEvent<EventTarget>) => void): Promise<I3JS.SkinnedMesh<I3JS.BufferGeometry, I3JS.Material | I3JS.Material[]>>

Overrides Loader.loadAsync
- Defined in lib/threejs-library/types/three/examples/loaders.ts:1835
Begin loading from url.

Parameters
- url: string
  
  The path or URL to the file.
- Optional onProgress: (event: ProgressEvent<EventTarget>) => void
  
  Will be called while load progresses.
  - - (event: ProgressEvent<EventTarget>): void
    - Parameters
      - event: ProgressEvent<EventTarget>
      Returns void
Returns Promise<I3JS.SkinnedMesh<I3JS.BufferGeometry, I3JS.Material | I3JS.Material[]>>

loadPMD

loadPMD(url: string, onLoad: (object: object) => void, onProgress?: (event: ProgressEvent<EventTarget>) => void, onError?: (event: ErrorEvent) => void): void

- Defined in lib/threejs-library/types/three/examples/loaders.ts:1843
Parameters
- url: string
- onLoad: (object: object) => void
  - - (object: object): void
    - Parameters
      - object: object
      Returns void
- Optional onProgress: (event: ProgressEvent<EventTarget>) => void
  - - (event: ProgressEvent<EventTarget>): void
    - Parameters
      - event: ProgressEvent<EventTarget>
      Returns void
- Optional onError: (event: ErrorEvent) => void
  - - (event: ErrorEvent): void
    - Parameters
      - event: ErrorEvent
      Returns void
Returns void

loadPMX

loadPMX(url: string, onLoad: (object: object) => void, onProgress?: (event: ProgressEvent<EventTarget>) => void, onError?: (event: ErrorEvent) => void): void

- Defined in lib/threejs-library/types/three/examples/loaders.ts:1849
Parameters
- url: string
- onLoad: (object: object) => void
  - - (object: object): void
    - Parameters
      - object: object
      Returns void
- Optional onProgress: (event: ProgressEvent<EventTarget>) => void
  - - (event: ProgressEvent<EventTarget>): void
    - Parameters
      - event: ProgressEvent<EventTarget>
      Returns void
- Optional onError: (event: ErrorEvent) => void
  - - (event: ErrorEvent): void
    - Parameters
      - event: ErrorEvent
      Returns void
Returns void

loadVMD

loadVMD(url: string, onLoad: (object: object) => void, onProgress?: (event: ProgressEvent<EventTarget>) => void, onError?: (event: ErrorEvent) => void): void

- Defined in lib/threejs-library/types/three/examples/loaders.ts:1855
Parameters
- url: string
- onLoad: (object: object) => void
  - - (object: object): void
    - Parameters
      - object: object
      Returns void
- Optional onProgress: (event: ProgressEvent<EventTarget>) => void
  - - (event: ProgressEvent<EventTarget>): void
    - Parameters
      - event: ProgressEvent<EventTarget>
      Returns void
- Optional onError: (event: ErrorEvent) => void
  - - (event: ErrorEvent): void
    - Parameters
      - event: ErrorEvent
      Returns void
Returns void

loadVPD

loadVPD(url: string, isUnicode: boolean, onLoad: (object: object) => void, onProgress?: (event: ProgressEvent<EventTarget>) => void, onError?: (event: ErrorEvent) => void): void

- Defined in lib/threejs-library/types/three/examples/loaders.ts:1861
Parameters
- url: string
- isUnicode: boolean
- onLoad: (object: object) => void
  - - (object: object): void
    - Parameters
      - object: object
      Returns void
- Optional onProgress: (event: ProgressEvent<EventTarget>) => void
  - - (event: ProgressEvent<EventTarget>): void
    - Parameters
      - event: ProgressEvent<EventTarget>
      Returns void
- Optional onError: (event: ErrorEvent) => void
  - - (event: ErrorEvent): void
    - Parameters
      - event: ErrorEvent
      Returns void
Returns void

loadWithAnimation

loadWithAnimation(url: string, vmdUrl: string | string[], onLoad: (object: MMDLoaderAnimationObject) => void, onProgress?: (event: ProgressEvent<EventTarget>) => void, onError?: (event: ErrorEvent) => void): void

- Defined in lib/threejs-library/types/three/examples/loaders.ts:1868
Parameters
- url: string
- vmdUrl: string | string[]
- onLoad: (object: MMDLoaderAnimationObject) => void
  - - (object: MMDLoaderAnimationObject): void
    - Parameters
      - object: MMDLoaderAnimationObject
      Returns void
- Optional onProgress: (event: ProgressEvent<EventTarget>) => void
  - - (event: ProgressEvent<EventTarget>): void
    - Parameters
      - event: ProgressEvent<EventTarget>
      Returns void
- Optional onError: (event: ErrorEvent) => void
  - - (event: ErrorEvent): void
    - Parameters
      - event: ErrorEvent
      Returns void
Returns void

setAnimationPath

setAnimationPath(animationPath: string): I3JS.MMDLoader

- Defined in lib/threejs-library/types/three/examples/loaders.ts:1875
Parameters
- animationPath: string
Returns I3JS.MMDLoader

setCrossOrigin

setCrossOrigin(crossOrigin: string): I3JS.MMDLoader

Inherited from Loader.setCrossOrigin
- Defined in lib/threejs-library/types/three/loaders.ts:663
Parameters
- crossOrigin: string
  
  The crossOrigin string to implement CORS for loading the url from a different domain that allows CORS.
Returns I3JS.MMDLoader

setPath

setPath(path: string): I3JS.MMDLoader

Inherited from Loader.setPath
- Defined in lib/threejs-library/types/three/loaders.ts:674
Parameters
- path: string
  
  Set the base path for the asset.
Returns I3JS.MMDLoader

setRequestHeader

setRequestHeader(requestHeader: {}): I3JS.MMDLoader

Inherited from Loader.setRequestHeader
- Defined in lib/threejs-library/types/three/loaders.ts:685
Parameters
- requestHeader: {}
  
  key: The name of the header whose value is to be set. value: The value to set as the body of the header. Set the request header used in HTTP request.
  - [header: string]: string
Returns I3JS.MMDLoader

setResourcePath

setResourcePath(resourcePath: string): I3JS.MMDLoader

Inherited from Loader.setResourcePath
- Defined in lib/threejs-library/types/three/loaders.ts:679
Parameters
- resourcePath: string
  
  Set the base path for dependent resources like textures.
Returns I3JS.MMDLoader

setWithCredentials

setWithCredentials(value: boolean): I3JS.MMDLoader

Inherited from Loader.setWithCredentials
- Defined in lib/threejs-library/types/three/loaders.ts:669
Whether the XMLHttpRequest uses credentials such as cookies, authorization headers or TLS client certificates. See XMLHttpRequest.withCredentials. Note that this has no effect if you are loading files locally or from the same domain.

Parameters
- value: boolean
Returns I3JS.MMDLoader

Examples

Hierarchy

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

Optional manager: I3JS.LoadingManager

Returns I3JS.MMDLoader

Parameters

Optional manager: I3JS.LoadingManager

Optional options: any

Returns I3JS.MMDLoader

Properties

animationBuilder

animationPath

crossOrigin

loader

manager

meshBuilder

parser

path

requestHeader

Type declaration

[header: string]: string

resourcePath

withCredentials

Methods

load

Parameters

url: string

onLoad: (mesh: I3JS.SkinnedMesh<I3JS.BufferGeometry, I3JS.Material | I3JS.Material[]>) => void

Parameters

mesh: I3JS.SkinnedMesh<I3JS.BufferGeometry, I3JS.Material | I3JS.Material[]>

Returns void

Optional onProgress: (event: ProgressEvent<EventTarget>) => void

Parameters

event: ProgressEvent<EventTarget>

Returns void

Optional onError: (event: ErrorEvent) => void

Parameters

event: ErrorEvent

Returns void

Returns void

loadAnimation

Parameters

url: string

object: I3JS.Camera | I3JS.SkinnedMesh<I3JS.BufferGeometry, I3JS.Material | I3JS.Material[]>

onLoad: (object: I3JS.AnimationClip | I3JS.SkinnedMesh<I3JS.BufferGeometry, I3JS.Material | I3JS.Material[]>) => void

Parameters

object: I3JS.AnimationClip | I3JS.SkinnedMesh<I3JS.BufferGeometry, I3JS.Material | I3JS.Material[]>

Returns void

Optional onProgress: (event: ProgressEvent<EventTarget>) => void

Parameters

event: ProgressEvent<EventTarget>

Returns void

Optional onError: (event: ErrorEvent) => void

Parameters

event: ErrorEvent

Returns void

Returns void

loadAsync

Parameters

url: string

Optional onProgress: (event: ProgressEvent<EventTarget>) => void

Parameters

event: ProgressEvent<EventTarget>

Returns void

Returns Promise<I3JS.SkinnedMesh<I3JS.BufferGeometry, I3JS.Material | I3JS.Material[]>>

loadPMD

Parameters

url: string

onLoad: (object: object) => void

Parameters

object: object

Returns void

Optional onProgress: (event: ProgressEvent<EventTarget>) => void

Parameters