BIM.works SDKs - v3.0.0-beta.168
    Preparing search index...

    Type Alias ViewFitOptions

    type ViewFitOptions = {
        animate?: boolean;
        animationTimeMs?: number;
        margin?: number;
        rotation?: ViewFitRotation;
        rotationObject?: Qid;
        target?: vec3;
        updatePivot?: boolean;
        viewDirection?: vec3;
    }
    Index

    Properties

    animate?: boolean

    Whether to animate, when omitted this will default to what has been defined on the Viewer

    animationTimeMs?: number

    The total animation time in milliseconds, only effective when animate is set to true

    margin?: number

    An optional margin (in percentage of total viewer size) to use as a buffer round the selected models. A perspective camera fits the bounding sphere of the objects, an orthographic one (fov 0) their bounding box as the screen sees it.

    rotation?: ViewFitRotation

    How the fit rotates a plan, default "KEEP": the Viewer2d's, and the Viewer3d's in a plan from the top or bottom

    rotationObject?: Qid

    The object whose oriented bounding box orients the plan for rotation "OBJECT_AXIS" (plans only)

    target?: vec3

    Optional target in 3D

    updatePivot?: boolean

    Whether the pivot should be updated to the center of the aabb of the given objects. Without it, the next orbit that starts on nothing pivots under the cursor, at the depth of the point the fit looks at (one that starts on an object pivots on that object's point under the cursor either way)

    viewDirection?: vec3

    Optional view direction in 3D