Glassvision/IfcOpenShell
1
0
Fork 0
mirror of https://github.com/IfcOpenShell/IfcOpenShell.git synced 2026-08-13 10:57:49 +00:00
Code Issues Packages Projects Releases Wiki Activity

Even more cleaning of documentation references

Browse Source
This commit is contained in:
Dion Moult
2024-05-07 19:08:13 +10:00
parent d76462ca42
commit 93639e9e50
15 changed files with 181 additions and 139 deletions
Download Patch File Download Diff File Expand all files Collapse all files
src/ifcopenshell-python/ifcopenshell/util/shape.py
+8 -8
View File
@@ -161,7 +161,7 @@ def get_element_bbox_centroid(element: ifcopenshell.entity_instance, geometry) -
is more efficient to use ``get_shape_bbox_centroid``.
:param element: The element occurrence
:type: ifcopenshell.entity_instance.entity_instance
:type: ifcopenshell.entity_instance
:param geometry: Geometry output calculated by IfcOpenShell
:type geometry: geometry
:return: A tuple representing the XYZ centroid
@@ -271,7 +271,7 @@ def get_element_vertices(element: ifcopenshell.entity_instance, geometry) -> npt
Results are a nested numpy array e.g. [[v1x, v1y, v1z], [v2x, v2y, v2z], ...]
:param element: The element occurrence
:type: ifcopenshell.entity_instance.entity_instance
:type: ifcopenshell.entity_instance
:param geometry: Geometry output calculated by IfcOpenShell
:type geometry: geometry
:return: A numpy array listing all the vertices. Each vertex is a numpy array with XYZ coordinates.
@@ -347,7 +347,7 @@ def get_element_bottom_elevation(element: ifcopenshell.entity_instance, geometry
``get_shape_bottom_elevation``.
:param element: The element occurrence
:type: ifcopenshell.entity_instance.entity_instance
:type: ifcopenshell.entity_instance
:param geometry: Geometry output calculated by IfcOpenShell
:type geometry: geometry
:return: The Z value
@@ -363,7 +363,7 @@ def get_element_top_elevation(element: ifcopenshell.entity_instance, geometry) -
``get_shape_top_elevation``.
:param element: The element occurrence
:type: ifcopenshell.entity_instance.entity_instance
:type: ifcopenshell.entity_instance
:param geometry: Geometry output calculated by IfcOpenShell
:type geometry: geometry
:return: The Z value
@@ -656,9 +656,9 @@ def get_profiles(element: ifcopenshell.entity_instance) -> list[ifcopenshell.ent
solid extrusions. This is useful for later doing 2D take-off from profiles.
:param element: The element occurrence
:type: ifcopenshell.entity_instance.entity_instance
:type: ifcopenshell.entity_instance
:return: A list of profiles
:rtype: list[ifcopenshell.entity_instance.entity_instance]
:rtype: list[ifcopenshell.entity_instance]
"""
material = ifcopenshell.util.element.get_material(element, should_skip_usage=True)
if material and material.is_a("IfcMaterialProfileSet"):
@@ -670,9 +670,9 @@ def get_extrusions(element: ifcopenshell.entity_instance) -> list[ifcopenshell.e
"""Gets all extruded area solids used to define an element's model body geometry
:param element: The element occurrence
:type: ifcopenshell.entity_instance.entity_instance
:type: ifcopenshell.entity_instance
:return: A list of extrusion representation items
:rtype: list[ifcopenshell.entity_instance.entity_instance]
:rtype: list[ifcopenshell.entity_instance]
"""
representation = ifcopenshell.util.representation.get_representation(element, "Model", "Body", "MODEL_VIEW")
if not representation: