@threenative/ueformat 0.1.1

package/dist/index.d.ts

@@ -0,0 +1,187 @@
+import * as three from 'three';
+import { Material, Group, LOD, Object3D, BufferGeometry, Loader, LoadingManager } from 'three';
+
+interface IVector2 {
+    u: number;
+    v: number;
+}
+interface IVector3 {
+    x: number;
+    y: number;
+    z: number;
+}
+interface IQuaternion extends IVector3 {
+    w: number;
+}
+interface IUEFormatCompression {
+    format: "GZIP" | "ZSTD";
+    uncompressedSize: number;
+    compressedSize: number;
+}
+interface IUEFormatHeader {
+    magic: "UEFORMAT";
+    identifier: "UEMODEL";
+    fileVersion: 10;
+    objectName: string;
+    objectPath: string;
+    compression: IUEFormatCompression | null;
+}
+interface IUEModelNormal extends IVector3 {
+    binormalSign: number;
+}
+interface IUEModelTexCoord {
+    name: string;
+    uvs: IVector2[];
+}
+interface IUEModelVertexColor {
+    name: string;
+    colors: Array<{
+        r: number;
+        g: number;
+        b: number;
+        a: number;
+    }>;
+}
+interface IUEModelMaterial {
+    materialName: string;
+    materialPath: string;
+    firstIndex: number;
+    numFaces: number;
+}
+interface IUEModelWeight {
+    boneIndex: number;
+    vertexIndex: number;
+    weight: number;
+}
+interface IUEModelMorphDelta {
+    positionDelta: IVector3;
+    tangentZDelta: IVector3;
+    vertexIndex: number;
+}
+interface IUEModelMorphTarget {
+    name: string;
+    deltas: IUEModelMorphDelta[];
+}
+interface IUEModelLOD {
+    name: string;
+    vertices: IVector3[];
+    normals: IUEModelNormal[];
+    tangents: IVector3[];
+    texCoords: IUEModelTexCoord[];
+    indices: number[];
+    vertexColors: IUEModelVertexColor[];
+    materials: IUEModelMaterial[];
+    weights: IUEModelWeight[];
+    morphTargets: IUEModelMorphTarget[];
+    unknownAttributes: string[];
+}
+interface IUEModelBone {
+    name: string;
+    parentIndex: number;
+    position: IVector3;
+    orientation: IQuaternion;
+    scale: IVector3;
+}
+interface IUEModelSocket {
+    name: string;
+    boneName: string;
+    relativeLocation: IVector3;
+    relativeRotation: IQuaternion;
+    relativeScale: IVector3;
+}
+interface IUEModelVirtualBone {
+    sourceBoneName: string;
+    targetBoneName: string;
+    virtualBoneName: string;
+}
+interface IUEModelSkeleton {
+    metadata: string;
+    bones: IUEModelBone[];
+    sockets: IUEModelSocket[];
+    virtualBones: IUEModelVirtualBone[];
+    unknownAttributes: string[];
+}
+interface IUEModelCollision {
+    name: string;
+    vertices: IVector3[];
+    indices: number[];
+}
+interface IUEModelData {
+    header: IUEFormatHeader;
+    lods: IUEModelLOD[];
+    skeleton: IUEModelSkeleton | null;
+    collision: IUEModelCollision[];
+    unknownAttributes: string[];
+}
+type ZstdDecoder = (compressed: Uint8Array, uncompressedSize: number) => Uint8Array;
+interface IParseUEModelOptions {
+    zstdDecoder?: ZstdDecoder;
+    maxStringBytes?: number;
+    maxArrayElements?: number;
+    maxAttributes?: number;
+}
+
+declare function parseUEModel(input: ArrayBuffer | ArrayBufferView, options?: IParseUEModelOptions): IUEModelData;
+
+type UECoordinateSystem = "three-y-up" | "unreal-z-up";
+type WindingRepair = "auto" | "always" | "never";
+interface IThreeAdapterOptions {
+    coordinateSystem?: UECoordinateSystem;
+    unitScale?: number;
+    flipV?: boolean;
+    repairWinding?: WindingRepair;
+    lodDistances?: readonly number[];
+    materialFactory?: (slot: IUEModelMaterial, materialIndex: number, lod: IUEModelLOD) => Material;
+}
+declare function createThreeGeometry(lod: IUEModelLOD, adapterOptions?: IThreeAdapterOptions): BufferGeometry;
+declare function createThreeObject(model: IUEModelData, adapterOptions?: IThreeAdapterOptions): Group | LOD;
+type UEFormatThreeObject = Group | LOD | Object3D;
+
+interface IUEFormatLoaderOptions {
+    parse?: IParseUEModelOptions;
+    three?: IThreeAdapterOptions;
+}
+declare class UEFormatLoader extends Loader {
+    readonly options: IUEFormatLoaderOptions;
+    constructor(manager?: LoadingManager, options?: IUEFormatLoaderOptions);
+    parse(data: ArrayBuffer | ArrayBufferView): three.Group<three.Object3DEventMap> | three.LOD<three.Object3DEventMap>;
+    load(url: string, onLoad: (object: ReturnType<UEFormatLoader["parse"]>) => void, onProgress?: (event: ProgressEvent) => void, onError?: (error: unknown) => void): this;
+}
+
+interface IUEModelSummary {
+    objectName: string;
+    objectPath: string;
+    formatVersion: number;
+    compression: string | null;
+    lods: Array<{
+        name: string;
+        vertices: number;
+        triangles: number;
+        materials: string[];
+        uvChannels: string[];
+        vertexColorChannels: string[];
+        weights: number;
+        morphTargets: string[];
+    }>;
+    skeleton: {
+        bones: number;
+        sockets: number;
+        virtualBones: number;
+    } | null;
+    collisionMeshes: Array<{
+        name: string;
+        vertices: number;
+        triangles: number;
+    }>;
+    unknownAttributes: string[];
+}
+declare function summarizeUEModel(model: IUEModelData): IUEModelSummary;
+
+type UEFormatErrorCode = "TRUNCATED_FILE" | "INVALID_MAGIC" | "INVALID_IDENTIFIER" | "UNSUPPORTED_VERSION" | "INVALID_LENGTH" | "INVALID_COUNT" | "INVALID_COMPRESSION" | "DECOMPRESSION_FAILED" | "SIZE_MISMATCH" | "ATTRIBUTE_SIZE_MISMATCH" | "INVALID_GEOMETRY";
+declare class UEFormatError extends Error {
+    readonly code: UEFormatErrorCode;
+    readonly offset: number;
+    constructor(code: UEFormatErrorCode, message: string, offset?: number, cause?: unknown);
+}
+
+export { type IParseUEModelOptions, type IQuaternion, type IThreeAdapterOptions, type IUEFormatCompression, type IUEFormatHeader, type IUEFormatLoaderOptions, type IUEModelBone, type IUEModelCollision, type IUEModelData, type IUEModelLOD, type IUEModelMaterial, type IUEModelMorphDelta, type IUEModelMorphTarget, type IUEModelNormal, type IUEModelSkeleton, type IUEModelSocket, type IUEModelSummary, type IUEModelTexCoord, type IUEModelVertexColor, type IUEModelVirtualBone, type IUEModelWeight, type IVector2, type IVector3, type UECoordinateSystem, UEFormatError, type UEFormatErrorCode, UEFormatLoader, type UEFormatThreeObject, type WindingRepair, type ZstdDecoder, createThreeGeometry, createThreeObject, parseUEModel, summarizeUEModel };