Skip to content

Utility Controller

api_autostart(api_name, option)

api autostart

Parameters:

Name Type Description Default
api_name str

api_name

 required
option int

option

 required

Returns:

Type Description
int

int
Source code in src/utility_controller/__init__.pyi 
345
346
347
348
349
350
351
352
353
354
def api_autostart(api_name: str, option: int) -> int:
    """api autostart

    Parameters:
        api_name: api_name
        option: option

    Returns:
        int
    """

change_check_and_query_data_to_no_queries()

change check and query data to no queries

Returns:

Type Description
None

None
Source code in src/utility_controller/__init__.pyi 
527
528
529
530
531
532
def change_check_and_query_data_to_no_queries() -> None:
    """change check and query data to no queries

    Returns:
        None
    """

change_check_and_query_data_to_queries()

change check and query data to queries

Returns:

Type Description
None

None
Source code in src/utility_controller/__init__.pyi 
534
535
536
537
538
539
def change_check_and_query_data_to_queries() -> None:
    """change check and query data to queries

    Returns:
        None
    """

check_autostart(api_name)

check autostart

Parameters:

Name Type Description Default
api_name str

api_name

 required

Returns:

Type Description
bool

bool
Source code in src/utility_controller/__init__.pyi 
376
377
378
379
380
381
382
383
384
def check_autostart(api_name: str) -> bool:
    """check autostart

    Parameters:
        api_name: api_name

    Returns:
        bool
    """

clear_errors()

clear errors

Returns:

Type Description
None

None
Source code in src/utility_controller/__init__.pyi 
506
507
508
509
510
511
def clear_errors() -> None:
    """clear errors

    Returns:
        None
    """

close_cadwork_document_saved()

close cadwork saved

Returns:

Type Description
None

None
Source code in src/utility_controller/__init__.pyi 
984
985
986
987
988
989
def close_cadwork_document_saved() -> None:
    """close cadwork saved

    Returns:
        None
    """

close_cadwork_document_unsaved()

close cadwork document unsaved

Returns:

Type Description
None

None
Source code in src/utility_controller/__init__.pyi 
991
992
993
994
995
996
def close_cadwork_document_unsaved() -> None:
    """close cadwork document unsaved

    Returns:
        None
    """

create_new_guid()

Creates a new GUID

Returns:

Type Description
str

GUID
Source code in src/utility_controller/__init__.pyi 
307
308
309
310
311
312
def create_new_guid() -> str:
    """Creates a new GUID

    Returns:
        GUID
    """

create_snapshot()

get snapshot from screen

Returns:

Type Description
str

snapshot
Source code in src/utility_controller/__init__.pyi 
1032
1033
1034
1035
1036
1037
def create_snapshot() -> str:
    """get snapshot from screen

    Returns:
        snapshot
    """

delete_project_data(element_id)

Deletes the project data

Parameters:

Name Type Description Default
element_id str

element_id

 required

Returns:

Type Description
None

None
Source code in src/utility_controller/__init__.pyi 
386
387
388
389
390
391
392
393
394
def delete_project_data(element_id: str) -> None:
    """Deletes the project data

    Parameters:
        element_id: element_id

    Returns:
        None
    """

disable_auto_display_refresh()

Disables automatic display refresh

Returns:

Type Description
None

None
Source code in src/utility_controller/__init__.pyi 
293
294
295
296
297
298
def disable_auto_display_refresh() -> None:
    """Disables automatic display refresh

    Returns:
        None
    """

disable_autostart(api_name)

disable autostart

Parameters:

Name Type Description Default
api_name str

api_name

 required

Returns:

Type Description
None

None
Source code in src/utility_controller/__init__.pyi 
366
367
368
369
370
371
372
373
374
def disable_autostart(api_name: str) -> None:
    """disable autostart

    Parameters:
        api_name: api_name

    Returns:
        None
    """

disable_direct_info()

disable direct info

Returns:

Type Description
None

None
Source code in src/utility_controller/__init__.pyi 
555
556
557
558
559
560
def disable_direct_info() -> None:
    """disable direct info

    Returns:
        None
    """

disable_update_variant()

disable update variant

Returns:

Type Description
None

None
Source code in src/utility_controller/__init__.pyi 
725
726
727
728
729
730
def disable_update_variant() -> None:
    """disable update variant

    Returns:
        None
    """

enable_auto_display_refresh()

Enables automatic display refresh

Returns:

Type Description
None

None
Source code in src/utility_controller/__init__.pyi 
300
301
302
303
304
305
def enable_auto_display_refresh() -> None:
    """Enables automatic display refresh

    Returns:
        None
    """

enable_autostart(api_name)

enable autostart

Parameters:

Name Type Description Default
api_name str

api_name

 required

Returns:

Type Description
None

None
Source code in src/utility_controller/__init__.pyi 
356
357
358
359
360
361
362
363
364
def enable_autostart(api_name: str) -> None:
    """enable autostart

    Parameters:
        api_name: api_name

    Returns:
        None
    """

enable_direct_info()

enable direct info

Returns:

Type Description
None

None
Source code in src/utility_controller/__init__.pyi 
548
549
550
551
552
553
def enable_direct_info() -> None:
    """enable direct info

    Returns:
        None
    """

