Skip to content

Geometry Controller

apply_global_scale(element_id_list, scale, origin)

Applies a global scale to element

Parameters:

Name Type Description Default
element_id_list List[int]

element_id_list

 required
scale float

scale

 required
origin point_3d

origin

 required

Returns:

Type Description
None

None
Source code in src/geometry_controller/__init__.pyi 
167
168
169
170
171
172
173
174
175
176
177
def apply_global_scale(element_id_list: List[int], scale: float, origin: point_3d) -> None:
    """Applies a global scale to element

    Parameters:
        element_id_list: element_id_list
        scale: scale
        origin: origin

    Returns:
        None
    """

are_facets_coplanar(first_facet, second_facet)

Tests if facets are coplanar

Parameters:

Name Type Description Default
first_facet List[point_3d]

first_facet

 required
second_facet List[point_3d]

second_facet

 required

Returns:

Type Description
bool

facet coplanarity
Source code in src/geometry_controller/__init__.pyi 
826
827
828
829
830
831
832
833
834
835
def are_facets_coplanar(first_facet: List[point_3d], second_facet: List[point_3d]) -> bool:
    """Tests if facets are coplanar

    Parameters:
        first_facet: first_facet
        second_facet: second_facet

    Returns:
        facet coplanarity
    """

auto_regenerate_axes(element_id_list)

Automatically regenerates axes on element

Parameters:

Name Type Description Default
element_id_list List[int]

element_id_list

 required

Returns:

Type Description
None

None
Source code in src/geometry_controller/__init__.pyi 
179
180
181
182
183
184
185
186
187
def auto_regenerate_axes(element_id_list: List[int]) -> None:
    """Automatically regenerates axes on element

    Parameters:
        element_id_list: element_id_list

    Returns:
        None
    """

auto_regenerate_axes_silently(a0)

auto regenerate axes silently

Parameters:

Name Type Description Default
a0 List[int]

a0

 required

Returns:

Type Description
None

None
Source code in src/geometry_controller/__init__.pyi 
282
283
284
285
286
287
288
289
290
def auto_regenerate_axes_silently(a0: List[int]) -> None:
    """auto regenerate axes silently

    Parameters:
        a0: a0

    Returns:
        None
    """

clear_errors()

clear errors

Returns:

Type Description
None

None
Source code in src/geometry_controller/__init__.pyi 
264
265
266
267
268
269
def clear_errors() -> None:
    """clear errors

    Returns:
        None
    """

get_actual_physical_volume(element_id)

Gets actual physical volume (includes negative geometry operations, such as end-types, drillings, connectors, openings, and MEP elements) (it might also take into account different drilling bodies and counterbores in a connector)

Parameters:

Name Type Description Default
element_id int

element_id

 required

Returns:

Type Description
float

actual physical volume
Source code in src/geometry_controller/__init__.pyi 
816
817
818
819
820
821
822
823
824
def get_actual_physical_volume(element_id: int) -> float:
    """Gets actual physical volume (includes negative geometry operations, such as end-types, drillings, connectors, openings, and MEP elements) (it might also take into account different drilling bodies and counterbores in a connector)

    Parameters:
        element_id: element_id

    Returns:
        actual physical volume
    """

get_actual_physical_weight(a0)

get actual physical weight

Parameters:

Name Type Description Default
a0 int

a0

 required

Returns:

Type Description
float

float
Source code in src/geometry_controller/__init__.pyi 
806
807
808
809
810
811
812
813
814
def get_actual_physical_weight(a0: int) -> float:
    """get actual physical weight

    Parameters:
        a0: a0

    Returns:
        float
    """

get_area_of_front_face(element)

Gets the front face are for element

Parameters:

Name Type Description Default
element int

element

 required

Returns:

Type Description
float

element front face area
Source code in src/geometry_controller/__init__.pyi 
685
686
687
688
689
690
691
692
693
def get_area_of_front_face(element: int) -> float:
    """Gets the front face are for element

    Parameters:
        element: element

    Returns:
        element front face area
    """

get_center_of_gravity(element_id)

Gets the element center of gravity

Parameters:

Name Type Description Default
element_id int

element_id

 required

Returns:

Type Description
point_3d

element center of gravity
Source code in src/geometry_controller/__init__.pyi 
594
595
596
597
598
599
600
601
602
def get_center_of_gravity(element_id: int) -> point_3d:
    """Gets the element center of gravity

    Parameters:
        element_id: element_id

    Returns:
        element center of gravity
    """

get_center_of_gravity_for_list(elements)

get center of gravity for list

Parameters:

Name Type Description Default
elements List[int]

elements

 required

Returns:

Type Description
point_3d

point_3d
Source code in src/geometry_controller/__init__.pyi 
766
767
768
769
770
771
772
773
774
def get_center_of_gravity_for_list(elements: List[int]) -> point_3d:
    """get center of gravity for list

    Parameters:
        elements: elements

    Returns:
        point_3d
    """

get_center_of_gravity_for_list_considering_materials(elements)

get center of gravity for list considering materials

Parameters:

Name Type Description Default
elements List[int]

elements

 required

Returns:

Type Description
point_3d

point_3d
Source code in src/geometry_controller/__init__.pyi 
776
777
778
779
780
781
782
783
784
def get_center_of_gravity_for_list_considering_materials(elements: List[int]) -> point_3d:
    """get center of gravity for list considering materials

    Parameters:
        elements: elements

    Returns:
        point_3d
    """

get_cross_correction_negative_height(element_id)

Gets the element negative height cross correction

Parameters:

Name Type Description Default
element_id int

element_id

 required

Returns:

Type Description
float

element negative height cross correction
Source code in src/geometry_controller/__init__.pyi 
484
485
486
487
488
489
490
491
492
def get_cross_correction_negative_height(element_id: int) -> float:
    """Gets the element negative height cross correction

    Parameters:
        element_id: element_id

    Returns:
        element negative height cross correction
    """

