Skip to content

Element Controller

activate_parts_without_situation()

activate parts without situation

Returns:

Type Description
List[int]

List[int]

Source code in src/element_controller/__init__.pyi
1054
1055
1056
1057
1058
1059
def activate_parts_without_situation() -> List[int]:
    """activate parts without situation

    Returns:
        List[int]
    """

activate_rv_without_situation()

activate rv without situation

Returns:

Type Description
List[int]

List[int]

Source code in src/element_controller/__init__.pyi
1047
1048
1049
1050
1051
1052
def activate_rv_without_situation() -> List[int]:
    """activate rv without situation

    Returns:
        List[int]
    """

add_created_elements_to_undo(elements)

add created elements to undo

Parameters:

Name Type Description Default
elements List[int]

elements

required

Returns:

Type Description
None

None

Source code in src/element_controller/__init__.pyi
501
502
503
504
505
506
507
508
509
def add_created_elements_to_undo(elements: List[int]) -> None:
    """add created elements to undo

    Parameters:
        elements: elements

    Returns:
        None
    """

add_element_to_detail(a0, a1)

add element to detail

Parameters:

Name Type Description Default
a0 List[int]

a0

required
a1 int

a1

required

Returns:

Type Description
None

None

Source code in src/element_controller/__init__.pyi
1133
1134
1135
1136
1137
1138
1139
1140
1141
1142
def add_element_to_detail(a0: List[int], a1: int) -> None:
    """add element to detail

    Parameters:
        a0: a0
        a1: a1

    Returns:
        None
    """

add_elements_to_detail(a0, a1)

add elements to detail

Parameters:

Name Type Description Default
a0 List[int]

a0

required
a1 int

a1

required

Returns:

Type Description
None

None

Source code in src/element_controller/__init__.pyi
1061
1062
1063
1064
1065
1066
1067
1068
1069
1070
def add_elements_to_detail(a0: List[int], a1: int) -> None:
    """add elements to detail

    Parameters:
        a0: a0
        a1: a1

    Returns:
        None
    """

add_elements_to_undo(elements, cmd)

add elements to undo

Parameters:

Name Type Description Default
elements List[int]

elements

required
cmd int

cmd

required

Returns:

Type Description
None

None

Source code in src/element_controller/__init__.pyi
382
383
384
385
386
387
388
389
390
391
def add_elements_to_undo(elements: List[int], cmd: int) -> None:
    """add elements to undo

    Parameters:
        elements: elements
        cmd: cmd

    Returns:
        None
    """

add_modified_elements_to_undo(elements)

add modified elements to undo

Parameters:

Name Type Description Default
elements List[int]

elements

required

Returns:

Type Description
None

None

Source code in src/element_controller/__init__.pyi
511
512
513
514
515
516
517
518
519
def add_modified_elements_to_undo(elements: List[int]) -> None:
    """add modified elements to undo

    Parameters:
        elements: elements

    Returns:
        None
    """

apply_transformation_coordinate(elements, old_point, old_xl, old_yl, new_point, new_xl, new_yl)

apply transformation coordinate

Parameters:

Name Type Description Default
elements List[int]

elements

required
old_point point_3d

old_point

required
old_xl point_3d

old_xl

required
old_yl point_3d

old_yl

required
new_point point_3d

new_point

required
new_xl point_3d

new_xl

required
new_yl point_3d

new_yl

required

Returns:

Type Description
None

None

Source code in src/element_controller/__init__.pyi
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
def apply_transformation_coordinate(elements: List[int], old_point: point_3d, old_xl: point_3d, old_yl: point_3d, new_point: point_3d, new_xl: point_3d, new_yl: point_3d) -> None:
    """apply transformation coordinate

    Parameters:
        elements: elements
        old_point: old_point
        old_xl: old_xl
        old_yl: old_yl
        new_point: new_point
        new_xl: new_xl
        new_yl: new_yl

    Returns:
        None
    """

auto_set_parts_situation(a0)

auto set parts situation

Parameters:

Name Type Description Default
a0 List[int]

a0

required

Returns:

Type Description
None

None

Source code in src/element_controller/__init__.pyi
1025
1026
1027
1028
1029
1030
1031
1032
1033
def auto_set_parts_situation(a0: List[int]) -> None:
    """auto set parts situation

    Parameters:
        a0: a0

    Returns:
        None
    """

auto_set_rough_volume_situation(a0)

auto set rough volume situation

Parameters:

Name Type Description Default
a0 List[int]

a0

required

Returns:

Type Description
None

None

Source code in src/element_controller/__init__.pyi
1003
1004
1005
1006
1007
1008
1009
1010
1011
def auto_set_rough_volume_situation(a0: List[int]) -> None:
    """auto set rough volume situation

    Parameters:
        a0: a0

    Returns:
        None
    """

chamfer_edge(a0, a1, a2, a3)

chamfer edge

Parameters:

Name Type Description Default
a0 int

a0

required
a1 point_3d

a1

required
a2 point_3d

a2

required
a3 float

a3

required

Returns:

Type Description
None

None

Source code in src/element_controller/__init__.pyi
1274
1275
1276
1277
1278
1279
1280
1281
1282
1283
1284
1285
def chamfer_edge(a0: int, a1: point_3d, a2: point_3d, a3: float) -> None:
    """chamfer edge

    Parameters:
        a0: a0
        a1: a1
        a2: a2
        a3: a3

    Returns:
        None
    """

check_element_duplicates(elements)

check element duplicates

Parameters:

Name Type Description Default
elements List[int]

elements

required

Returns:

Type Description
List[int]

List[int]

Source code in src/element_controller/__init__.pyi
1747
1748
1749
1750
1751
1752
1753
1754
1755
def check_element_duplicates(elements: List[int]) -> List[int]:
    """check element duplicates

    Parameters:
        elements: elements

    Returns:
        List[int]
    """

check_element_id(element_id)

check element id

Parameters:

Name Type Description Default
element_id int

element_id

required

Returns:

Type Description
bool

bool

Source code in src/element_controller/__init__.pyi
342
343
344
345
346
347
348
349
350
def check_element_id(element_id: int) -> bool:
    """check element id

    Parameters:
        element_id: element_id

    Returns:
        bool
    """

check_if_elements_are_in_collision(first_element_id, second_element_id)

check if elements are in collision

Parameters:

Name Type Description Default
first_element_id int

first_element_id

required
second_element_id int

second_element_id

required

Returns:

Type Description
bool

bool

Source code in src/element_controller/__init__.pyi
1609
1610
1611
1612
1613
1614
1615
1616
1617
1618
def check_if_elements_are_in_collision(first_element_id: int, second_element_id: int) -> bool:
    """check if elements are in collision

    Parameters:
        first_element_id: first_element_id
        second_element_id: second_element_id

    Returns:
        bool
    """

check_if_elements_are_in_contact(first_element_id, second_element_id)

check if elements are in contact

Parameters:

Name Type Description Default
first_element_id int

first_element_id

required
second_element_id int

second_element_id

required

Returns:

Type Description
bool

bool

Source code in src/element_controller/__init__.pyi
1620
1621
1622
1623
1624
1625
1626
1627
1628
1629
def check_if_elements_are_in_contact(first_element_id: int, second_element_id: int) -> bool:
    """check if elements are in contact

    Parameters:
        first_element_id: first_element_id
        second_element_id: second_element_id

    Returns:
        bool
    """

check_if_point_is_in_element(point, element_id)

check if point is in element

Parameters:

Name Type Description Default
point point_3d

point

required
element_id int

element_id

required

Returns:

Type Description
bool

bool

Source code in src/element_controller/__init__.pyi
1496
1497
1498
1499
1500
1501
1502
1503
1504
1505
def check_if_point_is_in_element(point: point_3d, element_id: int) -> bool:
    """check if point is in element

    Parameters:
        point: point
        element_id: element_id

    Returns:
        bool
    """

check_if_point_is_on_element(point, element_id)

check if point is on element

Parameters:

Name Type Description Default
point point_3d

point

required
element_id int

element_id

required

Returns:

Type Description
bool

bool

Source code in src/element_controller/__init__.pyi
1507
1508
1509
1510
1511
1512
1513
1514
1515
1516
def check_if_point_is_on_element(point: point_3d, element_id: int) -> bool:
    """check if point is on element

    Parameters:
        point: point
        element_id: element_id

    Returns:
        bool
    """

clear_errors()

clear errors

Returns:

Type Description
None

None

Source code in src/element_controller/__init__.pyi
558
559
560
561
562
563
def clear_errors() -> None:
    """clear errors

    Returns:
        None
    """

convert_auxiliary_to_beam(a0)

convert auxiliary to beam

Parameters:

Name Type Description Default
a0 List[int]

a0

required

Returns:

Type Description
None

None

Source code in src/element_controller/__init__.pyi
 993
 994
 995
 996
 997
 998
 999
1000
1001
def convert_auxiliary_to_beam(a0: List[int]) -> None:
    """convert auxiliary to beam

    Parameters:
        a0: a0

    Returns:
        None
    """

convert_auxiliary_to_panel(a0)

convert auxiliary to panel

Parameters:

Name Type Description Default
a0 List[int]

a0

required

Returns:

Type Description
None

None

Source code in src/element_controller/__init__.pyi
983
984
985
986
987
988
989
990
991
def convert_auxiliary_to_panel(a0: List[int]) -> None:
    """convert auxiliary to panel

    Parameters:
        a0: a0

    Returns:
        None
    """

convert_beam_to_panel(element_id_list)

convert beam to panel

Parameters:

Name Type Description Default
element_id_list List[int]

element_id_list

required

Returns:

Type Description
None

None

Source code in src/element_controller/__init__.pyi
229
230
231
232
233
234
235
236
237
def convert_beam_to_panel(element_id_list: List[int]) -> None:
    """convert beam to panel

    Parameters:
        element_id_list: element_id_list

    Returns:
        None
    """

convert_bolt_to_standardconnector(elements, standard_element_name)

convert bolt to standardconnector

Parameters:

Name Type Description Default
elements List[int]

elements

required
standard_element_name str

standard_element_name

required

Returns:

Type Description
None

None

Source code in src/element_controller/__init__.pyi
908
909
910
911
912
913
914
915
916
917
def convert_bolt_to_standardconnector(elements: List[int], standard_element_name: str) -> None:
    """convert bolt to standardconnector

    Parameters:
        elements: elements
        standard_element_name: standard_element_name

    Returns:
        None
    """

convert_circular_beam_to_drilling(elements)

converts circular/round beams into drillings

Parameters:

Name Type Description Default
elements List[int]

elements

required

Returns:

Type Description
None

None

Source code in src/element_controller/__init__.pyi
694
695
696
697
698
699
700
701
702
def convert_circular_beam_to_drilling(elements: List[int]) -> None:
    """converts circular/round beams into drillings

    Parameters:
        elements: elements

    Returns:
        None
    """

convert_container_to_container_block(elements)

convert container to container block

Parameters:

Name Type Description Default
elements List[int]

elements

required

Returns:

Type Description
None

None

Source code in src/element_controller/__init__.pyi
952
953
954
955
956
957
958
959
960
def convert_container_to_container_block(elements: List[int]) -> None:
    """convert container to container block

    Parameters:
        elements: elements

    Returns:
        None
    """

convert_drilling_to_circular_beam(elements)

convert drilling to circular beam

Parameters:

Name Type Description Default
elements List[int]

elements

required

Returns:

Type Description
None

None

Source code in src/element_controller/__init__.pyi
1287
1288
1289
1290
1291
1292
1293
1294
1295
def convert_drilling_to_circular_beam(elements: List[int]) -> None:
    """convert drilling to circular beam

    Parameters:
        elements: elements

    Returns:
        None
    """

convert_elements_to_auxiliary_elements(a0)

convert elements to auxiliary elements

Parameters:

Name Type Description Default
a0 List[int]

a0

required

Returns:

Type Description
None

None

