Geometry Controller
apply_global_scale(elements, scale, origin)
apply global scale
Parameters:
Name | Type | Description | Default |
---|---|---|---|
elements |
List[int] |
element IDs |
required |
scale |
float |
scale factor |
required |
origin |
point_3d |
a origin |
required |
Source code in geometry_controller/__init__.py
def apply_global_scale(elements: List[int], scale: float, origin: point_3d) -> None:
"""apply global scale
Args:
elements (List[int]): element IDs
scale (float): scale factor
origin (point_3d): a origin
"""
are_facets_coplanar(vertices_first_plane, vertices_second_plane)
checks if points of facet/plane are coplanar
Available for script filled attributes
Parameters:
Name | Type | Description | Default |
---|---|---|---|
vertices_first_plane |
List[point_3d] |
a first point list |
required |
vertices_second_plane |
List[point_3d] |
a second point list |
required |
Returns:
Type | Description |
---|---|
bool |
are facets/vertices coplanar |
Source code in geometry_controller/__init__.py
def are_facets_coplanar(vertices_first_plane: List[point_3d], vertices_second_plane: List[point_3d]) -> bool:
"""checks if points of facet/plane are coplanar
[:information_source: Available for script filled attributes](#){.mark-text}
Args:
vertices_first_plane (List[point_3d]): a first point list
vertices_second_plane (List[point_3d]): a second point list
Returns:
bool: are facets/vertices coplanar
"""
auto_regenerate_axes(elements)
regenerate element axis system
Parameters:
Name | Type | Description | Default |
---|---|---|---|
elements |
List[int] |
element IDs |
required |
Source code in geometry_controller/__init__.py
def auto_regenerate_axes(elements: List[int]) -> None:
"""regenerate element axis system
Args:
elements (List[int]): element IDs
"""
auto_regenerate_axes_silently(elements)
automatic, silent regeneration of element axes
Parameters:
Name | Type | Description | Default |
---|---|---|---|
elements |
List[int] |
element IDs |
required |
Source code in geometry_controller/__init__.py
def auto_regenerate_axes_silently(elements: List[int]) -> None:
"""automatic, silent regeneration of element axes
Args:
elements (List[int]): element IDs
"""
create_division_zone(element, point, direction)
create division zone positive direction = 1 negative direction = -1
Parameters:
Name | Type | Description | Default |
---|---|---|---|
element |
int |
element ID |
required |
point |
point_3d |
positon |
required |
direction |
point_3d |
direction vector |
required |
Source code in geometry_controller/__init__.py
def create_division_zone(element: int, point: point_3d, direction: int) -> None:
""" create division zone
positive direction = 1
negative direction = -1
Args:
element (int): element ID
point (point_3d): positon
direction (point_3d): direction vector
"""
delete_division_zone(element)
delete division zone
Parameters:
Name | Type | Description | Default |
---|---|---|---|
element |
int |
element ID |
required |
Source code in geometry_controller/__init__.py
def delete_division_zone(element: int) -> None:
""" delete division zone
Args:
element (int): element ID
"""
get_actual_physical_volume(element)
get the real/physical volume of an element
Available for script filled attributes
Parameters:
Name | Type | Description | Default |
---|---|---|---|
element |
int |
element ID |
required |
Returns:
Type | Description |
---|---|
float |
volume |
Source code in geometry_controller/__init__.py
def get_actual_physical_volume(element: int) -> float:
"""get the real/physical volume of an element
[:information_source: Available for script filled attributes](#){.mark-text}
Args:
element (int): element ID
Returns:
float: volume
"""
get_area_of_front_face(element)
accumulates area of all faces that are perpendicular to the length (Xl) axis.
Available for script filled attributes
Parameters:
Name | Type | Description | Default |
---|---|---|---|
element |
int |
element ID |
required |
Returns:
Type | Description |
---|---|
float |
value |
Source code in geometry_controller/__init__.py
def get_area_of_front_face(element: int) -> float:
"""accumulates area of all faces that are perpendicular to the length (Xl) axis.
[:information_source: Available for script filled attributes](#){.mark-text}
Args:
element (int): element ID
Returns:
float: value
"""
get_center_of_gravity(element)
get center of gravity geometrical
Available for script filled attributes
Parameters:
Name | Type | Description | Default |
---|---|---|---|
element |
int |
element ID |
required |
Returns:
Type | Description |
---|---|
point_3d |
point_3d (x,y,z) |
Source code in geometry_controller/__init__.py
def get_center_of_gravity(element: int) -> point_3d:
"""get center of gravity geometrical
[:information_source: Available for script filled attributes](#){.mark-text}
Args:
element (int): element ID
Returns:
point_3d: point_3d (x,y,z)
"""
get_center_of_gravity_for_list(elements)
get geometrical center of gravity for elements
Available for script filled attributes
Parameters:
Name | Type | Description | Default |
---|---|---|---|
elements |
List[int] |
element IDs |
required |
Returns:
Type | Description |
---|---|
point_3d |
point_3d (x,y,z) |
Source code in geometry_controller/__init__.py
def get_center_of_gravity_for_list(elements: List[int]) -> point_3d:
"""get geometrical center of gravity for elements
[:information_source: Available for script filled attributes](#){.mark-text}
Args:
elements (List[int]): element IDs
Returns:
point_3d: point_3d (x,y,z)
"""
get_center_of_gravity_for_list_considering_materials(elements)
get center of gravity considering material weights
Available for script filled attributes
Parameters:
Name | Type | Description | Default |
---|---|---|---|
elements |
List[int] |
element IDs |
required |
Returns:
Type | Description |
---|---|
point_3d |
point_3d (x,y,z) |
Source code in geometry_controller/__init__.py
def get_center_of_gravity_for_list_considering_materials(elements: List[int]) -> point_3d:
"""get center of gravity considering material weights
[:information_source: Available for script filled attributes](#){.mark-text}
Args:
elements (List[int]): element IDs
Returns:
point_3d: point_3d (x,y,z)
"""
get_cross_correction_negative_height(element)
set cross correction negative height
Available for script filled attributes
Parameters:
Name | Type | Description | Default |
---|---|---|---|
element |
int |
element ID |
required |
Returns:
Type | Description |
---|---|
float |
value |
Source code in geometry_controller/__init__.py
def get_cross_correction_negative_height(element: int) -> float:
"""set cross correction negative height
[:information_source: Available for script filled attributes](#){.mark-text}
Args:
element (int): element ID
Returns:
float: value
"""
get_cross_correction_negative_length(element)
get cross correction negative length
Available for script filled attributes
Parameters:
Name | Type | Description | Default |
---|---|---|---|
element |
int |
element ID |
required |
Returns:
Type | Description |
---|---|
float |
value |
Source code in geometry_controller/__init__.py
def get_cross_correction_negative_length(element: int) -> float:
"""get cross correction negative length
[:information_source: Available for script filled attributes](#){.mark-text}
Args:
element (int): element ID
Returns:
float: value
"""
get_cross_correction_negative_width(element)
get cross correction negative width
Available for script filled attributes
Parameters:
Name | Type | Description | Default |
---|---|---|---|
element |
int |
element ID |
required |
Returns:
Type | Description |
---|---|
float |
value |
Source code in geometry_controller/__init__.py
def get_cross_correction_negative_width(element: int) -> float:
"""get cross correction negative width
[:information_source: Available for script filled attributes](#){.mark-text}
Args:
element (int): element ID
Returns:
float: value
"""
get_cross_correction_positive_height(element)
get cross correction positive height
Available for script filled attributes
Parameters:
Name | Type | Description | Default |
---|---|---|---|
element |
int |
element ID |
required |
Returns:
Type | Description |
---|---|
float |
value |
Source code in geometry_controller/__init__.py
def get_cross_correction_positive_height(element: int) -> float:
"""get cross correction positive height
[:information_source: Available for script filled attributes](#){.mark-text}
Args:
element (int): element ID
Returns:
float: value
"""
get_cross_correction_positive_length(element)
get cross correction positive length
Available for script filled attributes
Parameters:
Name | Type | Description | Default |
---|---|---|---|
element |
int |
element ID |
required |
Returns:
Type | Description |
---|---|
float |
value |
Source code in geometry_controller/__init__.py
def get_cross_correction_positive_length(element: int) -> float:
"""get cross correction positive length
[:information_source: Available for script filled attributes](#){.mark-text}
Args:
element (int): element ID
Returns:
float: value
"""
get_cross_correction_positive_width(element)
get cross correction positive width
Available for script filled attributes
Parameters:
Name | Type | Description | Default |
---|---|---|---|
element |
int |
element ID |
required |
Returns:
Type | Description |
---|---|
float |
value |
Source code in geometry_controller/__init__.py
def get_cross_correction_positive_width(element: int) -> float:
"""get cross correction positive width
[:information_source: Available for script filled attributes](#){.mark-text}
Args:
element (int): element ID
Returns:
float: value
"""
get_division_zone_points(element)
get division zone points
Parameters:
Name | Type | Description | Default |
---|---|---|---|
element |
int |
element ID |
required |
Returns:
Type | Description |
---|---|
List[point_3d] |
list of points |
Source code in geometry_controller/__init__.py
def get_division_zone_points(element: int) -> List[point_3d]:
""" get division zone points
Args:
element (int): element ID
Returns:
List[point_3d]: list of points
"""
get_door_surface(elements)
get door surface
Available for script filled attributes
Parameters:
Name | Type | Description | Default |
---|---|---|---|
elements |
List[int] |
element IDs |
required |
Returns:
Type | Description |
---|---|
float |
value |
Source code in geometry_controller/__init__.py
def get_door_surface(elements: List[int]) -> float:
"""get door surface
[:information_source: Available for script filled attributes](#){.mark-text}
Args:
elements (List[int]): element IDs
Returns:
float: value
"""
get_drilling_tolerance(element)
get drilling tolerance
Available for script filled attributes
Parameters:
Name | Type | Description | Default |
---|---|---|---|
element |
int |
element ID |
required |
Returns:
Type | Description |
---|---|
float |
value |
Source code in geometry_controller/__init__.py
def get_drilling_tolerance(element: int) -> float:
"""get drilling tolerance
[:information_source: Available for script filled attributes](#){.mark-text}
Args:
element (int): element ID
Returns:
float: value
"""
get_element_facet_count(element)
Get element facet count
Available for script filled attributes
Parameters:
Name | Type | Description | Default |
---|---|---|---|
element |
int |
element ID |
required |
Returns:
Type | Description |
---|---|
int |
number of facets |
Source code in geometry_controller/__init__.py
def get_element_facet_count(element: int) -> int:
"""Get element facet count
[:information_source: Available for script filled attributes](#){.mark-text}
Args:
element (int): element ID
Returns:
int: number of facets
"""
get_element_facets(element)
get element facets
Examples:
>>> import cadwork
>>> import geometry_controller
>>> facets = geometry_controller.get_element_facets(element_id)
>>> for index in facets.count():
normal = facets.get_normal_vector(index)
Parameters:
Name | Type | Description | Default |
---|---|---|---|
element |
int |
element ID |
required |
Returns:
Type | Description |
---|---|
facet_list |
list of facets |
Source code in geometry_controller/__init__.py
def get_element_facets(element: int) -> facet_list:
"""get element facets
Examples:
>>> import cadwork
>>> import geometry_controller
>>> facets = geometry_controller.get_element_facets(element_id)
>>> for index in facets.count():
normal = facets.get_normal_vector(index)
Args:
element (int): element ID
Returns:
facet_list: list of facets
"""
get_element_reference_face_area(element)
get element reference face area
Available for script filled attributes
Parameters:
Name | Type | Description | Default |
---|---|---|---|
element |
int |
element ID |
required |
Returns:
Type | Description |
---|---|
float |
value |
Source code in geometry_controller/__init__.py
def get_element_reference_face_area(element: int) -> float:
"""get element reference face area
[:information_source: Available for script filled attributes](#){.mark-text}
Args:
element (int): element ID
Returns:
float: value
"""
get_element_reference_face_vertices(element)
get element reference face vertices
Available for script filled attributes
Parameters:
Name | Type | Description | Default |
---|---|---|---|
element |
int |
element ID |
required |
Returns:
Type | Description |
---|---|
List[point_3d] |
vertex list |
Source code in geometry_controller/__init__.py
def get_element_reference_face_vertices(element: int) -> List[point_3d]:
"""get element reference face vertices
[:information_source: Available for script filled attributes](#){.mark-text}
Args:
element (int): element ID
Returns:
List[point_3d]: vertex list
"""
get_element_vertices(element)
get BREP vertices of element
Available for script filled attributes
Parameters:
Name | Type | Description | Default |
---|---|---|---|
element |
int |
element ID |
required |
Returns:
Type | Description |
---|---|
List[point_3d] |
vertex list |
Source code in geometry_controller/__init__.py
def get_element_vertices(element: int) -> List[point_3d]:
"""get BREP vertices of element
[:information_source: Available for script filled attributes](#){.mark-text}
Args:
element (int): element ID
Returns:
List[point_3d]: vertex list
"""
get_end_height_cut_angle(element)
get end height cut angle
Available for script filled attributes
Parameters:
Name | Type | Description | Default |
---|---|---|---|
element |
int |
element ID |
required |
Returns:
Type | Description |
---|---|
float |
value |
Source code in geometry_controller/__init__.py
def get_end_height_cut_angle(element: int) -> float:
"""get end height cut angle
[:information_source: Available for script filled attributes](#){.mark-text}
Args:
element (int): element ID
Returns:
float: value
"""
get_end_width_cut_angle(element)
get end width cut angle
Available for script filled attributes
Parameters:
Name | Type | Description | Default |
---|---|---|---|
element |
int |
element ID |
required |
Returns:
Type | Description |
---|---|
float |
value |
Source code in geometry_controller/__init__.py
def get_end_width_cut_angle(element: int) -> float:
"""get end width cut angle
[:information_source: Available for script filled attributes](#){.mark-text}
Args:
element (int): element ID
Returns:
float: value
"""
get_height(element)
Get element height.
Available for script filled attributes
Parameters:
Name | Type | Description | Default |
---|---|---|---|
element |
int |
element ID |
required |
Returns:
Type | Description |
---|---|
float |
height |
Source code in geometry_controller/__init__.py
def get_height(element: int) -> float:
"""Get element height.
[:information_source: Available for script filled attributes](#){.mark-text}
Args:
element (int): element ID
Returns:
float: height
"""
get_length(element)
Get element length.
Available for script filled attributes
Parameters:
Name | Type | Description | Default |
---|---|---|---|
element |
int |
element ID |
required |
Returns:
Type | Description |
---|---|
float |
length |
Source code in geometry_controller/__init__.py
def get_length(element: int) -> float:
"""Get element length.
[:information_source: Available for script filled attributes](#){.mark-text}
Args:
element (int): element ID
Returns:
float: length
"""
get_list_height(element)
get list height
Available for script filled attributes
Parameters:
Name | Type | Description | Default |
---|---|---|---|
element |
int |
element ID |
required |
Returns:
Type | Description |
---|---|
float |
value |
Source code in geometry_controller/__init__.py
def get_list_height(element: int) -> float:
"""get list height
[:information_source: Available for script filled attributes](#){.mark-text}
Args:
element (int): element ID
Returns:
float: value
"""
get_list_length(element)
get list length
Available for script filled attributes
Parameters:
Name | Type | Description | Default |
---|---|---|---|
element |
int |
element ID |
required |
Returns:
Type | Description |
---|---|
float |
value |
Source code in geometry_controller/__init__.py
def get_list_length(element: int) -> float:
"""get list length
[:information_source: Available for script filled attributes](#){.mark-text}
Args:
element (int): element ID
Returns:
float: value
"""
get_list_volume(element)
get element list volume
Available for script filled attributes
Parameters:
Name | Type | Description | Default |
---|---|---|---|
element |
int |
element ID |
required |
Returns:
Type | Description |
---|---|
float |
value |
Source code in geometry_controller/__init__.py
def get_list_volume(element: int) -> float:
"""get element list volume
[:information_source: Available for script filled attributes](#){.mark-text}
Args:
element (int): element ID
Returns:
float: value
"""
get_list_weight(element)
get element list weight
Available for script filled attributes
Parameters:
Name | Type | Description | Default |
---|---|---|---|
element |
int |
element ID |
required |
Returns:
Type | Description |
---|---|
float |
value |
Source code in geometry_controller/__init__.py
def get_list_weight(element: int) -> float:
"""get element list weight
[:information_source: Available for script filled attributes](#){.mark-text}
Args:
element (int): element ID
Returns:
float: value
"""
get_list_width(element)
get list width
Available for script filled attributes
Parameters:
Name | Type | Description | Default |
---|---|---|---|
element |
int |
element ID |
required |
Returns:
Type | Description |
---|---|
float |
value |
Source code in geometry_controller/__init__.py
def get_list_width(element: int) -> float:
"""get list width
[:information_source: Available for script filled attributes](#){.mark-text}
Args:
element (int): element ID
Returns:
float: value
"""
get_local_x()
X vector of the coordinate system in 3D
Available for script filled attributes
Returns:
Type | Description |
---|---|
point_3d |
point_3d (x,y,z) |
Source code in geometry_controller/__init__.py
def get_local_x() -> point_3d:
"""X vector of the coordinate system in 3D
[:information_source: Available for script filled attributes](#){.mark-text}
Returns:
point_3d: point_3d (x,y,z)
"""
get_local_y()
Y vector of the coordinate system in 3D
Available for script filled attributes
Returns:
Type | Description |
---|---|
point_3d |
point_3d (x,y,z) |
Source code in geometry_controller/__init__.py
def get_local_y() -> point_3d:
"""Y vector of the coordinate system in 3D
[:information_source: Available for script filled attributes](#){.mark-text}
Returns:
point_3d: point_3d (x,y,z)
"""
get_local_z()
Z vector of the coordinate system in 3D
Available for script filled attributes
Returns:
Type | Description |
---|---|
point_3d |
point_3d (x,y,z) |
Source code in geometry_controller/__init__.py
def get_local_z() -> point_3d:
"""Z vector of the coordinate system in 3D
[:information_source: Available for script filled attributes](#){.mark-text}
Returns:
point_3d: point_3d (x,y,z)
"""
get_minimum_distance_between_elements(first_element, second_element)
get the minimum distance between two elements
Available for script filled attributes
Parameters:
Name | Type | Description | Default |
---|---|---|---|
first_element |
int |
element ID |
required |
second_element |
int |
element ID |
required |
Returns:
Type | Description |
---|---|
float |
value |
Source code in geometry_controller/__init__.py
def get_minimum_distance_between_elements(first_element: int, second_element: int) -> float:
"""get the minimum distance between two elements
[:information_source: Available for script filled attributes](#){.mark-text}
Args:
first_element (int): element ID
second_element (int): element ID
Returns:
float: value
"""
get_over_height(element)
get over height
Available for script filled attributes
Parameters:
Name | Type | Description | Default |
---|---|---|---|
element |
int |
element ID |
required |
Returns:
Type | Description |
---|---|
float |
value |
Source code in geometry_controller/__init__.py
def get_over_height(element: int) -> float:
"""get over height
[:information_source: Available for script filled attributes](#){.mark-text}
Args:
element (int): element ID
Returns:
float: value
"""
get_over_length(element)
get over length
Available for script filled attributes
Parameters:
Name | Type | Description | Default |
---|---|---|---|
element |
int |
element ID |
required |
Returns:
Type | Description |
---|---|
float |
value |
Source code in geometry_controller/__init__.py
def get_over_length(element: int) -> float:
"""get over length
[:information_source: Available for script filled attributes](#){.mark-text}
Args:
element (int): element ID
Returns:
float: value
"""
get_over_width(element)
get over widht
Available for script filled attributes
Parameters:
Name | Type | Description | Default |
---|---|---|---|
element |
int |
element ID |
required |
Returns:
Type | Description |
---|---|
float |
value |
Source code in geometry_controller/__init__.py
def get_over_width(element: int) -> float:
"""get over widht
[:information_source: Available for script filled attributes](#){.mark-text}
Args:
element (int): element ID
Returns:
float: value
"""
get_p1(element)
Get start Point of element.
Available for script filled attributes
Parameters:
Name | Type | Description | Default |
---|---|---|---|
element |
int |
element ID |
required |
Returns:
Type | Description |
---|---|
point_3d |
start point |
Source code in geometry_controller/__init__.py
def get_p1(element: int) -> point_3d:
"""Get start Point of element.
[:information_source: Available for script filled attributes](#){.mark-text}
Args:
element (int): element ID
Returns:
point_3d: start point
"""
get_p2(element)
Get end Point of element.
Available for script filled attributes
Parameters:
Name | Type | Description | Default |
---|---|---|---|
element |
int |
element ID |
required |
Returns:
Type | Description |
---|---|
point_3d |
end point |
Source code in geometry_controller/__init__.py
def get_p2(element: int) -> point_3d:
"""Get end Point of element.
[:information_source: Available for script filled attributes](#){.mark-text}
Args:
element (int): element ID
Returns:
point_3d: end point
"""
get_p3(element)
Point for orientation of the Z axis of the element. This point is on the same plane as point 1.
Available for script filled attributes
Parameters:
Name | Type | Description | Default |
---|---|---|---|
element |
int |
element ID |
required |
Returns:
Type | Description |
---|---|
point_3d |
orientation point |
Source code in geometry_controller/__init__.py
def get_p3(element: int) -> point_3d:
"""Point for orientation of the Z axis of the element. This point is on the same plane as point 1.
[:information_source: Available for script filled attributes](#){.mark-text}
Args:
element (int): element ID
Returns:
point_3d: orientation point
"""
get_reference_side(element)
get element reference side
Available for script filled attributes
Parameters:
Name | Type | Description | Default |
---|---|---|---|
element |
int |
element ID |
required |
Returns:
Type | Description |
---|---|
int |
face ID |
Source code in geometry_controller/__init__.py
def get_reference_side(element: int) -> int:
"""get element reference side
[:information_source: Available for script filled attributes](#){.mark-text}
Args:
element (int): element ID
Returns:
int: face ID
"""
get_rounding_height(element)
get rounding height
Available for script filled attributes
Parameters:
Name | Type | Description | Default |
---|---|---|---|
element |
int |
element ID |
required |
Returns:
Type | Description |
---|---|
float |
value |
Source code in geometry_controller/__init__.py
def get_rounding_height(element: int) -> float:
"""get rounding height
[:information_source: Available for script filled attributes](#){.mark-text}
Args:
element (int): element ID
Returns:
float: value
"""
get_rounding_length(element)
get rounding length
Available for script filled attributes
Parameters:
Name | Type | Description | Default |
---|---|---|---|
element |
int |
element ID |
required |
Returns:
Type | Description |
---|---|
float |
value |
Source code in geometry_controller/__init__.py
def get_rounding_length(element: int) -> float:
"""get rounding length
[:information_source: Available for script filled attributes](#){.mark-text}
Args:
element (int): element ID
Returns:
float: value
"""
get_rounding_width(element)
get rounding width
Available for script filled attributes
Parameters:
Name | Type | Description | Default |
---|---|---|---|
element |
int |
element ID |
required |
Returns:
Type | Description |
---|---|
float |
value |
Source code in geometry_controller/__init__.py
def get_rounding_width(element: int) -> float:
"""get rounding width
[:information_source: Available for script filled attributes](#){.mark-text}
Args:
element (int): element ID
Returns:
float: value
"""
get_start_height_cut_angle(element)
get start height cut angle
Available for script filled attributes
Parameters:
Name | Type | Description | Default |
---|---|---|---|
element |
int |
element ID |
required |
Returns:
Type | Description |
---|---|
float |
value |
Source code in geometry_controller/__init__.py
def get_start_height_cut_angle(element: int) -> float:
"""get start height cut angle
[:information_source: Available for script filled attributes](#){.mark-text}
Args:
element (int): element ID
Returns:
float: value
"""
get_start_width_cut_angle(element)
get start width cut angle
Available for script filled attributes
Parameters:
Name | Type | Description | Default |
---|---|---|---|
element |
int |
element ID |
required |
Returns:
Type | Description |
---|---|
float |
value |
Source code in geometry_controller/__init__.py
def get_start_width_cut_angle(element: int) -> float:
"""get start width cut angle
[:information_source: Available for script filled attributes](#){.mark-text}
Args:
element (int): element ID
Returns:
float: value
"""
get_total_area_of_all_faces(element)
get total area fo all element faces
Available for script filled attributes
Parameters:
Name | Type | Description | Default |
---|---|---|---|
element |
int |
element ID |
required |
Returns:
Type | Description |
---|---|
float |
value |
Source code in geometry_controller/__init__.py
def get_total_area_of_all_faces(element: int) -> float:
"""get total area fo all element faces
[:information_source: Available for script filled attributes](#){.mark-text}
Args:
element (int): element ID
Returns:
float: value
"""
get_volume(element)
get element volume
Available for script filled attributes
Parameters:
Name | Type | Description | Default |
---|---|---|---|
element |
int |
element ID |
required |
Returns:
Type | Description |
---|---|
float |
value |
Source code in geometry_controller/__init__.py
def get_volume(element: int) -> float:
"""get element volume
[:information_source: Available for script filled attributes](#){.mark-text}
Args:
element (int): element ID
Returns:
float: value
"""
get_weight(element)
get element weight
Available for script filled attributes
Parameters:
Name | Type | Description | Default |
---|---|---|---|
element |
int |
element ID |
required |
Returns:
Type | Description |
---|---|
float |
value |
Source code in geometry_controller/__init__.py
def get_weight(element: int) -> float:
"""get element weight
[:information_source: Available for script filled attributes](#){.mark-text}
Args:
element (int): element ID
Returns:
float: value
"""
get_weight_real(element)
Get weight real
Available for script filled attributes
Parameters:
Name | Type | Description | Default |
---|---|---|---|
element |
int |
element ID |
required |
Returns:
Type | Description |
---|---|
float |
weight real |
Source code in geometry_controller/__init__.py
def get_weight_real(element: int) -> float:
"""Get weight real
[:information_source: Available for script filled attributes](#){.mark-text}
Args:
element (int): element ID
Returns:
float: weight real
"""
get_width(element)
Get element width.
Available for script filled attributes
Parameters:
Name | Type | Description | Default |
---|---|---|---|
element |
int |
element ID |
required |
Returns:
Type | Description |
---|---|
float |
width |
Source code in geometry_controller/__init__.py
def get_width(element: int) -> float:
"""Get element width.
[:information_source: Available for script filled attributes](#){.mark-text}
Args:
element (int): element ID
Returns:
float: width
"""
get_window_surface(elements)
get window surface
Available for script filled attributes
Parameters:
Name | Type | Description | Default |
---|---|---|---|
elements |
List[int] |
element IDs |
required |
Returns:
Type | Description |
---|---|
float |
value |
Source code in geometry_controller/__init__.py
def get_window_surface(elements: List[int]) -> float:
"""get window surface
[:information_source: Available for script filled attributes](#){.mark-text}
Args:
elements (List[int]): element IDs
Returns:
float: value
"""
get_xl(element)
get local X vector
Available for script filled attributes
Parameters:
Name | Type | Description | Default |
---|---|---|---|
element |
int |
element ID |
required |
Returns:
Type | Description |
---|---|
point_3d |
point_3d (x,y,z) |
Source code in geometry_controller/__init__.py
def get_xl(element: int) -> point_3d:
"""get local X vector
[:information_source: Available for script filled attributes](#){.mark-text}
Args:
element (int): element ID
Returns:
point_3d: point_3d (x,y,z)
"""
get_yl(element)
get local Y vector
Available for script filled attributes
Parameters:
Name | Type | Description | Default |
---|---|---|---|
element |
int |
element ID |
required |
Returns:
Type | Description |
---|---|
point_3d |
point_3d (x,y,z) |
Source code in geometry_controller/__init__.py
def get_yl(element: int) -> point_3d:
"""get local Y vector
[:information_source: Available for script filled attributes](#){.mark-text}
Args:
element (int): element ID
Returns:
point_3d: point_3d (x,y,z)
"""
get_zl(element)
get local Z vector
Available for script filled attributes
Parameters:
Name | Type | Description | Default |
---|---|---|---|
element |
int |
element ID |
required |
Returns:
Type | Description |
---|---|
point_3d |
point_3d (x,y,z) |
Source code in geometry_controller/__init__.py
def get_zl(element: int) -> point_3d:
"""get local Z vector
[:information_source: Available for script filled attributes](#){.mark-text}
Args:
element (int): element ID
Returns:
point_3d: point_3d (x,y,z)
"""
invert_model(elements)
Inverts element model
Parameters:
Name | Type | Description | Default |
---|---|---|---|
elements |
List[int] |
element IDs |
required |
Source code in geometry_controller/__init__.py
def invert_model(elements: List[int]) -> None:
"""Inverts element model
Args:
elements (List[int]): element IDs
"""
rotate_height_axis_180(elements)
rotate element height axis 180°
Parameters:
Name | Type | Description | Default |
---|---|---|---|
elements |
List[int] |
element IDs |
required |
Source code in geometry_controller/__init__.py
def rotate_height_axis_180(elements: List[int]) -> None:
"""rotate element height axis 180°
Args:
elements (List[int]): element IDs
"""
rotate_height_axis_2_points(elements, start, end)
rotate height axis via 2 points. The axis is defined by a point 1 and a point 2.
Parameters:
Name | Type | Description | Default |
---|---|---|---|
elements |
List[int] |
element IDs |
required |
start |
point_3d |
start point |
required |
end |
point_3d |
end point |
required |
Source code in geometry_controller/__init__.py
def rotate_height_axis_2_points(elements: List[int], start: point_3d, end: point_3d) -> None:
"""rotate height axis via 2 points. The axis is defined by a point 1 and a point 2.
Args:
elements (List[int]): element IDs
start (point_3d): start point
end (point_3d): end point
"""
rotate_height_axis_90(elements)
rotate element height axis 90°
Parameters:
Name | Type | Description | Default |
---|---|---|---|
elements |
List[int] |
element IDs |
required |
Source code in geometry_controller/__init__.py
def rotate_height_axis_90(elements: List[int]) -> None:
"""rotate element height axis 90°
Args:
elements (List[int]): element IDs
"""
rotate_length_axis_180(elements)
rotate length axis 180°
Parameters:
Name | Type | Description | Default |
---|---|---|---|
elements |
List[int] |
element IDs |
required |
Source code in geometry_controller/__init__.py
def rotate_length_axis_180(elements: List[int]) -> None:
"""rotate length axis 180°
Args:
elements (List[int]): element IDs
"""
rotate_length_axis_2_points(elements, start, end)
rotate length axis via 2 points. The axis is defined by a point 1 and a point 2.
Parameters:
Name | Type | Description | Default |
---|---|---|---|
elements |
List[int] |
element IDs |
required |
start |
point_3d |
start point |
required |
end |
point_3d |
end point |
required |
Source code in geometry_controller/__init__.py
def rotate_length_axis_2_points(elements: List[int], start: point_3d, end: point_3d) -> None:
"""rotate length axis via 2 points. The axis is defined by a point 1 and a point 2.
Args:
elements (List[int]): element IDs
start (point_3d): start point
end (point_3d): end point
"""
rotate_length_axis_90(elements)
rotate length axis 90°
Parameters:
Name | Type | Description | Default |
---|---|---|---|
elements |
List[int] |
element IDs |
required |
Source code in geometry_controller/__init__.py
def rotate_length_axis_90(elements: List[int]) -> None:
"""rotate length axis 90°
Args:
elements (List[int]): element IDs
"""
set_cross_correction_negative_height(element, value)
set cross correction negative height
Parameters:
Name | Type | Description | Default |
---|---|---|---|
element |
int |
element ID |
required |
value |
float |
a value |
required |
Source code in geometry_controller/__init__.py
def set_cross_correction_negative_height(element: int, value: float) -> None:
"""set cross correction negative height
Args:
element (int): element ID
value (float): a value
"""
set_cross_correction_negative_length(element, value)
set cross correction negative length
Parameters:
Name | Type | Description | Default |
---|---|---|---|
element |
int |
element ID |
required |
value |
float |
a value |
required |
Source code in geometry_controller/__init__.py
def set_cross_correction_negative_length(element: int, value: float) -> None:
"""set cross correction negative length
Args:
element (int): element ID
value (float): a value
"""
set_cross_correction_negative_width(element, value)
set cross correction negative width
Parameters:
Name | Type | Description | Default |
---|---|---|---|
element |
int |
element ID |
required |
value |
float |
a value |
required |
Source code in geometry_controller/__init__.py
def set_cross_correction_negative_width(element: int, value: float) -> None:
"""set cross correction negative width
Args:
element (int): element ID
value (float): a value
"""
set_cross_correction_positive_height(element, value)
set cross correction positive height
Parameters:
Name | Type | Description | Default |
---|---|---|---|
element |
int |
element ID |
required |
value |
float |
a value |
required |
Source code in geometry_controller/__init__.py
def set_cross_correction_positive_height(element: int, value: float) -> None:
"""set cross correction positive height
Args:
element (int): element ID
value (float): a value
"""
set_cross_correction_positive_length(element, value)
set cross correction positive length
Parameters:
Name | Type | Description | Default |
---|---|---|---|
element |
int |
element ID |
required |
value |
float |
a value |
required |
Source code in geometry_controller/__init__.py
def set_cross_correction_positive_length(element: int, value: float) -> None:
"""set cross correction positive length
Args:
element (int): element ID
value (float): a value
"""
set_cross_correction_positive_width(element, value)
set cross correction positive width
Parameters:
Name | Type | Description | Default |
---|---|---|---|
element |
int |
element ID |
required |
value |
float |
a value |
required |
Source code in geometry_controller/__init__.py
def set_cross_correction_positive_width(element: int, value: float) -> None:
"""set cross correction positive width
Args:
element (int): element ID
value (float): a value
"""
set_drilling_tolerance(elements, value)
set drilling tolerance
Parameters:
Name | Type | Description | Default |
---|---|---|---|
elements |
List[int] |
element IDs |
required |
value |
float |
a value |
required |
Source code in geometry_controller/__init__.py
def set_drilling_tolerance(elements: List[int], value: float) -> None:
"""set drilling tolerance
Args:
elements (List[int]): element IDs
value (float): a value
"""
set_height_real(elements, value)
set height real
Parameters:
Name | Type | Description | Default |
---|---|---|---|
elements |
List[int] |
element IDs |
required |
value |
float |
a value |
required |
Source code in geometry_controller/__init__.py
def set_height_real(elements: List[int], value: float) -> None:
"""set height real
Args:
elements (List[int]): element IDs
value (float): a value
"""
set_length_real(elements, value)
set length real
Parameters:
Name | Type | Description | Default |
---|---|---|---|
elements |
List[int] |
element IDs |
required |
value |
float |
a value |
required |
Source code in geometry_controller/__init__.py
def set_length_real(elements: List[int], value: float) -> None:
"""set length real
Args:
elements (List[int]): element IDs
value (float): a value
"""
set_over_height(element, value)
set over height
Parameters:
Name | Type | Description | Default |
---|---|---|---|
element |
int |
element ID |
required |
value |
float |
a value |
required |
Source code in geometry_controller/__init__.py
def set_over_height(element: int, value: float) -> None:
"""set over height
Args:
element (int): element ID
value (float): a value
"""
set_over_length(element, value)
set over length
Parameters:
Name | Type | Description | Default |
---|---|---|---|
element |
int |
element ID |
required |
value |
float |
a value |
required |
Source code in geometry_controller/__init__.py
def set_over_length(element: int, value: float) -> None:
"""set over length
Args:
element (int): element ID
value (float): a value
"""
set_over_width(element, value)
set over width
Parameters:
Name | Type | Description | Default |
---|---|---|---|
element |
int |
element ID |
required |
value |
float |
a value |
required |
Source code in geometry_controller/__init__.py
def set_over_width(element: int, value: float) -> None:
"""set over width
Args:
element (int): element ID
value (float): a value
"""
set_rounding_height(element, value)
set rounding height
Parameters:
Name | Type | Description | Default |
---|---|---|---|
element |
int |
element ID |
required |
value |
float |
a value |
required |
Source code in geometry_controller/__init__.py
def set_rounding_height(element: int, value: float) -> None:
"""set rounding height
Args:
element (int): element ID
value (float): a value
"""
set_rounding_length(element, value)
set rounding length
Parameters:
Name | Type | Description | Default |
---|---|---|---|
element |
int |
element ID |
required |
value |
float |
a value |
required |
Source code in geometry_controller/__init__.py
def set_rounding_length(element: int, value: float) -> None:
"""set rounding length
Args:
element (int): element ID
value (float): a value
"""
set_rounding_width(element, value)
set rounding width
Parameters:
Name | Type | Description | Default |
---|---|---|---|
element |
int |
element ID |
required |
value |
float |
a value |
required |
Source code in geometry_controller/__init__.py
def set_rounding_width(element: int, value: float) -> None:
"""set rounding width
Args:
element (int): element ID
value (float): a value
"""
set_width_real(elements, value)
set width real
Parameters:
Name | Type | Description | Default |
---|---|---|---|
elements |
List[int] |
element IDs |
required |
value |
float |
a value |
required |
Source code in geometry_controller/__init__.py
def set_width_real(elements: List[int], value: float) -> None:
"""set width real
Args:
elements (List[int]): element IDs
value (float): a value
"""