get_cross_correction_negative_length(element_id)

Gets the element negative length cross correction

Parameters:

Name Type Description Default
element_id int

element_id

 required

Returns:

Type Description
float

element negative length cross correction
Source code in src/geometry_controller/__init__.pyi 
504
505
506
507
508
509
510
511
512
def get_cross_correction_negative_length(element_id: int) -> float:
    """Gets the element negative length cross correction

    Parameters:
        element_id: element_id

    Returns:
        element negative length cross correction
    """

get_cross_correction_negative_width(element_id)

Gets the element negative width cross correction

Parameters:

Name Type Description Default
element_id int

element_id

 required

Returns:

Type Description
float

element negative width cross correction
Source code in src/geometry_controller/__init__.pyi 
464
465
466
467
468
469
470
471
472
def get_cross_correction_negative_width(element_id: int) -> float:
    """Gets the element negative width cross correction

    Parameters:
        element_id: element_id

    Returns:
        element negative width cross correction
    """

get_cross_correction_positive_height(element_id)

Gets the element positive height cross correction

Parameters:

Name Type Description Default
element_id int

element_id

 required

Returns:

Type Description
float

element positive height cross correction
Source code in src/geometry_controller/__init__.pyi 
494
495
496
497
498
499
500
501
502
def get_cross_correction_positive_height(element_id: int) -> float:
    """Gets the element positive height cross correction

    Parameters:
        element_id: element_id

    Returns:
        element positive height cross correction
    """

get_cross_correction_positive_length(element_id)

Gets the element positive length cross correction

Parameters:

Name Type Description Default
element_id int

element_id

 required

Returns:

Type Description
float

element positive length cross correction
Source code in src/geometry_controller/__init__.pyi 
514
515
516
517
518
519
520
521
522
def get_cross_correction_positive_length(element_id: int) -> float:
    """Gets the element positive length cross correction

    Parameters:
        element_id: element_id

    Returns:
        element positive length cross correction
    """

get_cross_correction_positive_width(element_id)

Gets the element positive width cross correction

Parameters:

Name Type Description Default
element_id int

element_id

 required

Returns:

Type Description
float

element positive width cross correction
Source code in src/geometry_controller/__init__.pyi 
474
475
476
477
478
479
480
481
482
def get_cross_correction_positive_width(element_id: int) -> float:
    """Gets the element positive width cross correction

    Parameters:
        element_id: element_id

    Returns:
        element positive width cross correction
    """

get_door_surface(elements)

Gets the element door surface

Parameters:

Name Type Description Default
elements List[int]

elements

 required

Returns:

Type Description
float

element door surface
Source code in src/geometry_controller/__init__.pyi 
695
696
697
698
699
700
701
702
703
def get_door_surface(elements: List[int]) -> float:
    """Gets the element door surface

    Parameters:
        elements: elements

    Returns:
        element door surface
    """

get_drilling_tolerance(element)

Gets the drilling tolerance of an axis

Parameters:

Name Type Description Default
element int

element

 required

Returns:

Type Description
float

the drilling tolerance
Source code in src/geometry_controller/__init__.pyi 
736
737
738
739
740
741
742
743
744
def get_drilling_tolerance(element: int) -> float:
    """Gets the drilling tolerance of an axis

    Parameters:
        element: element

    Returns:
        the drilling tolerance
    """

get_element_facet_count(element_id)

get element facet count

Parameters:

Name Type Description Default
element_id int

element_id

 required

Returns:

Type Description
int

int
Source code in src/geometry_controller/__init__.pyi 
786
787
788
789
790
791
792
793
794
def get_element_facet_count(element_id: int) -> int:
    """get element facet count

    Parameters:
        element_id: element_id

    Returns:
        int
    """

get_element_facets(element_id)

Gets the element facets

Parameters:

Name Type Description Default
element_id int

element_id

 required

Returns:

Type Description
facet_list

element facets
Source code in src/geometry_controller/__init__.pyi 
624
625
626
627
628
629
630
631
632
def get_element_facets(element_id: int) -> facet_list:
    """Gets the element facets

    Parameters:
        element_id: element_id

    Returns:
        element facets
    """

get_element_reference_face_area(element_id)

Gets the area of the reference side

Parameters:

Name Type Description Default
element_id int

element_id

 required

Returns:

Type Description
float

area(size) of reference face
Source code in src/geometry_controller/__init__.pyi 
756
757
758
759
760
761
762
763
764
def get_element_reference_face_area(element_id: int) -> float:
    """Gets the area of the reference side

    Parameters:
        element_id: element_id

    Returns:
        area(size) of reference face
    """

get_element_reference_face_vertices(element_id)

Gets the vertices of the reference side

Parameters:

Name Type Description Default
element_id int

element_id

 required

Returns:

Type Description
List[point_3d]

vertexlist of all points
Source code in src/geometry_controller/__init__.pyi 
746
747
748
749
750
751
752
753
754
def get_element_reference_face_vertices(element_id: int) -> List[point_3d]:
    """Gets the vertices of the reference side

    Parameters:
        element_id: element_id

    Returns:
        vertexlist of all points
    """

get_element_vertices(element_id)

Gets the element vertices

Parameters:

Name Type Description Default
element_id int

element_id

 required

Returns:

Type Description
List[point_3d]

element vertices
Source code in src/geometry_controller/__init__.pyi 
614
615
616
617
618
619
620
621
622
def get_element_vertices(element_id: int) -> List[point_3d]:
    """Gets the element vertices

    Parameters:
        element_id: element_id

    Returns:
        element vertices
    """

get_end_height_cut_angle(element_id)

Gets the element end height cut angle

Parameters:

Name Type Description Default
element_id int

