kindred/create
1
1
Fork 0
Code Issues 37 Pull Requests Actions Packages Projects 9 Releases 2 Wiki Activity

BIM: fix ArchRebar default name (#21681)

Browse Source 
* BIM: ArchRebar, only import GUI modules if the GUI is up

* BIM: ArchRebar, add tests

* BIM: Arch.makeRebar, fix rebar default name

* BIM: Arch.makeRebar, add type hints

* BIM: Arch.makeRebar, add code comments

* BIM: Arch.makeRebar, expand docstring
This commit is contained in:
Furgo
2025-06-02 18:31:50 +02:00
committed by GitHub
parent 3fc9cac29c
commit b7008de12a
3 changed files with 222 additions and 27 deletions
Download Patch File Download Diff File Expand all files Collapse all files

150
src/Mod/BIM/bimtests/TestArchRebar.py
View File

@@ -22,18 +22,152 @@
# * *
# ***************************************************************************
import FreeCAD
import Arch
import Part
from bimtests import TestArchBase
class TestArchRebar(TestArchBase.TestArchBase):
# TODO: remove NOT_ prefix once it is understood why Arch.makeRebar fails
# Check https://wiki.freecad.org/Arch_Rebar#Scripting
def NOT_test_makeRebar(self):
"""Test the makeRebar function."""
operation = "Testing makeRebar function"
self.printTestMessage(operation)
def _create_sketch(self, add_line=True, length=500.0):
"""Helper function to create a basic sketch."""
sketch = self.document.addObject("Sketcher::SketchObject")
if add_line:
sketch.addGeometry(Part.LineSegment(FreeCAD.Vector(0,0,0),
FreeCAD.Vector(length,0,0)), False)
self.document.recompute()
return sketch
def _create_host_structure(self, length=1000.0, width=200.0, height=300.0):
"""Helper function to create a basic host structure."""
host = Arch.makeStructure(length=length, width=width, height=height)
self.document.recompute()
return host
def test_makeRebar_default_name(self):
"""Test makeRebar creates rebar with default 'Rebar' Label.
See https://github.com/FreeCAD/FreeCAD/issues/21670
"""
sketch = self._create_sketch()
rebar = Arch.makeRebar(sketch=sketch, diameter=6)
self.document.recompute()
rebar = Arch.makeRebar(diameter=16, amount=5, name="TestRebar")
self.assertIsNotNone(rebar, "makeRebar failed to create a rebar object.")
self.assertEqual(rebar.Label, "TestRebar", "Rebar label is incorrect.")
self.assertEqual(rebar.Label, "Rebar", "Rebar default label should be 'Rebar'.")
self.assertTrue(rebar.Name.startswith("Rebar"),
"Rebar internal name should start with 'Rebar'.")
def test_makeRebar_custom_name(self):
"""Test makeRebar with a custom name sets Label and Mark correctly."""
sketch = self._create_sketch()
custom_name = "MyCustomRebar"
rebar = Arch.makeRebar(sketch=sketch, diameter=16, amount=5, name=custom_name)
self.document.recompute()
self.assertIsNotNone(rebar, "makeRebar failed to create a rebar object.")
self.assertEqual(rebar.Label, custom_name, "Rebar label is incorrect.")
self.assertEqual(rebar.Mark, custom_name,
"Rebar mark should match label by default.")
def test_makeRebar_with_sketch_and_host(self):
"""Test makeRebar with both sketch and host object links them correctly."""
sketch_len = 800.0
host_len = 1000.0
sketch = self._create_sketch(length=sketch_len)
host = self._create_host_structure(length=host_len)
rebar = Arch.makeRebar(baseobj=host, sketch=sketch, diameter=10, amount=3, offset=20)
self.document.recompute()
self.assertIsNotNone(rebar, "makeRebar failed.")
self.assertEqual(rebar.Host, host, "Rebar.Host is not set correctly.")
self.assertEqual(rebar.Base, sketch, "Rebar.Base (sketch) is not set correctly.")
self.assertAlmostEqual(rebar.Diameter.Value, 10.0, delta=1e-9)
self.assertEqual(rebar.Amount, 3)
self.assertAlmostEqual(rebar.OffsetStart.Value, 20.0, delta=1e-9)
self.assertTrue(hasattr(rebar, "Shape"), "Rebar should have a Shape attribute.")
self.assertIsNotNone(rebar.Shape, "Rebar.Shape should not be None after recompute.")
self.assertTrue(rebar.Shape.isValid(), "Rebar.Shape should be valid.")
self.assertGreater(rebar.Shape.Length, 0, "Rebar shape seems to have no length.")
self.assertGreater(rebar.TotalLength.Value, 0,
"Rebar total length should be greater than 0.")
def test_makeRebar_with_sketch_only(self):
"""Test makeRebar with only sketch results in no host and valid geometry."""
sketch = self._create_sketch()
rebar = Arch.makeRebar(sketch=sketch, diameter=8)
self.document.recompute()
self.assertIsNotNone(rebar, "makeRebar failed.")
self.assertIsNone(rebar.Host, "Rebar.Host should be None.")
self.assertEqual(rebar.Base, sketch, "Rebar.Base (sketch) is not set correctly.")
self.assertAlmostEqual(rebar.Diameter.Value, 8.0, delta=1e-9)
self.assertIsNotNone(rebar.Shape)
self.assertTrue(rebar.Shape.isValid())
self.assertGreater(rebar.Shape.Length, 0)
def test_makeRebar_with_baseobj_only_shape_conversion(self):
"""Test makeRebar with baseobj only copies shape."""
host_shape_provider = self._create_host_structure()
rebar = Arch.makeRebar(baseobj=host_shape_provider)
self.document.recompute()
self.assertIsNotNone(rebar, "makeRebar failed.")
self.assertIsNone(rebar.Host, "Rebar.Host should be None in this mode.")
self.assertIsNone(rebar.Base, "Rebar.Base should be None in this mode.")
self.assertIsNotNone(rebar.Shape, "Rebar.Shape should be set from baseobj.")
self.assertTrue(rebar.Shape.isValid())
self.assertGreater(rebar.Shape.Volume, 0,
"Converted rebar shape should have volume.")
def test_makeRebar_properties_set_correctly(self):
"""Test makeRebar sets dimensional and calculated properties correctly."""
sketch = self._create_sketch(length=900)
host = self._create_host_structure(length=1200)
rebar = Arch.makeRebar(
baseobj=host,
sketch=sketch,
diameter=12.5,
amount=7,
offset=30.0
)
# Default label "Rebar" will be used, and Mark will also be "Rebar"
self.document.recompute()
self.assertEqual(rebar.Mark, "Rebar")
self.assertAlmostEqual(rebar.Diameter.Value, 12.5, delta=1e-9)
self.assertEqual(rebar.Amount, 7)
self.assertAlmostEqual(rebar.OffsetStart.Value, 30.0, delta=1e-9)
self.assertAlmostEqual(rebar.OffsetEnd.Value, 30.0, delta=1e-9)
self.assertEqual(rebar.Host, host)
self.assertEqual(rebar.Base, sketch)
self.assertTrue(hasattr(rebar, "Length"), "Rebar should have Length property.")
self.assertTrue(hasattr(rebar, "TotalLength"), "Rebar should have TotalLength property.")
self.assertAlmostEqual(rebar.Length.Value, sketch.Shape.Length, delta=1e-9,
msg="Single rebar length should match sketch length.")
expected_total_length = rebar.Length.Value * rebar.Amount
self.assertAlmostEqual(rebar.TotalLength.Value, expected_total_length, delta=1e-9,
msg="TotalLength calculation is incorrect.")
def test_makeRebar_no_sketch_no_baseobj(self):
"""Test makeRebar with no sketch/baseobj creates object with no meaningful shape."""
rebar = Arch.makeRebar(diameter=10, amount=1)
self.document.recompute()
self.assertIsNotNone(rebar,
"makeRebar should create an object even with minimal inputs.")
self.assertIsNone(rebar.Base, "Rebar.Base should be None.")
self.assertIsNone(rebar.Host, "Rebar.Host should be None.")
self.assertAlmostEqual(rebar.Diameter.Value, 10.0, delta=1e-9)
self.assertEqual(rebar.Amount, 1)
# A Part::FeaturePython object always has a .Shape attribute.
# For a rebar with no Base, its execute() returns early, so no geometry is made.
# The Shape should be the default null/empty shape.
self.assertIsNotNone(rebar.Shape, "Rebar object should always have a Shape attribute.")
self.assertTrue(rebar.Shape.isNull(),
"Rebar.Shape should be a null shape if no Base is provided.")