Source code in src/element_controller/__init__.pyi
1144
1145
1146
1147
1148
1149
1150
1151
1152
def convert_elements_to_auxiliary_elements(a0: List[int]) -> None:
    """convert elements to auxiliary elements

    Parameters:
        a0: a0

    Returns:
        None
    """

convert_lines_to_surfaces(elements)

convert lines to surfaces

Parameters:

Name Type Description Default
elements List[int]

elements

required

Returns:

Type Description
List[int]

List[int]

Source code in src/element_controller/__init__.pyi
1297
1298
1299
1300
1301
1302
1303
1304
1305
def convert_lines_to_surfaces(elements: List[int]) -> List[int]:
    """convert lines to surfaces

    Parameters:
        elements: elements

    Returns:
        List[int]
    """

convert_panel_to_beam(element_id_list)

convert panel to beam

Parameters:

Name Type Description Default
element_id_list List[int]

element_id_list

required

Returns:

Type Description
None

None

Source code in src/element_controller/__init__.pyi
239
240
241
242
243
244
245
246
247
def convert_panel_to_beam(element_id_list: List[int]) -> None:
    """convert panel to beam

    Parameters:
        element_id_list: element_id_list

    Returns:
        None
    """

convert_surfaces_to_roof_surfaces(elements, roof_name)

converts surfaces to roof surfaces

Parameters:

Name Type Description Default
elements List[int]

elements

required
roof_name str

roof_name

required

Returns:

Type Description
None

None

Source code in src/element_controller/__init__.pyi
1780
1781
1782
1783
1784
1785
1786
1787
1788
1789
def convert_surfaces_to_roof_surfaces(elements: List[int], roof_name: str) -> None:
    """converts surfaces to roof surfaces

    Parameters:
        elements: elements
        roof_name: roof_name

    Returns:
        None
    """

convert_surfaces_to_volume(elements)

convert surfaces to volume

Parameters:

Name Type Description Default
elements List[int]

elements

required

Returns:

Type Description
int

int

Source code in src/element_controller/__init__.pyi
1307
1308
1309
1310
1311
1312
1313
1314
1315
def convert_surfaces_to_volume(elements: List[int]) -> int:
    """convert surfaces to volume

    Parameters:
        elements: elements

    Returns:
        int
    """

copy_elements(element_id_list, copy_vector)

copy elements

Parameters:

Name Type Description Default
element_id_list List[int]

element_id_list

required
copy_vector point_3d

copy_vector

required

Returns:

Type Description
List[int]

List[int]

Source code in src/element_controller/__init__.pyi
307
308
309
310
311
312
313
314
315
316
def copy_elements(element_id_list: List[int], copy_vector: point_3d) -> List[int]:
    """copy elements

    Parameters:
        element_id_list: element_id_list
        copy_vector: copy_vector

    Returns:
        List[int]
    """

create_auto_container_from_standard(elements, output_name, standard_element_name)

create auto container from standard

Parameters:

Name Type Description Default
elements List[int]

elements

required
output_name str

output_name

required
standard_element_name str

standard_element_name

required

Returns:

Type Description
int

int

Source code in src/element_controller/__init__.pyi
634
635
636
637
638
639
640
641
642
643
644
def create_auto_container_from_standard(elements: List[int], output_name: str, standard_element_name: str) -> int:
    """create auto container from standard

    Parameters:
        elements: elements
        output_name: output_name
        standard_element_name: standard_element_name

    Returns:
        int
    """

create_auto_container_from_standard_with_reference(elements, output_name, standard_element_name, reference_id)

create auto container from standard with reference

Parameters:

Name Type Description Default
elements List[int]

elements

required
output_name str

output_name

required
standard_element_name str

standard_element_name

required
reference_id int

reference_id

required

Returns:

Type Description
int

int

Source code in src/element_controller/__init__.pyi
659
660
661
662
663
664
665
666
667
668
669
670
def create_auto_container_from_standard_with_reference(elements: List[int], output_name: str, standard_element_name: str, reference_id: int) -> int:
    """create auto container from standard with reference

    Parameters:
        elements: elements
        output_name: output_name
        standard_element_name: standard_element_name
        reference_id: reference_id

    Returns:
        int
    """

create_auto_export_solid_from_standard(elements, output_name, standard_element_name)

create auto export solid from standard

Parameters:

Name Type Description Default
elements List[int]

elements

required
output_name str

output_name

required
standard_element_name str

standard_element_name

required

Returns:

Type Description
int

int

Source code in src/element_controller/__init__.pyi
437
438
439
440
441
442
443
444
445
446
447
def create_auto_export_solid_from_standard(elements: List[int], output_name: str, standard_element_name: str) -> int:
    """create auto export solid from standard

    Parameters:
        elements: elements
        output_name: output_name
        standard_element_name: standard_element_name

    Returns:
        int
    """

create_auto_export_solid_from_standard_with_reference(elements, output_name, standard_element_name, reference_id)

create auto export solid from standard with reference

Parameters:

Name Type Description Default
elements List[int]

elements

required
output_name str

output_name

required
standard_element_name str

standard_element_name

required
reference_id int

reference_id

required

Returns:

Type Description
int

int

Source code in src/element_controller/__init__.pyi
646
647
648
649
650
651
652
653
654
655
656
657
def create_auto_export_solid_from_standard_with_reference(elements: List[int], output_name: str, standard_element_name: str, reference_id: int) -> int:
    """create auto export solid from standard with reference

    Parameters:
        elements: elements
        output_name: output_name
        standard_element_name: standard_element_name
        reference_id: reference_id

    Returns:
        int
    """

create_bounding_box_global(a1)

create bounding box global

Parameters:

Name Type Description Default
a1 List[int]

a1

required

Returns:

Type Description
int

int

Source code in src/element_controller/__init__.pyi
973
974
975
976
977
978
979
980
981
def create_bounding_box_global(a1: List[int]) -> int:
    """create bounding box global

    Parameters:
        a1: a1

    Returns:
        int
    """

create_bounding_box_local(a0, a1)

create bounding box local

Parameters:

Name Type Description Default
a0 int

a0

required
a1 List[int]

a1

required

Returns:

Type Description
int

int

Source code in src/element_controller/__init__.pyi
962
963
964
965
966
967
968
969
970
971
def create_bounding_box_local(a0: int, a1: List[int]) -> int:
    """create bounding box local

    Parameters:
        a0: a0
        a1: a1

    Returns:
        int
    """

create_circular_axis_points(a0, a1, a2)

create circular axis points

Parameters:

Name Type Description Default
a0 float

a0

required
a1 point_3d

a1

required
a2 point_3d

a2

required

Returns:

Type Description
int

int

Source code in src/element_controller/__init__.pyi
1154
1155
1156
1157
1158
1159
1160
1161
1162
1163
1164
def create_circular_axis_points(a0: float, a1: point_3d, a2: point_3d) -> int:
    """create circular axis points

    Parameters:
        a0: a0
        a1: a1
        a2: a2

    Returns:
        int
    """

create_circular_axis_vector(a0, a1, a2, a3)

create circular axis vector

Parameters:

Name Type Description Default
a0 float

a0

required
a1 float

a1

required
a2 point_3d

a2

required
a3 point_3d

a3

required

Returns:

Type Description
int

int

Source code in src/element_controller/__init__.pyi
1166
1167
1168
1169
1170
1171
1172
1173
1174
1175
1176
1177
def create_circular_axis_vector(a0: float, a1: float, a2: point_3d, a3: point_3d) -> int:
    """create circular axis vector

    Parameters:
        a0: a0
        a1: a1
        a2: a2
        a3: a3

    Returns:
        int
    """

create_circular_beam_points(diameter, p1, p2, p3)

create circular beam points

Parameters:

Name Type Description Default
diameter float

diameter

required
p1 point_3d

p1

required
p2 point_3d

p2

required
p3 point_3d

p3

required

Returns:

Type Description
int

int

Source code in src/element_controller/__init__.pyi
63
64
65
66
67
68
69
70
71
72
73
74
def create_circular_beam_points(diameter: float, p1: point_3d, p2: point_3d, p3: point_3d) -> int:
    """create circular beam points

    Parameters:
        diameter: diameter
        p1: p1
        p2: p2
        p3: p3

    Returns:
        int
    """

create_circular_beam_vectors(diameter, length, p1, xl, zl)

create circular beam vectors

Parameters:

Name Type Description Default
diameter float

diameter

required
length float

length

required
p1 point_3d

p1

required
xl point_3d

xl

required
zl point_3d

zl

required

Returns:

Type Description
int

int

Source code in src/element_controller/__init__.pyi
104
105
106
107
108
109
110
111
112
113
114
115
116
def create_circular_beam_vectors(diameter: float, length: float, p1: point_3d, xl: point_3d, zl: point_3d) -> int:
    """create circular beam vectors

    Parameters:
        diameter: diameter
        length: length
        p1: p1
        xl: xl
        zl: zl

    Returns:
        int
    """

create_circular_mep(diameter, points)

create circular mep

Parameters:

Name Type Description Default
diameter float

diameter

required
points List[point_3d]

points

required

Returns:

Type Description
int

int

Source code in src/element_controller/__init__.pyi
599
600
601
602
603
604
605
606
607
608
def create_circular_mep(diameter: float, points: List[point_3d]) -> int:
    """create circular mep

    Parameters:
        diameter: diameter
        points: points

    Returns:
        int
    """

create_drilling_points(diameter, p1, p2)

create drilling points

Parameters:

Name Type Description Default
diameter float

diameter

required
p1 point_3d

p1

required
p2 point_3d

p2

required

Returns:

Type Description
int

int

Source code in src/element_controller/__init__.pyi
161
162
163
164
165
166
167
168
169
170
171
def create_drilling_points(diameter: float, p1: point_3d, p2: point_3d) -> int:
    """create drilling points

    Parameters:
        diameter: diameter
        p1: p1
        p2: p2

    Returns:
        int
    """

create_drilling_vectors(diameter, length, p1, xl)

create drilling vectors

Parameters:

Name Type Description Default
diameter float

diameter

required
length float

length

required
p1 point_3d

p1

required
xl point_3d

xl

required

Returns:

Type Description
int

int

Source code in src/element_controller/__init__.pyi
173
174
175
176
177
178
179
180
181
182
183
184
def create_drilling_vectors(diameter: float, length: float, p1: point_3d, xl: point_3d) -> int:
    """create drilling vectors

    Parameters:
        diameter: diameter
        length: length
        p1: p1
        xl: xl

    Returns:
        int
    """

create_line_points(p1, p2)

create line points

Parameters:

Name Type Description Default
p1 point_3d

p1

required
p2 point_3d

p2

required

Returns:

Type Description
int

int

Source code in src/element_controller/__init__.pyi
186
187
188
189
190
191
192
193
194
195
def create_line_points(p1: point_3d, p2: point_3d) -> int:
    """create line points

    Parameters:
        p1: p1
        p2: p2

    Returns:
        int
    """

create_line_vectors(length, p1, xl)

create line vectors

Parameters:

Name Type Description Default
length float

length

required
p1 point_3d

p1

required
xl point_3d

xl

required

Returns:

Type Description
int

int

Source code in src/element_controller/__init__.pyi
197
198
199
200
201
202
203
204
205
206
207
def create_line_vectors(length: float, p1: point_3d, xl: point_3d) -> int:
    """create line vectors

    Parameters:
        length: length
        p1: p1
        xl: xl

    Returns:
        int
    """

create_linear_optimization(elements, optimization_number, total_length, start_cut, end_cut, saw_kerf, is_production_list)

create linear optimization

Parameters:

Name Type Description Default
elements List[int]

elements

required
optimization_number int

optimization_number

required
total_length float

total_length

required
start_cut float

start_cut

required
end_cut float

end_cut

required
saw_kerf float

saw_kerf

required
is_production_list bool

is_production_list

required

Returns:

Type Description
int

int

