Skip to content

Shop Drawing Controller

add_wall_section_horizontal(element, position)

Adds a horizontal wall section

Parameters:

Name Type Description Default
element int

element

 required
position point_3d

position

 required

Returns:

Type Description
None

None
Source code in src/shop_drawing_controller/__init__.pyi 
113
114
115
116
117
118
119
120
121
122
def add_wall_section_horizontal(element: int, position: point_3d) -> None:
    """Adds a horizontal wall section

    Parameters:
        element: element
        position: position

    Returns:
        None
    """

add_wall_section_vertical(element, position)

Adds a vertical wall section

Parameters:

Name Type Description Default
element int

element

 required
position point_3d

position

 required

Returns:

Type Description
None

None
Source code in src/shop_drawing_controller/__init__.pyi 
124
125
126
127
128
129
130
131
132
133
def add_wall_section_vertical(element: int, position: point_3d) -> None:
    """Adds a vertical wall section

    Parameters:
        element: element
        position: position

    Returns:
        None
    """

assign_export_solid(ceo_element, element_id_list)

Assigns elements to an export solid

Parameters:

Name Type Description Default
ceo_element List[int]

ceo_element

 required
element_id_list List[int]

element_id_list

 required

Returns:

Type Description
None

None
Source code in src/shop_drawing_controller/__init__.pyi 
 91
 92
 93
 94
 95
 96
 97
 98
 99
100
def assign_export_solid(ceo_element: List[int], element_id_list: List[int]) -> None:
    """Assigns elements to an export solid

    Parameters:
        ceo_element: ceo_element
        element_id_list: element_id_list

    Returns:
        None
    """

clear_errors()

clear errors

Returns:

Type Description
None

None
Source code in src/shop_drawing_controller/__init__.pyi 
167
168
169
170
171
172
def clear_errors() -> None:
    """clear errors

    Returns:
        None
    """

export_2d_hidden_lines_with_2dc(file_path, with_layout)

Exports a 2D hidden lines to a 2DC file

Parameters:

Name Type Description Default
file_path str

file_path

 required
with_layout bool

with_layout

 required

Returns:

Type Description
None

None
Source code in src/shop_drawing_controller/__init__.pyi 
47
48
49
50
51
52
53
54
55
56
def export_2d_hidden_lines_with_2dc(file_path: str, with_layout: bool) -> None:
    """Exports a 2D hidden lines to a 2DC file

    Parameters:
        file_path: file_path
        with_layout: with_layout

    Returns:
        None
    """

export_2d_hidden_lines_with_clipboard(clipboard_number, with_layout)

Exports a 2D hidden lines to the clipboard

Parameters:

Name Type Description Default
clipboard_number int

clipboard_number

 required
with_layout bool

with_layout

 required

Returns:

Type Description
None

None
Source code in src/shop_drawing_controller/__init__.pyi 
25
26
27
28
29
30
31
32
33
34
def export_2d_hidden_lines_with_clipboard(clipboard_number: int, with_layout: bool) -> None:
    """Exports a 2D hidden lines to the clipboard

    Parameters:
        clipboard_number: clipboard_number
        with_layout: with_layout

    Returns:
        None
    """

export_2d_wireframe_with_2dc(file_path, with_layout)

Exports a 2D wireframe to a 2DC file

Parameters:

Name Type Description Default
file_path str

file_path

 required
with_layout bool

with_layout

 required

Returns:

Type Description
None

None
Source code in src/shop_drawing_controller/__init__.pyi 
36
37
38
39
40
41
42
43
44
45
def export_2d_wireframe_with_2dc(file_path: str, with_layout: bool) -> None:
    """Exports a 2D wireframe to a 2DC file

    Parameters:
        file_path: file_path
        with_layout: with_layout

    Returns:
        None
    """

export_2d_wireframe_with_clipboard(clipboard_number, with_layout)

Exports a 2D wireframe to the clipboard

Parameters:

Name Type Description Default
clipboard_number int

clipboard_number

 required
with_layout bool

with_layout

 required

Returns:

Type Description
None

None
Source code in src/shop_drawing_controller/__init__.pyi 
14
15
16
17
18
19
20
21
22
23
def export_2d_wireframe_with_clipboard(clipboard_number: int, with_layout: bool) -> None:
    """Exports a 2D wireframe to the clipboard

    Parameters:
        clipboard_number: clipboard_number
        with_layout: with_layout

    Returns:
        None
    """

export_container_with_clipboard(clipboard_number, elements)

Export a container to the clipboard

Parameters:

Name Type Description Default
clipboard_number int

clipboard_number

 required
elements List[int]

elements

 required

Returns:

Type Description
None

None
Source code in src/shop_drawing_controller/__init__.pyi 
102
103
104
105
106
107
108
109
110
111
def export_container_with_clipboard(clipboard_number: int, elements: List[int]) -> None:
    """Export a container to the clipboard

    Parameters:
        clipboard_number: clipboard_number
        elements: elements

    Returns:
        None
    """

export_export_solid_with_clipboard(clipboard_number, element_id_list)

Exports an export solid to the clipboard

Parameters:

Name Type Description Default
clipboard_number int

clipboard_number

 required
element_id_list List[int]

element_id_list

 required

Returns:

Type Description
None