element_id

 required

Returns:

Type Description
float

element end height cut angle
Source code in src/geometry_controller/__init__.pyi 
384
385
386
387
388
389
390
391
392
def get_end_height_cut_angle(element_id: int) -> float:
    """Gets the element end height cut angle

    Parameters:
        element_id: element_id

    Returns:
        element end height cut angle
    """

get_end_width_cut_angle(element_id)

Gets the element end width cut angle

Parameters:

Name Type Description Default
element_id int

element_id

 required

Returns:

Type Description
float

element end width cut angle
Source code in src/geometry_controller/__init__.pyi 
394
395
396
397
398
399
400
401
402
def get_end_width_cut_angle(element_id: int) -> float:
    """Gets the element end width cut angle

    Parameters:
        element_id: element_id

    Returns:
        element end width cut angle
    """

get_height(element_id)

Gets the element height

Parameters:

Name Type Description Default
element_id int

element_id

 required

Returns:

Type Description
float

element height
Source code in src/geometry_controller/__init__.pyi 
314
315
316
317
318
319
320
321
322
def get_height(element_id: int) -> float:
    """Gets the element height

    Parameters:
        element_id: element_id

    Returns:
        element height
    """

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

    Parameters:
        error_code: error_code

    Returns:
        error string
    """

get_length(element_id)

Gets the element length

Parameters:

Name Type Description Default
element_id int

element_id

 required

Returns:

Type Description
float

element length
Source code in src/geometry_controller/__init__.pyi 
324
325
326
327
328
329
330
331
332
def get_length(element_id: int) -> float:
    """Gets the element length

    Parameters:
        element_id: element_id

    Returns:
        element length
    """

get_list_height(element_id)

Gets the element list height

Parameters:

Name Type Description Default
element_id int

element_id

 required

Returns:

Type Description
float

element list height
Source code in src/geometry_controller/__init__.pyi 
644
645
646
647
648
649
650
651
652
def get_list_height(element_id: int) -> float:
    """Gets the element list height

    Parameters:
        element_id: element_id

    Returns:
        element list height
    """

get_list_length(element_id)

Gets the element list length

Parameters:

Name Type Description Default
element_id int

element_id

 required

Returns:

Type Description
float

element list length
Source code in src/geometry_controller/__init__.pyi 
654
655
656
657
658
659
660
661
662
def get_list_length(element_id: int) -> float:
    """Gets the element list length

    Parameters:
        element_id: element_id

    Returns:
        element list length
    """

get_list_volume(element_id)

Gets the element list volume

Parameters:

Name Type Description Default
element_id int

element_id

 required

Returns:

Type Description
float

element list volume
Source code in src/geometry_controller/__init__.pyi 
554
555
556
557
558
559
560
561
562
def get_list_volume(element_id: int) -> float:
    """Gets the element list volume

    Parameters:
        element_id: element_id

    Returns:
        element list volume
    """

get_list_weight(element_id)

Gets the element list weight

Parameters:

Name Type Description Default
element_id int

element_id

 required

Returns:

Type Description
float

element list weight
Source code in src/geometry_controller/__init__.pyi 
534
535
536
537
538
539
540
541
542
def get_list_weight(element_id: int) -> float:
    """Gets the element list weight

    Parameters:
        element_id: element_id

    Returns:
        element list weight
    """

get_list_width(element_id)

Get the element list width

Parameters:

Name Type Description Default
element_id int

element_id

 required

Returns:

Type Description
float

element list width
Source code in src/geometry_controller/__init__.pyi 
634
635
636
637
638
639
640
641
642
def get_list_width(element_id: int) -> float:
    """Get the element list width

    Parameters:
        element_id: element_id

    Returns:
        element list width
    """

get_local_x()

Gets the local X vector

Returns:

Type Description
point_3d

local X vector
Source code in src/geometry_controller/__init__.pyi 
715
716
717
718
719
720
def get_local_x() -> point_3d:
    """Gets the local X vector

    Returns:
        local X vector
    """

get_local_y()

Gets the local Z vector

Returns:

Type Description
point_3d

local Z vector
Source code in src/geometry_controller/__init__.pyi 
729
730
731
732
733
734
def get_local_y() -> point_3d:
    """Gets the local Z vector

    Returns:
        local Z vector
    """

get_local_z()

Gets the local Y vector

Returns:

Type Description
point_3d

local Y vector
Source code in src/geometry_controller/__init__.pyi 
722
723
724
725
726
727
def get_local_z() -> point_3d:
    """Gets the local Y vector

    Returns:
        local Y vector
    """

get_minimum_distance_between_elements(first_id, second_id)

Gets the minimum distance between 2 elements

Parameters:

Name Type Description Default
first_id int

first_id

 required
second_id int

second_id

 required

Returns:

Type Description
float

minimum distance
Source code in src/geometry_controller/__init__.pyi 
664
665
666
667
668
669
670
671
672
673
def get_minimum_distance_between_elements(first_id: int, second_id: int) -> float:
    """Gets the minimum distance between 2 elements

    Parameters:
        first_id: first_id
        second_id: second_id

    Returns:
        minimum distance
    """

get_over_height(element_id)

Gets the element overheight

Parameters:

Name Type Description Default
element_id int

element_id

 required

Returns:

Type Description
float

element overheight
Source code in src/geometry_controller/__init__.pyi 
414
415
416
417
418
419
420
421
422
def get_over_height(element_id: int) -> float:
    """Gets the element overheight

    Parameters:
        element_id: element_id

    Returns:
        element overheight
    """

get_over_length(element_id)

Gets the element overlength

Parameters:

Name Type Description Default
element_id int

element_id

 required

Returns:

Type Description
float

element overlength
Source code in src/geometry_controller/__init__.pyi 
424
425
426
427
428
429
430
431
432
def get_over_length(element_id: int) -> float:
    """Gets the element overlength

    Parameters:
        element_id: element_id

    Returns:
        element overlength
    """

get_over_width(element_id)

Gets the element overwidth

Parameters:

Name Type Description Default
element_id int

element_id

 required

Returns:

Type Description
float

element overwidth
Source code in src/geometry_controller/__init__.pyi 
404
405
406
407
408
409
410
411
412
def get_over_width(element_id: int) -> float:
    """Gets the element overwidth

    Parameters:
        element_id: element_id

    Returns:
        element overwidth
    """

get_p1(element_id)

Gets the element P1

Parameters:

Name Type Description Default
element_id int

element_id

 required

Returns:

Type Description
point_3d

element P1
Source code in src/geometry_controller/__init__.pyi 
334
335
336
337
338
339
340
341
342
def get_p1(element_id: int) -> point_3d:
    """Gets the element P1

    Parameters:
        element_id: element_id

    Returns:
        element P1
    """

get_p2(element_id)

Gets the element P2

Parameters:

Name Type Description Default
element_id int

element_id

 required

Returns:

Type Description
point_3d

element P2
Source code in src/geometry_controller/__init__.pyi 
344
345
346
347
348
349
350
351
352
def get_p2(element_id: int) -> point_3d:
    """Gets the element P2

    Parameters:
        element_id: element_id

    Returns:
        element P2
    """

get_p3(element_id)

Gets the element P3

Parameters:

Name Type Description Default
element_id int

element_id

 required

Returns:

Type Description
point_3d

element P3
Source code in src/geometry_controller/__init__.pyi 
354
355
356
357
358
359
360
361
362
def get_p3(element_id: int) -> point_3d:
    """Gets the element P3

    Parameters:
        element_id: element_id

    Returns:
        element P3
    """

get_reference_side(element_id)

Gets the element reference side

Parameters:

Name Type Description Default
element_id int

element_id

 required

Returns:

Type Description
int

element reference side
Source code in src/geometry_controller/__init__.pyi 
604
605
606
607
608
609
610
611
612
def get_reference_side(element_id: int) -> int:
    """Gets the element reference side

    Parameters:
        element_id: element_id

    Returns:
        element reference side
    """

get_round_machine_rough_part_negative_height(element_id)

get round machine rough part negative height

Parameters:

Name Type Description Default
element_id int

element_id

 required

Returns:

Type Description
bool

bool
Source code in src/geometry_controller/__init__.pyi 
879
880
881
882
883
884
885
886
887
def get_round_machine_rough_part_negative_height(element_id: int) -> bool:
    """get round machine rough part negative height

    Parameters:
        element_id: element_id

    Returns:
        bool
    """

get_round_machine_rough_part_negative_length(element_id)

get round machine rough part negative length

Parameters:

Name Type Description Default
element_id int

element_id

 required

Returns:

Type Description
bool

bool
Source code in src/geometry_controller/__init__.pyi 
921
922
923
924
925
926
927
928
929
def get_round_machine_rough_part_negative_length(element_id: int) -> bool:
    """get round machine rough part negative length

    Parameters:
        element_id: element_id

    Returns:
        bool
    """

get_round_machine_rough_part_negative_width(element_id)

get round machine rough part negative width

Parameters:

Name Type Description Default
element_id int

element_id

 required

Returns:

Type Description
bool

bool
Source code in src/geometry_controller/__init__.pyi 
837
838
839
840
841
842
843
844
845
def get_round_machine_rough_part_negative_width(element_id: int) -> bool:
    """get round machine rough part negative width

    Parameters:
        element_id: element_id

    Returns:
        bool
    """

get_round_machine_rough_part_positive_height(element_id)

get round machine rough part positive height

Parameters:

Name Type Description Default
element_id int

element_id

 required

Returns:

Type Description
bool

bool
Source code in src/geometry_controller/__init__.pyi 
900
901
902
903
904
905
906
907
908
def get_round_machine_rough_part_positive_height(element_id: int) -> bool:
    """get round machine rough part positive height

    Parameters:
        element_id: element_id

    Returns:
        bool
    """

get_round_machine_rough_part_positive_length(element_id)

get round machine rough part positive length

Parameters:

Name Type Description Default
element_id int

element_id

 required

Returns:

Type Description
bool

bool
Source code in src/geometry_controller/__init__.pyi 
942
943
944
945
946
947
948
949
950
def get_round_machine_rough_part_positive_length(element_id: int) -> bool:
    """get round machine rough part positive length

    Parameters:
        element_id: element_id

    Returns:
        bool
    """

get_round_machine_rough_part_positive_width(element_id)

get round machine rough part positive width

Parameters:

Name Type Description Default
element_id int

element_id

 required

Returns:

Type Description
bool

bool
Source code in src/geometry_controller/__init__.pyi 
858
859
860
861
862
863
864
865
866
def get_round_machine_rough_part_positive_width(element_id: int) -> bool:
    """get round machine rough part positive width

    Parameters:
        element_id: element_id

    Returns:
        bool
    """

get_rounding_height(element_id)

Gets the element rounding height

Parameters:

Name Type Description Default
element_id int

element_id

 required

Returns:

Type Description
float

element rounding height
Source code in src/geometry_controller/__init__.pyi 
444
445
446
447
448
449
450
451
452
def get_rounding_height(element_id: int) -> float:
    """Gets the element rounding height

    Parameters:
        element_id: element_id

    Returns:
        element rounding height
    """

get_rounding_length(element_id)

Gets the element rounding length

Parameters:

Name Type Description Default
element_id int

element_id

 required

Returns:

Type Description
float

element rounding length
Source code in src/geometry_controller/__init__.pyi 
454
455
456
457
458
459
460
461
462
def get_rounding_length(element_id: int) -> float:
    """Gets the element rounding length

    Parameters:
        element_id: element_id

    Returns:
        element rounding length
    """

get_rounding_width(element_id)

Gets the element rounding width

Parameters:

Name Type Description Default
element_id int

element_id

 required

Returns:

Type Description
float

element rounding width
Source code in src/geometry_controller/__init__.pyi 
434
435
436
437
438
439
440
441
442
def get_rounding_width(element_id: int) -> float:
    """Gets the element rounding width

    Parameters:
        element_id: element_id

    Returns:
        element rounding width
    """

get_standard_element_height_from_guid(standard_element_guid)

get standard element height from guid

Parameters:

Name Type Description Default
standard_element_guid str

standard_element_guid

 required

Returns:

Type Description
float

float
Source code in src/geometry_controller/__init__.pyi 
973
974
975
976
977
978
979
980
981
def get_standard_element_height_from_guid(standard_element_guid: str) -> float:
    """get standard element height from guid

    Parameters:
        standard_element_guid: standard_element_guid

    Returns:
        float
    """

get_standard_element_height_from_name(standard_element_name)

get standard element height from name

Parameters:

Name Type Description Default
standard_element_name str

standard_element_name

 required

Returns:

Type Description
float

float
Source code in src/geometry_controller/__init__.pyi 
1003
1004
1005
1006
1007
1008
1009
1010
1011
def get_standard_element_height_from_name(standard_element_name: str) -> float:
    """get standard element height from name

    Parameters:
        standard_element_name: standard_element_name

    Returns:
        float
    """

get_standard_element_length_from_guid(standard_element_guid)

get standard element length from guid

Parameters:

Name Type Description Default
standard_element_guid str

standard_element_guid

 required

Returns:

Type Description
float

float
Source code in src/geometry_controller/__init__.pyi 
983
984
985
986
987
988
989
990
991
def get_standard_element_length_from_guid(standard_element_guid: str) -> float:
    """get standard element length from guid

    Parameters:
        standard_element_guid: standard_element_guid

    Returns:
        float
    """

get_standard_element_length_from_name(standard_element_name)

get standard element length from name

Parameters:

Name Type Description Default
standard_element_name str

standard_element_name

 required

Returns:

Type Description
float

float
Source code in src/geometry_controller/__init__.pyi 
1013
1014
1015
1016
1017
1018
1019
1020
1021
def get_standard_element_length_from_name(standard_element_name: str) -> float:
    """get standard element length from name

    Parameters:
        standard_element_name: standard_element_name

    Returns:
        float
    """

get_standard_element_width_from_guid(standard_element_guid)

get standard element width from guid

Parameters:

Name Type Description Default
standard_element_guid str

standard_element_guid

 required

Returns:

Type Description
float

float
Source code in src/geometry_controller/__init__.pyi 
963
964
965
966
967
968
969
970
971
def get_standard_element_width_from_guid(standard_element_guid: str) -> float:
    """get standard element width from guid

    Parameters:
        standard_element_guid: standard_element_guid

    Returns:
        float
    """

get_standard_element_width_from_name(standard_element_name)

get standard element width from name

Parameters:

Name Type Description Default
standard_element_name str

standard_element_name

 required

Returns:

Type Description
float

float
Source code in src/geometry_controller/__init__.pyi 
 993
 994
 995
 996
 997
 998
 999
1000
1001
def get_standard_element_width_from_name(standard_element_name: str) -> float:
    """get standard element width from name

    Parameters:
        standard_element_name: standard_element_name

    Returns:
        float
    """

get_start_height_cut_angle(element_id)

Gets the element start height cut angle

Parameters:

Name Type Description Default
element_id int

element_id

 required

Returns:

Type Description
float

element start height cut angle
Source code in src/geometry_controller/__init__.pyi 
364
365
366
367
368
369
370
371
372
def get_start_height_cut_angle(element_id: int) -> float:
    """Gets the element start height cut angle

    Parameters:
        element_id: element_id

    Returns:
        element start height cut angle
    """

get_start_width_cut_angle(element_id)

Gets the element start width cut angle

Parameters:

Name Type Description Default
element_id int

element_id

 required

Returns:

Type Description
float

element start width cut angle
Source code in src/geometry_controller/__init__.pyi 
374
375
376
377
378
379
380
381
382
def get_start_width_cut_angle(element_id: int) -> float:
    """Gets the element start width cut angle

    Parameters:
        element_id: element_id

    Returns:
        element start width cut angle
    """

get_total_area_of_all_faces(element)

Gets the total area of all faces for element

Parameters:

Name Type Description Default
element int

element

 required

Returns:

Type Description
float

element total faces area
Source code in src/geometry_controller/__init__.pyi 
675
676
677
678
679
680
681
682
683
def get_total_area_of_all_faces(element: int) -> float:
    """Gets the total area of all faces for element

    Parameters:
        element: element

    Returns:
        element total faces area
    """

get_volume(element_id)

Gets the element rough volume (does not include negative geometry operations, such as end-types, drillings, connectors, openings, and MEP elements)

Parameters:

Name Type Description Default
element_id int

element_id

 required

Returns:

Type Description
float

element rough volume
Source code in src/geometry_controller/__init__.pyi 
544
545
546
547
548
549
550
551
552
def get_volume(element_id: int) -> float:
    """Gets the element rough volume (does not include negative geometry operations, such as end-types, drillings, connectors, openings, and MEP elements)

    Parameters:
        element_id: element_id

    Returns:
        element rough volume
    """

get_weight(element_id)

Gets the element real weight

Parameters:

Name Type Description Default
element_id int

element_id

 required

Returns:

Type Description
float

element real weight
Source code in src/geometry_controller/__init__.pyi 
524
525
526
527
528
529
530
531
532
def get_weight(element_id: int) -> float:
    """Gets the element real weight

    Parameters:
        element_id: element_id

    Returns:
        element real weight
    """

get_weight_real(element_id)

get weight real

Parameters:

Name Type Description Default
element_id int

element_id

 required

Returns:

Type Description
float

float
Source code in src/geometry_controller/__init__.pyi 
796
797
798
799
800
801
802
803
804
def get_weight_real(element_id: int) -> float:
    """get weight real

    Parameters:
        element_id: element_id

    Returns:
        float
    """

get_width(element_id)

Gets the element width

Parameters:

Name Type Description Default
element_id int

element_id

 required

Returns:

Type Description
float

element width
Source code in src/geometry_controller/__init__.pyi 
304
305
306
307
308
309
310
311
312
def get_width(element_id: int) -> float:
    """Gets the element width

    Parameters:
        element_id: element_id

    Returns:
        element width
    """

get_window_surface(elements)

Gets the element window surface

Parameters:

Name Type Description Default
elements List[int]

elements

 required

Returns:

Type Description
float

element window surface
Source code in src/geometry_controller/__init__.pyi 
705
706
707
708
709
710
711
712
713
def get_window_surface(elements: List[int]) -> float:
    """Gets the element window surface

    Parameters:
        elements: elements

    Returns:
        element window surface
    """

get_xl(element_id)

Gets the element XL vector

Parameters:

Name Type Description Default
element_id int

element_id

 required

Returns:

Type Description
point_3d

element XL vector
Source code in src/geometry_controller/__init__.pyi 
564
565
566
567
568
569
570
571
572
def get_xl(element_id: int) -> point_3d:
    """Gets the element XL vector

    Parameters:
        element_id: element_id

    Returns:
        element XL vector
    """

get_yl(element_id)

Gets the element YL vector

Parameters:

Name Type Description Default
element_id int

element_id

 required

Returns:

Type Description
point_3d

element YL vector
Source code in src/geometry_controller/__init__.pyi 
574
575
576
577
578
579
580
581
582
def get_yl(element_id: int) -> point_3d:
    """Gets the element YL vector

    Parameters:
        element_id: element_id

    Returns:
        element YL vector
    """

get_zl(element_id)

Gets the element ZL vector

Parameters:

Name Type Description Default
element_id int

element_id

 required

Returns:

Type Description
point_3d

element ZL vector
Source code in src/geometry_controller/__init__.pyi 
584
585
586
587
588
589
590
591
592
def get_zl(element_id: int) -> point_3d:
    """Gets the element ZL vector

    Parameters:
        element_id: element_id

    Returns:
        element ZL vector
    """

invert_model(element_id_list)

Inverts element model

Parameters:

Name Type Description Default
element_id_list List[int]

element_id_list

 required

Returns:

Type Description
None

None
Source code in src/geometry_controller/__init__.pyi 
209
210
211
212
213
214
215
216
217
def invert_model(element_id_list: List[int]) -> None:
    """Inverts element model

    Parameters:
        element_id_list: element_id_list

    Returns:
        None
    """

rotate_height_axis_180(element_id_list)

Rotates the element height axis 180 degrees

Parameters:

Name Type Description Default
element_id_list List[int]

element_id_list

 required

Returns:

Type Description
None

None
Source code in src/geometry_controller/__init__.pyi 
25
26
27
28
29
30
31
32
33
def rotate_height_axis_180(element_id_list: List[int]) -> None:
    """Rotates the element height axis 180 degrees

    Parameters:
        element_id_list: element_id_list

    Returns:
        None
    """

rotate_height_axis_2_points(elements, point1, point2)

Rotates the element height axis via 2 points

Parameters:

Name Type Description Default
elements List[int]

elements

 required
point1 point_3d

point1

 required
point2 point_3d

point2

 required

Returns:

Type Description
None

None
Source code in src/geometry_controller/__init__.pyi 
252
253
254
255
256
257
258
259
260
261
262
def rotate_height_axis_2_points(elements: List[int], point1: point_3d, point2: point_3d) -> None:
    """Rotates the element height axis via 2 points

    Parameters:
        elements: elements
        point1: point1
        point2: point2

    Returns:
        None
    """

rotate_height_axis_90(element_id_list)

Rotates the element height axis 90 degrees

Parameters:

Name Type Description Default
element_id_list List[int]

element_id_list

 required

Returns:

Type Description
None

None
Source code in src/geometry_controller/__init__.pyi 
15
16
17
18
19
20
21
22
23
def rotate_height_axis_90(element_id_list: List[int]) -> None:
    """Rotates the element height axis 90 degrees

    Parameters:
        element_id_list: element_id_list

    Returns:
        None
    """

rotate_length_axis_180(element_id_list)

Rotates element length axis 180 degrees

Parameters:

Name Type Description Default
element_id_list List[int]

element_id_list

 required

Returns:

Type Description
None

None
Source code in src/geometry_controller/__init__.pyi 
199
200
201
202
203
204
205
206
207
def rotate_length_axis_180(element_id_list: List[int]) -> None:
    """Rotates element length axis 180 degrees

    Parameters:
        element_id_list: element_id_list

    Returns:
        None
    """

rotate_length_axis_2_points(elements, point1, point2)

Rotates the element length axis via 2 points

Parameters:

Name Type Description Default
elements List[int]

elements

 required
point1 point_3d

point1

 required
point2 point_3d

point2

 required

Returns:

Type Description
None

None
Source code in src/geometry_controller/__init__.pyi 
292
293
294
295
296
297
298
299
300
301
302
def rotate_length_axis_2_points(elements: List[int], point1: point_3d, point2: point_3d) -> None:
    """Rotates the element length axis via 2 points

    Parameters:
        elements: elements
        point1: point1
        point2: point2

    Returns:
        None
    """

rotate_length_axis_90(element_id_list)

Rotates element length axis 90 degrees

Parameters:

Name Type Description Default
element_id_list List[int]

element_id_list

 required

Returns:

Type Description
None

None
Source code in src/geometry_controller/__init__.pyi 
189
190
191
192
193
194
195
196
197
def rotate_length_axis_90(element_id_list: List[int]) -> None:
    """Rotates element length axis 90 degrees

    Parameters:
        element_id_list: element_id_list

    Returns:
        None
    """

set_cross_correction_negative_height(element_id_list, value)

Sets the element negative height cross correction

Parameters:

Name Type Description Default
element_id_list List[int]

element_id_list

 required
value float

value

 required

Returns:

Type Description
None

None
Source code in src/geometry_controller/__init__.pyi 
123
124
125
126
127
128
129
130
131
132
def set_cross_correction_negative_height(element_id_list: List[int], value: float) -> None:
    """Sets the element negative height cross correction

    Parameters:
        element_id_list: element_id_list
        value: value

    Returns:
        None
    """

set_cross_correction_negative_length(element_id_list, value)

Sets the element negative length cross correction

Parameters:

Name Type Description Default
element_id_list List[int]

element_id_list

 required
value float

value

 required

Returns:

Type Description
None

None
Source code in src/geometry_controller/__init__.pyi 
145
146
147
148
149
150
151
152
153
154
def set_cross_correction_negative_length(element_id_list: List[int], value: float) -> None:
    """Sets the element negative length cross correction

    Parameters:
        element_id_list: element_id_list
        value: value

    Returns:
        None
    """

set_cross_correction_negative_width(element_id_list, value)

Sets the element negative width cross correction

Parameters:

Name Type Description Default
element_id_list List[int]

element_id_list

 required
value float

value

 required

Returns:

Type Description
None

None
Source code in src/geometry_controller/__init__.pyi 
101
102
103
104
105
106
107
108
109
110
def set_cross_correction_negative_width(element_id_list: List[int], value: float) -> None:
    """Sets the element negative width cross correction

    Parameters:
        element_id_list: element_id_list
        value: value

    Returns:
        None
    """

set_cross_correction_positive_height(element_id_list, value)

Sets the element positive height cross correction

Parameters:

Name Type Description Default
element_id_list List[int]

element_id_list

 required
value float

value

 required

Returns:

Type Description
None

None
Source code in src/geometry_controller/__init__.pyi 
134
135
136
137
138
139
140
141
142
143
def set_cross_correction_positive_height(element_id_list: List[int], value: float) -> None:
    """Sets the element positive height cross correction

    Parameters:
        element_id_list: element_id_list
        value: value

    Returns:
        None
    """

set_cross_correction_positive_length(element_id_list, value)

Sets the element positive length cross correction

Parameters:

Name Type Description Default
element_id_list List[int]

element_id_list

 required
value float

value

 required

Returns:

Type Description
None

None
Source code in src/geometry_controller/__init__.pyi 
156
157
158
159
160
161
162
163
164
165
def set_cross_correction_positive_length(element_id_list: List[int], value: float) -> None:
    """Sets the element positive length cross correction

    Parameters:
        element_id_list: element_id_list
        value: value

    Returns:
        None
    """

set_cross_correction_positive_width(element_id_list, value)

Sets the element positive width cross correction

Parameters:

Name Type Description Default
element_id_list List[int]

element_id_list

 required
value float

value

 required

Returns:

Type Description
None

None
Source code in src/geometry_controller/__init__.pyi 
112
113
114
115
116
117
118
119
120
121
def set_cross_correction_positive_width(element_id_list: List[int], value: float) -> None:
    """Sets the element positive width cross correction

    Parameters:
        element_id_list: element_id_list
        value: value

    Returns:
        None
    """

set_drilling_tolerance(elements, tolerance)

Gets the division zone points

Parameters:

Name Type Description Default
elements List[int]

elements

 required
tolerance float

tolerance

 required

Returns:

Type Description
None

None
Source code in src/geometry_controller/__init__.pyi 
271
272
273
274
275
276
277
278
279
280
def set_drilling_tolerance(elements: List[int], tolerance: float) -> None:
    """Gets the division zone points

    Parameters:
        elements: elements
        tolerance: tolerance

    Returns:
        None
    """

set_height_real(elements, height)

Sets the element real height

Parameters:

Name Type Description Default
elements List[int]

elements

 required
height float

height

 required

Returns:

Type Description
None

None
Source code in src/geometry_controller/__init__.pyi 
230
231
232
233
234
235
236
237
238
239
def set_height_real(elements: List[int], height: float) -> None:
    """Sets the element real height

    Parameters:
        elements: elements
        height: height

    Returns:
        None
    """

set_length_real(elements, length)

Gets the element real length

Parameters:

Name Type Description Default
elements List[int]

elements

 required
length float

length

 required

Returns:

Type Description
None

None
Source code in src/geometry_controller/__init__.pyi 
241
242
243
244
245
246
247
248
249
250
def set_length_real(elements: List[int], length: float) -> None:
    """Gets the element real length

    Parameters:
        elements: elements
        length: length

    Returns:
        None
    """

set_over_height(element_id_list, value)

Sets the element overheight

Parameters:

Name Type Description Default
element_id_list List[int]

element_id_list

 required
value float

value

 required

Returns:

Type Description
None

None
Source code in src/geometry_controller/__init__.pyi 
46
47
48
49
50
51
52
53
54
55
def set_over_height(element_id_list: List[int], value: float) -> None:
    """Sets the element overheight

    Parameters:
        element_id_list: element_id_list
        value: value

    Returns:
        None
    """

set_over_length(element_id_list, value)

Sets the element overlength

Parameters:

Name Type Description Default
element_id_list List[int]

element_id_list

 required
value float

value

 required

Returns:

Type Description
None

None
Source code in src/geometry_controller/__init__.pyi 
57
58
59
60
61
62
63
64
65
66
def set_over_length(element_id_list: List[int], value: float) -> None:
    """Sets the element overlength

    Parameters:
        element_id_list: element_id_list
        value: value

    Returns:
        None
    """

set_over_width(element_id_list, value)

Sets the element overwidth

Parameters:

Name Type Description Default
element_id_list List[int]

element_id_list

 required
value float

value

 required

Returns:

Type Description
None

None
Source code in src/geometry_controller/__init__.pyi 
35
36
37
38
39
40
41
42
43
44
def set_over_width(element_id_list: List[int], value: float) -> None:
    """Sets the element overwidth

    Parameters:
        element_id_list: element_id_list
        value: value

    Returns:
        None
    """

set_round_machine_rough_part_negative_height(elements, value)

set round machine rough part negative height

Parameters:

Name Type Description Default
elements List[int]

elements

 required
value bool

value

 required

Returns:

Type Description
None

None
Source code in src/geometry_controller/__init__.pyi 
889
890
891
892
893
894
895
896
897
898
def set_round_machine_rough_part_negative_height(elements: List[int], value: bool) -> None:
    """set round machine rough part negative height

    Parameters:
        elements: elements
        value: value

    Returns:
        None
    """

set_round_machine_rough_part_negative_length(elements, value)

set round machine rough part negative length

Parameters:

Name Type Description Default
elements List[int]

elements

 required
value bool

value

 required

Returns:

Type Description
None

None
Source code in src/geometry_controller/__init__.pyi 
931
932
933
934
935
936
937
938
939
940
def set_round_machine_rough_part_negative_length(elements: List[int], value: bool) -> None:
    """set round machine rough part negative length

    Parameters:
        elements: elements
        value: value

    Returns:
        None
    """

set_round_machine_rough_part_negative_width(elements, value)

set round machine rough part negative width

Parameters:

Name Type Description Default
elements List[int]

elements

 required
value bool

value

 required

Returns:

Type Description
None

None
Source code in src/geometry_controller/__init__.pyi 
847
848
849
850
851
852
853
854
855
856
def set_round_machine_rough_part_negative_width(elements: List[int], value: bool) -> None:
    """set round machine rough part negative width

    Parameters:
        elements: elements
        value: value

    Returns:
        None
    """

set_round_machine_rough_part_positive_height(elements, value)

set round machine rough part positive height

Parameters:

Name Type Description Default
elements List[int]

elements

 required
value bool

value

 required

Returns:

Type Description
None

None
Source code in src/geometry_controller/__init__.pyi 
910
911
912
913
914
915
916
917
918
919
def set_round_machine_rough_part_positive_height(elements: List[int], value: bool) -> None:
    """set round machine rough part positive height

    Parameters:
        elements: elements
        value: value

    Returns:
        None
    """

set_round_machine_rough_part_positive_length(elements, value)

set round machine rough part positive length

Parameters:

Name Type Description Default
elements List[int]

elements

 required
value bool

value

 required

Returns:

Type Description
None

None
Source code in src/geometry_controller/__init__.pyi 
952
953
954
955
956
957
958
959
960
961
def set_round_machine_rough_part_positive_length(elements: List[int], value: bool) -> None:
    """set round machine rough part positive length

    Parameters:
        elements: elements
        value: value

    Returns:
        None
    """

set_round_machine_rough_part_positive_width(elements, value)

set round machine rough part positive width

Parameters:

Name Type Description Default
elements List[int]

elements

 required
value bool

value

 required

Returns:

Type Description
None

None
Source code in src/geometry_controller/__init__.pyi 
868
869
870
871
872
873
874
875
876
877
def set_round_machine_rough_part_positive_width(elements: List[int], value: bool) -> None:
    """set round machine rough part positive width

    Parameters:
        elements: elements
        value: value

    Returns:
        None
    """

set_rounding_height(element_id_list, value)

Sets the element rounding height

Parameters:

Name Type Description Default
element_id_list List[int]

element_id_list

 required
value float

value

 required

Returns:

Type Description
None

None
Source code in src/geometry_controller/__init__.pyi 
79
80
81
82
83
84
85
86
87
88
def set_rounding_height(element_id_list: List[int], value: float) -> None:
    """Sets the element rounding height

    Parameters:
        element_id_list: element_id_list
        value: value

    Returns:
        None
    """

set_rounding_length(element_id_list, value)

Sets the element rounding length

Parameters:

Name Type Description Default
element_id_list List[int]

element_id_list

 required
value float

value

 required

Returns:

Type Description
None

None
Source code in src/geometry_controller/__init__.pyi 
90
91
92
93
94
95
96
97
98
99
def set_rounding_length(element_id_list: List[int], value: float) -> None:
    """Sets the element rounding length

    Parameters:
        element_id_list: element_id_list
        value: value

    Returns:
        None
    """

set_rounding_width(element_id_list, value)

Sets the element rounding width

Parameters:

Name Type Description Default
element_id_list List[int]

element_id_list

 required
value float

value

 required

Returns:

Type Description
None

None
Source code in src/geometry_controller/__init__.pyi 
68
69
70
71
72
73
74
75
76
77
def set_rounding_width(element_id_list: List[int], value: float) -> None:
    """Sets the element rounding width

    Parameters:
        element_id_list: element_id_list
        value: value

    Returns:
        None
    """

set_width_real(elements, width)

Sets the element real width

Parameters:

Name Type Description Default
elements List[int]

elements

 required
width float

width

 required

Returns:

Type Description
None

None
Source code in src/geometry_controller/__init__.pyi 
219
220
221
222
223
224
225
226
227
228
def set_width_real(elements: List[int], width: float) -> None:
    """Sets the element real width

    Parameters:
        elements: elements
        width: width

    Returns:
        None
    """