Source code in src/element_controller/__init__.pyi
1084
1085
1086
1087
1088
1089
1090
1091
1092
1093
1094
1095
1096
1097
1098
def create_linear_optimization(elements: List[int], optimization_number: int, total_length: float, start_cut: float, end_cut: float, saw_kerf: float, is_production_list: bool) -> int:
    """create linear optimization

    Parameters:
        elements: elements
        optimization_number: optimization_number
        total_length: total_length
        start_cut: start_cut
        end_cut: end_cut
        saw_kerf: saw_kerf
        is_production_list: is_production_list

    Returns:
        int
    """

create_multi_wall(elements)

create multi wall

Parameters:

Name Type Description Default
elements List[int]

elements

required

Returns:

Type Description
None

None

Source code in src/element_controller/__init__.pyi
531
532
533
534
535
536
537
538
539
def create_multi_wall(elements: List[int]) -> None:
    """create multi wall

    Parameters:
        elements: elements

    Returns:
        None
    """

create_node(p1)

create node

Parameters:

Name Type Description Default
p1 point_3d

p1

required

Returns:

Type Description
int

int

Source code in src/element_controller/__init__.pyi
209
210
211
212
213
214
215
216
217
def create_node(p1: point_3d) -> int:
    """create node

    Parameters:
        p1: p1

    Returns:
        int
    """

create_normal_axis_points(p1, p2)

create normal axis points

Parameters:

Name Type Description Default
p1 point_3d

p1

required
p2 point_3d

p2

required

Returns:

Type Description
int

int

Source code in src/element_controller/__init__.pyi
885
886
887
888
889
890
891
892
893
894
def create_normal_axis_points(p1: point_3d, p2: point_3d) -> int:
    """create normal axis points

    Parameters:
        p1: p1
        p2: p2

    Returns:
        int
    """

create_normal_axis_vectors(length, p1, xl)

create normal axis vectors

Parameters:

Name Type Description Default
length float

length

required
p1 point_3d

p1

required
xl point_3d

xl

required

Returns:

Type Description
int

int

Source code in src/element_controller/__init__.pyi
896
897
898
899
900
901
902
903
904
905
906
def create_normal_axis_vectors(length: float, p1: point_3d, xl: point_3d) -> int:
    """create normal axis vectors

    Parameters:
        length: length
        p1: p1
        xl: xl

    Returns:
        int
    """

create_polygon_beam(polygon_vertices, thickness, xl, zl)

create polygon beam

Parameters:

Name Type Description Default
polygon_vertices List[point_3d]

polygon_vertices

required
thickness float

thickness

required
xl point_3d

xl

required
zl point_3d

zl

required

Returns:

Type Description
int

int

Source code in src/element_controller/__init__.pyi
280
281
282
283
284
285
286
287
288
289
290
291
def create_polygon_beam(polygon_vertices: List[point_3d], thickness: float, xl: point_3d, zl: point_3d) -> int:
    """create polygon beam

    Parameters:
        polygon_vertices: polygon_vertices
        thickness: thickness
        xl: xl
        zl: zl

    Returns:
        int
    """

create_polygon_panel(polygon_vertices, thickness, xl, zl)

create polygon panel

Parameters:

Name Type Description Default
polygon_vertices List[point_3d]

polygon_vertices

required
thickness float

thickness

required
xl point_3d

xl

required
zl point_3d

zl

required

Returns:

Type Description
int

int

Source code in src/element_controller/__init__.pyi
1179
1180
1181
1182
1183
1184
1185
1186
1187
1188
1189
1190
def create_polygon_panel(polygon_vertices: List[point_3d], thickness: float, xl: point_3d, zl: point_3d) -> int:
    """create polygon panel

    Parameters:
        polygon_vertices: polygon_vertices
        thickness: thickness
        xl: xl
        zl: zl

    Returns:
        int
    """

create_rectangular_beam_points(width, height, p1, p2, p3)

create rectangular beam points

Parameters:

Name Type Description Default
width float

width

required
height float

height

required
p1 point_3d

p1

required
p2 point_3d

p2

required
p3 point_3d

p3

required

Returns:

Type Description
int

int

Source code in src/element_controller/__init__.pyi
49
50
51
52
53
54
55
56
57
58
59
60
61
def create_rectangular_beam_points(width: float, height: float, p1: point_3d, p2: point_3d, p3: point_3d) -> int:
    """create rectangular beam points

    Parameters:
        width: width
        height: height
        p1: p1
        p2: p2
        p3: p3

    Returns:
        int
    """

create_rectangular_beam_vectors(width, height, length, p1, xl, zl)

create rectangular beam vectors

Parameters:

Name Type Description Default
width float

width

required
height float

height

required
length float

length

required
p1 point_3d

p1

required
xl point_3d

xl

required
zl point_3d

zl

required

Returns:

Type Description
int

int

Source code in src/element_controller/__init__.pyi
 89
 90
 91
 92
 93
 94
 95
 96
 97
 98
 99
100
101
102
def create_rectangular_beam_vectors(width: float, height: float, length: float, p1: point_3d, xl: point_3d, zl: point_3d) -> int:
    """create rectangular beam vectors

    Parameters:
        width: width
        height: height
        length: length
        p1: p1
        xl: xl
        zl: zl

    Returns:
        int
    """

create_rectangular_mep(width, depth, points)

create rectangular mep

Parameters:

Name Type Description Default
width float

width

required
depth float

depth

required
points List[point_3d]

points

required

Returns:

Type Description
int

int

Source code in src/element_controller/__init__.pyi
610
611
612
613
614
615
616
617
618
619
620
def create_rectangular_mep(width: float, depth: float, points: List[point_3d]) -> int:
    """create rectangular mep

    Parameters:
        width: width
        depth: depth
        points: points

    Returns:
        int
    """

create_rectangular_panel_points(width, thickness, p1, p2, p3)

create rectangular panel points

Parameters:

Name Type Description Default
width float

width

required
thickness float

thickness

required
p1 point_3d

p1

required
p2 point_3d

p2

required
p3 point_3d

p3

required

Returns:

Type Description
int

int

Source code in src/element_controller/__init__.pyi
132
133
134
135
136
137
138
139
140
141
142
143
144
def create_rectangular_panel_points(width: float, thickness: float, p1: point_3d, p2: point_3d, p3: point_3d) -> int:
    """create rectangular panel points

    Parameters:
        width: width
        thickness: thickness
        p1: p1
        p2: p2
        p3: p3

    Returns:
        int
    """

create_rectangular_panel_vectors(width, thickness, length, p1, xl, zl)

create rectangular panel vectors

Parameters:

Name Type Description Default
width float

width

required
thickness float

thickness

required
length float

length

required
p1 point_3d

p1

required
xl point_3d

xl

required
zl point_3d

zl

required

Returns:

Type Description
int

int

Source code in src/element_controller/__init__.pyi
146
147
148
149
150
151
152
153
154
155
156
157
158
159
def create_rectangular_panel_vectors(width: float, thickness: float, length: float, p1: point_3d, xl: point_3d, zl: point_3d) -> int:
    """create rectangular panel vectors

    Parameters:
        width: width
        thickness: thickness
        length: length
        p1: p1
        xl: xl
        zl: zl

    Returns:
        int
    """

create_spline_line(spline_points)

create spline line

Parameters:

Name Type Description Default
spline_points None

spline_points

required

Returns:

Type Description
int

int

Source code in src/element_controller/__init__.pyi
1956
1957
1958
1959
1960
1961
1962
1963
1964
def create_spline_line(spline_points: None) -> int:
    """create spline line

    Parameters:
        spline_points: spline_points

    Returns:
        int
    """

create_square_beam_points(width, p1, p2, p3)

create square beam points

Parameters:

Name Type Description Default
width float

width

required
p1 point_3d

p1

required
p2 point_3d

p2

required
p3 point_3d

p3

required

Returns:

Type Description
int

int

Source code in src/element_controller/__init__.pyi
76
77
78
79
80
81
82
83
84
85
86
87
def create_square_beam_points(width: float, p1: point_3d, p2: point_3d, p3: point_3d) -> int:
    """create square beam points

    Parameters:
        width: width
        p1: p1
        p2: p2
        p3: p3

    Returns:
        int
    """

create_square_beam_vectors(width, length, p1, xl, zl)

create square beam vectors

Parameters:

Name Type Description Default
width float

width

required
length float

length

required
p1 point_3d

p1

required
xl point_3d

xl

required
zl point_3d

zl

required

Returns:

Type Description
int

int

Source code in src/element_controller/__init__.pyi
118
119
120
121
122
123
124
125
126
127
128
129
130
def create_square_beam_vectors(width: float, length: float, p1: point_3d, xl: point_3d, zl: point_3d) -> int:
    """create square beam vectors

    Parameters:
        width: width
        length: length
        p1: p1
        xl: xl
        zl: zl

    Returns:
        int
    """

create_standard_beam_points(standard_element_name, p1, p2, p3)

create standard beam points

Parameters:

Name Type Description Default
standard_element_name str

standard_element_name

required
p1 point_3d

p1

required
p2 point_3d

p2

required
p3 point_3d

p3

required

Returns:

Type Description
int

int

Source code in src/element_controller/__init__.pyi
793
794
795
796
797
798
799
800
801
802
803
804
def create_standard_beam_points(standard_element_name: str, p1: point_3d, p2: point_3d, p3: point_3d) -> int:
    """create standard beam points

    Parameters:
        standard_element_name: standard_element_name
        p1: p1
        p2: p2
        p3: p3

    Returns:
        int
    """

create_standard_beam_vectors(standard_element_name, length, p1, xl, zl)

create standard beam vectors

Parameters:

Name Type Description Default
standard_element_name str

standard_element_name

required
length float

length

required
p1 point_3d

p1

required
xl point_3d

xl

required
zl point_3d

zl

required

Returns:

Type Description
int

int

Source code in src/element_controller/__init__.pyi
806
807
808
809
810
811
812
813
814
815
816
817
818
def create_standard_beam_vectors(standard_element_name: str, length: float, p1: point_3d, xl: point_3d, zl: point_3d) -> int:
    """create standard beam vectors

    Parameters:
        standard_element_name: standard_element_name
        length: length
        p1: p1
        xl: xl
        zl: zl

    Returns:
        int
    """

create_standard_element_from_guid_points(a0, a1, a2, a3)

create standard element from guid points

Parameters:

Name Type Description Default
a0 str

a0

required
a1 point_3d

a1

required
a2 point_3d

a2

required
a3 point_3d

a3

required

Returns:

Type Description
int

int

Source code in src/element_controller/__init__.pyi
1234
1235
1236
1237
1238
1239
1240
1241
1242
1243
1244
1245
def create_standard_element_from_guid_points(a0: str, a1: point_3d, a2: point_3d, a3: point_3d) -> int:
    """create standard element from guid points

    Parameters:
        a0: a0
        a1: a1
        a2: a2
        a3: a3

    Returns:
        int
    """

create_standard_element_from_guid_vectors(a0, a1, a2, a3, a4)

create standard element from guid vectors

Parameters:

Name Type Description Default
a0 str

a0

required
a1 float

a1

required
a2 point_3d

a2

required
a3 point_3d

a3

required
a4 point_3d

a4

required

Returns:

Type Description
int

int

Source code in src/element_controller/__init__.pyi
1247
1248
1249
1250
1251
1252
1253
1254
1255
1256
1257
1258
1259
def create_standard_element_from_guid_vectors(a0: str, a1: float, a2: point_3d, a3: point_3d, a4: point_3d) -> int:
    """create standard element from guid vectors

    Parameters:
        a0: a0
        a1: a1
        a2: a2
        a3: a3
        a4: a4

    Returns:
        int
    """

create_standard_panel_points(standard_element_name, p1, p2, p3)

create standard panel points

Parameters:

Name Type Description Default
standard_element_name str

standard_element_name

required
p1 point_3d

p1

required
p2 point_3d

p2

required
p3 point_3d

p3

required

Returns:

Type Description
int

int

Source code in src/element_controller/__init__.pyi
820
821
822
823
824
825
826
827
828
829
830
831
def create_standard_panel_points(standard_element_name: str, p1: point_3d, p2: point_3d, p3: point_3d) -> int:
    """create standard panel points

    Parameters:
        standard_element_name: standard_element_name
        p1: p1
        p2: p2
        p3: p3

    Returns:
        int
    """

