Documentation - v20.0.0-dev
    Preparing search index...

    One object to add to the MeshController: the engine's input format. Each source format (.mgeom, three.js...) is converted to InputMesh outside the engine. The controller copies what it needs: an InputMesh and its arrays can be reused once added. Its uuid, name, tag and parentUuid are the application's: the controller keeps none of them (an object is its index), they name the object in the errors and the MeshLoader's report, and reach the ObjectImportController.

    interface InputMesh {
        layer?: MeshLayer;
        name: string;
        parentUuid?: string;
        parts: InputMeshPart[];
        tag?: string;
        userData?: Record<string, unknown>;
        uuid: string;
    }
    Index

    Properties

    layer?: MeshLayer

    The layer the object is drawn in (see MeshLayer); default MeshLayer.Layer1.

    name: string

    Name of the object.

    parentUuid?: string

    The uuid of its parent's input in the file's hierarchy (e.g. a glTF node's parent node); absent at the top. A reader gives the parents before their children.

    parts: InputMeshPart[]

    E.g. one per material of an IFC element. At least one for MeshController.addMeshes; the MeshLoader gives an object without to its ObjectImportController only (onObjectRead).

    tag?: string

    A label of the application for the object, e.g. its representation (3D, 2D) when an object of the application has several, each an object of the controller. Plain text, sent from the reader's worker.

    userData?: Record<string, unknown>

    Data of the object in its file (e.g. a glTF node's extras), for the ObjectImportController: plain data (sent from the reader's worker), not kept by the controller.

    uuid: string

    Identifies the object for the application (e.g. its id in its file).