Skip to content

Shop Drawing Controller

2D shop and workshop drawing generation.

Covers the production of 2D drawings from the 3D model: wireframe and hidden-line views, layout-based and clipboard-based outputs, section and detail generation (wall sections and similar), and export-solid handling for shop-drawing workflows. The 2D-output counterpart to file_controller's neutral 3D exports.

add_wall_section_horizontal(element_id: ElementId, position: point_3d) -> None

Adds a horizontal wall section.

Parameters:

Name Type Description Default
element_id ElementId

The element id.

required
position point_3d

The section position.

required

add_wall_section_vertical(element_id: ElementId, position: point_3d) -> None

Adds a vertical wall section.

Parameters:

Name Type Description Default
element_id ElementId

The element id.

required
position point_3d

The section position.

required

assign_export_solid(ceo_element_id_list: list[ElementId], element_id_list: list[ElementId]) -> None

Assigns elements to an export solid.

Parameters:

Name Type Description Default
ceo_element_id_list list[ElementId]

The export solid to assign.

required
element_id_list list[ElementId]

The elements to assign.

required

clear_errors() -> None

Clears all errors.

export_2d_hidden_lines_with_2dc(file_path: str, with_layout: bool) -> None

Exports a 2D hidden lines to a 2DC file.

Parameters:

Name Type Description Default
file_path str

The export file path.

required
with_layout bool

Use layout, false by default.

required

export_2d_hidden_lines_with_clipboard(clipboard_number: UnsignedInt, with_layout: bool) -> None

Exports a 2D hidden lines to the clipboard.

Parameters:

Name Type Description Default
clipboard_number UnsignedInt

The clipboard number.

required
with_layout bool

Use layout, false by default.

required

export_2d_wireframe_with_2dc(file_path: str, with_layout: bool) -> None

Exports a 2D wireframe to a 2DC file.

Parameters:

Name Type Description Default
file_path str

The export file path.

required
with_layout bool

Use layout, false by default.

required

export_2d_wireframe_with_clipboard(clipboard_number: UnsignedInt, with_layout: bool) -> None

Exports a 2D wireframe to the clipboard.

Parameters:

Name Type Description Default
clipboard_number UnsignedInt

The clipboard number.

required
with_layout bool

Use layout, false by default.

required

export_container_with_clipboard(clipboard_number: UnsignedInt, element_id_list: list[ElementId]) -> None

Export a container to the clipboard.

Parameters:

Name Type Description Default
clipboard_number UnsignedInt

The clipboard number.

required
element_id_list list[ElementId]

The elements to export.

required

export_export_solid_with_clipboard(clipboard_number: UnsignedInt, element_id_list: list[ElementId]) -> None

Exports an export solid to the clipboard.

Parameters:

Name Type Description Default
clipboard_number UnsignedInt

The clipboard number.

required
element_id_list list[ElementId]

The elements to export.

required

export_piece_by_piece_with_clipboard(clipboard_number: UnsignedInt, element_id_list: list[ElementId]) -> None

Exports a piece-by-piece to the clipboard.

Parameters:

Name Type Description Default
clipboard_number UnsignedInt

The clipboard number.

required
element_id_list list[ElementId]

The elements to export.

required

export_wall_with_clipboard(clipboard_number: UnsignedInt, element_id_list: list[ElementId]) -> None

Exports a wall to the clipboard.

Parameters:

Name Type Description Default
clipboard_number UnsignedInt

The clipboard number.

required
element_id_list list[ElementId]

The elements to export.

required

export_wall_with_clipboard_and_presetting(clipboard_number: UnsignedInt, element_id_list: list[ElementId], presetting_file: str) -> None

Exports a wall to the clipboard.

Parameters:

Name Type Description Default
clipboard_number UnsignedInt

The clipboard number.

required
element_id_list list[ElementId]

The element id list to export.

required
presetting_file str

The presetting file path.

required

load_export_container_settings(settings_file_path: str) -> None

Loads container export settings.

Parameters:

Name Type Description Default
settings_file_path str

The settings file path.

required

load_export_piece_by_piece_settings(settings_file_path: str) -> None

Loads piece by piece export settings.

Parameters:

Name Type Description Default
settings_file_path str

The settings file path.

required

load_export_solid_settings(settings_file_path: str) -> None

Loads export solid settings.

Parameters:

Name Type Description Default
settings_file_path str

The settings file path.

required

load_export_wall_settings(settings_file_path: str) -> None

Loads wall export settings.

Parameters:

Name Type Description Default
settings_file_path str

The settings file path.

required

save_export_piece_by_piece_settings(settings_file_path: str) -> None

Saves piece by piece export settings.

Parameters:

Name Type Description Default
settings_file_path str

The settings file path.

required