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

    Options for LoadFileCommand: the model version to load and its project.

    All these values are given by the models endpoint of the twin API (id, currentVersion and projectId).

    interface LoadFileCommandOptions {
        axis?: Vector3;
        geometryType?: GeometryType;
        gltfObjectsPerRequest?: number;
        mgeomObjectsPerRequest?: number;
        modelId: number;
        onMeshLoaded?: MeshLoadedCallback;
        projectId: number;
        version: number;
    }

    Hierarchy (View Summary)

    Index

    Properties

    axis?: Vector3

    Normal of the projection plane of the 2D, for a project in FlatBuffers.

    geometryType?: GeometryType

    For a project in FlatBuffers (its models loaded as .mgeom): the geometry asked for, its 3D, or its 2D projected along axis. A glTF model gives its own.

    3D

    gltfObjectsPerRequest?: number

    Objects per glTF page asked for.

    1000
    
    mgeomObjectsPerRequest?: number

    Meshes per .mgeom page asked for, for a project in FlatBuffers.

    10000
    
    modelId: number

    Identifier of the model

    onMeshLoaded?: MeshLoadedCallback

    Called while each object loads: once made, before it is added to the scene, then at each geometry linked; e.g. to set its visibility, then its colour, its state from its first frame (see MeshLoadedCallback).

    projectId: number

    Identifier of the project holding the model

    version: number

    Number of the model version, as displayed in its versions history