I3mfObject | Babylon.js API documentation

API
API|
@babylonjs/serializers|
I3mfObject
Babylon.js API documentation
    Preparing search index...

    Interface I3mfObject

    Object resource. An object either contains a mesh (geometry) or components (composite object).

    Properties (pid/pindex):

    • pid references a property group (e.g. basematerials id).
    • pindex is an index within that group.
    • If pindex is used, pid is required.

    Metadata:

    • metadatagroup is optional and can store additional object-level metadata.
    interface I3mfObject {
        content?: I3mfMesh | I3mfComponents;
        id: number;
        metadatagroup?: I3mfMetadataGroup;
        name?: string;
        partnumber?: string;
        pid?: number;
        pindex?: number;
        thumbnail?: string;
        type?: ST_ObjectType;
    }

    Implemented by

    Index
    content? id metadatagroup? name? partnumber? pid? pindex? thumbnail? type?

    Optionalcontent

    content?: I3mfMesh | I3mfComponents

    Content of the object:

    • Mesh geometry OR
    • Components (composite object).
    In the 3MF XML schema, this corresponds to having either a element or a element.
    id: number

    Unique object id within the model.

    metadatagroup?: I3mfMetadataGroup

    Optional grouped metadata for the object.

    name?: string

    Optional human-readable name.

    partnumber?: string

    Optional part number (often used by manufacturing systems).

    pid?: number

    Property group reference. Example: ... then pid=5. Required if pindex is specified.

    pindex?: number

    Index inside the property group referenced by pid. Meaning depends on the property group type (base materials, color group, etc.).

    thumbnail?: string

    Optional thumbnail reference (usually a package path).

    type?: ST_ObjectType

    Optional object type hint.

    Settings
    Member Visibility

    On This Page
    Properties