Class BvlHelper

constructor

• new BvlHelper(
      objectStateManager: ObjectStateManager,
      viewer3d?: unknown,
  ): BvlHelper

  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

StaticiconRoot

applyDelta

• applyDelta(
      actions: object,
      options?: { resultColorOf?: ((qid: string) => string | null) | null },
  ): Promise<BvlUndo>

  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>

execute

• execute(versionUuids: string[], input: string | object): Promise<void>

  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>

processResults

• processResults(resolved: object[], options?: BvlProcessOptions): Promise<void>

  Shows resolved BVL actions; by default it first takes away the previous result (Viewer3d.resetResults)

  Parameters

  • resolved: object[]
  • Optionaloptions: BvlProcessOptions

  Returns Promise<void>

undoDelta

• undoDelta(undo: BvlUndo | null): Promise<void>

  Takes a pick away again: what applyDelta returned

  Parameters

  • undo: BvlUndo | null

  Returns Promise<void>