Class VRMLoaderPlugin

Implements

GLTFLoaderPlugin

Index

Constructors

Properties

expressionPlugin firstPersonPlugin humanoidPlugin lookAtPlugin materialsHDREmissiveMultiplierPlugin materialsV0CompatPlugin metaPlugin mtoonMaterialPlugin nodeConstraintPlugin parser springBonePlugin

Accessors

Methods

afterRoot beforeRoot extendMaterialParams getMaterialType loadMesh

Constructors

constructor

new VRMLoaderPlugin(
parser: GLTFParser,
options?: VRMLoaderPluginOptions,
): VRMLoaderPlugin
Parameters
- parser: GLTFParser
- Optionaloptions: VRMLoaderPluginOptions
Returns VRMLoaderPlugin
- Defined in packages/three-vrm/src/VRMLoaderPlugin.ts:38

Properties

`Readonly`expressionPlugin

expressionPlugin: VRMExpressionLoaderPlugin

`Readonly`firstPersonPlugin

firstPersonPlugin: VRMFirstPersonLoaderPlugin

`Readonly`humanoidPlugin

humanoidPlugin: VRMHumanoidLoaderPlugin

`Readonly`lookAtPlugin

lookAtPlugin: VRMLookAtLoaderPlugin

`Readonly`materialsHDREmissiveMultiplierPlugin

materialsHDREmissiveMultiplierPlugin: VRMMaterialsHDREmissiveMultiplierLoaderPlugin

`Readonly`materialsV0CompatPlugin

materialsV0CompatPlugin: VRMMaterialsV0CompatPlugin

`Readonly`metaPlugin

metaPlugin: VRMMetaLoaderPlugin

`Readonly`mtoonMaterialPlugin

mtoonMaterialPlugin: MToonMaterialLoaderPlugin

`Readonly`nodeConstraintPlugin

nodeConstraintPlugin: VRMNodeConstraintLoaderPlugin

`Readonly`parser

parser: GLTFParser

`Readonly`springBonePlugin

springBonePlugin: VRMSpringBoneLoaderPlugin

Accessors

name

get name(): string
Returns string
Implementation of GLTFLoaderPlugin.name
- Defined in packages/three-vrm/src/VRMLoaderPlugin.ts:34

Methods

afterRoot

afterRoot(gltf: GLTF): Promise<void>
Parameters
- gltf: GLTF
Returns Promise<void>
Implementation of GLTFLoaderPlugin.afterRoot
- Defined in packages/three-vrm/src/VRMLoaderPlugin.ts:93

beforeRoot

beforeRoot(): Promise<void>
Returns Promise<void>
Implementation of GLTFLoaderPlugin.beforeRoot
- Defined in packages/three-vrm/src/VRMLoaderPlugin.ts:70

extendMaterialParams

extendMaterialParams(
materialIndex: number,
materialParams: { [key: string]: any },
): Promise<any>
Parameters
- materialIndex: number
- materialParams: { [key: string]: any }
Returns Promise<any>
Implementation of GLTFLoaderPlugin.extendMaterialParams
- Defined in packages/three-vrm/src/VRMLoaderPlugin.ts:88

getMaterialType

getMaterialType(materialIndex: number): null | typeof Material
Parameters
- materialIndex: number
Returns null | typeof Material
Implementation of GLTFLoaderPlugin.getMaterialType
- Defined in packages/three-vrm/src/VRMLoaderPlugin.ts:79

loadMesh

loadMesh(
    meshIndex: number,
): Promise<
    | Group<Object3DEventMap>
    | Mesh<
        BufferGeometry<NormalBufferAttributes>,
        Material | Material[],
        Object3DEventMap,
    >
    | SkinnedMesh<
        BufferGeometry<NormalBufferAttributes>,
        Material | Material[],
        Object3DEventMap,
    >,
>
Parameters
- meshIndex: number
Returns Promise<
    | Group<Object3DEventMap>
    | Mesh<
        BufferGeometry<NormalBufferAttributes>,
        Material | Material[],
        Object3DEventMap,
    >
    | SkinnedMesh<
        BufferGeometry<NormalBufferAttributes>,
        Material | Material[],
        Object3DEventMap,
    >,
>
Implementation of GLTFLoaderPlugin.loadMesh
- Defined in packages/three-vrm/src/VRMLoaderPlugin.ts:75