Class VrmaImporter

A utility class for importing VRMA (VRM Animation) files.

VRMA is an extension format for VRM that adds animation capabilities, allowing for the import and processing of humanoid animation data. This class provides static methods to import VRMA files from various sources and processes the humanoid bone mapping for efficient animation playback.

Remarks

This class extends the functionality of Gltf2Importer to handle VRMA-specific features, particularly the VRMC_vrm_animation extension that contains humanoid bone definitions and animation data.

Example

// Import from URL
const vrmaData = await VrmaImporter.importFromUrl('https://example.com/animation.vrma');

// Import from file buffer
const fileBuffer = await file.arrayBuffer();
const vrmaData = await VrmaImporter.importFromArrayBuffer(fileBuffer);

Constructors

constructor

Methods

importFromArrayBuffer importFromUrl readHumanoid

Constructors

constructor

Methods

StaticimportFromArrayBuffer

  • importFromArrayBuffer(arrayBuffer): Promise<RnM2Vrma>

  • Imports a VRMA (VRM Animation) file from an ArrayBuffer.

    Parameters

    • arrayBuffer: ArrayBuffer

      The ArrayBuffer containing the VRMA file data

    Returns Promise<RnM2Vrma>

    A Promise that resolves to the imported VRMA data structure

    Throws

    Will reject the promise if the import fails or the ArrayBuffer is invalid

    Example

    const fileBuffer = await file.arrayBuffer();
    const vrmaData = await VrmaImporter.importFromArrayBuffer(fileBuffer);

StaticimportFromUrl

  • importFromUrl(url): Promise<RnM2Vrma>

  • Imports a VRMA (VRM Animation) file from a URL.

    Parameters

    • url: string

      The URL of the VRMA file to import

    Returns Promise<RnM2Vrma>

    A Promise that resolves to the imported VRMA data structure

    Throws

    Will reject the promise if the import fails or the URL is invalid

    Example

    const vrmaData = await VrmaImporter.importFromUrl('https://example.com/animation.vrma');

StaticreadHumanoid

  • readHumanoid(rnm): void

  • Reads and processes the humanoid bone data from a VRMA file. Creates a mapping between node IDs and human bone names for easier bone lookup.

    Parameters

    • rnm: RnM2Vrma

      The RnM2Vrma object containing the VRMA data

    Returns void

    void - This method modifies the input object in place

    Remarks

    This method extracts humanoid bone information from the VRMC_vrm_animation extension and creates a reverse mapping from node IDs to bone names for efficient bone queries. If no humanoid bones are found, the method returns early without processing.

Settings

Member Visibility

On This Page

Constructors
Methods