Class GltfAsset

Represents a GLTF 3D Model.

Example

// @input Asset.BitmojiModule bitmojiModule
// @input Asset.RemoteMediaModule remoteMediaModule
// @input Asset.Material pbrMaterialHolder

script.bitmojiModule.requestBitmoji3DResource(
    function (bitmoji3DResource) {
      script.remoteMediaModule.loadResourceAsGltfAsset(
        bitmoji3DResource,
        onDownloaded,
        onFail
      )
    }
  )

function onDownloaded (gltfAsset){
  var root = scene.createSceneObject("BitmojiAvatar");
  var gltfSettings = GltfSettings.create();
  gltfSettings.convertMetersToCentimeters = true;
  var avatar = gltfAsset.tryInstantiateWithSetting(root, script.pbrMaterialHolder, gltfSettings);
}

function onFail (e){
    print(e);
}

Hierarchy (View Summary, Expand)

Constructors

constructor

Properties

extras name uniqueIdentifier

Methods

getTypeName isOfType isSame tryInstantiate tryInstantiateAsync tryInstantiateWithSetting

Constructors

Protectedconstructor

Properties

Readonlyextras

extras: string

name

name: string

The name of the Asset in Lens Studio.

ReadonlyuniqueIdentifier

uniqueIdentifier: string

Methods

getTypeName

  • getTypeName(): string

    Returns the name of this object's type.

    Returns string

isOfType

  • isOfType(type: string): boolean

    Returns true if the object matches or derives from the passed in type.

    Parameters

    • type: string

    Returns boolean

isSame

  • isSame(other: ScriptObject): boolean

    Returns true if this object is the same as other. Useful for checking if two references point to the same thing.

    Parameters

    Returns boolean

tryInstantiate

tryInstantiateAsync

  • tryInstantiateAsync(
        parent: SceneObject,
        material: Material,
        onSuccess: (sceneObject: SceneObject) => void,
        onFailure: (error: string) => void,
        onProgress: (progress: number) => void,
        gltfSettings?: GltfSettings,
    ): void

    Asynchronously try instantiating an object from the GLTF asset. Useful to prevent frame drops when loading multiple assets simultaenously as to not block the the thread.

    Parameters

    Returns void

tryInstantiateWithSetting

Settings

Member Visibility

On This Page

Constructors
Properties
Methods
MMNEPVFCICPMFPCPTTAAATR