enable_update_variant()

enable update variant

Returns:

Type Description
None

None
Source code in src/utility_controller/__init__.pyi 
718
719
720
721
722
723
def enable_update_variant() -> None:
    """enable update variant

    Returns:
        None
    """

execute_shortcut(a0, a1)

execute shortcut

Parameters:

Name Type Description Default
a0 int

a0

 required
a1 int

a1

 required

Returns:

Type Description
None

None
Source code in src/utility_controller/__init__.pyi 
766
767
768
769
770
771
772
773
774
775
def execute_shortcut(a0: int, a1: int) -> None:
    """execute shortcut

    Parameters:
        a0: a0
        a1: a1

    Returns:
        None
    """

export_screen_to_image(file_path, factor)

Exports the screen to an image

Parameters:

Name Type Description Default
file_path str

file_path

 required
factor int

factor

 required

Returns:

Type Description
None

None
Source code in src/utility_controller/__init__.pyi 
324
325
326
327
328
329
330
331
332
333
def export_screen_to_image(file_path: str, factor: int) -> None:
    """Exports the screen to an image

    Parameters:
        file_path: file_path
        factor: factor

    Returns:
        None
    """

get_3d_angular_display_units()

Gets the current angular display units

Returns:

Type Description
str

str
Source code in src/utility_controller/__init__.pyi 
482
483
484
485
486
487
def get_3d_angular_display_units() -> str:
    """Gets the current angular display units

    Returns:
        str
    """

get_3d_angular_units()

Gets the current angular units

Returns:

Type Description
str

str
Source code in src/utility_controller/__init__.pyi 
475
476
477
478
479
480
def get_3d_angular_units() -> str:
    """Gets the current angular units

    Returns:
        str
    """

get_3d_build()

Gets the 3D build

Returns:

Type Description
int

3D build
Source code in src/utility_controller/__init__.pyi 
23
24
25
26
27
28
def get_3d_build() -> int:
    """Gets the 3D build

    Returns:
        3D build
    """

get_3d_build_date()

Gets the current build date

Returns:

Type Description
str

str
Source code in src/utility_controller/__init__.pyi 
489
490
491
492
493
494
def get_3d_build_date() -> str:
    """Gets the current build date

    Returns:
        str
    """

get_3d_file_name()

Gets the 3D file name

Returns:

Type Description
str

3D file name
Source code in src/utility_controller/__init__.pyi 
787
788
789
790
791
792
def get_3d_file_name() -> str:
    """Gets the 3D file name

    Returns:
        3D file name
    """

get_3d_file_path()

Gets the 3D file path

Returns:

Type Description
str

3D file path
Source code in src/utility_controller/__init__.pyi 
30
31
32
33
34
35
def get_3d_file_path() -> str:
    """Gets the 3D file path

    Returns:
        3D file path
    """

get_3d_gui_upper_left_screen_coordinates()

get 3d gui upper left screen coordinates

Returns:

Type Description
Tuple[int, int]

coordinates of the upper left corner of the 3D GUI
Source code in src/utility_controller/__init__.pyi 
1039
1040
1041
1042
1043
1044
def get_3d_gui_upper_left_screen_coordinates() -> Tuple[int, int]:
    """get 3d gui upper left screen coordinates

    Returns:
        coordinates of the upper left corner of the 3D GUI
    """

get_3d_hwnd()

Gets the 3D HWND

Returns:

Type Description
int

3D HWND
Source code in src/utility_controller/__init__.pyi 
977
978
979
980
981
982
def get_3d_hwnd() -> int:
    """Gets the 3D HWND

    Returns:
        3D HWND
    """

get_3d_linear_display_units()

Gets the current display units

Returns:

Type Description
str

str
Source code in src/utility_controller/__init__.pyi 
468
469
470
471
472
473
def get_3d_linear_display_units() -> str:
    """Gets the current display units

    Returns:
        str
    """

get_3d_linear_units()

Gets the current linear units

Returns:

Type Description
str

str
Source code in src/utility_controller/__init__.pyi 
461
462
463
464
465
466
def get_3d_linear_units() -> str:
    """Gets the current linear units

    Returns:
        str
    """

get_3d_main_window_geometry()

get 3d main window geometry

Returns:

Type Description
window_geometry

window geometry
Source code in src/utility_controller/__init__.pyi 
1046
1047
1048
1049
1050
1051
def get_3d_main_window_geometry() -> 'window_geometry':
    """get 3d main window geometry

    Returns:
        window geometry
    """

get_3d_userprofil_path()

Gets the 3D userprofil path

Returns:

Type Description
str

the 3D userprofil path
Source code in src/utility_controller/__init__.pyi 
936
937
938
939
940
941
def get_3d_userprofil_path() -> str:
    """Gets the 3D userprofil path

    Returns:
        the 3D userprofil path
    """

get_3d_version()

Gets the 3D version

Returns:

Type Description
int

3D version
Source code in src/utility_controller/__init__.pyi 
16
17
18
19
20
21
def get_3d_version() -> int:
    """Gets the 3D version

    Returns:
        3D version
    """

get_client_number()

Gets the client number

Returns:

Type Description
str

