Write documentation for structural API module

This commit is contained in:
Dion Moult
2023-01-03 17:32:08 +11:00
parent e53a9cd66c
commit 0c77fb81ce
21 changed files with 342 additions and 101 deletions
@@ -18,22 +18,34 @@
class Usecase:
def __init__(self, file, **settings):
def __init__(self, file, structural_item=None, axis=None, ref_direction=None):
"""Edits the coordinate system of a structural connection
:param structural_item: The IfcStructuralItem you want to modify.
:type structural_item: ifcopenshell.entity_instance.entity_instance
:param axis: The unit Z axis vector defined as a list of 3 floats.
Defaults to [0., 0., 1.].
:type axis: list[float]
:param ref_direction: The unit X axis vector defined as a list of 3
floats. Defaults to [1., 0., 0.].
:type ref_direction: list[float]
:return: None
:rtype: None
"""
self.file = file
self.settings = {"structural_item": None, "axis": [0.0, 0.0, 1.0], "ref_direction": [1.0, 0.0, 0.0]}
for key, value in settings.items():
self.settings[key] = value
self.settings = {
"structural_item": structural_item,
"axis": axis or [0.0, 0.0, 1.0],
"ref_direction": ref_direction or [1.0, 0.0, 0.0],
}
def execute(self):
if self.settings["structural_item"].ConditionCoordinateSystem is None:
point = self.file.createIfcCartesianPoint((0.0, 0.0, 0.0))
ccs = self.file.createIfcAxis2Placement3D(point, None, None)
self.settings["structural_item"].ConditionCoordinateSystem = ccs
print(ccs)
ccs = self.settings["structural_item"].ConditionCoordinateSystem
print("use case")
print(ccs)
if ccs.Axis and len(self.file.get_inverse(ccs.Axis)) == 1:
self.file.remove(ccs.Axis)
ccs.Axis = self.file.createIfcDirection(self.settings["axis"])