None
Source code in src/shop_drawing_controller/__init__.pyi 
69
70
71
72
73
74
75
76
77
78
def export_export_solid_with_clipboard(clipboard_number: int, element_id_list: List[int]) -> None:
    """Exports an export solid to the clipboard

    Parameters:
        clipboard_number: clipboard_number
        element_id_list: element_id_list

    Returns:
        None
    """

export_piece_by_piece_with_clipboard(clipboard_number, element_id_list)

Exports a piece-by-piece to the clipboard

Parameters:

Name Type Description Default
clipboard_number int

clipboard_number

 required
element_id_list List[int]

element_id_list

 required

Returns:

Type Description
None

None
Source code in src/shop_drawing_controller/__init__.pyi 
80
81
82
83
84
85
86
87
88
89
def export_piece_by_piece_with_clipboard(clipboard_number: int, element_id_list: List[int]) -> None:
    """Exports a piece-by-piece to the clipboard

    Parameters:
        clipboard_number: clipboard_number
        element_id_list: element_id_list

    Returns:
        None
    """

export_wall_with_clipboard(clipboard_number, element_id_list)

Exports a wall to the clipboard

Parameters:

Name Type Description Default
clipboard_number int

clipboard_number

 required
element_id_list List[int]

element_id_list

 required

Returns:

Type Description
None

None
Source code in src/shop_drawing_controller/__init__.pyi 
58
59
60
61
62
63
64
65
66
67
def export_wall_with_clipboard(clipboard_number: int, element_id_list: List[int]) -> None:
    """Exports a wall to the clipboard

    Parameters:
        clipboard_number: clipboard_number
        element_id_list: element_id_list

    Returns:
        None
    """

export_wall_with_clipboard_and_presetting(clipboard_number, element_id_list, presetting_file)

Exports a wall to the clipboard

Parameters:

Name Type Description Default
clipboard_number int

clipboard_number

 required
element_id_list List[int]

element_id_list

 required
presetting_file str

presetting_file

 required

Returns:

Type Description
None

None
Source code in src/shop_drawing_controller/__init__.pyi 
135
136
137
138
139
140
141
142
143
144
145
def export_wall_with_clipboard_and_presetting(clipboard_number: int, element_id_list: List[int], presetting_file: str) -> None:
    """Exports a wall to the clipboard

    Parameters:
        clipboard_number: clipboard_number
        element_id_list: element_id_list
        presetting_file: presetting_file

    Returns:
        None
    """

get_last_error(error_code)

Gets the last error

Parameters:

Name Type Description Default
error_code int

error_code

 required

Returns:

Type Description
str

error string
Source code in src/shop_drawing_controller/__init__.pyi 
 4
 5
 6
 7
 8
 9
10
11
12
def get_last_error(error_code: int) -> str:
    """Gets the last error

    Parameters:
        error_code: error_code

    Returns:
        error string
    """

load_export_container_settings(settings_file_path)

Loads container export settings

Parameters:

Name Type Description Default
settings_file_path str

settings_file_path

 required

Returns:

Type Description
None

None
Source code in src/shop_drawing_controller/__init__.pyi 
194
195
196
197
198
199
200
201
202
def load_export_container_settings(settings_file_path: str) -> None:
    """Loads container export settings

    Parameters:
        settings_file_path: settings_file_path

    Returns:
        None
    """

load_export_piece_by_piece_settings(settings_file_path)

Loads piece by piece export settings

Parameters:

Name Type Description Default
settings_file_path str

settings_file_path

 required

Returns:

Type Description
None

None
Source code in src/shop_drawing_controller/__init__.pyi 
147
148
149
150
151
152
153
154
155
def load_export_piece_by_piece_settings(settings_file_path: str) -> None:
    """Loads piece by piece export settings

    Parameters:
        settings_file_path: settings_file_path

    Returns:
        None
    """

load_export_solid_settings(settings_file_path)

Loads export solid settings

Parameters:

Name Type Description Default
settings_file_path str

settings_file_path

 required

Returns:

Type Description
None

None
Source code in src/shop_drawing_controller/__init__.pyi 
184
185
186
187
188
189
190
191
192
def load_export_solid_settings(settings_file_path: str) -> None:
    """Loads export solid settings

    Parameters:
        settings_file_path: settings_file_path

    Returns:
        None
    """

load_export_wall_settings(settings_file_path)

Loads wall export settings

Parameters:

Name Type Description Default
settings_file_path str

settings_file_path

 required

Returns:

Type Description
None

None
Source code in src/shop_drawing_controller/__init__.pyi 
174
175
176
177
178
179
180
181
182
def load_export_wall_settings(settings_file_path: str) -> None:
    """Loads wall export settings

    Parameters:
        settings_file_path: settings_file_path

    Returns:
        None
    """

save_export_piece_by_piece_settings(settings_file_path)

Saves piece by piece export settings

Parameters:

Name Type Description Default
settings_file_path str

settings_file_path

 required

Returns:

Type Description
None

None
Source code in src/shop_drawing_controller/__init__.pyi 
157
158
159
160
161
162
163
164
165
def save_export_piece_by_piece_settings(settings_file_path: str) -> None:
    """Saves piece by piece export settings

    Parameters:
        settings_file_path: settings_file_path

    Returns:
        None
    """