client number
Source code in src/utility_controller/__init__.pyi 
279
280
281
282
283
284
def get_client_number() -> str:
    """Gets the client number

    Returns:
        client number
    """

get_global_origin()

Gets the global origin

Returns:

Type Description
point_3d

global origin
Source code in src/utility_controller/__init__.pyi 
1015
1016
1017
1018
1019
1020
def get_global_origin() -> point_3d:
    """Gets the global origin

    Returns:
        global origin
    """

get_global_x_offset()

get global x offset

Returns:

Type Description
float

float
Source code in src/utility_controller/__init__.pyi 
607
608
609
610
611
612
def get_global_x_offset() -> float:
    """get global x offset

    Returns:
        float
    """

get_global_y_offset()

get global y offset

Returns:

Type Description
float

float
Source code in src/utility_controller/__init__.pyi 
624
625
626
627
628
629
def get_global_y_offset() -> float:
    """get global y offset

    Returns:
        float
    """

get_global_z_offset()

get global z offset

Returns:

Type Description
float

float
Source code in src/utility_controller/__init__.pyi 
641
642
643
644
645
646
def get_global_z_offset() -> float:
    """get global z offset

    Returns:
        float
    """

get_imperial_string_from_millimetre(value)

get imperial string from millimetre

Parameters:

Name Type Description Default
value float

value

 required

Returns:

Type Description
str

str
Source code in src/utility_controller/__init__.pyi 
960
961
962
963
964
965
966
967
968
def get_imperial_string_from_millimetre(value: float) -> str:
    """get imperial string from millimetre

    Parameters:
        value: value

    Returns:
        str
    """

get_language()

Gets the 3D language

Returns:

Type Description
str

