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

    The BVL runtime: shows resolved BVL actions (the server's ResolvedActions JSON, documented with the BVL language) in the viewers - colours, visibility, selection, labels, annotations, shapes, routes and check overlays (docs/ui-api-wp5/README.md §2.6)

    Index

    Constructors

    • Parameters

      • objectStateManager: ObjectStateManager
      • Optionalviewer3d: unknown

        a Viewer3d; without one only colours, visibility, selection and labels are applied (no shapes, routes, overlays or measurements)

      Returns BvlHelper

    Properties

    iconRoot: string

    Where the app's img/ folder is, for svg("glyphicons-…") icons: the page's own folder ("") by default

    Methods

    • Applies a pick's actions on top of what is shown: only colours (also COLOR RESULT), ON_TOP, SHOW of hidden objects and annotations, the ones that can be taken away again; returns how to

      Parameters

      • actions: object
      • Optionaloptions: { resultColorOf?: ((qid: string) => string | null) | null }

      Returns Promise<BvlUndo>

    • Resolves BVL input on the server (ResolveBvl) and shows the result; rejects when the server refuses it

      Parameters

      • versionUuids: string[]
      • input: string | object

      Returns Promise<void>

    • The objects resolved BVL actions are about, to fit the view to once processResults applied them: the VIEWFIT objects when the script names any; else those it shows, selects, puts on top, labels, annotates, gives a shape or a colour less than half transparent; else every object it colours. Never the ones it hides, and only those the viewer shows. Empty when there are none

      Parameters

      • resolved: object[]

      Returns QidSet

    • Shows resolved BVL actions; by default it first takes away the previous result (Viewer3d.resetResults). Resolves to the Transition once its state is in when it applies one (options.transition, or the script's TRANSITION header)

      Parameters

      Returns Promise<void | Transition>

    • Takes a pick away again: what applyDelta returned

      Parameters

      Returns Promise<void>