Files
IfcOpenShell/src/ifcopenshell-python/ifcopenshell/api/geometry/add_door_representation.py
T

508 lines
23 KiB
Python

# IfcOpenShell - IFC toolkit and geometry engine
# Copyright (C) 2023 @Andrej730
#
# 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/>.
import ifcopenshell.util.unit
from ifcopenshell.util.shape_builder import ShapeBuilder, V
from ifcopenshell.api.geometry.add_window_representation import create_ifc_window
from mathutils import Vector
from math import cos, radians
import collections
SUPPORTED_DOOR_TYPES = (
"SINGLE_SWING_LEFT",
"SINGLE_SWING_RIGHT",
"DOUBLE_SWING_RIGHT",
"DOUBLE_SWING_LEFT",
"DOUBLE_DOOR_SINGLE_SWING",
"DOUBLE_DOOR_DOUBLE_SWING",
"SLIDING_TO_LEFT",
"SLIDING_TO_RIGHT",
"DOUBLE_DOOR_SLIDING",
)
def create_ifc_door_lining(
builder: ShapeBuilder, size: Vector, thickness: list, position: Vector = V(0, 0, 0).freeze()
):
"""`thickness` of the profile is defined as list in the following order: `(SIDE, TOP)`
`thickness` can be also defined just as 1 float value.
"""
if not isinstance(thickness, collections.abc.Iterable):
thickness = [thickness] * 2
th_side, th_up = thickness
points = [
V(0.0, 0.0, 0.0),
V(0.0, 0.0, size.z),
V(size.x, 0.0, size.z),
V(size.x, 0.0, 0.0),
V(size.x - th_side, 0.0, 0.0),
V(size.x - th_side, 0.0, size.z - th_up),
V(th_side, 0.0, size.z - th_up),
V(th_side, 0.0, 0.0),
]
points = [p.xz for p in points]
door_lining = builder.polyline(points, closed=True)
door_lining = builder.extrude(
door_lining,
size.y,
position_x_axis=V(1, 0, 0),
position_z_axis=V(0, -1, 0),
extrusion_vector=V(0, 0, -1),
)
builder.translate(door_lining, position)
return door_lining
def create_ifc_box(builder: ShapeBuilder, size: Vector, position: Vector = V(0, 0, 0).freeze()):
rect = builder.rectangle(size.xy)
box = builder.extrude(rect, size.z, position=position, extrusion_vector=V(0, 0, 1))
return box
class Usecase:
def __init__(self, file, **settings):
"""units in settings expected to be in ifc project units"""
self.file = file
# http://ifc43-docs.standards.buildingsmart.org/IFC/RELEASE/IFC4x3/HTML/lexical/IfcDoor.htm
# http://ifc43-docs.standards.buildingsmart.org/IFC/RELEASE/IFC4x3/HTML/lexical/IfcDoorTypeOperationEnum.htm
# http://ifc43-docs.standards.buildingsmart.org/IFC/RELEASE/IFC4x3/HTML/lexical/IfcDoorLiningProperties.htm
# http://ifc43-docs.standards.buildingsmart.org/IFC/RELEASE/IFC4x3/HTML/lexical/IfcDoorPanelProperties.htm
self.settings = {"unit_scale": ifcopenshell.util.unit.calculate_unit_scale(self.file)}
self.settings.update(
{
"context": None, # IfcGeometricRepresentationContext
"overall_height": self.convert_si_to_unit(2.0),
"overall_width": self.convert_si_to_unit(0.9),
# DOUBLE_DOOR_DOUBLE_SWING, DOUBLE_DOOR_FOLDING, DOUBLE_DOOR_LIFTING_VERTICAL,
# DOUBLE_DOOR_SINGLE_SWING, DOUBLE_DOOR_SINGLE_SWING_OPPOSITE_LEFT,
# DOUBLE_DOOR_SINGLE_SWING_OPPOSITE_RIGHT, DOUBLE_DOOR_SLIDING,
# DOUBLE_SWING_LEFT, DOUBLE_SWING_RIGHT, FOLDING_TO_LEFT,
# FOLDING_TO_RIGHT, LIFTING_HORIZONTAL, LIFTING_VERTICAL_LEFT,
# LIFTING_VERTICAL_RIGHT, REVOLVING, REVOLVING_VERTICAL,
# ROLLINGUP, SINGLE_SWING_LEFT, SINGLE_SWING_RIGHT, SLIDING_TO_LEFT,
# SLIDING_TO_RIGHT, SWING_FIXED_LEFT, SWING_FIXED_RIGHT
"operation_type": "SINGLE_SWING_LEFT", # door type
"lining_properties": {
"LiningDepth": self.convert_si_to_unit(0.050),
"LiningThickness": self.convert_si_to_unit(0.050),
# offset from the outer side of the wall (by Y-axis)
"LiningOffset": self.convert_si_to_unit(0.0),
# offset from the wall
"LiningToPanelOffsetX": self.convert_si_to_unit(0.025),
# offset from the X-axis (unlike windows)
"LiningToPanelOffsetY": self.convert_si_to_unit(0.025),
# transom - vertical distance between door and window panels
"TransomThickness": self.convert_si_to_unit(0.000),
# TransomOffset - distance from the bottom door opening
# to the beginning of the transom
# unlike windows TransomOffset which goes to the center of the transom
"TransomOffset": self.convert_si_to_unit(1.525),
"ShapeAspectStyle": None, # DEPRECATED
# Casing cover wall faces around the opening
# on the left, right and upper sides
# Casing should be either on both sides of the wall or no casing
# If `LiningOffset` is present then therefore casing is not possible on outer wall
# therefore there will be no casing on inner wall either
"CasingDepth": self.convert_si_to_unit(0.005),
"CasingThickness": self.convert_si_to_unit(0.075), # by Z-axis
# Threshold covers the bottom side of the opening
"ThresholdDepth": self.convert_si_to_unit(0.1),
"ThresholdThickness": self.convert_si_to_unit(0.025), # by Z-axis
# offset by Y-axis
"ThresholdOffset": self.convert_si_to_unit(0.000),
},
"panel_properties": {
"PanelDepth": self.convert_si_to_unit(0.035), # by Y
"PanelWidth": 1.0, # as ratio to the clear door opening
"FrameDepth": self.convert_si_to_unit(0.035), # by Y
"FrameThickness": self.convert_si_to_unit(0.035), # by X
# LEFT, MIDDLE, RIGHT, NOTDEFINED
"PanelPosition": ..., # NEVER USED
# defines the basic ways to describe how door panels operate
# basically how it opens
"PanelOperation": None, # NEVER USED
"ShapeAspectStyle": None, # DEPRECATED
},
}
)
for key, value in settings.items():
self.settings[key] = value
def execute(self):
builder = ShapeBuilder(self.file)
overall_height = self.settings["overall_height"]
overall_width = self.settings["overall_width"]
door_type = self.settings["operation_type"]
double_swing_door = "DOUBLE_SWING" in door_type
double_door = "DOUBLE_DOOR" in door_type
sliding_door = "SLIDING" in door_type
if door_type not in SUPPORTED_DOOR_TYPES:
raise NotImplementedError(f'Door type "{door_type}" is not currently supported.')
if self.settings["context"].TargetView == "ELEVATION_VIEW":
rect = builder.rectangle(V(overall_width, 0, overall_height))
representation_evelevation = builder.get_representation(self.settings["context"], rect)
return representation_evelevation
panel_props = self.settings["panel_properties"]
lining_props = self.settings["lining_properties"]
# lining params
lining_depth = lining_props["LiningDepth"]
lining_thickness_default = lining_props["LiningThickness"]
lining_offset = lining_props["LiningOffset"]
lining_to_panel_offset_x = (
lining_props["LiningToPanelOffsetX"] if not sliding_door else lining_thickness_default
)
panel_depth = panel_props["PanelDepth"]
lining_to_panel_offset_y_full = lining_props["LiningToPanelOffsetY"] if not sliding_door else -panel_depth
transom_thickness = lining_props["TransomThickness"] / 2
transfom_offset = lining_props["TransomOffset"]
if transom_thickness == 0:
transfom_offset = 0
window_lining_height = overall_height - transfom_offset - transom_thickness
side_lining_thickness = lining_thickness_default
panel_lining_overlap_x = max(lining_thickness_default - lining_to_panel_offset_x, 0) if not sliding_door else 0
top_lining_thickness = transom_thickness or lining_thickness_default
panel_top_lining_overlap_x = max(top_lining_thickness - lining_to_panel_offset_x, 0) if not sliding_door else 0
door_opening_width = overall_width - lining_to_panel_offset_x * 2
if double_swing_door:
side_lining_thickness = side_lining_thickness - panel_lining_overlap_x
top_lining_thickness = top_lining_thickness - panel_top_lining_overlap_x
threshold_thickness = lining_props["ThresholdThickness"]
threshold_depth = lining_props["ThresholdDepth"]
threshold_offset = lining_props["ThresholdOffset"]
threshold_width = overall_width - side_lining_thickness * 2
casing_thickness = lining_props["CasingThickness"]
casing_depth = lining_props["CasingDepth"]
# panel params
panel_width = door_opening_width * panel_props["PanelWidth"]
frame_depth = panel_props["FrameDepth"]
frame_thickness = panel_props["FrameThickness"]
frame_height = window_lining_height - lining_to_panel_offset_x * 2
glass_thickness = self.convert_si_to_unit(0.01)
# handle dimensions (hardcoded)
handle_size = self.convert_si_to_unit(V(120, 40, 20) * 0.001)
handle_offset = self.convert_si_to_unit(V(60, 0, 1000) * 0.001) # to the handle center
handle_center_offset = V(handle_size.y / 2, 0, handle_size.z) / 2
slider_arrow_symbol_size = self.convert_si_to_unit(30 * 0.001)
if transfom_offset:
panel_height = transfom_offset + transom_thickness - lining_to_panel_offset_x - threshold_thickness
lining_height = transfom_offset + transom_thickness
else:
panel_height = overall_height - lining_to_panel_offset_x - threshold_thickness
lining_height = overall_height
# add lining
lining_size = V(overall_width, lining_depth, lining_height)
lining_thickness = [side_lining_thickness, top_lining_thickness]
def l_shape_check(lining_thickness):
return lining_to_panel_offset_y_full < lining_depth and any(
lining_to_panel_offset_x < th for th in lining_thickness
)
# create 2d representation
if self.settings["context"].TargetView == "PLAN_VIEW":
items_2d = []
panel_size = V(panel_width, panel_depth)
if not sliding_door:
panel_position = V(lining_to_panel_offset_x, lining_depth)
else:
panel_position = V(lining_to_panel_offset_x, -panel_size.y)
if self.settings["context"].ContextIdentifier == "Annotation":
# only sliding door has annotation representation
if not sliding_door:
return None
# arrow symbol
arrow_symbol = []
arrow_offset = slider_arrow_symbol_size / cos(radians(15))
arrow_symbol.append(
builder.polyline(
points=(V(0.35 * panel_size.x, 0), V(0.65 * panel_size.x, 0)),
)
)
arrow_symbol.append(
builder.polyline(
points=(
V(slider_arrow_symbol_size, arrow_offset),
V(0, 0),
V(slider_arrow_symbol_size, -arrow_offset),
),
position_offset=V(0.35 * panel_size.x, 0),
)
)
builder.translate(arrow_symbol, panel_position + V(0, -arrow_offset * 1.5))
items_2d.extend(arrow_symbol)
representation_2d = builder.get_representation(self.settings["context"], items_2d, "Curve2D")
return representation_2d
door_items = []
# create lining
if l_shape_check([side_lining_thickness]):
lining_points = [
V(0, 0),
V(0, lining_depth),
V(lining_to_panel_offset_x, lining_depth),
V(lining_to_panel_offset_x, lining_to_panel_offset_y_full),
V(lining_thickness_default, lining_to_panel_offset_y_full),
V(lining_thickness_default, 0),
]
lining = builder.polyline(lining_points, closed=True)
else:
lining = builder.rectangle(V(side_lining_thickness, lining_depth))
items_2d.append(lining)
items_2d.append(
builder.mirror(lining, mirror_axes=V(1, 0), mirror_point=V(overall_width / 2, 0), create_copy=True)
)
# TODO: make second swing lines dashed
def create_ifc_door_panel_2d(panel_size, panel_position, door_swing_type, sliding=False):
if sliding:
return create_ifc_door_sliding_panel_2d(panel_size, panel_position, door_swing_type)
door_items = []
panel_size = panel_size.yx
# create semi-semi-circle
if double_swing_door:
trim_points_mask = (3, 1)
second_swing_line = builder.polyline(
points=(V(0, 0), V(0, -panel_size.y), V(panel_size.x, -panel_size.y))
)
door_items.append(second_swing_line)
else:
trim_points_mask = (0, 1)
semicircle = builder.create_ellipse_curve(
panel_size.y - panel_size.x,
panel_size.y,
trim_points_mask=trim_points_mask,
position=V(panel_size.x, 0),
)
door_items.append(semicircle)
# create door
door = builder.rectangle(panel_size)
door_items.append(door)
builder.translate(door_items, panel_position)
if door_swing_type == "RIGHT":
mirror_point = panel_position + V(panel_size.y / 2, 0)
builder.mirror(door_items, mirror_axes=V(1, 0), mirror_point=mirror_point)
return door_items
def create_ifc_door_sliding_panel_2d(panel_size, panel_position, door_swing_type):
door_items = []
# create door
door_items.append(
builder.polyline(points=(V(0, 0), V(panel_size.x, 0)), position_offset=V(0, panel_size.y * 0.5))
)
door_items.append(builder.polyline(points=(V(0, 0), V(panel_size.x * 0.3, 0))))
door_items.append(
builder.rectangle(size=handle_size.zz, position=V(panel_size.x * 0.1, -handle_size.z * 0.5))
)
builder.translate(door_items, panel_position - V(panel_size.x * 0.2, 0))
if door_swing_type == "RIGHT":
mirror_point = panel_position + V(panel_size.x / 2, 0)
builder.mirror(door_items, mirror_axes=V(1, 0), mirror_point=mirror_point)
return door_items
door_items = []
if double_door:
panel_size.x = panel_size.x / 2
door_items.extend(create_ifc_door_panel_2d(panel_size, panel_position, "LEFT", sliding_door))
mirror_point = panel_position + V(door_opening_width / 2, 0)
door_items.extend(
builder.mirror(door_items, mirror_axes=V(1, 0), mirror_point=mirror_point, create_copy=True)
)
else:
door_swing_type = "LEFT" if door_type.endswith("LEFT") else "RIGHT"
door_items.extend(create_ifc_door_panel_2d(panel_size, panel_position, door_swing_type, sliding_door))
items_2d.extend(door_items)
builder.translate(items_2d, V(0, lining_offset))
representation_2d = builder.get_representation(self.settings["context"], items_2d)
return representation_2d
lining_items = []
main_lining_size = lining_size
# need to check offsets to decide whether lining should be rectangle
# or L shaped
if l_shape_check(lining_thickness):
main_lining_size = lining_size.copy()
main_lining_size.y = lining_to_panel_offset_y_full
second_lining_size = lining_size.copy()
second_lining_size.y = lining_size.y - lining_to_panel_offset_y_full
second_lining_position = V(0, lining_to_panel_offset_y_full, 0)
second_lining_thickness = [min(th, lining_to_panel_offset_x) for th in lining_thickness]
second_lining = create_ifc_door_lining(
builder, second_lining_size, second_lining_thickness, second_lining_position
)
lining_items.append(second_lining)
main_lining = create_ifc_door_lining(builder, main_lining_size, lining_thickness)
lining_items.append(main_lining)
# add threshold
if not threshold_thickness:
threshold_items = []
else:
threshold_size = V(threshold_width, threshold_depth, threshold_thickness)
threshold_position = V(side_lining_thickness, threshold_offset, 0)
threshold_items = [create_ifc_box(builder, threshold_size, threshold_position)]
# add casings
casing_items = []
if not lining_offset and casing_thickness:
casing_wall_overlap = max(casing_thickness - lining_thickness_default, 0)
inner_casing_thickness = [
casing_thickness - panel_lining_overlap_x,
casing_thickness - panel_top_lining_overlap_x,
]
outer_casing_thickness = inner_casing_thickness.copy() if double_swing_door else casing_thickness
casing_size = V(overall_width + casing_wall_overlap * 2, casing_depth, overall_height + casing_wall_overlap)
casing_position = V(-casing_wall_overlap, -casing_depth, 0)
outer_casing = create_ifc_door_lining(builder, casing_size, outer_casing_thickness, casing_position)
casing_items.append(outer_casing)
inner_casing_position = V(-casing_wall_overlap, lining_depth, 0)
inner_casing = create_ifc_door_lining(builder, casing_size, inner_casing_thickness, inner_casing_position)
casing_items.append(inner_casing)
def create_ifc_door_panel(panel_size, panel_position, door_swing_type):
door_items = []
# add door panel
door_items.append(create_ifc_box(builder, panel_size, panel_position))
# add door handle
handle_points = [
V(0, 0),
V(0, -handle_size.y),
V(handle_size.x, -handle_size.y),
V(handle_size.x, -handle_size.y / 2),
V(handle_size.y / 2, -handle_size.y / 2),
V(handle_size.y / 2, 0),
]
handle_polyline = builder.polyline(handle_points, closed=True)
handle_position = panel_position + handle_offset - handle_center_offset
door_handle = builder.extrude(handle_polyline, handle_size.z, position=handle_position)
door_items.append(door_handle)
if door_swing_type == "LEFT":
builder.mirror(
door_handle, mirror_axes=V(1, 0), mirror_point=panel_position.xy + V(panel_size.x / 2, 0)
)
door_handle_mirrored = builder.mirror(
door_handle,
mirror_axes=V(0, 1),
mirror_point=handle_position.xy + V(0, panel_size.y / 2),
create_copy=True,
)
door_items.append(door_handle_mirrored)
return door_items
door_items = []
panel_size = V(panel_width, panel_depth, panel_height)
panel_position = V(lining_to_panel_offset_x, lining_to_panel_offset_y_full, threshold_thickness)
if double_door:
# keeping a little space between doors for readibility
double_door_offset = self.convert_si_to_unit(0.001)
panel_size.x = panel_size.x / 2 - double_door_offset
door_items.extend(create_ifc_door_panel(panel_size, panel_position, "LEFT"))
mirror_point = panel_position + V(door_opening_width / 2, 0, 0)
door_items.extend(
builder.mirror(door_items, mirror_axes=V(1, 0), mirror_point=mirror_point.xy, create_copy=True)
)
else:
door_swing_type = "LEFT" if door_type.endswith("LEFT") else "RIGHT"
door_items.extend(create_ifc_door_panel(panel_size, panel_position, door_swing_type))
# add on top window
if not transom_thickness:
window_lining_items = []
frame_items = []
glass_items = []
else:
window_lining_thickness = [
side_lining_thickness,
lining_thickness_default,
side_lining_thickness,
transom_thickness,
]
window_lining_thickness.append(transom_thickness)
window_lining_size = V(overall_width, lining_depth, window_lining_height)
window_position = V(0, 0, overall_height - window_lining_height)
frame_size = V(door_opening_width, frame_depth, frame_height)
window_lining_items, frame_items, glass_items = create_ifc_window(
builder,
window_lining_size,
window_lining_thickness,
lining_to_panel_offset_x,
lining_to_panel_offset_y_full,
frame_size,
frame_thickness,
glass_thickness,
window_position,
)
lining_offset_items = lining_items + door_items + window_lining_items + frame_items + glass_items
builder.translate(lining_offset_items, V(0, lining_offset, 0))
output_items = lining_offset_items + threshold_items + casing_items
representation = builder.get_representation(self.settings["context"], output_items)
return representation
def convert_si_to_unit(self, value):
si_conversion = 1 / self.settings["unit_scale"]
if isinstance(value, Vector):
return V(*[i * si_conversion for i in value])
return value * si_conversion