3D language
Source code in src/utility_controller/__init__.pyi 
58
59
60
61
62
63
def get_language() -> str:
    """Gets the 3D language

    Returns:
        3D language
    """

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

    Parameters:
        error_code: error_code

    Returns:
        error string
    """

get_licence_first_part()

Gets the first part of the licence

Returns:

Type Description
str

first part of licence
Source code in src/utility_controller/__init__.pyi 
413
414
415
416
417
418
def get_licence_first_part() -> str:
    """Gets the first part of the licence

    Returns:
        first part of licence
    """

get_licence_second_part()

Gets the second part of the licence

Returns:

Type Description
str

second part of licence
Source code in src/utility_controller/__init__.pyi 
420
421
422
423
424
425
def get_licence_second_part() -> str:
    """Gets the second part of the licence

    Returns:
        second part of licence
    """

get_millimetre_from_imperial_string(value)

get millimetre from imperial string

Parameters:

Name Type Description Default
value str

value

 required

Returns:

Type Description
float

float
Source code in src/utility_controller/__init__.pyi 
950
951
952
953
954
955
956
957
958
def get_millimetre_from_imperial_string(value: str) -> float:
    """get millimetre from imperial string

    Parameters:
        value: value

    Returns:
        float
    """

get_new_user_file_from_dialog(name_filter)

Gets a new file with a dialog

Parameters:

Name Type Description Default
name_filter str

name_filter

 required

Returns:

Type Description
str

file path
Source code in src/utility_controller/__init__.pyi 
335
336
337
338
339
340
341
342
343
def get_new_user_file_from_dialog(name_filter: str) -> str:
    """Gets a new file with a dialog

    Parameters:
        name_filter: name_filter

    Returns:
        file path
    """

get_new_user_file_from_dialog_in_path(name_filter, path)

get new user file from dialog in path

Parameters:

Name Type Description Default
name_filter str

name_filter

 required
path str

path

 required

Returns:

Type Description
str

str
Source code in src/utility_controller/__init__.pyi 
707
708
709
710
711
712
713
714
715
716
def get_new_user_file_from_dialog_in_path(name_filter: str, path: str) -> str:
    """get new user file from dialog in path

    Parameters:
        name_filter: name_filter
        path: path

    Returns:
        str
    """

get_north_angle()

get north angle

Returns:

Type Description
float

float
Source code in src/utility_controller/__init__.pyi 
679
680
681
682
683
684
def get_north_angle() -> float:
    """get north angle

    Returns:
        float
    """

get_plugin_path()

get plugin path

Returns:

Type Description
str

str
Source code in src/utility_controller/__init__.pyi 
943
944
945
946
947
948
def get_plugin_path() -> str:
    """get plugin path

    Returns:
        str
    """

get_project_address()

Gets the project address

Returns:

Type Description
str

project address
Source code in src/utility_controller/__init__.pyi 
894
895
896
897
898
899
def get_project_address() -> str:
    """Gets the project address

    Returns:
        project address
    """

get_project_architect()

Gets the project architect

Returns:

Type Description
str

project architect
Source code in src/utility_controller/__init__.pyi 
818
819
820
821
822
823
def get_project_architect() -> str:
    """Gets the project architect

    Returns:
        project architect
    """

get_project_city()

Gets the project city

Returns:

Type Description
str

project city
Source code in src/utility_controller/__init__.pyi 
901
902
903
904
905
906
def get_project_city() -> str:
    """Gets the project city

    Returns:
        project city
    """

get_project_country()

Gets the project country

Returns:

Type Description
str

project country
Source code in src/utility_controller/__init__.pyi 
908
909
910
911
912
913
def get_project_country() -> str:
    """Gets the project country

    Returns:
        project country
    """

get_project_customer()

Gets the project customer

Returns:

Type Description
str

project customer
Source code in src/utility_controller/__init__.pyi 
832
833
834
835
836
837
def get_project_customer() -> str:
    """Gets the project customer

    Returns:
        project customer
    """

get_project_data(element_id)

Gets the project data

Parameters:

Name Type Description Default
element_id str

element_id

 required

Returns:

Type Description
str

project data
Source code in src/utility_controller/__init__.pyi 
794
795
796
797
798
799
800
801
802
def get_project_data(element_id: str) -> str:
    """Gets the project data

    Parameters:
        element_id: element_id

    Returns:
        project data
    """

get_project_data_keys()

get project data keys

Returns:

Type Description
List[str]

List[str]
Source code in src/utility_controller/__init__.pyi 
1053
1054
1055
1056
1057
1058
def get_project_data_keys() -> List[str]:
    """get project data keys

    Returns:
        List[str]
    """

get_project_deadline()

Gets the project deadline

Returns:

Type Description
str

project deadline
Source code in src/utility_controller/__init__.pyi 
846
847
848
849
850
851
def get_project_deadline() -> str:
    """Gets the project deadline

    Returns:
        project deadline
    """

get_project_description()

get project description

Returns:

Type Description
str

str
Source code in src/utility_controller/__init__.pyi 
922
923
924
925
926
927
def get_project_description() -> str:
    """get project description

    Returns:
        str
    """

get_project_designer()

Gets the project designer

Returns:

Type Description
str

project designer
Source code in src/utility_controller/__init__.pyi 
839
840
841
842
843
844
def get_project_designer() -> str:
    """Gets the project designer

    Returns:
        project designer
    """

get_project_elevation()

Gets the project elevation

Returns:

Type Description
float

project elevation
Source code in src/utility_controller/__init__.pyi 
915
916
917
918
919
920
def get_project_elevation() -> float:
    """Gets the project elevation

    Returns:
        project elevation
    """

get_project_guid()

Gets the project GUID

Returns:

Type Description
str

project GUID
Source code in src/utility_controller/__init__.pyi 
929
930
931
932
933
934
def get_project_guid() -> str:
    """Gets the project GUID

    Returns:
        project GUID
    """

get_project_latitude()

Gets the project latitude

Returns:

Type Description
float

project latitude
Source code in src/utility_controller/__init__.pyi 
873
874
875
876
877
878
def get_project_latitude() -> float:
    """Gets the project latitude

    Returns:
        project latitude
    """

get_project_longitude()

Gets the project longitude

Returns:

Type Description
float

project longitude
Source code in src/utility_controller/__init__.pyi 
880
881
882
883
884
885
def get_project_longitude() -> float:
    """Gets the project longitude

    Returns:
        project longitude
    """

get_project_name()

Gets the project name

Returns:

Type Description
str

project name
Source code in src/utility_controller/__init__.pyi 
804
805
806
807
808
809
def get_project_name() -> str:
    """Gets the project name

    Returns:
        project name
    """

get_project_number()

Gets the project number

Returns:

Type Description
str

project number
Source code in src/utility_controller/__init__.pyi 
825
826
827
828
829
830
def get_project_number() -> str:
    """Gets the project number

    Returns:
        project number
    """

get_project_part()

Sets the project part

Returns:

Type Description
str

project part
Source code in src/utility_controller/__init__.pyi 
811
812
813
814
815
816
def get_project_part() -> str:
    """Sets the project part

    Returns:
        project part
    """

get_project_postal_code()

Gets the project postal code

Returns:

Type Description
str

project postal code
Source code in src/utility_controller/__init__.pyi 
887
888
889
890
891
892
def get_project_postal_code() -> str:
    """Gets the project postal code

    Returns:
        project postal code
    """

get_project_user_attribute(number)

Gets the project user attribute

Parameters:

Name Type Description Default
number int

number

 required

Returns:

Type Description
str

project user attribute
Source code in src/utility_controller/__init__.pyi 
853
854
855
856
857
858
859
860
861
def get_project_user_attribute(number: int) -> str:
    """Gets the project user attribute

    Parameters:
        number: number

    Returns:
        project user attribute
    """

get_project_user_attribute_name(number)

Gets the project user attribute name

Parameters:

Name Type Description Default
number int

number

 required

Returns:

Type Description
str

project user attribute name
Source code in src/utility_controller/__init__.pyi 
863
864
865
866
867
868
869
870
871
def get_project_user_attribute_name(number: int) -> str:
    """Gets the project user attribute name

    Parameters:
        number: number

    Returns:
        project user attribute name
    """

get_use_of_global_coordinates()

get use of global coordinates

Returns:

Type Description
bool

bool
Source code in src/utility_controller/__init__.pyi 
 998
 999
1000
1001
1002
1003
def get_use_of_global_coordinates() -> bool:
    """get use of global coordinates

    Returns:
        bool
    """

get_user_bool(message, default_yes)

Prompts the user for a boolean

Parameters:

Name Type Description Default
message str

message

 required
default_yes bool

default_yes

 required

Returns:

Type Description
bool

user boolean
Source code in src/utility_controller/__init__.pyi 
 96
 97
 98
 99
100
101
102
103
104
105
def get_user_bool(message: str, default_yes: bool) -> bool:
    """Prompts the user for a boolean

    Parameters:
        message: message
        default_yes: default_yes

    Returns:
        user boolean
    """

get_user_catalog_path()

get user catalog path

Returns:

Type Description
str

str
Source code in src/utility_controller/__init__.pyi 
970
971
972
973
974
975
def get_user_catalog_path() -> str:
    """get user catalog path

    Returns:
        str
    """

get_user_color(initial_color)

Gets a color choosen by the user

Parameters:

Name Type Description Default
initial_color int

initial_color

 required

Returns:

Type Description
int

the colornumber
Source code in src/utility_controller/__init__.pyi 
451
452
453
454
455
456
457
458
459
def get_user_color(initial_color: int) -> int:
    """Gets a color choosen by the user

    Parameters:
        initial_color: initial_color

    Returns:
        the colornumber
    """

get_user_double(message)

Prompts the user for a double

Parameters:

Name Type Description Default
message str

message

 required

Returns:

Type Description
float

user double
Source code in src/utility_controller/__init__.pyi 
86
87
88
89
90
91
92
93
94
def get_user_double(message: str) -> float:
    """Prompts the user for a double

    Parameters:
        message: message

    Returns:
        user double
    """

get_user_file_from_dialog(name_filter)

Gets a file with a dialog

Parameters:

Name Type Description Default
name_filter str

name_filter

 required

Returns:

Type Description
str

file path
Source code in src/utility_controller/__init__.pyi 
269
270
271
272
273
274
275
276
277
def get_user_file_from_dialog(name_filter: str) -> str:
    """Gets a file with a dialog

    Parameters:
        name_filter: name_filter

    Returns:
        file path
    """

get_user_file_from_dialog_in_path(name_filter, path)

get user file from dialog in path

Parameters:

Name Type Description Default
name_filter str

name_filter

 required
path str

path

 required

Returns:

Type Description
str

str
Source code in src/utility_controller/__init__.pyi 
696
697
698
699
700
701
702
703
704
705
def get_user_file_from_dialog_in_path(name_filter: str, path: str) -> str:
    """get user file from dialog in path

    Parameters:
        name_filter: name_filter
        path: path

    Returns:
        str
    """

get_user_int(message)

Prompts the user for an integer

Parameters:

Name Type Description Default
message str

message

 required

Returns:

Type Description
int

user integer
Source code in src/utility_controller/__init__.pyi 
76
77
78
79
80
81
82
83
84
def get_user_int(message: str) -> int:
    """Prompts the user for an integer

    Parameters:
        message: message

    Returns:
        user integer
    """

get_user_path_from_dialog()

get user path from dialog

Returns:

Type Description
str

str
Source code in src/utility_controller/__init__.pyi 
749
750
751
752
753
754
def get_user_path_from_dialog() -> str:
    """get user path from dialog

    Returns:
        str
    """

get_user_path_from_dialog_in_path(a0)

get user path from dialog in path

Parameters:

Name Type Description Default
a0 str

a0

 required

Returns:

Type Description
str

str
Source code in src/utility_controller/__init__.pyi 
756
757
758
759
760
761
762
763
764
def get_user_path_from_dialog_in_path(a0: str) -> str:
    """get user path from dialog in path

    Parameters:
        a0: a0

    Returns:
        str
    """

get_user_point()

Gets a point from the user

Returns:

Type Description
point_3d

user point
Source code in src/utility_controller/__init__.pyi 
286
287
288
289
290
291
def get_user_point() -> point_3d:
    """Gets a point from the user

    Returns:
        user point
    """

get_user_points()

get user points

Returns:

Type Description
List[point_3d]

List[point_3d]
Source code in src/utility_controller/__init__.pyi 
732
733
734
735
736
737
def get_user_points() -> List[point_3d]:
    """get user points

    Returns:
        List[point_3d]
    """

get_user_points_with_count(a0)

get user points with count

Parameters:

Name Type Description Default
a0 int

a0

 required

Returns:

Type Description
List[point_3d]

List[point_3d]
Source code in src/utility_controller/__init__.pyi 
739
740
741
742
743
744
745
746
747
def get_user_points_with_count(a0: int) -> List[point_3d]:
    """get user points with count

    Parameters:
        a0: a0

    Returns:
        List[point_3d]
    """

get_user_string(message)

Prompts the user for a string

Parameters:

Name Type Description Default
message str

message

 required

Returns:

Type Description
str

user string
Source code in src/utility_controller/__init__.pyi 
107
108
109
110
111
112
113
114
115
def get_user_string(message: str) -> str:
    """Prompts the user for a string

    Parameters:
        message: message

    Returns:
        user string
    """

hide_north_arrow()

hide north arrow

Returns:

Type Description
None

None
Source code in src/utility_controller/__init__.pyi 
665
666
667
668
669
670
def hide_north_arrow() -> None:
    """hide north arrow

    Returns:
        None
    """

hide_progress_bar()

Hides the ProgressBar

Returns:

Type Description
None

None
Source code in src/utility_controller/__init__.pyi 
444
445
446
447
448
449
def hide_progress_bar() -> None:
    """Hides the ProgressBar

    Returns:
        None
    """

init_LxSDK()

init LxSDK

Returns:

Type Description
None

None
Source code in src/utility_controller/__init__.pyi 
589
590
591
592
593
594
def init_LxSDK() -> None:
    """init LxSDK

    Returns:
        None
    """

is_direct_info_enabled()

is direct info enabled

Returns:

Type Description
bool

bool
Source code in src/utility_controller/__init__.pyi 
541
542
543
544
545
546
def is_direct_info_enabled() -> bool:
    """is direct info enabled

    Returns:
        bool
    """

is_north_arrow_visible()

is north arrow visible

Returns:

Type Description
bool

bool
Source code in src/utility_controller/__init__.pyi 
672
673
674
675
676
677
def is_north_arrow_visible() -> bool:
    """is north arrow visible

    Returns:
        bool
    """

load_attribute_display_settings(file_path)

load attribute display settings

Parameters:

Name Type Description Default
file_path str

file_path

 required

Returns:

Type Description
None

None
Source code in src/utility_controller/__init__.pyi 
562
563
564
565
566
567
568
569
570
def load_attribute_display_settings(file_path: str) -> None:
    """load attribute display settings

    Parameters:
        file_path: file_path

    Returns:
        None
    """

load_element_attribute_display_settings(file_path, elements)

load element attribute display settings

Parameters:

Name Type Description Default
file_path str

file_path

 required
elements List[int]

elements

 required

Returns:

Type Description
None

None
Source code in src/utility_controller/__init__.pyi 
596
597
598
599
600
601
602
603
604
605
def load_element_attribute_display_settings(file_path: str, elements: List[int]) -> None:
    """load element attribute display settings

    Parameters:
        file_path: file_path
        elements: elements

    Returns:
        None
    """

pop_check_and_query_data()

pop check and query data

Returns:

Type Description
None

None
Source code in src/utility_controller/__init__.pyi 
520
521
522
523
524
525
def pop_check_and_query_data() -> None:
    """pop check and query data

    Returns:
        None
    """

print_error(message)

Prints an error

Parameters:

Name Type Description Default
message str

message

 required

Returns:

Type Description
None

None
Source code in src/utility_controller/__init__.pyi 
48
49
50
51
52
53
54
55
56
def print_error(message: str) -> None:
    """Prints an error

    Parameters:
        message: message

    Returns:
        None
    """

print_message(message, column)

Prints a message

Parameters:

Name Type Description Default
message str

message

 required
column int

column

 required

Returns:

Type Description
None

None
Source code in src/utility_controller/__init__.pyi 
65
66
67
68
69
70
71
72
73
74
def print_message(message: str, column: int) -> None:
    """Prints a message

    Parameters:
        message: message
        column: column

    Returns:
        None
    """

print_to_console(message)

Prints a message to the console

Parameters:

Name Type Description Default
message str

message

 required

Returns:

Type Description
None

None
Source code in src/utility_controller/__init__.pyi 
314
315
316
317
318
319
320
321
322
def print_to_console(message: str) -> None:
    """Prints a message to the console

    Parameters:
        message: message

    Returns:
        None
    """

push_check_and_query_data()

push check and query data

Returns:

Type Description
None

None
Source code in src/utility_controller/__init__.pyi 
513
514
515
516
517
518
def push_check_and_query_data() -> None:
    """push check and query data

    Returns:
        None
    """

run_external_program(name)

Runs a 3D external program

Parameters:

Name Type Description Default
name str

name

 required

Returns:

Type Description
bool

external program return
Source code in src/utility_controller/__init__.pyi 
396
397
398
399
400
401
402
403
404
def run_external_program(name: str) -> bool:
    """Runs a 3D external program

    Parameters:
        name: name

    Returns:
        external program return
    """

run_external_program_from_custom_directory(file_path)

Runs a 3D external program from a custom file path

Parameters:

Name Type Description Default
file_path str

file_path

 required

Returns:

Type Description
bool

external program return
Source code in src/utility_controller/__init__.pyi 
777
778
779
780
781
782
783
784
785
def run_external_program_from_custom_directory(file_path: str) -> bool:
    """Runs a 3D external program from a custom file path

    Parameters:
        file_path: file_path

    Returns:
        external program return
    """

save_3d_file_silently()

Saves the 3D file silently

Returns:

Type Description
None

None
Source code in src/utility_controller/__init__.pyi 
406
407
408
409
410
411
def save_3d_file_silently() -> None:
    """Saves the 3D file silently

    Returns:
        None
    """

set_global_origin(global_origin)

Sets the global origin

Parameters:

Name Type Description Default
global_origin point_3d

global_origin

 required

Returns:

Type Description
None

None
Source code in src/utility_controller/__init__.pyi 
1022
1023
1024
1025
1026
1027
1028
1029
1030
def set_global_origin(global_origin: point_3d) -> None:
    """Sets the global origin

    Parameters:
        global_origin: global_origin

    Returns:
        None
    """

set_global_x_offset(offset)

set global x offset

Parameters:

Name Type Description Default
offset float

offset

 required

Returns:

Type Description
None

None
Source code in src/utility_controller/__init__.pyi 
614
615
616
617
618
619
620
621
622
def set_global_x_offset(offset: float) -> None:
    """set global x offset

    Parameters:
        offset: offset

    Returns:
        None
    """

set_global_y_offset(offset)

set global y offset

Parameters:

Name Type Description Default
offset float

offset

 required

Returns:

Type Description
None

None
Source code in src/utility_controller/__init__.pyi 
631
632
633
634
635
636
637
638
639
def set_global_y_offset(offset: float) -> None:
    """set global y offset

    Parameters:
        offset: offset

    Returns:
        None
    """

set_global_z_offset(offset)

set global z offset

Parameters:

Name Type Description Default
offset float

offset

 required

Returns:

Type Description
None

None
Source code in src/utility_controller/__init__.pyi 
648
649
650
651
652
653
654
655
656
def set_global_z_offset(offset: float) -> None:
    """set global z offset

    Parameters:
        offset: offset

    Returns:
        None
    """

set_north_angle(north_angle)

set north angle

Parameters:

Name Type Description Default
north_angle float

north_angle

 required

Returns:

Type Description
None

None
Source code in src/utility_controller/__init__.pyi 
686
687
688
689
690
691
692
693
694
def set_north_angle(north_angle: float) -> None:
    """set north angle

    Parameters:
        north_angle: north_angle

    Returns:
        None
    """

set_project_address(address)

Sets the project address

Parameters:

Name Type Description Default
address str

address

 required

Returns:

Type Description
None

None
Source code in src/utility_controller/__init__.pyi 
229
230
231
232
233
234
235
236
237
def set_project_address(address: str) -> None:
    """Sets the project address

    Parameters:
        address: address

    Returns:
        None
    """

set_project_architect(project_architect)

Sets the project architect

Parameters:

Name Type Description Default
project_architect str

project_architect

 required

Returns:

Type Description
None

None
Source code in src/utility_controller/__init__.pyi 
147
148
149
150
151
152
153
154
155
def set_project_architect(project_architect: str) -> None:
    """Sets the project architect

    Parameters:
        project_architect: project_architect

    Returns:
        None
    """

set_project_city(city)

Sets the project city

Parameters:

Name Type Description Default
city str

city

 required

Returns:

Type Description
None

None
Source code in src/utility_controller/__init__.pyi 
249
250
251
252
253
254
255
256
257
def set_project_city(city: str) -> None:
    """Sets the project city

    Parameters:
        city: city

    Returns:
        None
    """

set_project_country(country)

Sets the project country

Parameters:

Name Type Description Default
country str

country

 required

Returns:

Type Description
None

None
Source code in src/utility_controller/__init__.pyi 
259
260
261
262
263
264
265
266
267
def set_project_country(country: str) -> None:
    """Sets the project country

    Parameters:
        country: country

    Returns:
        None
    """

set_project_customer(project_customer)

Sets the project customer

Parameters:

Name Type Description Default
project_customer str

project_customer

 required

Returns:

Type Description
None

None
Source code in src/utility_controller/__init__.pyi 
157
158
159
160
161
162
163
164
165
def set_project_customer(project_customer: str) -> None:
    """Sets the project customer

    Parameters:
        project_customer: project_customer

    Returns:
        None
    """

set_project_data(element_id, data)

Sets the project data

Parameters:

Name Type Description Default
element_id str

element_id

 required
data str

data

 required

Returns:

Type Description
None

None
Source code in src/utility_controller/__init__.pyi 
37
38
39
40
41
42
43
44
45
46
def set_project_data(element_id: str, data: str) -> None:
    """Sets the project data

    Parameters:
        element_id: element_id
        data: data

    Returns:
        None
    """

set_project_deadline(project_deadline)

Sets the project deadline

Parameters:

Name Type Description Default
project_deadline str

project_deadline

 required

Returns:

Type Description
None

None
Source code in src/utility_controller/__init__.pyi 
177
178
179
180
181
182
183
184
185
def set_project_deadline(project_deadline: str) -> None:
    """Sets the project deadline

    Parameters:
        project_deadline: project_deadline

    Returns:
        None
    """

set_project_description(description)

set project description

Parameters:

Name Type Description Default
description str

description

 required

Returns:

Type Description
None

None
Source code in src/utility_controller/__init__.pyi 
572
573
574
575
576
577
578
579
580
def set_project_description(description: str) -> None:
    """set project description

    Parameters:
        description: description

    Returns:
        None
    """

set_project_designer(project_designer)

Sets the project designer

Parameters:

Name Type Description Default
project_designer str

project_designer

 required

Returns:

Type Description
None

None
Source code in src/utility_controller/__init__.pyi 
167
168
169
170
171
172
173
174
175
def set_project_designer(project_designer: str) -> None:
    """Sets the project designer

    Parameters:
        project_designer: project_designer

    Returns:
        None
    """

set_project_elevation(elevation)

Sets the project elevation

Parameters:

Name Type Description Default
elevation float

elevation

 required

Returns:

Type Description
None

None
Source code in src/utility_controller/__init__.pyi 
496
497
498
499
500
501
502
503
504
def set_project_elevation(elevation: float) -> None:
    """Sets the project elevation

    Parameters:
        elevation: elevation

    Returns:
        None
    """

set_project_latitude(latitude)

Sets the project latitude

Parameters:

Name Type Description Default
latitude float

latitude

 required

Returns:

Type Description
None

None
Source code in src/utility_controller/__init__.pyi 
209
210
211
212
213
214
215
216
217
def set_project_latitude(latitude: float) -> None:
    """Sets the project latitude

    Parameters:
        latitude: latitude

    Returns:
        None
    """

set_project_longitude(longitude)

Sets the project longitude

Parameters:

Name Type Description Default
longitude float

longitude

 required

Returns:

Type Description
None

None
Source code in src/utility_controller/__init__.pyi 
219
220
221
222
223
224
225
226
227
def set_project_longitude(longitude: float) -> None:
    """Sets the project longitude

    Parameters:
        longitude: longitude

    Returns:
        None
    """

set_project_name(project_name)

Sets the project name

Parameters:

Name Type Description Default
project_name str

project_name

 required

Returns:

Type Description
None

None
Source code in src/utility_controller/__init__.pyi 
117
118
119
120
121
122
123
124
125
def set_project_name(project_name: str) -> None:
    """Sets the project name

    Parameters:
        project_name: project_name

    Returns:
        None
    """

set_project_number(project_number)

Sets the project number

Parameters:

Name Type Description Default
project_number str

project_number

 required

Returns:

Type Description
None

None
Source code in src/utility_controller/__init__.pyi 
127
128
129
130
131
132
133
134
135
def set_project_number(project_number: str) -> None:
    """Sets the project number

    Parameters:
        project_number: project_number

    Returns:
        None
    """

set_project_part(project_part)

Sets the project part

Parameters:

Name Type Description Default
project_part str

project_part

 required

Returns:

Type Description
None

None
Source code in src/utility_controller/__init__.pyi 
137
138
139
140
141
142
143
144
145
def set_project_part(project_part: str) -> None:
    """Sets the project part

    Parameters:
        project_part: project_part

    Returns:
        None
    """

set_project_postal_code(postal_code)

Sets the project postal code

Parameters:

Name Type Description Default
postal_code str

postal_code

 required

Returns:

Type Description
None

None
Source code in src/utility_controller/__init__.pyi 
239
240
241
242
243
244
245
246
247
def set_project_postal_code(postal_code: str) -> None:
    """Sets the project postal code

    Parameters:
        postal_code: postal_code

    Returns:
        None
    """

set_project_user_attribute(number, user_attribute)

Sets the project user attribute

Parameters:

Name Type Description Default
number int

number

 required
user_attribute str

user_attribute

 required

Returns:

Type Description
None

None
Source code in src/utility_controller/__init__.pyi 
187
188
189
190
191
192
193
194
195
196
def set_project_user_attribute(number: int, user_attribute: str) -> None:
    """Sets the project user attribute

    Parameters:
        number: number
        user_attribute: user_attribute

    Returns:
        None
    """

set_project_user_attribute_name(number, user_attribute_name)

Sets the project user attribute name

Parameters:

Name Type Description Default
number int

number

 required
user_attribute_name str

user_attribute_name

 required

Returns:

Type Description
None

None
Source code in src/utility_controller/__init__.pyi 
198
199
200
201
202
203
204
205
206
207
def set_project_user_attribute_name(number: int, user_attribute_name: str) -> None:
    """Sets the project user attribute name

    Parameters:
        number: number
        user_attribute_name: user_attribute_name

    Returns:
        None
    """

set_use_of_global_coordinates(use_of_global_coordinates)

Sets the use of global coordinates

Parameters:

Name Type Description Default
use_of_global_coordinates bool

use_of_global_coordinates

 required

Returns:

Type Description
None

None
Source code in src/utility_controller/__init__.pyi 
1005
1006
1007
1008
1009
1010
1011
1012
1013
def set_use_of_global_coordinates(use_of_global_coordinates: bool) -> None:
    """Sets the use of global coordinates

    Parameters:
        use_of_global_coordinates: use_of_global_coordinates

    Returns:
        None
    """

show_north_arrow()

show north arrow

Returns:

Type Description
None

None
Source code in src/utility_controller/__init__.pyi 
658
659
660
661
662
663
def show_north_arrow() -> None:
    """show north arrow

    Returns:
        None
    """

show_progress_bar()

Shows a ProgressBar in the CommandBar

Returns:

Type Description
None

None
Source code in src/utility_controller/__init__.pyi 
427
428
429
430
431
432
def show_progress_bar() -> None:
    """Shows a ProgressBar in the CommandBar

    Returns:
        None
    """

start_project_data_dialog()

start project data dialog

Returns:

Type Description
None

None
Source code in src/utility_controller/__init__.pyi 
582
583
584
585
586
587
def start_project_data_dialog() -> None:
    """start project data dialog

    Returns:
        None
    """

update_progress_bar(value)

Updates the ProgressBar with a value

Parameters:

Name Type Description Default
value int

value

 required

Returns:

Type Description
None

None
Source code in src/utility_controller/__init__.pyi 
434
435
436
437
438
439
440
441
442
def update_progress_bar(value: int) -> None:
    """Updates the ProgressBar with a value

    Parameters:
        value: value

    Returns:
        None
    """