Function exportStepMeta

cadquery/occ_impl/exporters/assembly.py:169–344

Export an assembly to a STEP file with faces tagged with names and colors. This is done as a separate method from the main STEP export because this is not compatible with the fused mode and also flattens the hierarchy of the STEP. Layers are used because some software does not unde

(
    assy: AssemblyProtocol,
    path: str,
    write_pcurves: bool = True,
    precision_mode: int = 0,
    unit: UnitLiterals = "MM",
    outputUnit: Optional[UnitLiterals] = None,
)

def exportStepMeta(
    assy: AssemblyProtocol,
    path: str,
    write_pcurves: bool = True,
    precision_mode: int = 0,
    unit: UnitLiterals = "MM",
    outputUnit: Optional[UnitLiterals] = None,
) -> bool:
    """
    Export an assembly to a STEP file with faces tagged with names and colors. This is done as a
    separate method from the main STEP export because this is not compatible with the fused mode
    and also flattens the hierarchy of the STEP.

    Layers are used because some software does not understand the ADVANCED_FACE entity and needs
    names attached to layers instead.

    :param assy: assembly
    :param path: Path and filename for writing
    :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.
    :param precision_mode: Controls the uncertainty value for STEP entities. Specify -1, 0, or 1. Default 0.
        See OCCT documentation.
    :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
    """

    pcurves = 1
    if not write_pcurves:
        pcurves = 0

    # Initialize the XCAF document that will allow the STEP export
    app = XCAFApp_Application.GetApplication_s()
    doc = TDocStd_Document(TCollection_ExtendedString("XmlOcaf"))
    app.InitDocument(doc)

    # Shape and color tools
    shape_tool = XCAFDoc_DocumentTool.ShapeTool_s(doc.Main())
    color_tool = XCAFDoc_DocumentTool.ColorTool_s(doc.Main())
    layer_tool = XCAFDoc_DocumentTool.LayerTool_s(doc.Main())

    def _process_child(child: AssemblyProtocol, assy_label: TDF_Label):
        """
        Process a child part which is not a subassembly.
        :param child: Child part to process (we should already have filtered out subassemblies)
        :param assy_label: The label for the assembly to add this part to
        :return: None
        """

        child_items = None

        # We combine these because the metadata could be stored at the parent or child level
        combined_names = {**assy._subshape_names, **child._subshape_names}
        combined_colors = {**assy._subshape_colors, **child._subshape_colors}
        combined_layers = {**assy._subshape_layers, **child._subshape_layers}