Skip to content

EntityBuilderCall

Represents a call to perform geometry ingestion with an entity builder

Call build in order to invoke the underlying function

Type Parameter Default type

BuildResult

‐

PostBuildResult

BuildResult

build(ref): Promise<PostBuildResult>

Invokes this builder, return the value produce by the onPostBuild.

If not onPostBuild is called, the value returned will be that of the original builder call

Parameter Type Description

ref

EntitiesContainer | EntitiesContainerRef

the entity container to invoke the builder on

Promise<PostBuildResult>


onPostBuild<T>(func): EntityBuilderCall<BuildResult, T>

When used this alters the return type of the build call to the type T

This action will return after the builder has been invoked, which allows the user to gain access to any faces or edges that were created as part of the entity builder for further modification

Type Parameter

T

Parameter Type Description

func

(converter, buildResult) => T | Promise<T>

the function to run after build but before commit

EntityBuilderCall<BuildResult, T>


withOptions(callOptions): EntityBuilderCall<BuildResult, PostBuildResult>

Alters the configuration options for the entity builder call

Parameter Type Description

callOptions

Partial<{ debug: boolean; }>

the partial new options

EntityBuilderCall<BuildResult, PostBuildResult>