create_standard_panel_vectors(standard_element_name, length, p1, xl, zl)

create standard panel vectors

Parameters:

Name Type Description Default
standard_element_name str

standard_element_name

required
length float

length

required
p1 point_3d

p1

required
xl point_3d

xl

required
zl point_3d

zl

required

Returns:

Type Description
int

int

Source code in src/element_controller/__init__.pyi
833
834
835
836
837
838
839
840
841
842
843
844
845
def create_standard_panel_vectors(standard_element_name: str, length: float, p1: point_3d, xl: point_3d, zl: point_3d) -> int:
    """create standard panel vectors

    Parameters:
        standard_element_name: standard_element_name
        length: length
        p1: p1
        xl: xl
        zl: zl

    Returns:
        int
    """

create_standard_steel_points(standard_element_name, p1, p2, p3)

create standard steel points

Parameters:

Name Type Description Default
standard_element_name str

standard_element_name

required
p1 point_3d

p1

required
p2 point_3d

p2

required
p3 point_3d

p3

required

Returns:

Type Description
int

int

Source code in src/element_controller/__init__.pyi
847
848
849
850
851
852
853
854
855
856
857
858
def create_standard_steel_points(standard_element_name: str, p1: point_3d, p2: point_3d, p3: point_3d) -> int:
    """create standard steel points

    Parameters:
        standard_element_name: standard_element_name
        p1: p1
        p2: p2
        p3: p3

    Returns:
        int
    """

create_standard_steel_vectors(standard_element_name, length, p1, xl, zl)

create standard steel vectors

Parameters:

Name Type Description Default
standard_element_name str

standard_element_name

required
length float

length

required
p1 point_3d

p1

required
xl point_3d

xl

required
zl point_3d

zl

required

Returns:

Type Description
int

int

Source code in src/element_controller/__init__.pyi
860
861
862
863
864
865
866
867
868
869
870
871
872
def create_standard_steel_vectors(standard_element_name: str, length: float, p1: point_3d, xl: point_3d, zl: point_3d) -> int:
    """create standard steel vectors

    Parameters:
        standard_element_name: standard_element_name
        length: length
        p1: p1
        xl: xl
        zl: zl

    Returns:
        int
    """

create_surface(surface_vertices)

create surface

Parameters:

Name Type Description Default
surface_vertices List[point_3d]

surface_vertices

required

Returns:

Type Description
int

int

Source code in src/element_controller/__init__.pyi
684
685
686
687
688
689
690
691
692
def create_surface(surface_vertices: List[point_3d]) -> int:
    """create surface

    Parameters:
        surface_vertices: surface_vertices

    Returns:
        int
    """

create_text_object(text, position, xl, zl, size)

create text object

Parameters:

Name Type Description Default
text str

text

required
position point_3d

position

required
xl point_3d

xl

required
zl point_3d

zl

required
size float

size

required

Returns:

Type Description
int

int

Source code in src/element_controller/__init__.pyi
293
294
295
296
297
298
299
300
301
302
303
304
305
def create_text_object(text: str, position: point_3d, xl: point_3d, zl: point_3d, size: float) -> int:
    """create text object

    Parameters:
        text: text
        position: position
        xl: xl
        zl: zl
        size: size

    Returns:
        int
    """

create_text_object_with_font(text, position, xl, zl, size, font_name)

create text object with font

Parameters:

Name Type Description Default
text str

text

required
position point_3d

position

required
xl point_3d

xl

required
zl point_3d

zl

required
size float

size

required
font_name str

font_name

required

Returns:

Type Description
int

int

Source code in src/element_controller/__init__.pyi
460
461
462
463
464
465
466
467
468
469
470
471
472
473
def create_text_object_with_font(text: str, position: point_3d, xl: point_3d, zl: point_3d, size: float, font_name: str) -> int:
    """create text object with font

    Parameters:
        text: text
        position: position
        xl: xl
        zl: zl
        size: size
        font_name: font_name

    Returns:
        int
    """

create_text_object_with_options(position, xl, zl, text_options)

create text object with options

Parameters:

Name Type Description Default
position point_3d

position

required
xl point_3d

xl

required
zl point_3d

zl

required
text_options text_object_options

text_options

required

Returns:

Type Description
int

int

Source code in src/element_controller/__init__.pyi
1767
1768
1769
1770
1771
1772
1773
1774
1775
1776
1777
1778
def create_text_object_with_options(position: point_3d, xl: point_3d, zl: point_3d, text_options: text_object_options) -> int:
    """create text object with options

    Parameters:
        position: position
        xl: xl
        zl: zl
        text_options: text_options

    Returns:
        int
    """

create_truncated_cone_beam_points(start_diameter, end_diameter, p1, p2, p3)

create truncated cone beam points

Parameters:

Name Type Description Default
start_diameter float

start_diameter

required
end_diameter float

end_diameter

required
p1 point_3d

p1

required
p2 point_3d

p2

required
p3 point_3d

p3

required

Returns:

Type Description
int

int

Source code in src/element_controller/__init__.pyi
1927
1928
1929
1930
1931
1932
1933
1934
1935
1936
1937
1938
1939
def create_truncated_cone_beam_points(start_diameter: float, end_diameter: float, p1: point_3d, p2: point_3d, p3: point_3d) -> int:
    """create truncated cone beam points

    Parameters:
        start_diameter: start_diameter
        end_diameter: end_diameter
        p1: p1
        p2: p2
        p3: p3

    Returns:
        int
    """

create_truncated_cone_beam_vectors(start_diameter, end_diameter, length, p1, xl, zl)

create truncated cone beam vectors

Parameters:

Name Type Description Default
start_diameter float

start_diameter

required
end_diameter float

end_diameter

required
length float

length

required
p1 point_3d

p1

required
xl point_3d

xl

required
zl point_3d

zl

required

Returns:

Type Description
int

int

Source code in src/element_controller/__init__.pyi
1941
1942
1943
1944
1945
1946
1947
1948
1949
1950
1951
1952
1953
1954
def create_truncated_cone_beam_vectors(start_diameter: float, end_diameter: float, length: float, p1: point_3d, xl: point_3d, zl: point_3d) -> int:
    """create truncated cone beam vectors

    Parameters:
        start_diameter: start_diameter
        end_diameter: end_diameter
        length: length
        p1: p1
        xl: xl
        zl: zl

    Returns:
        int
    """

cut_beam_end_profile(elements, profile_name, on_start_face, on_end_face)

cut beam end profile

Parameters:

Name Type Description Default
elements List[int]

elements

required
profile_name str

profile_name

required
on_start_face bool

on_start_face

required
on_end_face bool

on_end_face

required

Returns:

Type Description
None

None

Source code in src/element_controller/__init__.pyi
1914
1915
1916
1917
1918
1919
1920
1921
1922
1923
1924
1925
def cut_beam_end_profile(elements: List[int], profile_name: str, on_start_face: bool, on_end_face: bool) -> None:
    """cut beam end profile

    Parameters:
        elements: elements
        profile_name: profile_name
        on_start_face: on_start_face
        on_end_face: on_end_face

    Returns:
        None
    """

cut_corner_lap(elements, depth, clearance_base, clearance_side, backcut, drilling_count, drilling_diameter, drilling_tolerance)

cuts a corner-lap with specific parameters

Parameters:

Name Type Description Default
elements List[int]

elements

required
depth float

depth

required
clearance_base float

clearance_base

required
clearance_side float

clearance_side

required
backcut float

backcut

required
drilling_count int

drilling_count

required
drilling_diameter float

drilling_diameter

required
drilling_tolerance float

drilling_tolerance

required

Returns:

Type Description
None

None

Source code in src/element_controller/__init__.pyi
1317
1318
1319
1320
1321
1322
1323
1324
1325
1326
1327
1328
1329
1330
1331
1332
def cut_corner_lap(elements: List[int], depth: float, clearance_base: float, clearance_side: float, backcut: float, drilling_count: int, drilling_diameter: float, drilling_tolerance: float) -> None:
    """cuts a corner-lap with specific parameters

    Parameters:
        elements: elements
        depth: depth
        clearance_base: clearance_base
        clearance_side: clearance_side
        backcut: backcut
        drilling_count: drilling_count
        drilling_diameter: drilling_diameter
        drilling_tolerance: drilling_tolerance

    Returns:
        None
    """

cut_cross_lap(elements, depth, clearance_base, clearance_side, drilling_count, drilling_diameter, drilling_tolerance)

cuts a cross-lap with specific parameters

Parameters:

Name Type Description Default
elements List[int]

elements

required
depth float

depth

required
clearance_base float

clearance_base

required
clearance_side float

clearance_side

required
drilling_count int

drilling_count

required
drilling_diameter float

drilling_diameter

required
drilling_tolerance float

drilling_tolerance

required

Returns:

Type Description
None

None

Source code in src/element_controller/__init__.pyi
1351
1352
1353
1354
1355
1356
1357
1358
1359
1360
1361
1362
1363
1364
1365
def cut_cross_lap(elements: List[int], depth: float, clearance_base: float, clearance_side: float, drilling_count: int, drilling_diameter: float, drilling_tolerance: float) -> None:
    """cuts a cross-lap with specific parameters

    Parameters:
        elements: elements
        depth: depth
        clearance_base: clearance_base
        clearance_side: clearance_side
        drilling_count: drilling_count
        drilling_diameter: drilling_diameter
        drilling_tolerance: drilling_tolerance

    Returns:
        None
    """

cut_diagonal_cut(elements, length, clearance_length, drilling_count, drilling_diameter, drilling_tolerance)

cuts a diagonal cut joint with specific parameters

Parameters:

Name Type Description Default
elements List[int]

elements

required
length float

length

required
clearance_length float

clearance_length

required
drilling_count int

drilling_count

required
drilling_diameter float

drilling_diameter

required
drilling_tolerance float

drilling_tolerance

required

Returns:

Type Description
None

None

Source code in src/element_controller/__init__.pyi
1439
1440
1441
1442
1443
1444
1445
1446
1447
1448
1449
1450
1451
1452
def cut_diagonal_cut(elements: List[int], length: float, clearance_length: float, drilling_count: int, drilling_diameter: float, drilling_tolerance: float) -> None:
    """cuts a diagonal cut joint with specific parameters

    Parameters:
        elements: elements
        length: length
        clearance_length: clearance_length
        drilling_count: drilling_count
        drilling_diameter: drilling_diameter
        drilling_tolerance: drilling_tolerance

    Returns:
        None
    """

cut_double_tenon(elements, depth1, depth2, clearance, backcut, drilling_count, drilling_diameter, drilling_tolerance)

cuts a double tenon with specific parameters

Parameters:

Name Type Description Default
elements List[int]

elements

required
depth1 float

depth1

required
depth2 float

depth2

required
clearance float

clearance

required
backcut float

backcut

required
drilling_count int

drilling_count

required
drilling_diameter float

drilling_diameter

required
drilling_tolerance float

drilling_tolerance

required

Returns:

Type Description
None

None

Source code in src/element_controller/__init__.pyi
1378
1379
1380
1381
1382
1383
1384
1385
1386
1387
1388
1389
1390
1391
1392
1393
def cut_double_tenon(elements: List[int], depth1: float, depth2: float, clearance: float, backcut: float, drilling_count: int, drilling_diameter: float, drilling_tolerance: float) -> None:
    """cuts a double tenon with specific parameters

    Parameters:
        elements: elements
        depth1: depth1
        depth2: depth2
        clearance: clearance
        backcut: backcut
        drilling_count: drilling_count
        drilling_diameter: drilling_diameter
        drilling_tolerance: drilling_tolerance

    Returns:
        None
    """

cut_element_with_plane(element_id, cut_plane_normal_vector, distance_from_global_origin)

cut element with plane

Parameters:

Name Type Description Default
element_id int

element_id

required
cut_plane_normal_vector point_3d

cut_plane_normal_vector

required
distance_from_global_origin float

distance_from_global_origin

required

Returns:

Type Description
bool

bool

