API

Interface I3mfModel

Root model element.

Extensions:

  • requiredextensions: a space-separated list of prefixes (or namespaces depending on your serializer conventions) that are required to interpret the model.
  • recommendedextensions: extensions that improve fidelity but are not required.

Notes:

  • resources and build are typically present in a valid printable model.
  • metadata at the model level stores global information like title, author, etc.
interface I3mfModel {
    build?: I3mfBuild;
    metadata?: I3mfMetadata[];
    recommendedextensions?: string;
    requiredextensions?: string;
    resources?: I3mfResources;
    unit?: ST_Unit;
}

Implemented by

Index
build?: I3mfBuild

Optional build section (what to instantiate/print).

metadata?: I3mfMetadata[]

Optional model-level metadata entries.

recommendedextensions?: string

Declares extensions that may be used for better results.

requiredextensions?: string

Declares extensions that must be understood by consumers.

resources?: I3mfResources

Optional resources section (objects, materials, etc.).

unit?: ST_Unit

Unit used for all coordinates in the model.