mirror of
https://github.com/IfcOpenShell/IfcOpenShell.git
synced 2026-08-10 01:41:57 +00:00
Gorgious56
4d4c5b4d51
add_railing_representation now factors into two parts: * compute_wall_mounted_handrail_geometry returns a pure-geometry WallMountedHandrailGeometry dataclass (handrail polyline + support list + terminal caps), no IFC mutation. * add_railing_representation wraps that dataclass into an IfcShapeRepresentation as before. Downstream consumers that want the same math without round-tripping through an IFC file (Blender gizmo previews, viewport drafts) now drive compute_X directly. Future add_X_representation work in the geometry API is encouraged to follow the same shape — a sibling compute_X function + thin IFC wrapper. The railing_type parameter is dropped from the signature — only WALL_MOUNTED_HANDRAIL was ever supported, so the kwarg was dead. The Bonsai railing-modifier caller is updated in the same commit to stop passing it; without that update Bonsai's finish_editing_railing_path raises TypeError on the first edit. RailingSupport and WallMountedHandrailGeometry use @dataclass(slots=True) — they're constructed N-per-cap during arc sampling, so the per-instance overhead matters. Public symbols (RailingSupport, TERMINAL_TYPE, WallMountedHandrailGeometry, compute_wall_mounted_handrail_geometry, add_railing_representation) re-exported from ifcopenshell.api.geometry. New test/api/geometry/test_add_railing_representation.py covers the compute/wrap contract. Generated with the assistance of an AI coding tool.
114 lines
4.4 KiB
Python
114 lines
4.4 KiB
Python
# IfcOpenShell - IFC toolkit and geometry engine
|
|
# Copyright (C) 2022 Dion Moult <dion@thinkmoult.com>
|
|
#
|
|
# This file is part of IfcOpenShell.
|
|
#
|
|
# IfcOpenShell is free software: you can redistribute it and/or modify
|
|
# it under the terms of the GNU Lesser General Public License as published by
|
|
# the Free Software Foundation, either version 3 of the License, or
|
|
# (at your option) any later version.
|
|
#
|
|
# IfcOpenShell is distributed in the hope that it will be useful,
|
|
# but WITHOUT ANY WARRANTY; without even the implied warranty of
|
|
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
|
# GNU Lesser General Public License for more details.
|
|
#
|
|
# You should have received a copy of the GNU Lesser General Public License
|
|
# along with IfcOpenShell. If not, see <http://www.gnu.org/licenses/>.
|
|
|
|
"""Create geometric representations and assign them to elements
|
|
|
|
These functions support both the creation of arbitrary geometry as well as
|
|
geometry that follows parametric rules (e.g. layered geometry or profiled
|
|
geometry extrusions).
|
|
"""
|
|
|
|
from .. import wrap_usecases
|
|
from .add_axis_representation import add_axis_representation
|
|
from .add_topology_representation import add_topology_representation
|
|
from .add_boolean import add_boolean
|
|
from .clip_solid import clip_solid
|
|
from .clip_solid_bounded import clip_solid_bounded
|
|
from .add_door_representation import add_door_representation
|
|
from .add_footprint_representation import add_footprint_representation
|
|
from .add_mesh_representation import add_mesh_representation
|
|
from .add_profile_representation import add_profile_representation
|
|
|
|
# add_railing_representation is the pilot for a "pure-compute + IFC-wrap" split:
|
|
# compute_wall_mounted_handrail_geometry returns a dataclass with the raw geometry,
|
|
# add_railing_representation wraps it into an IfcShapeRepresentation. The split lets
|
|
# downstream consumers (Blender gizmo previews, etc.) drive the same math without
|
|
# round-tripping through an IFC file. Future add_X_representation work is encouraged
|
|
# to follow the same shape — sibling compute_X_geometry function + thin IFC wrapper.
|
|
from .add_railing_representation import (
|
|
RailingSupport,
|
|
TERMINAL_TYPE,
|
|
WallMountedHandrailGeometry,
|
|
add_railing_representation,
|
|
compute_wall_mounted_handrail_geometry,
|
|
)
|
|
|
|
try:
|
|
from .add_representation import add_representation
|
|
except (ModuleNotFoundError, ImportError):
|
|
# ImportError - in case if user has fake-bpy modules.
|
|
pass # Silently fail. This is Blender / Bonsai specific and on its way out.
|
|
from .add_shape_aspect import add_shape_aspect
|
|
from .add_slab_representation import add_slab_representation
|
|
from .add_wall_representation import add_wall_representation
|
|
from .add_window_representation import add_window_representation
|
|
from .assign_representation import assign_representation
|
|
from .connect_element import connect_element
|
|
from .connect_path import connect_path
|
|
from .connect_wall import connect_wall
|
|
from .create_2pt_wall import create_2pt_wall
|
|
from .disconnect_element import disconnect_element
|
|
from .disconnect_path import disconnect_path
|
|
from .edit_object_placement import edit_object_placement
|
|
from .map_representation import map_representation
|
|
from .copy_representation import copy_representation
|
|
from .regenerate_wall_representation import regenerate_wall_representation
|
|
from .remove_boolean import remove_boolean
|
|
from .remove_representation import remove_representation
|
|
from .unassign_representation import unassign_representation
|
|
from .validate_type import validate_type
|
|
|
|
wrap_usecases(__path__, __name__)
|
|
|
|
__all__ = [
|
|
"add_axis_representation",
|
|
"add_topology_representation",
|
|
"add_boolean",
|
|
"clip_solid",
|
|
"clip_solid_bounded",
|
|
"copy_representation",
|
|
"add_door_representation",
|
|
"add_footprint_representation",
|
|
"add_mesh_representation",
|
|
"RailingSupport",
|
|
"TERMINAL_TYPE",
|
|
"WallMountedHandrailGeometry",
|
|
"add_profile_representation",
|
|
"add_railing_representation",
|
|
"compute_wall_mounted_handrail_geometry",
|
|
"add_representation",
|
|
"add_shape_aspect",
|
|
"add_slab_representation",
|
|
"add_wall_representation",
|
|
"add_window_representation",
|
|
"assign_representation",
|
|
"connect_element",
|
|
"connect_path",
|
|
"connect_wall",
|
|
"create_2pt_wall",
|
|
"disconnect_element",
|
|
"disconnect_path",
|
|
"edit_object_placement",
|
|
"map_representation",
|
|
"regenerate_wall_representation",
|
|
"remove_boolean",
|
|
"remove_representation",
|
|
"unassign_representation",
|
|
"validate_type",
|
|
]
|