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

    Options for LoadTwinCommand. A twin of a project in FlatBuffers is loaded whole, as .mgeom: the glTF options (filter, fieldSelectionRules, endpoint, gltfObjectsPerRequest) are then left out, and the twin's source has an empty filter.

    interface LoadTwinCommandOptions {
        axis?: Vector3;
        endpoint?: string;
        fieldSelectionRules?: TwinObjectProperty[];
        filter?: TeiaSearchFilter;
        geometryType?: TwinObjectGeometryType;
        gltfObjectsPerRequest?: number;
        mgeomObjectsPerRequest?: number;
        onlySetSource?: boolean;
        onMeshLoaded?: MeshLoadedCallback;
    }
    Index

    Properties

    axis?: Vector3

    Projection axis used when loading 2D or Original geometries. Backend defaults to Y (0, 1, 0) when omitted.

    endpoint?: string

    glTF only: twin api endpoint to get the geometry from.

    "objects"
    
    fieldSelectionRules?: TwinObjectProperty[]

    glTF only: the properties of the objects to load.

    glTF only: the objects to load.

    the twin's objects
    
    geometryType?: TwinObjectGeometryType

    The type of geometry to load.

    • 2D: load only the 2D projected geometry along axis
    • 3D: load only the 3D geometry
    • Original: load the original geometry (3D or original 2D along axis); for a twin in FlatBuffers, whose .mgeom has no original geometry, its 3D is asked

    Original in glTF, 3D in FlatBuffers

    gltfObjectsPerRequest?: number

    Objects per glTF page asked for.

    1000
    
    mgeomObjectsPerRequest?: number

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

    10000
    
    onlySetSource?: boolean

    Whether to only set the current viewer source without loading objects

    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).