Source code in src/element_controller/__init__.pyi
587
588
589
590
591
592
593
594
595
596
597
def cut_element_with_plane(element_id: int, cut_plane_normal_vector: point_3d, distance_from_global_origin: float) -> bool:
    """cut element with plane

    Parameters:
        element_id: element_id
        cut_plane_normal_vector: cut_plane_normal_vector
        distance_from_global_origin: distance_from_global_origin

    Returns:
        bool
    """

cut_element_with_processing_group(a0, a1)

cut element with processing group

Parameters:

Name Type Description Default
a0 int

a0

required
a1 int

a1

required

Returns:

Type Description
None

None

Source code in src/element_controller/__init__.pyi
1122
1123
1124
1125
1126
1127
1128
1129
1130
1131
def cut_element_with_processing_group(a0: int, a1: int) -> None:
    """cut element with processing group

    Parameters:
        a0: a0
        a1: a1

    Returns:
        None
    """

cut_elements_with_miter(first_id, second_id)

cut elements with miter

Parameters:

Name Type Description Default
first_id int

first_id

required
second_id int

second_id

required

Returns:

Type Description
bool

bool

Source code in src/element_controller/__init__.pyi
576
577
578
579
580
581
582
583
584
585
def cut_elements_with_miter(first_id: int, second_id: int) -> bool:
    """cut elements with miter

    Parameters:
        first_id: first_id
        second_id: second_id

    Returns:
        bool
    """

cut_elements_with_overmeasure(a0, a1)

cut elements with overmeasure

Parameters:

Name Type Description Default
a0 List[int]

a0

required
a1 List[int]

a1

required

Returns:

Type Description
None

None

Source code in src/element_controller/__init__.pyi
1192
1193
1194
1195
1196
1197
1198
1199
1200
1201
def cut_elements_with_overmeasure(a0: List[int], a1: List[int]) -> None:
    """cut elements with overmeasure

    Parameters:
        a0: a0
        a1: a1

    Returns:
        None
    """

cut_half_lap(elements, length, clearance_length, clearance_depth, drilling_count, drilling_diameter, drilling_tolerance)

cuts a half lap joint with specific parameters

Parameters:

Name Type Description Default
elements List[int]

elements

required
length float

length

required
clearance_length float

clearance_length

required
clearance_depth float

clearance_depth

required
drilling_count int

drilling_count

required
drilling_diameter float

drilling_diameter

required
drilling_tolerance float

drilling_tolerance

required

Returns:

Type Description
None

None

Source code in src/element_controller/__init__.pyi
1406
1407
1408
1409
1410
1411
1412
1413
1414
1415
1416
1417
1418
1419
1420
def cut_half_lap(elements: List[int], length: float, clearance_length: float, clearance_depth: float, drilling_count: int, drilling_diameter: float, drilling_tolerance: float) -> None:
    """cuts a half lap joint with specific parameters

    Parameters:
        elements: elements
        length: length
        clearance_length: clearance_length
        clearance_depth: clearance_depth
        drilling_count: drilling_count
        drilling_diameter: drilling_diameter
        drilling_tolerance: drilling_tolerance

    Returns:
        None
    """

cut_log_corner_joint(a0, a1)

cut log corner joint

Parameters:

Name Type Description Default
a0 str

a0

required
a1 List[int]

a1

required

Returns:

Type Description
None

None

Source code in src/element_controller/__init__.pyi
1203
1204
1205
1206
1207
1208
1209
1210
1211
1212
def cut_log_corner_joint(a0: str, a1: List[int]) -> None:
    """cut log corner joint

    Parameters:
        a0: a0
        a1: a1

    Returns:
        None
    """

cut_scarf_diagonal(elements, length, depth, clearance_length, clearance_depth, drilling_count, drilling_diameter, drilling_tolerance)

cut scarf diagonal

Parameters:

Name Type Description Default
elements List[int]

elements

required
length float

length

required
depth float

depth

required
clearance_length float

clearance_length

required
clearance_depth float

clearance_depth

required
drilling_count int

drilling_count

required
drilling_diameter float

drilling_diameter

required
drilling_tolerance float

drilling_tolerance

required

Returns:

Type Description
None

None

Source code in src/element_controller/__init__.pyi
1879
1880
1881
1882
1883
1884
1885
1886
1887
1888
1889
1890
1891
1892
1893
1894
def cut_scarf_diagonal(elements: List[int], length: float, depth: float, clearance_length: float, clearance_depth: float, drilling_count: int, drilling_diameter: float, drilling_tolerance: float) -> None:
    """cut scarf diagonal

    Parameters:
        elements: elements
        length: length
        depth: depth
        clearance_length: clearance_length
        clearance_depth: clearance_depth
        drilling_count: drilling_count
        drilling_diameter: drilling_diameter
        drilling_tolerance: drilling_tolerance

    Returns:
        None
    """

cut_scarf_straight(elements, length, depth, clearance_length, clearance_depth, clearance_hook, drilling_count, drilling_diameter, drilling_tolerance)

cut scarf straight

Parameters:

Name Type Description Default
elements List[int]

elements

required
length float

length

required
depth float

depth

required
clearance_length float

clearance_length

required
clearance_depth float

clearance_depth

required
clearance_hook float

clearance_hook

required
drilling_count int

drilling_count

required
drilling_diameter float

drilling_diameter

required
drilling_tolerance float

drilling_tolerance

required

Returns:

Type Description
None

None

Source code in src/element_controller/__init__.pyi
1861
1862
1863
1864
1865
1866
1867
1868
1869
1870
1871
1872
1873
1874
1875
1876
1877
def cut_scarf_straight(elements: List[int], length: float, depth: float, clearance_length: float, clearance_depth: float, clearance_hook: float, drilling_count: int, drilling_diameter: float, drilling_tolerance: float) -> None:
    """cut scarf straight

    Parameters:
        elements: elements
        length: length
        depth: depth
        clearance_length: clearance_length
        clearance_depth: clearance_depth
        clearance_hook: clearance_hook
        drilling_count: drilling_count
        drilling_diameter: drilling_diameter
        drilling_tolerance: drilling_tolerance

    Returns:
        None
    """

cut_scarf_with_wedge(elements, length, depth, clearance_length, clearance_depth, wedge_width, drilling_count, drilling_diameter, drilling_tolerance)

cut scarf with wedge

Parameters:

Name Type Description Default
elements List[int]

elements

required
length float

length

required
depth float

depth

required
clearance_length float

clearance_length

required
clearance_depth float

clearance_depth

required
wedge_width float

wedge_width

required
drilling_count int

drilling_count

required
drilling_diameter float

drilling_diameter

required
drilling_tolerance float

drilling_tolerance

required

Returns:

Type Description
None

None

Source code in src/element_controller/__init__.pyi
1896
1897
1898
1899
1900
1901
1902
1903
1904
1905
1906
1907
1908
1909
1910
1911
1912
def cut_scarf_with_wedge(elements: List[int], length: float, depth: float, clearance_length: float, clearance_depth: float, wedge_width: float, drilling_count: int, drilling_diameter: float, drilling_tolerance: float) -> None:
    """cut scarf with wedge

    Parameters:
        elements: elements
        length: length
        depth: depth
        clearance_length: clearance_length
        clearance_depth: clearance_depth
        wedge_width: wedge_width
        drilling_count: drilling_count
        drilling_diameter: drilling_diameter
        drilling_tolerance: drilling_tolerance

    Returns:
        None
    """

cut_simple_scarf(elements, length, depth, clearance_length, clearance_depth, drilling_count, drilling_diameter, drilling_tolerance)

cuts a simple scarf joint with specific parameters

Parameters:

Name Type Description Default
elements List[int]

elements

required
length float

length

required
depth float

depth

required
clearance_length float

clearance_length

required
clearance_depth float

clearance_depth

required
drilling_count int

drilling_count

required
drilling_diameter float

drilling_diameter

required
drilling_tolerance float

drilling_tolerance

required

Returns:

Type Description
None

None

Source code in src/element_controller/__init__.pyi
1422
1423
1424
1425
1426
1427
1428
1429
1430
1431
1432
1433
1434
1435
1436
1437
def cut_simple_scarf(elements: List[int], length: float, depth: float, clearance_length: float, clearance_depth: float, drilling_count: int, drilling_diameter: float, drilling_tolerance: float) -> None:
    """cuts a simple scarf joint with specific parameters

    Parameters:
        elements: elements
        length: length
        depth: depth
        clearance_length: clearance_length
        clearance_depth: clearance_depth
        drilling_count: drilling_count
        drilling_diameter: drilling_diameter
        drilling_tolerance: drilling_tolerance

    Returns:
        None
    """

cut_t_lap(elements, depth, clearance_base, clearance_side, backcut, drilling_count, drilling_diameter, drilling_tolerance)

cuts a t-lap with specific parameters

Parameters:

Name Type Description Default
elements List[int]

elements

required
depth float

depth

required
clearance_base float

clearance_base

required
clearance_side float

clearance_side

required
backcut float

backcut

required
drilling_count int

drilling_count

required
drilling_diameter float

drilling_diameter

required
drilling_tolerance float

drilling_tolerance

required

Returns:

Type Description
None

None

Source code in src/element_controller/__init__.pyi
1334
1335
1336
1337
1338
1339
1340
1341
1342
1343
1344
1345
1346
1347
1348
1349
def cut_t_lap(elements: List[int], depth: float, clearance_base: float, clearance_side: float, backcut: float, drilling_count: int, drilling_diameter: float, drilling_tolerance: float) -> None:
    """cuts a t-lap with specific parameters

    Parameters:
        elements: elements
        depth: depth
        clearance_base: clearance_base
        clearance_side: clearance_side
        backcut: backcut
        drilling_count: drilling_count
        drilling_diameter: drilling_diameter
        drilling_tolerance: drilling_tolerance

    Returns:
        None
    """

delete_all_element_end_types(element_id_list)

delete all element end types

Parameters:

Name Type Description Default
element_id_list List[int]

element_id_list

required

Returns:

Type Description
None

None

Source code in src/element_controller/__init__.pyi
249
250
251
252
253
254
255
256
257
def delete_all_element_end_types(element_id_list: List[int]) -> None:
    """delete all element end types

    Parameters:
        element_id_list: element_id_list

    Returns:
        None
    """

delete_all_element_processes(element_id_list)

delete all element processes

Parameters:

Name Type Description Default
element_id_list List[int]

element_id_list

required

Returns:

Type Description
None

None

Source code in src/element_controller/__init__.pyi
259
260
261
262
263
264
265
266
267
def delete_all_element_processes(element_id_list: List[int]) -> None:
    """delete all element processes

    Parameters:
        element_id_list: element_id_list

    Returns:
        None
    """

delete_elements(element_id_list)

delete elements

Parameters:

Name Type Description Default
element_id_list List[int]

element_id_list

required

Returns:

Type Description
None

None

Source code in src/element_controller/__init__.pyi
19
20
21
22
23
24
25
26
27
def delete_elements(element_id_list: List[int]) -> None:
    """delete elements

    Parameters:
        element_id_list: element_id_list

    Returns:
        None
    """

delete_elements_with_undo(elements)

delete elements with undo

Parameters:

Name Type Description Default
elements List[int]

elements

required

Returns:

Type Description
None

None

Source code in src/element_controller/__init__.pyi
491
492
493
494
495
496
497
498
499
def delete_elements_with_undo(elements: List[int]) -> None:
    """delete elements with undo

    Parameters:
        elements: elements

    Returns:
        None
    """

delete_processes_keep_cutting_bodies(elements, keep_cutting_elements_only)

Gets the cutting bodies of all processes (and deletes processes), like Ctrl+D Action

Parameters:

Name Type Description Default
elements List[int]

elements

required
keep_cutting_elements_only bool

keep_cutting_elements_only

required

Returns:

Type Description
List[int]

List[int]

