API Reference

All functions live in io_mesh_3mf.api. Import them directly:

from io_mesh_3mf.api import import_3mf, export_3mf, inspect_3mf

Version & Capabilities

API_VERSION = (1, 0, 0)
API_VERSION_STRING = ".".join(str(v) for v in API_VERSION)


API_CAPABILITIES = frozenset({
    "import",                 # import_3mf() available
    "export",                 # export_3mf() available
    "inspect",                # inspect_3mf() available
    "batch",                  # batch_import/batch_export available
    "callbacks",              # on_progress, on_warning, on_object_created
    "target_collection",      # import to specific collection
    "orca_format",            # Orca/BambuStudio export format
    "prusa_format",           # PrusaSlicer export format
    "paint_mode",             # MMU paint segmentation
    "project_template",       # Custom Orca project template
    "object_settings",        # Per-object Orca settings
    "building_blocks",        # colors, types, segmentation sub-namespaces
})

Result Dataclasses

ImportResult

ExportResult

InspectResult

import_3mf

def import_3mf(filepath: str,
    global_scale: float = 1.0,
    import_materials: str = 'MATERIALS',
    reuse_materials: bool = True,
    import_location: str = 'KEEP',
    origin_to_geometry: str = 'KEEP',
    grid_spacing: float = 0.1,
    auto_smooth: bool = False,
    auto_smooth_angle: float = 0.5236,
    paint_uv_method: str = 'SMART',
    paint_texture_size: int = 0,
    target_collection: str | None = None,
    on_progress: ProgressCallback | None = None,
    on_warning: WarningCallback | None = None,
    on_object_created: ObjectCreatedCallback | None = None,
) -> ImportResult

Import a 3MF file into the current Blender scene.

Returns: ImportResult — ImportResult with status, loaded count, and object list.

export_3mf

def export_3mf(filepath: str,
    objects = None,
    use_selection: bool = False,
    export_hidden: bool = False,
    skip_disabled: bool = True,
    global_scale: float = 1.0,
    use_mesh_modifiers: bool = True,
    coordinate_precision: int = 9,
    compression_level: int = 3,
    use_orca_format: str = 'AUTO',
    use_components: bool = True,
    mmu_slicer_format: str = 'ORCA',
    subdivision_depth: int = 7,
    thumbnail_mode: str = 'AUTO',
    thumbnail_resolution: int = 256,
    thumbnail_image: str = '',
    project_template: str | None = None,
    object_settings: Dict | None = None,
    on_progress: ProgressCallback | None = None,
    on_warning: WarningCallback | None = None,
) -> ExportResult

Export Blender objects to a 3MF file.

Returns: ExportResult — ExportResult with status, written count, and filepath.

inspect_3mf

def inspect_3mf(filepath: str,
) -> InspectResult

Inspect a 3MF file without importing anything into Blender.

Returns: InspectResult — InspectResult with archive metadata and statistics.

batch_import

def batch_import(filepaths: Sequence[str],
    on_progress: ProgressCallback | None = None,
    on_warning: WarningCallback | None = None,
    on_object_created: ObjectCreatedCallback | None = None,
    **import_kwargs,
) -> List[ImportResult]

Import multiple 3MF files in sequence with per-file error isolation.

Returns: List[ImportResult] — List of ImportResult, one per input file (same order).

batch_export

def batch_export(items: Sequence[Tuple[str, List]] | None,
    on_progress: ProgressCallback | None = None,
    on_warning: WarningCallback | None = None,
    **export_kwargs,
) -> List[ExportResult]

Export multiple 3MF files in sequence with per-file error isolation.

Returns: List[ExportResult] — List of ExportResult, one per item (same order).

Callback Types