Glassvision/IfcOpenShell
1
0
Fork 0
mirror of https://github.com/IfcOpenShell/IfcOpenShell.git synced 2026-09-07 12:56:26 +00:00
Code Issues Packages Projects Releases Wiki Activity

clip_solid: add element param signature and doc warning

Browse Source
This commit is contained in:
Bruno Postle
2026-03-23 22:35:03 +00:00
parent 25e99c722e
commit 020ef09a0c
1 changed files with 10 additions and 3 deletions
Download Patch File Download Diff File Expand all files Collapse all files
src/ifcopenshell-python/ifcopenshell/api/geometry/clip_solid.py
+10 -3
View File
@@ -29,13 +29,20 @@ def clip_solid(
item: ifcopenshell.entity_instance, item: ifcopenshell.entity_instance,
location: Sequence[float], location: Sequence[float],
normal: Sequence[float], normal: Sequence[float],
element: Optional[ifcopenshell.entity_instance] = None,
) -> ifcopenshell.entity_instance: ) -> ifcopenshell.entity_instance:
"""Clip a solid with a half-space plane, returning an IfcBooleanClippingResult. """Clip a solid with a half-space plane, returning an IfcBooleanClippingResult.
Convenience wrapper around :class:`ifcopenshell.util.data.Clipping` for Convenience wrapper around :class:`ifcopenshell.util.data.Clipping` for
use with any solid. The ``normal`` points toward the **removed** material use with any solid. This is the same convention used by the ``clippings``
(the void side); the kept region is on the opposite side. This is the same parameter of :func:`add_wall_representation`.
convention used by the ``clippings`` parameter of :func:`add_wall_representation`.
.. warning::
The ``normal`` points toward the **removed** material (the discarded
side), not toward the kept material. For a slope clip the normal
points upward into the removed wedge above the slope line. For a
side mitre the normal points outward away from the wall body.
After clipping, set the parent ``IfcShapeRepresentation`` After clipping, set the parent ``IfcShapeRepresentation``
``RepresentationType`` to ``"Clipping"``. ``RepresentationType`` to ``"Clipping"``.