Source code in src/element_controller/__init__.pyi
1367
1368
1369
1370
1371
1372
1373
1374
1375
1376
def delete_processes_keep_cutting_bodies(elements: List[int], keep_cutting_elements_only: bool) -> List[int]:
    """Gets the cutting bodies of all processes (and deletes processes), like Ctrl+D Action

    Parameters:
        elements: elements
        keep_cutting_elements_only: keep_cutting_elements_only

    Returns:
        List[int]
    """

extrude_surface_to_auxiliary_vector(surface, vector)

extrude surface to auxiliary vector

Parameters:

Name Type Description Default
surface int

surface

required
vector point_3d

vector

required

Returns:

Type Description
int

int

Source code in src/element_controller/__init__.pyi
919
920
921
922
923
924
925
926
927
928
def extrude_surface_to_auxiliary_vector(surface: int, vector: point_3d) -> int:
    """extrude surface to auxiliary vector

    Parameters:
        surface: surface
        vector: vector

    Returns:
        int
    """

extrude_surface_to_beam_vector(surface, vector)

extrude surface to beam vector

Parameters:

Name Type Description Default
surface int

surface

required
vector point_3d

vector

required

Returns:

Type Description
int

int

Source code in src/element_controller/__init__.pyi
941
942
943
944
945
946
947
948
949
950
def extrude_surface_to_beam_vector(surface: int, vector: point_3d) -> int:
    """extrude surface to beam vector

    Parameters:
        surface: surface
        vector: vector

    Returns:
        int
    """

extrude_surface_to_panel_vector(surface, vector)

extrude surface to panel vector

Parameters:

Name Type Description Default
surface int

surface

required
vector point_3d

vector

required

Returns:

Type Description
int

int

Source code in src/element_controller/__init__.pyi
930
931
932
933
934
935
936
937
938
939
def extrude_surface_to_panel_vector(surface: int, vector: point_3d) -> int:
    """extrude surface to panel vector

    Parameters:
        surface: surface
        vector: vector

    Returns:
        int
    """

fillet_edge(a0, a1, a2, a3)

fillet edge

Parameters:

Name Type Description Default
a0 int

a0

required
a1 point_3d

a1

required
a2 point_3d

a2

required
a3 float

a3

required

Returns:

Type Description
None

None

Source code in src/element_controller/__init__.pyi
1261
1262
1263
1264
1265
1266
1267
1268
1269
1270
1271
1272
def fillet_edge(a0: int, a1: point_3d, a2: point_3d, a3: float) -> None:
    """fillet edge

    Parameters:
        a0: a0
        a1: a1
        a2: a2
        a3: a3

    Returns:
        None
    """

get_active_identifiable_element_ids()

get active identifiable element ids

Returns:

Type Description
List[int]

List[int]

Source code in src/element_controller/__init__.pyi
1475
1476
1477
1478
1479
1480
def get_active_identifiable_element_ids() -> List[int]:
    """get active identifiable element ids

    Returns:
        List[int]
    """

get_all_identifiable_element_ids()

get all identifiable element ids

Returns:

Type Description
List[int]

List[int]

Source code in src/element_controller/__init__.pyi
1454
1455
1456
1457
1458
1459
def get_all_identifiable_element_ids() -> List[int]:
    """get all identifiable element ids

    Returns:
        List[int]
    """

get_all_nesting_raw_parts()

get all nesting raw parts

Returns:

Type Description
List[int]

List[int]

Source code in src/element_controller/__init__.pyi
1730
1731
1732
1733
1734
1735
def get_all_nesting_raw_parts() -> List[int]:
    """get all nesting raw parts

    Returns:
        List[int]
    """

get_bounding_box_vertices_global(a0)

get bounding box vertices global

Parameters:

Name Type Description Default
a0 List[int]

a0

required

Returns:

Type Description
List[point_3d]

List[point_3d]

Source code in src/element_controller/__init__.pyi
1720
1721
1722
1723
1724
1725
1726
1727
1728
def get_bounding_box_vertices_global(a0: List[int]) -> List[point_3d]:
    """get bounding box vertices global

    Parameters:
        a0: a0

    Returns:
        List[point_3d]
    """

get_bounding_box_vertices_local(a0, a1)

get bounding box vertices local

Parameters:

Name Type Description Default
a0 int

a0

required
a1 List[int]

a1

required

Returns:

Type Description
List[point_3d]

List[point_3d]

Source code in src/element_controller/__init__.pyi
1709
1710
1711
1712
1713
1714
1715
1716
1717
1718
def get_bounding_box_vertices_local(a0: int, a1: List[int]) -> List[point_3d]:
    """get bounding box vertices local

    Parameters:
        a0: a0
        a1: a1

    Returns:
        List[point_3d]
    """

get_container_content_elements(element_id)

get container content elements

Parameters:

Name Type Description Default
element_id int

element_id

required

Returns:

Type Description
List[int]

List[int]

Source code in src/element_controller/__init__.pyi
1682
1683
1684
1685
1686
1687
1688
1689
1690
def get_container_content_elements(element_id: int) -> List[int]:
    """get container content elements

    Parameters:
        element_id: element_id

    Returns:
        List[int]
    """

get_coordinate_system_data_nesting_child(nesting_parent_id, nesting_child_id)

Get the coordinate system of nesting child

Parameters:

Name Type Description Default
nesting_parent_id int

nesting_parent_id

required
nesting_child_id int

nesting_child_id

required

Returns:

Type Description
coordinate_system_data

A global element coordinate-system of the nested child element consisting of a Point1, a Point2 and a Point3. You can get the local placement by subtracting the parent coordinate-system with child coordinate-system

Source code in src/element_controller/__init__.pyi
1395
1396
1397
1398
1399
1400
1401
1402
1403
1404
def get_coordinate_system_data_nesting_child(nesting_parent_id: int, nesting_child_id: int) -> coordinate_system_data:
    """Get the coordinate system of nesting child

    Parameters:
        nesting_parent_id: nesting_parent_id
        nesting_child_id: nesting_child_id

    Returns:
        A global element coordinate-system of the nested child element consisting of a Point1, a Point2 and a Point3. You can get the local placement by subtracting the parent coordinate-system with child coordinate-system
    """

get_edge_selection(a0)

get edge selection

Parameters:

Name Type Description Default
a0 List[int]

a0

required

Returns:

Type Description
edge_list

edge_list

Source code in src/element_controller/__init__.pyi
1214
1215
1216
1217
1218
1219
1220
1221
1222
def get_edge_selection(a0: List[int]) -> edge_list:
    """get edge selection

    Parameters:
        a0: a0

    Returns:
        edge_list
    """

get_element_cadwork_guid(element_id)

get element cadwork guid

Parameters:

Name Type Description Default
element_id int

element_id

required

Returns:

Type Description
str

str

Source code in src/element_controller/__init__.pyi
1699
1700
1701
1702
1703
1704
1705
1706
1707
def get_element_cadwork_guid(element_id: int) -> str:
    """get element cadwork guid

    Parameters:
        element_id: element_id

    Returns:
        str
    """

get_element_contact_facets(first_id, second_id)

get element contact facets

Parameters:

Name Type Description Default
first_id int

first_id

required
second_id int

second_id

required

Returns:

Type Description
facet_list

facet_list

Source code in src/element_controller/__init__.pyi
1518
1519
1520
1521
1522
1523
1524
1525
1526
1527
def get_element_contact_facets(first_id: int, second_id: int) -> facet_list:
    """get element contact facets

    Parameters:
        first_id: first_id
        second_id: second_id

    Returns:
        facet_list
    """

get_element_contact_vertices(first_id, second_id)

get element contact vertices

Parameters:

Name Type Description Default
first_id int

first_id

required
second_id int

second_id

required

Returns:

Type Description
List[point_3d]

List[point_3d]

Source code in src/element_controller/__init__.pyi
1588
1589
1590
1591
1592
1593
1594
1595
1596
1597
def get_element_contact_vertices(first_id: int, second_id: int) -> List[point_3d]:
    """get element contact vertices

    Parameters:
        first_id: first_id
        second_id: second_id

    Returns:
        List[point_3d]
    """

get_element_detail_path()

get element detail path

Returns:

Type Description
str

str

Source code in src/element_controller/__init__.pyi
1692
1693
1694
1695
1696
1697
def get_element_detail_path() -> str:
    """get element detail path

    Returns:
        str
    """

get_element_from_cadwork_guid(cadwork_guid)

get element from cadwork guid

Parameters:

Name Type Description Default
cadwork_guid str

cadwork_guid

required

Returns:

Type Description
int

int

Source code in src/element_controller/__init__.pyi
372
373
374
375
376
377
378
379
380
def get_element_from_cadwork_guid(cadwork_guid: str) -> int:
    """get element from cadwork guid

    Parameters:
        cadwork_guid: cadwork_guid

    Returns:
        int
    """

get_element_module_properties_for_element(element_id)

get element module properties for element

Parameters:

Name Type Description Default
element_id int

element_id

required

Returns:

Type Description
element_module_properties

element_module_properties

Source code in src/element_controller/__init__.pyi
1631
1632
1633
1634
1635
1636
1637
1638
1639
def get_element_module_properties_for_element(element_id: int) -> element_module_properties:
    """get element module properties for element

    Parameters:
        element_id: element_id

    Returns:
        element_module_properties
    """

get_element_raw_interface_vertices(first_id, second_id)

get element raw interface vertices

Parameters:

Name Type Description Default
first_id int

first_id

required
second_id int

second_id

required

Returns:

Type Description
List[point_3d]

List[point_3d]

Source code in src/element_controller/__init__.pyi
1529
1530
1531
1532
1533
1534
1535
1536
1537
1538
def get_element_raw_interface_vertices(first_id: int, second_id: int) -> List[point_3d]:
    """get element raw interface vertices

    Parameters:
        first_id: first_id
        second_id: second_id

    Returns:
        List[point_3d]
    """

get_element_type_description(element_id)

get element type description

Parameters:

Name Type Description Default
element_id int

element_id

required

Returns:

Type Description
str

str

Source code in src/element_controller/__init__.pyi
1641
1642
1643
1644
1645
1646
1647
1648
1649
def get_element_type_description(element_id: int) -> str:
    """get element type description

    Parameters:
        element_id: element_id

    Returns:
        str
    """

get_elements_in_contact(a0)

get elements in contact

Parameters:

Name Type Description Default
a0 int

a0

required

Returns:

Type Description
List[int]

List[int]

Source code in src/element_controller/__init__.pyi
1757
1758
1759
1760
1761
1762
1763
1764
1765
def get_elements_in_contact(a0: int) -> List[int]:
    """get elements in contact

    Parameters:
        a0: a0

    Returns:
        List[int]
    """

get_export_solid_content_elements(element_id)

get export solid content elements

Parameters:

Name Type Description Default
element_id int

element_id

required

Returns:

Type Description
List[int]

List[int]

Source code in src/element_controller/__init__.pyi
1672
1673
1674
1675
1676
1677
1678
1679
1680
def get_export_solid_content_elements(element_id: int) -> List[int]:
    """get export solid content elements

    Parameters:
        element_id: element_id

    Returns:
        List[int]
    """

get_facets_with_lasso(a0)

get facets with lasso

Parameters:

Name Type Description Default
a0 List[int]

a0

required

Returns:

Type Description
facet_list

facet_list

Source code in src/element_controller/__init__.pyi
1224
1225
1226
1227
1228
1229
1230
1231
1232
def get_facets_with_lasso(a0: List[int]) -> facet_list:
    """get facets with lasso

    Parameters:
        a0: a0

    Returns:
        facet_list
    """

get_inactive_all_identifiable_element_ids()

get inactive all identifiable element ids

Returns:

Type Description
List[int]

List[int]

Source code in src/element_controller/__init__.pyi
1482
1483
1484
1485
1486
1487
def get_inactive_all_identifiable_element_ids() -> List[int]:
    """get inactive all identifiable element ids

    Returns:
        List[int]
    """

get_inactive_visible_identifiable_element_ids()

get inactive visible identifiable element ids

Returns:

Type Description
List[int]

List[int]

Source code in src/element_controller/__init__.pyi
1489
1490
1491
1492
1493
1494
def get_inactive_visible_identifiable_element_ids() -> List[int]:
    """get inactive visible identifiable element ids

    Returns:
        List[int]
    """

