Class RecipeExecutor

The RecipeExecutor can be used to visualize the results of BIM.works model checks in both the Viewer2d and Viewer3d. Anything the RecipeExecutor does, can also be done manually by using the methods provided by the ModelManager and ObjectStateManager.

Deprecated

Do not use for new development, this will be replaced by the new BIM.works Action Language

Index

Constructors

constructor

Methods

cleanupAux executeResults executeSingleResult processSingleResult reset

Constructors

constructor

new RecipeExecutor(
    viewer2d: unknown,
    viewer3d: unknown,
    objectStateManager: ObjectStateManager,
): RecipeExecutor
Create a new RecipeExecutor
Parameters
- viewer2d: unknown
  An optional Viewer2d, which will be used in to visualize results that can be visualized in 2D
- viewer3d: unknown
  An optional Viewer2d, which will be used in to visualize results that can be visualized in 3D
- objectStateManager: ObjectStateManager
  An ObjectStateManager
Returns RecipeExecutor
- Defined in ViewerCommon/viewercommon.d.ts:803

Methods

cleanupAux

cleanupAux(): void | Promise<void>
Returns void | Promise<void>
- Defined in ViewerCommon/viewercommon.d.ts:806

executeResults

executeResults(
    versionUuid: string,
    results: unknown,
    type: unknown,
    lastResults: unknown,
): void | Promise<void>
Parameters
- versionUuid: string
- results: unknown
- type: unknown
- lastResults: unknown
Returns void | Promise<void>
- Defined in ViewerCommon/viewercommon.d.ts:807

executeSingleResult

executeSingleResult(
    versionUuid: string,
    result: unknown,
    lastResults: unknown,
): void | Promise<void>
Parameters
- versionUuid: string
- result: unknown
- lastResults: unknown
Returns void | Promise<void>
- Defined in ViewerCommon/viewercommon.d.ts:808

processSingleResult

processSingleResult(
    versionUuid: string,
    result: unknown,
    output: unknown,
    type: unknown,
    lastResults: unknown,
): void | Promise<void>
Parameters
- versionUuid: string
- result: unknown
- output: unknown
- type: unknown
- lastResults: unknown
Returns void | Promise<void>
- Defined in ViewerCommon/viewercommon.d.ts:809

reset

reset(): void | Promise<void>
Returns void | Promise<void>
- Defined in ViewerCommon/viewercommon.d.ts:805

Class RecipeExecutor

Deprecated

Index

Constructors

Methods

Constructors

constructor

Parameters

Returns RecipeExecutor

Methods

cleanupAux

Returns void | Promise<void>

executeResults

Parameters

Returns void | Promise<void>

executeSingleResult

Parameters

Returns void | Promise<void>

processSingleResult

Parameters

Returns void | Promise<void>

reset

Returns void | Promise<void>

Settings

On This Page