info.laht.threekt.external.loaders.GLTFLoader.kt Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of wrapper Show documentation

kotlin wrappers for three.js (https://threejs.org/)

The newest version!

@file:JsQualifier("THREE")

package info.laht.threekt.external.loaders

import info.laht.threekt.animation.AnimationClip
import info.laht.threekt.cameras.Camera
import info.laht.threekt.loaders.LoadingManager
import info.laht.threekt.scenes.Scene
import org.khronos.webgl.ArrayBuffer
import org.w3c.xhr.XMLHttpRequest

external interface GLTFOnLoadCallback {
    val animations: Array
    val scene: Scene
    val scenes: Array
    val cameras: Array
}

/**
 * A loader for loading glTF 2.0 resource.
 * glTF (GL Transmission Format) is an open format specification for efficient delivery
 * and loading of 3D content. Assets may be provided either in JSON (.gltf) or binary (.glb) format.
 * External files store textures (.jpg, .png, ...) and additional binary data (.bin).
 * A glTF asset may deliver one or more scenes, including meshes, materials, textures, skins,
 * skeletons, morph targets, animations, lights, and/or cameras.
 */
open external class GLTFLoader(
        manager: LoadingManager = definedExternally
) {

    /**
     * Begin loading from url and call the callback function with the parsed response content.
     */
    fun load(url: String,
             onLoad: (GLTFOnLoadCallback) -> Unit,
             onProgress: (XMLHttpRequest) -> Unit = definedExternally,
             onError: (dynamic) -> Unit = definedExternally)

    /**
     * Set the base path for additional resources.
     */
    fun setPath(path: String)
    fun setCrossOrigin(value: String)

    /**
     * Parse a glTF-based ArrayBuffer and fire onLoad callback when complete.
     * The argument to onLoad will be an object that contains loaded parts: .scene, .scenes, .cameras, and .animations.
     */
    fun parse(data: ArrayBuffer, path: String, onLoad: (GLTFOnLoadCallback) -> Unit, onError: (dynamic) -> Unit)

    /**
     * Parse a glTF-based JSON String and fire onLoad callback when complete.
     * The argument to onLoad will be an object that contains loaded parts: .scene, .scenes, .cameras, and .animations.
     */
    fun parse(data: String, path: String, onLoad: (GLTFOnLoadCallback) -> Unit, onError: (dynamic) -> Unit)

}