@pixiv/three-vrm/types/VRMLoaderPluginOptions.d.ts

VRM file loader for three.js.

import type * as THREE from 'three';
import type { VRMExpressionLoaderPlugin, VRMFirstPersonLoaderPlugin, VRMHumanoidLoaderPlugin, VRMLookAtLoaderPlugin, VRMMetaLoaderPlugin } from '@pixiv/three-vrm-core';
import type { MToonMaterialLoaderPlugin } from '@pixiv/three-vrm-materials-mtoon';
import type { VRMMaterialsHDREmissiveMultiplierLoaderPlugin } from '@pixiv/three-vrm-materials-hdr-emissive-multiplier';
import type { VRMMaterialsV0CompatPlugin } from '@pixiv/three-vrm-materials-v0compat';
import type { VRMNodeConstraintLoaderPlugin } from '@pixiv/three-vrm-node-constraint';
import type { VRMSpringBoneLoaderPlugin } from '@pixiv/three-vrm-springbone';
export interface VRMLoaderPluginOptions {
    expressionPlugin?: VRMExpressionLoaderPlugin;
    firstPersonPlugin?: VRMFirstPersonLoaderPlugin;
    humanoidPlugin?: VRMHumanoidLoaderPlugin;
    lookAtPlugin?: VRMLookAtLoaderPlugin;
    metaPlugin?: VRMMetaLoaderPlugin;
    mtoonMaterialPlugin?: MToonMaterialLoaderPlugin;
    materialsHDREmissiveMultiplierPlugin?: VRMMaterialsHDREmissiveMultiplierLoaderPlugin;
    materialsV0CompatPlugin?: VRMMaterialsV0CompatPlugin;
    springBonePlugin?: VRMSpringBoneLoaderPlugin;
    nodeConstraintPlugin?: VRMNodeConstraintLoaderPlugin;
    /**
     * If assigned, the object will be used as a helper root of every component.
     * Useful for debug.
     * Will be overwritten if you use custom loader plugins for each components.
     */
    helperRoot?: THREE.Object3D;
    /**
     * Whether it copies pose from normalizedHumanBones to rawHumanBones on {@link update}.
     * `true` by default.
     *
     * @default true
     */
    autoUpdateHumanBones?: boolean;
}