get_invisible_identifiable_element_ids()

get invisible identifiable element ids

Returns:

Type Description
List[int]

List[int]

Source code in src/element_controller/__init__.pyi
1468
1469
1470
1471
1472
1473
def get_invisible_identifiable_element_ids() -> List[int]:
    """get invisible identifiable element ids

    Returns:
        List[int]
    """

get_joined_elements(a0)

get joined elements

Parameters:

Name Type Description Default
a0 int

a0

required

Returns:

Type Description
List[int]

List[int]

Source code in src/element_controller/__init__.pyi
1737
1738
1739
1740
1741
1742
1743
1744
1745
def get_joined_elements(a0: int) -> List[int]:
    """get joined elements

    Parameters:
        a0: a0

    Returns:
        List[int]
    """

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/element_controller/__init__.pyi
 9
10
11
12
13
14
15
16
17
def get_last_error(error_code: int) -> str:
    """Gets the last error

    Parameters:
        error_code: error_code

    Returns:
        error string
    """

get_nesting_parent_id(element_id)

get nesting parent id

Parameters:

Name Type Description Default
element_id int

element_id

required

Returns:

Type Description
int

int

Source code in src/element_controller/__init__.pyi
1599
1600
1601
1602
1603
1604
1605
1606
1607
def get_nesting_parent_id(element_id: int) -> int:
    """get nesting parent id

    Parameters:
        element_id: element_id

    Returns:
        int
    """

get_opening_variant_ids(elements, opening_type)

get opening variant ids

Parameters:

Name Type Description Default
elements List[int]

elements

required
opening_type int

opening_type

required

Returns:

Type Description
List[int]

List[int]

Source code in src/element_controller/__init__.pyi
1651
1652
1653
1654
1655
1656
1657
1658
1659
1660
def get_opening_variant_ids(elements: List[int], opening_type: int) -> List[int]:
    """get opening variant ids

    Parameters:
        elements: elements
        opening_type: opening_type

    Returns:
        List[int]
    """

get_parent_container_id(element_id)

get parent container id

Parameters:

Name Type Description Default
element_id int

element_id

required

Returns:

Type Description
int

int

Source code in src/element_controller/__init__.pyi
1662
1663
1664
1665
1666
1667
1668
1669
1670
def get_parent_container_id(element_id: int) -> int:
    """get parent container id

    Parameters:
        element_id: element_id

    Returns:
        int
    """

get_reference_element(element)

get reference element

Parameters:

Name Type Description Default
element int

element

required

Returns:

Type Description
int

int

Source code in src/element_controller/__init__.pyi
1578
1579
1580
1581
1582
1583
1584
1585
1586
def get_reference_element(element: int) -> int:
    """get reference element

    Parameters:
        element: element

    Returns:
        int
    """

get_standard_beam_list()

get standard beam list

Returns:

Type Description
List[str]

List[str]

Source code in src/element_controller/__init__.pyi
1554
1555
1556
1557
1558
1559
def get_standard_beam_list() -> List[str]:
    """get standard beam list

    Returns:
        List[str]
    """

get_standard_container_list()

get standard container list

Returns:

Type Description
List[str]

List[str]

Source code in src/element_controller/__init__.pyi
1547
1548
1549
1550
1551
1552
def get_standard_container_list() -> List[str]:
    """get standard container list

    Returns:
        List[str]
    """

get_standard_export_solid_list()

get standard export solid list

Returns:

Type Description
List[str]

List[str]

Source code in src/element_controller/__init__.pyi
1540
1541
1542
1543
1544
1545
def get_standard_export_solid_list() -> List[str]:
    """get standard export solid list

    Returns:
        List[str]
    """

get_standard_panel_list()

get standard panel list

Returns:

Type Description
List[str]

List[str]

Source code in src/element_controller/__init__.pyi
1561
1562
1563
1564
1565
1566
def get_standard_panel_list() -> List[str]:
    """get standard panel list

    Returns:
        List[str]
    """

get_user_element_ids()

get user element ids

Returns:

Type Description
List[int]

List[int]

Source code in src/element_controller/__init__.pyi
541
542
543
544
545
546
def get_user_element_ids() -> List[int]:
    """get user element ids

    Returns:
        List[int]
    """

get_user_element_ids_with_count(count)

get user element ids with count

Parameters:

Name Type Description Default
count int

count

required

Returns:

Type Description
List[int]

List[int]

Source code in src/element_controller/__init__.pyi
1851
1852
1853
1854
1855
1856
1857
1858
1859
def get_user_element_ids_with_count(count: int) -> List[int]:
    """get user element ids with count

    Parameters:
        count: count

    Returns:
        List[int]
    """

get_user_element_ids_with_existing(elements)

get user element ids with existing

Parameters:

Name Type Description Default
elements List[int]

elements

required

Returns:

Type Description
List[int]

List[int]

Source code in src/element_controller/__init__.pyi
548
549
550
551
552
553
554
555
556
def get_user_element_ids_with_existing(elements: List[int]) -> List[int]:
    """get user element ids with existing

    Parameters:
        elements: elements

    Returns:
        List[int]
    """

get_variant_sibling_element_ids(a0)

get variant sibling element ids

Parameters:

Name Type Description Default
a0 int

a0

required

Returns:

Type Description
List[int]

List[int]

Source code in src/element_controller/__init__.pyi
1568
1569
1570
1571
1572
1573
1574
1575
1576
def get_variant_sibling_element_ids(a0: int) -> List[int]:
    """get variant sibling element ids

    Parameters:
        a0: a0

    Returns:
        List[int]
    """

get_visible_identifiable_element_ids()

get visible identifiable element ids

Returns:

Type Description
List[int]

List[int]

Source code in src/element_controller/__init__.pyi
1461
1462
1463
1464
1465
1466
def get_visible_identifiable_element_ids() -> List[int]:
    """get visible identifiable element ids

    Returns:
        List[int]
    """

glide_elements(element_i_ds, glide_point)

Glides elements

Parameters:

Name Type Description Default
element_i_ds List[int]

element_i_ds

required
glide_point point_3d

glide_point

required

Returns:

Type Description
None

None

Source code in src/element_controller/__init__.pyi
565
566
567
568
569
570
571
572
573
574
def glide_elements(element_i_ds: List[int], glide_point: point_3d) -> None:
    """Glides elements

    Parameters:
        element_i_ds: element_i_ds
        glide_point: glide_point

    Returns:
        None
    """

join_elements(element_id_list)

join elements

Parameters:

Name Type Description Default
element_id_list List[int]

element_id_list

required

Returns:

Type Description
None

None

Source code in src/element_controller/__init__.pyi
29
30
31
32
33
34
35
36
37
def join_elements(element_id_list: List[int]) -> None:
    """join elements

    Parameters:
        element_id_list: element_id_list

    Returns:
        None
    """

join_top_level_elements(element_id_list)

join top level elements

Parameters:

Name Type Description Default
element_id_list List[int]

element_id_list

required

Returns:

Type Description
None

None

Source code in src/element_controller/__init__.pyi
39
40
41
42
43
44
45
46
47
def join_top_level_elements(element_id_list: List[int]) -> None:
    """join top level elements

    Parameters:
        element_id_list: element_id_list

    Returns:
        None
    """

make_redo()

make redo

Returns:

Type Description
None

None

Source code in src/element_controller/__init__.pyi
400
401
402
403
404
405
def make_redo() -> None:
    """make redo

    Returns:
        None
    """

make_undo()

make undo

Returns:

Type Description
None

None

Source code in src/element_controller/__init__.pyi
393
394
395
396
397
398
def make_undo() -> None:
    """make undo

    Returns:
        None
    """

mirror_copy_elements(elements, plane, plane_distance)

mirror copy elements

Parameters:

Name Type Description Default
elements List[int]

elements

required
plane point_3d

plane

required
plane_distance float

plane_distance

required

Returns:

Type Description
List[int]

List[int]

Source code in src/element_controller/__init__.pyi
771
772
773
774
775
776
777
778
779
780
781
def mirror_copy_elements(elements: List[int], plane: point_3d, plane_distance: float) -> List[int]:
    """mirror copy elements

    Parameters:
        elements: elements
        plane: plane
        plane_distance: plane_distance

    Returns:
        List[int]
    """

mirror_move_elements(elements, plane, plane_distance)

mirror move elements

Parameters:

Name Type Description Default
elements List[int]

elements

required
plane point_3d

plane

required
plane_distance float

plane_distance

required

Returns:

Type Description
None

None

Source code in src/element_controller/__init__.pyi
759
760
761
762
763
764
765
766
767
768
769
def mirror_move_elements(elements: List[int], plane: point_3d, plane_distance: float) -> None:
    """mirror move elements

    Parameters:
        elements: elements
        plane: plane
        plane_distance: plane_distance

    Returns:
        None
    """

move_element(element_id_list, vector)

move element

Parameters:

Name Type Description Default
element_id_list List[int]

element_id_list

required
vector point_3d

vector

required

Returns:

Type Description
None

None

Source code in src/element_controller/__init__.pyi
269
270
271
272
273
274
275
276
277
278
def move_element(element_id_list: List[int], vector: point_3d) -> None:
    """move element

    Parameters:
        element_id_list: element_id_list
        vector: vector

    Returns:
        None
    """

move_element_with_undo(element_id_list, vector)

move element with undo

Parameters:

Name Type Description Default
element_id_list List[int]

element_id_list

required
vector point_3d

vector

required

Returns:

Type Description
None

None

Source code in src/element_controller/__init__.pyi
874
875
876
877
878
879
880
881
882
883
def move_element_with_undo(element_id_list: List[int], vector: point_3d) -> None:
    """move element with undo

    Parameters:
        element_id_list: element_id_list
        vector: vector

    Returns:
        None
    """

parts_situation_manual(a0, a1, a2)

parts situation manual

Parameters:

Name Type Description Default
a0 int

a0

required
a1 List[int]

a1

required
a2 List[int]

a2

required

Returns:

Type Description
None

None

Source code in src/element_controller/__init__.pyi
1035
1036
1037
1038
1039
1040
1041
1042
1043
1044
1045
def parts_situation_manual(a0: int, a1: List[int], a2: List[int]) -> None:
    """parts situation manual

    Parameters:
        a0: a0
        a1: a1
        a2: a2

    Returns:
        None
    """

recreate_elements(elements)

recreate elements

Parameters:

Name Type Description Default
elements List[int]

elements

required

Returns:

Type Description
None

None

Source code in src/element_controller/__init__.pyi
521
522
523
524
525
526
527
528
529
def recreate_elements(elements: List[int]) -> None:
    """recreate elements

    Parameters:
        elements: elements

    Returns:
        None
    """

remove_standard_beam(guid)

remove standard beam

Parameters:

Name Type Description Default
guid str

guid

required

Returns:

Type Description
None

None

Source code in src/element_controller/__init__.pyi
1811
1812
1813
1814
1815
1816
1817
1818
1819
def remove_standard_beam(guid: str) -> None:
    """remove standard beam

    Parameters:
        guid: guid

    Returns:
        None
    """

remove_standard_connector_axis(a0)

remove standard connector axis

Parameters:

Name Type Description Default
a0 str

a0

required

Returns:

Type Description
None

None

Source code in src/element_controller/__init__.pyi
1801
1802
1803
1804
1805
1806
1807
1808
1809
def remove_standard_connector_axis(a0: str) -> None:
    """remove standard connector axis

    Parameters:
        a0: a0

    Returns:
        None
    """

remove_standard_container(guid)

remove standard container

Parameters:

Name Type Description Default
guid str

guid

required

Returns:

Type Description
None

None

Source code in src/element_controller/__init__.pyi
1831
1832
1833
1834
1835
1836
1837
1838
1839
def remove_standard_container(guid: str) -> None:
    """remove standard container

    Parameters:
        guid: guid

    Returns:
        None
    """

remove_standard_export_solid(guid)

remove standard export solid

Parameters:

Name Type Description Default
guid str

