Function exportAssembly

cadquery/occ_impl/exporters/assembly.py:62–166

Export an assembly to a STEP file. kwargs is used to provide optional keyword arguments to configure the exporter. :param assy: assembly :param path: Path and filename for writing :param mode: STEP export mode. The options are "default", and "fused" (a single fused compound).

(
    assy: AssemblyProtocol,
    path: str,
    mode: STEPExportModeLiterals = "default",
    unit: UnitLiterals = "MM",
    outputUnit: Optional[UnitLiterals] = None,
    **kwargs,
)

def exportAssembly(
    assy: AssemblyProtocol,
    path: str,
    mode: STEPExportModeLiterals = "default",
    unit: UnitLiterals = "MM",
    outputUnit: Optional[UnitLiterals] = None,
    **kwargs,
) -> bool:
    """
    Export an assembly to a STEP file.

    kwargs is used to provide optional keyword arguments to configure the exporter.

    :param assy: assembly
    :param path: Path and filename for writing
    :param mode: STEP export mode. The options are "default", and "fused" (a single fused compound).
        It is possible that fused mode may exhibit low performance.
    :param unit: The internal unit of the model's geometry values. Default "MM".
    :type unit: UnitLiterals
    :param outputUnit: The unit to use in the STEP file header. If None, defaults to the value of ``unit``.
        Use this when you want the output file to declare a different unit than the model's internal unit,
        for example to export a MM model as a STEP file declaring meters.
    :type outputUnit: UnitLiterals or None
    :param fuzzy_tol: OCCT fuse operation tolerance setting used only for fused assembly export.
    :type fuzzy_tol: float
    :param glue: Enable gluing mode for improved performance during fused assembly export.
        This option should only be used for non-intersecting shapes or those that are only touching or partially overlapping.
        Note that when glue is enabled, the resulting fused shape may be invalid if shapes are intersecting in an incompatible way.
        Defaults to False.
    :type glue: bool
    :param write_pcurves: Enable or disable writing parametric curves to the STEP file. Default True.
        If False, writes STEP file without pcurves. This decreases the size of the resulting STEP file.
    :type write_pcurves: bool
    :param precision_mode: Controls the uncertainty value for STEP entities. Specify -1, 0, or 1. Default 0.
        See OCCT documentation.
    :type precision_mode: int
    :param name_geometries: Propagate subshape names to geometric STEP entities.
    :type name_geometries: bool
    """

    # Handle the extra settings for the STEP export
    pcurves = 1
    if "write_pcurves" in kwargs and not kwargs["write_pcurves"]:
        pcurves = 0
    precision_mode = kwargs["precision_mode"] if "precision_mode" in kwargs else 0
    fuzzy_tol = kwargs["fuzzy_tol"] if "fuzzy_tol" in kwargs else None
    glue = kwargs["glue"] if "glue" in kwargs else False
    name_geometries = kwargs.get("name_geometries", False)

    # Handle the doc differently based on which mode we are using
    if mode == "fused":
        _, doc = toFusedCAF(assy, glue, fuzzy_tol)
    else:  # Includes "default"
        _, doc = toCAF(assy, True,)

    session = XSControl_WorkSession()
    writer = STEPCAFControl_Writer(session, False)
    writer.SetColorMode(True)