Class ThreeMfModelBuilder

constructor

• new ThreeMfModelBuilder(): ThreeMfModelBuilder

  Returns ThreeMfModelBuilder

_model

_objects

StaticKnownMetaSet

build

• build(): ThreeMfModel

  Validates and returns the model that has been built.

  Returns ThreeMfModel

  The built 3MF model.

  Throws

  When the model has no object resource or no build item.

reset

• reset(): ThreeMfModelBuilder

  Discards the current model and starts building a new one.

  Returns ThreeMfModelBuilder

  This builder, to allow chaining.

withBuild

• withBuild(
      objectid: number,
      transform?: Matrix3d,
      partnumber?: string,
  ): ThreeMfModelBuilder

  Adds a build item, which places an object resource in the build plate.

  Parameters

  • objectid: number

    The resource id of the object to place.

  • Optionaltransform: Matrix3d

    The optional transform applied to the object.

  • Optionalpartnumber: string

    The optional part number identifying the produced part.

  Returns ThreeMfModelBuilder

  This builder, to allow chaining.

withComponents

• withComponents(
      components: I3mfObject | ThreeMfComponentsBuilder,
  ): ThreeMfModelBuilder

  Adds a components object to the model resources.

  Parameters

  • components: I3mfObject | ThreeMfComponentsBuilder

    The object resource, or a builder that produces one.

  Returns ThreeMfModelBuilder

  This builder, to allow chaining.

withMaterial

• withMaterial(
      material: I3mfBaseMaterials | ThreeMfMaterialBuilder,
  ): ThreeMfModelBuilder

  Adds a base materials group to the model resources.

  Parameters

  • material: I3mfBaseMaterials | ThreeMfMaterialBuilder

    The base materials resource, or a builder that produces one.

  Returns ThreeMfModelBuilder

  This builder, to allow chaining.

withMesh

• withMesh(object: I3mfObject | ThreeMfMeshBuilder): ThreeMfModelBuilder

  Adds a mesh object to the model resources.

  Parameters

  • object: I3mfObject | ThreeMfMeshBuilder

    The object resource, or a builder that produces one.

  Returns ThreeMfModelBuilder

  This builder, to allow chaining.

withMetaData

• withMetaData(
      name: string,
      value: string,
      preserve?: boolean,
      type?: string,
  ): ThreeMfModelBuilder

  Adds a metadata entry to the model.

  Parameters

  • name: string

    The metadata name. Names outside of the 3MF specification must be namespace qualified.

  • value: string

    The metadata value.

  • Optionalpreserve: boolean

    Whether consumers must preserve this entry when editing the document.

  • Optionaltype: string

    The XML schema type of the value. Defaults to xs:string.

  Returns ThreeMfModelBuilder

  This builder, to allow chaining.

withUnit

• withUnit(unit: ST_Unit): ThreeMfModelBuilder

  Sets the unit in which the model coordinates are expressed.

  Parameters

  • unit: ST_Unit

    The 3MF unit (micron, millimeter, centimeter, inch, foot or meter).

  Returns ThreeMfModelBuilder

  This builder, to allow chaining.