babylon-mmd/esm/Runtime/mmdMesh.d.ts

babylon.js mmd loader and runtime

import type { Skeleton } from "@babylonjs/core/Bones/skeleton";
import type { Material } from "@babylonjs/core/Materials/material";
import type { Mesh } from "@babylonjs/core/Meshes/mesh";
import type { MmdModelMetadata } from "../Loader/mmdModelMetadata";
/**
 * Mesh type that has MMD model metadata
 */
export interface MmdMesh extends Mesh {
    _mmdMeshPhantomProperty: true;
    metadata: MmdModelMetadata;
}
/**
 * Mesh type that able to create `MmdModel` instance
 */
export interface MmdSkinnedMesh extends MmdMesh {
    _mmdSkinnedMeshPhantomProperty: true;
    metadata: MmdSkinedModelMetadata;
}
/**
 * Metadata for `MmdModel`
 */
export interface MmdSkinedModelMetadata extends MmdModelMetadata {
    /**
     * Mmd model skeleton
     */
    readonly skeleton: Skeleton;
}
/**
 * Mesh type that has trimmed MMD model metadata
 */
export interface TrimmedMmdSkinnedMesh extends Mesh {
    metadata: TrimmedMmdSkinedModelMetadata;
}
/**
 * Metadata for `RuntimeMmdModel`
 */
export interface TrimmedMmdSkinedModelMetadata {
    readonly isTrimmedMmdSkinedModel: true;
    readonly header: MmdModelMetadata.Header;
    /**
     * Mmd model meshes
     */
    readonly meshes: readonly Mesh[];
    /**
     * Mmd model materials
     */
    readonly materials: readonly Material[];
    /**
     * Mmd model skeleton
     */
    readonly skeleton: Skeleton;
}
/**
 * Provides a way to validate that a mesh meets the components to be loaded into the MMD runtime
 */
export declare namespace MmdMesh {
    /**
     * Check if the mesh is MMD model root mesh
     */
    function isMmdMesh(mesh: Mesh): mesh is MmdMesh;
    /**
     * Check if the mesh is MMD model root mesh and can create `MmdModel` instance
     * @param mesh Mesh to check
     * @returns `true` if the mesh is `MmdSkinnedMesh`
     */
    function isMmdSkinnedMesh(mesh: Mesh): mesh is MmdSkinnedMesh;
}