Skip to content

Commit ad294f0

Browse files
committed
## src
- add new api function stubs ## docs - update changelog - add example to run plugin from cmd
1 parent 672ec60 commit ad294f0

6 files changed

Lines changed: 418 additions & 20 deletions

File tree

docs/release_notes.md

Lines changed: 272 additions & 20 deletions
Original file line numberDiff line numberDiff line change
@@ -6,15 +6,15 @@ hide:
66
# Differences from the last to the current version
77

88
- What all counts as a change:
9-
- New functions
10-
- Changed function descriptions (docstrings)
11-
- New classes
12-
- Changed classes descriptions (docstrings)
13-
- New enums
14-
- Changed enums descriptions (docstrings)
9+
- New functions
10+
- Changed function descriptions (docstrings)
11+
- New classes
12+
- Changed classes descriptions (docstrings)
13+
- New enums
14+
- Changed enums descriptions (docstrings)
1515

1616

17-
## Missing Items
17+
## New Items
1818
### Functions attribute_controller
1919
#### is_attribute_visible_in_modify_window
2020

@@ -48,7 +48,23 @@ def set_attribute_visibility_in_modify_window(number: int, visibility: bool
4848

4949
```
5050

51-
## Missing Items
51+
#### set_cutting_set
52+
53+
```python
54+
def set_cutting_set(element_id_list: List[int], cutting_set_name: str) ->bool:
55+
"""set cutting set
56+
57+
Parameters:
58+
element_id_list: element_id_list
59+
cutting_set_name: cutting_set_name
60+
61+
Returns:
62+
bool
63+
"""
64+
65+
```
66+
67+
## New Items
5268
### Functions bim_controller
5369
#### get_ifc_predefined_type
5470

@@ -82,7 +98,7 @@ def set_ifc_predefined_type(element_i_ds: List[int], predefined_type: None
8298

8399
```
84100

85-
## Missing Items
101+
## New Items
86102
### Functions dimension_controller
87103
#### get_distance
88104

@@ -160,7 +176,7 @@ def get_segment_distance(element: int, segment_index: int) ->float:
160176

161177
```
162178

163-
## Missing Items
179+
## New Items
164180
### Functions element_controller
165181
#### convert_surfaces_to_roof_surfaces
166182

@@ -360,7 +376,26 @@ def cut_scarf_with_wedge(elements: List[int], length: float, depth: float,
360376

361377
```
362378

363-
## Missing Items
379+
#### cut_beam_end_profile
380+
381+
```python
382+
def cut_beam_end_profile(elements: List[int], profile_name: str,
383+
on_start_face: bool, on_end_face: bool) ->None:
384+
"""cut beam end profile
385+
386+
Parameters:
387+
elements: elements
388+
profile_name: profile_name
389+
on_start_face: on_start_face
390+
on_end_face: on_end_face
391+
392+
Returns:
393+
None
394+
"""
395+
396+
```
397+
398+
## New Items
364399
### Functions geometry_controller
365400
#### get_round_machine_rough_part_negative_width
366401

@@ -554,7 +589,97 @@ def set_round_machine_rough_part_positive_length(elements: List[int], value:
554589

555590
```
556591

557-
## Missing Items
592+
#### get_standard_element_width_from_guid
593+
594+
```python
595+
def get_standard_element_width_from_guid(standard_element_guid: str) ->float:
596+
"""get standard element width from guid
597+
598+
Parameters:
599+
standard_element_guid: standard_element_guid
600+
601+
Returns:
602+
float
603+
"""
604+
605+
```
606+
607+
#### get_standard_element_height_from_guid
608+
609+
```python
610+
def get_standard_element_height_from_guid(standard_element_guid: str) ->float:
611+
"""get standard element height from guid
612+
613+
Parameters:
614+
standard_element_guid: standard_element_guid
615+
616+
Returns:
617+
float
618+
"""
619+
620+
```
621+
622+
#### get_standard_element_length_from_guid
623+
624+
```python
625+
def get_standard_element_length_from_guid(standard_element_guid: str) ->float:
626+
"""get standard element length from guid
627+
628+
Parameters:
629+
standard_element_guid: standard_element_guid
630+
631+
Returns:
632+
float
633+
"""
634+
635+
```
636+
637+
#### get_standard_element_width_from_name
638+
639+
```python
640+
def get_standard_element_width_from_name(standard_element_name: str) ->float:
641+
"""get standard element width from name
642+
643+
Parameters:
644+
standard_element_name: standard_element_name
645+
646+
Returns:
647+
float
648+
"""
649+
650+
```
651+
652+
#### get_standard_element_height_from_name
653+
654+
```python
655+
def get_standard_element_height_from_name(standard_element_name: str) ->float:
656+
"""get standard element height from name
657+
658+
Parameters:
659+
standard_element_name: standard_element_name
660+
661+
Returns:
662+
float
663+
"""
664+
665+
```
666+
667+
#### get_standard_element_length_from_name
668+
669+
```python
670+
def get_standard_element_length_from_name(standard_element_name: str) ->float:
671+
"""get standard element length from name
672+
673+
Parameters:
674+
standard_element_name: standard_element_name
675+
676+
Returns:
677+
float
678+
"""
679+
680+
```
681+
682+
## New Items
558683
### Functions list_controller
559684
#### export_cover_list
560685

@@ -590,7 +715,7 @@ def export_cover_list_with_settings(element_id_list: List[int], file_path:
590715

591716
```
592717

593-
## Missing Items
718+
## New Items
594719
### Functions material_controller
595720
#### get_material_color_assignment_for_nodes
596721

@@ -1027,7 +1152,7 @@ def set_texture_zoom_y(a0: int, a1: float) ->None:
10271152

10281153
```
10291154

1030-
## Missing Items
1155+
## New Items
10311156
### Functions scene_controller
10321157
#### is_scene_present
10331158

@@ -1044,7 +1169,89 @@ def is_scene_present(name: str) ->bool:
10441169

10451170
```
10461171

1047-
## Missing Items
1172+
#### set_group_tab_color
1173+
1174+
```python
1175+
def set_group_tab_color(scene_group_name: str, red: int, green: int, blue: int
1176+
) ->None:
1177+
"""set group tab color
1178+
1179+
Parameters:
1180+
scene_group_name: scene_group_name
1181+
red: red
1182+
green: green
1183+
blue: blue
1184+
1185+
Returns:
1186+
None
1187+
"""
1188+
1189+
```
1190+
1191+
#### rename_scene_group
1192+
1193+
```python
1194+
def rename_scene_group(old_name: str, new_name: str) ->None:
1195+
"""rename scene group
1196+
1197+
Parameters:
1198+
old_name: old_name
1199+
new_name: new_name
1200+
1201+
Returns:
1202+
None
1203+
"""
1204+
1205+
```
1206+
1207+
#### get_group_index_by_name
1208+
1209+
```python
1210+
def get_group_index_by_name(scene_group_name: str) ->int:
1211+
"""get group index by name
1212+
1213+
Parameters:
1214+
scene_group_name: scene_group_name
1215+
1216+
Returns:
1217+
int
1218+
"""
1219+
1220+
```
1221+
1222+
#### rename_scene_group_by_index
1223+
1224+
```python
1225+
def rename_scene_group_by_index(group_index: int, new_name: str) ->None:
1226+
"""rename scene group by index
1227+
1228+
Parameters:
1229+
group_index: group_index
1230+
new_name: new_name
1231+
1232+
Returns:
1233+
None
1234+
"""
1235+
1236+
```
1237+
1238+
#### group_scences_with_name
1239+
1240+
```python
1241+
def group_scences_with_name(a0: List[str], a1: str) ->int:
1242+
"""group scences with name
1243+
1244+
Parameters:
1245+
a0: a0
1246+
a1: a1
1247+
1248+
Returns:
1249+
int
1250+
"""
1251+
1252+
```
1253+
1254+
## New Items
10481255
### Functions utility_controller
10491256
#### get_3d_main_window_geometry
10501257

@@ -1058,7 +1265,19 @@ def get_3d_main_window_geometry() ->'window_geometry':
10581265

10591266
```
10601267

1061-
## Missing Items
1268+
#### get_project_data_keys
1269+
1270+
```python
1271+
def get_project_data_keys() ->List[str]:
1272+
"""get project data keys
1273+
1274+
Returns:
1275+
List[str]
1276+
"""
1277+
1278+
```
1279+
1280+
## New Items
10621281
### Classes cadwork
10631282
#### coordinate_system_data
10641283

@@ -1088,7 +1307,7 @@ class coordinate_system_data:
10881307

10891308
```
10901309

1091-
## Missing Items
1310+
## New Items
10921311
### Classes cadwork
10931312
#### ifc_predefined_type
10941313

@@ -3330,8 +3549,39 @@ class ifc_predefined_type:
33303549

33313550
```
33323551

3333-
## Missing Items
3334-
## Missing Items
3552+
## New Items
3553+
### Classes cadwork
3554+
#### multi_layer_type
3555+
3556+
```python
3557+
@unique
3558+
class multi_layer_type(IntEnum):
3559+
"""multi layer type
3560+
3561+
Examples:
3562+
>>> cadwork.multi_layer_type.undefined
3563+
undefined
3564+
"""
3565+
undefined = 0
3566+
""""""
3567+
structure = 1
3568+
""""""
3569+
panel = 2
3570+
""""""
3571+
lathing = 3
3572+
""""""
3573+
air = 4
3574+
""""""
3575+
covering = 5
3576+
""""""
3577+
3578+
def __int__(self) ->int:
3579+
return self.value
3580+
3581+
```
3582+
3583+
## New Items
3584+
## New Items
33353585
### Classes cadwork
33363586
#### standard_element_type
33373587

@@ -3362,7 +3612,7 @@ class standard_element_type(IntEnum):
33623612

33633613
```
33643614

3365-
## Missing Items
3615+
## New Items
33663616
### Classes cadwork
33673617
#### window_geometry
33683618

@@ -3385,3 +3635,5 @@ class window_geometry:
33853635
```
33863636

33873637

3638+
3639+

0 commit comments

Comments
 (0)