guid

required

Returns:

Type Description
None

None

Source code in src/element_controller/__init__.pyi
1841
1842
1843
1844
1845
1846
1847
1848
1849
def remove_standard_export_solid(guid: str) -> None:
    """remove standard export solid

    Parameters:
        guid: guid

    Returns:
        None
    """

remove_standard_panel(guid)

remove standard panel

Parameters:

Name Type Description Default
guid str

guid

required

Returns:

Type Description
None

None

Source code in src/element_controller/__init__.pyi
1821
1822
1823
1824
1825
1826
1827
1828
1829
def remove_standard_panel(guid: str) -> None:
    """remove standard panel

    Parameters:
        guid: guid

    Returns:
        None
    """

replace_physical_drillings_with_drilling_axes(a0, a1, a2)

replace physical drillings with drilling axes

Parameters:

Name Type Description Default
a0 List[int]

a0

required
a1 float

a1

required
a2 float

a2

required

Returns:

Type Description
List[int]

List[int]

Source code in src/element_controller/__init__.pyi
1110
1111
1112
1113
1114
1115
1116
1117
1118
1119
1120
def replace_physical_drillings_with_drilling_axes(a0: List[int], a1: float, a2: float) -> List[int]:
    """replace physical drillings with drilling axes

    Parameters:
        a0: a0
        a1: a1
        a2: a2

    Returns:
        List[int]
    """

reset_element_cadwork_guid(element_id)

sets the Cadwork Guid of an element to NULL

Parameters:

Name Type Description Default
element_id int

element_id

required

Returns:

Type Description
None

None

Source code in src/element_controller/__init__.pyi
783
784
785
786
787
788
789
790
791
def reset_element_cadwork_guid(element_id: int) -> None:
    """sets the Cadwork Guid of an element to NULL

    Parameters:
        element_id: element_id

    Returns:
        None
    """

rotate_elements(element_id_list, origin, rotation_axis, rotation_angle)

rotate elements

Parameters:

Name Type Description Default
element_id_list List[int]

element_id_list

required
origin point_3d

origin

required
rotation_axis point_3d

rotation_axis

required
rotation_angle float

rotation_angle

required

Returns:

Type Description
None

None

Source code in src/element_controller/__init__.pyi
318
319
320
321
322
323
324
325
326
327
328
329
def rotate_elements(element_id_list: List[int], origin: point_3d, rotation_axis: point_3d, rotation_angle: float) -> None:
    """rotate elements

    Parameters:
        element_id_list: element_id_list
        origin: origin
        rotation_axis: rotation_axis
        rotation_angle: rotation_angle

    Returns:
        None
    """

rough_volume_situation_manual(a0, a1, a2)

rough volume situation manual

Parameters:

Name Type Description Default
a0 int

a0

required
a1 List[int]

a1

required
a2 List[int]

a2

required

Returns:

Type Description
None

None

Source code in src/element_controller/__init__.pyi
1013
1014
1015
1016
1017
1018
1019
1020
1021
1022
1023
def rough_volume_situation_manual(a0: int, a1: List[int], a2: List[int]) -> None:
    """rough volume situation manual

    Parameters:
        a0: a0
        a1: a1
        a2: a2

    Returns:
        None
    """

set_container_contents(a0, a1)

set container contents

Parameters:

Name Type Description Default
a0 int

a0

required
a1 List[int]

a1

required

Returns:

Type Description
None

None

Source code in src/element_controller/__init__.pyi
737
738
739
740
741
742
743
744
745
746
def set_container_contents(a0: int, a1: List[int]) -> None:
    """set container contents

    Parameters:
        a0: a0
        a1: a1

    Returns:
        None
    """

set_element_detail_path(path)

set element detail path

Parameters:

Name Type Description Default
path str

path

required

Returns:

Type Description
None

None

Source code in src/element_controller/__init__.pyi
362
363
364
365
366
367
368
369
370
def set_element_detail_path(path: str) -> None:
    """set element detail path

    Parameters:
        path: path

    Returns:
        None
    """

set_element_module_properties_for_elements(elements, properties)

set element module properties for elements

Parameters:

Name Type Description Default
elements List[int]

elements

required
properties None

properties

required

Returns:

Type Description
None

None

Source code in src/element_controller/__init__.pyi
449
450
451
452
453
454
455
456
457
458
def set_element_module_properties_for_elements(elements: List[int], properties: None) -> None:
    """set element module properties for elements

    Parameters:
        elements: elements
        properties: properties

    Returns:
        None
    """

set_export_solid_contents(a0, a1)

set export solid contents

Parameters:

Name Type Description Default
a0 int

a0

required
a1 List[int]

a1

required

Returns:

Type Description
None

None

Source code in src/element_controller/__init__.pyi
726
727
728
729
730
731
732
733
734
735
def set_export_solid_contents(a0: int, a1: List[int]) -> None:
    """set export solid contents

    Parameters:
        a0: a0
        a1: a1

    Returns:
        None
    """

set_line_to_marking_line(elements)

set line to marking line

Parameters:

Name Type Description Default
elements List[int]

elements

required

Returns:

Type Description
None

None

Source code in src/element_controller/__init__.pyi
417
418
419
420
421
422
423
424
425
def set_line_to_marking_line(elements: List[int]) -> None:
    """set line to marking line

    Parameters:
        elements: elements

    Returns:
        None
    """

set_line_to_normal_line(elements)

set line to normal line

Parameters:

Name Type Description Default
elements List[int]

elements

required

Returns:

Type Description
None

None

Source code in src/element_controller/__init__.pyi
427
428
429
430
431
432
433
434
435
def set_line_to_normal_line(elements: List[int]) -> None:
    """set line to normal line

    Parameters:
        elements: elements

    Returns:
        None
    """

set_parent_opening_variants_opening_angle(a0, a1)

set parent opening variants opening angle

Parameters:

Name Type Description Default
a0 List[int]

a0

required
a1 float

a1

required

Returns:

Type Description
None

None

Source code in src/element_controller/__init__.pyi
748
749
750
751
752
753
754
755
756
757
def set_parent_opening_variants_opening_angle(a0: List[int], a1: float) -> None:
    """set parent opening variants opening angle

    Parameters:
        a0: a0
        a1: a1

    Returns:
        None
    """

slice_element_with_plane(element_id, cut_plane_normal_vector, distance_from_global_origin)

slice element with plane

Parameters:

Name Type Description Default
element_id int

element_id

required
cut_plane_normal_vector point_3d

cut_plane_normal_vector

required
distance_from_global_origin float

distance_from_global_origin

required

Returns:

Type Description
bool

bool

Source code in src/element_controller/__init__.pyi
622
623
624
625
626
627
628
629
630
631
632
def slice_element_with_plane(element_id: int, cut_plane_normal_vector: point_3d, distance_from_global_origin: float) -> bool:
    """slice element with plane

    Parameters:
        element_id: element_id
        cut_plane_normal_vector: cut_plane_normal_vector
        distance_from_global_origin: distance_from_global_origin

    Returns:
        bool
    """

slice_elements_with_plane_and_get_new_elements(a0, a1, a2)

slice elements with plane and get new elements

Parameters:

Name Type Description Default
a0 int

a0

required
a1 point_3d

a1

required
a2 float

a2

required

Returns:

Type Description
List[int]

List[int]

Source code in src/element_controller/__init__.pyi
672
673
674
675
676
677
678
679
680
681
682
def slice_elements_with_plane_and_get_new_elements(a0: int, a1: point_3d, a2: float) -> List[int]:
    """slice elements with plane and get new elements

    Parameters:
        a0: a0
        a1: a1
        a2: a2

    Returns:
        List[int]
    """

solder_elements(element_id_list)

solder elements

Parameters:

Name Type Description Default
element_id_list List[int]

element_id_list

required

Returns:

Type Description
List[int]

List[int]

Source code in src/element_controller/__init__.pyi
219
220
221
222
223
224
225
226
227
def solder_elements(element_id_list: List[int]) -> List[int]:
    """solder elements

    Parameters:
        element_id_list: element_id_list

    Returns:
        List[int]
    """

split_elements(elements)

split elements

Parameters:

Name Type Description Default
elements List[int]

elements

required

Returns:

Type Description
None

None

Source code in src/element_controller/__init__.pyi
407
408
409
410
411
412
413
414
415
def split_elements(elements: List[int]) -> None:
    """split elements

    Parameters:
        elements: elements

    Returns:
        None
    """

start_element_module_calculation(covers)

start element module calculation

Parameters:

Name Type Description Default
covers List[int]

covers

required

Returns:

Type Description
None

None

Source code in src/element_controller/__init__.pyi
352
353
354
355
356
357
358
359
360
def start_element_module_calculation(covers: List[int]) -> None:
    """start element module calculation

    Parameters:
        covers: covers

    Returns:
        None
    """

start_element_module_calculation_silently(covers)

start element module calculation silently

Parameters:

Name Type Description Default
covers List[int]

covers

required

Returns:

Type Description
None

None

Source code in src/element_controller/__init__.pyi
1100
1101
1102
1103
1104
1105
1106
1107
1108
def start_element_module_calculation_silently(covers: List[int]) -> None:
    """start element module calculation silently

    Parameters:
        covers: covers

    Returns:
        None
    """

start_standard_element_dialog(standard_element_type)

Starts the standard element dialogue based on the chosen element type

Parameters:

Name Type Description Default
standard_element_type None

standard_element_type

required

Returns:

Type Description
str

Returns guid of selected standard element if item is valid, else null

Source code in src/element_controller/__init__.pyi
1791
1792
1793
1794
1795
1796
1797
1798
1799
def start_standard_element_dialog(standard_element_type: None) -> str:
    """Starts the standard element dialogue based on the chosen element type

    Parameters:
        standard_element_type: standard_element_type

    Returns:
        Returns guid of selected standard element if item is valid, else null
    """

stretch_end_facet(a0, a1)

stretch end facet

Parameters:

Name Type Description Default
a0 List[int]

a0

required
a1 point_3d

a1

required

Returns:

Type Description
None

None

Source code in src/element_controller/__init__.pyi
715
716
717
718
719
720
721
722
723
724
def stretch_end_facet(a0: List[int], a1: point_3d) -> None:
    """stretch end facet

    Parameters:
        a0: a0
        a1: a1

    Returns:
        None
    """

stretch_start_facet(a0, a1)

stretch start facet

Parameters:

Name Type Description Default
a0 List[int]

a0

required
a1 point_3d

a1

required

Returns:

Type Description
None

None

Source code in src/element_controller/__init__.pyi
704
705
706
707
708
709
710
711
712
713
def stretch_start_facet(a0: List[int], a1: point_3d) -> None:
    """stretch start facet

    Parameters:
        a0: a0
        a1: a1

    Returns:
        None
    """

subtract_elements(hard_elements, soft_elements)

subtract elements

Parameters:

Name Type Description Default
hard_elements List[int]

hard_elements

required
soft_elements List[int]

soft_elements

required

Returns:

Type Description
List[int]

List[int]

Source code in src/element_controller/__init__.pyi
331
332
333
334
335
336
337
338
339
340
def subtract_elements(hard_elements: List[int], soft_elements: List[int]) -> List[int]:
    """subtract elements

    Parameters:
        hard_elements: hard_elements
        soft_elements: soft_elements

    Returns:
        List[int]
    """

subtract_elements_with_undo(hard_elements, soft_elements, with_undo)

subtract elements with undo

Parameters:

Name Type Description Default
hard_elements List[int]

hard_elements

required
soft_elements List[int]

soft_elements

required
with_undo bool

with_undo

required

Returns:

Type Description
List[int]

List[int]

Source code in src/element_controller/__init__.pyi
1072
1073
1074
1075
1076
1077
1078
1079
1080
1081
1082
def subtract_elements_with_undo(hard_elements: List[int], soft_elements: List[int], with_undo: bool) -> List[int]:
    """subtract elements with undo

    Parameters:
        hard_elements: hard_elements
        soft_elements: soft_elements
        with_undo: with_undo

    Returns:
        List[int]
    """