Files
IfcOpenShell/src/bonsai/test/tool/test_root.py
T
sboddy 0a50a3cb24 Option to convert custom properties to ifc psets when assigning an IFC class (#6921)
Feature location - https://files.catbox.moe/cuvdan.png (assign class with alt+click modifier)
See #6921 for an example of converted props
2025-07-24 06:12:22 +00:00

315 lines
12 KiB
Python

# Bonsai - OpenBIM Blender Add-on
# Copyright (C) 2021 Dion Moult <dion@thinkmoult.com>
#
# This file is part of Bonsai.
#
# Bonsai is free software: you can redistribute it and/or modify
# it under the terms of the GNU General Public License as published by
# the Free Software Foundation, either version 3 of the License, or
# (at your option) any later version.
#
# Bonsai 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 General Public License for more details.
#
# You should have received a copy of the GNU General Public License
# along with Bonsai. If not, see <http://www.gnu.org/licenses/>.
import bpy
import ifcopenshell
import ifcopenshell.api
import ifcopenshell.api.feature
import ifcopenshell.api.type
import bonsai.core.tool
import bonsai.tool as tool
from test.bim.bootstrap import NewFile
from bonsai.tool.root import Root as subject
class TestImplementsTool(NewFile):
def test_run(self):
assert isinstance(subject(), bonsai.core.tool.Root)
class TestAddTrackedOpening(NewFile):
def test_run(self):
obj = bpy.data.objects.new("Object", None)
subject.add_tracked_opening(obj, "OPENING")
props = tool.Model.get_model_props()
assert props.openings[0].obj == obj
assert props.openings[0].name == "OPENING"
class TestCopyRepresentation(NewFile):
def test_copying_a_product(self):
ifc = ifcopenshell.file()
tool.Ifc.set(ifc)
source = ifc.createIfcWall(Representation=ifc.createIfcProductDefinitionShape())
dest = ifc.createIfcWall()
subject.copy_representation(source, dest)
assert dest.Representation.is_a("IfcProductDefinitionShape")
def test_copying_a_type_product(self):
ifc = ifcopenshell.file()
tool.Ifc.set(ifc)
source = ifc.createIfcWallType(RepresentationMaps=[ifc.createIfcRepresentationMap()])
dest = ifc.createIfcWallType()
subject.copy_representation(source, dest)
assert dest.RepresentationMaps[0].is_a("IfcRepresentationMap")
class TestDoesTypeHaveRepresentations(NewFile):
def test_run(self):
ifc = ifcopenshell.file()
element = ifc.createIfcWallType()
assert subject.does_type_have_representations(element) is False
element.RepresentationMaps = [ifc.createIfcRepresentationMap()]
assert subject.does_type_have_representations(element) is True
class TestGetDecompositionRelationships(NewFile):
def test_run(self):
ifc = ifcopenshell.file()
tool.Ifc.set(ifc)
element = ifc.createIfcWall()
opening = ifc.createIfcOpeningElement()
fill = ifc.createIfcWindow()
ifcopenshell.api.feature.add_feature(ifc, feature=opening, element=element)
ifcopenshell.api.feature.add_filling(ifc, opening=opening, element=fill)
obj = bpy.data.objects.new("Object", None)
tool.Ifc.link(fill, obj)
assert subject.get_decomposition_relationships([obj]) == {fill: {"type": "fill", "element": element}}
class TestGetElementRepresentation(NewFile):
def test_run(self):
ifc = ifcopenshell.file()
tool.Ifc.set(ifc)
context = ifc.createIfcGeometricRepresentationContext(ContextType="Model")
representation = ifc.createIfcShapeRepresentation(ContextOfItems=context)
wall = ifc.createIfcWall(Representation=ifc.createIfcProductDefinitionShape(Representations=[representation]))
assert subject.get_element_representation(wall, context) == representation
class TestGetElementType(NewFile):
def test_run(self):
bpy.ops.bim.create_project()
ifc = tool.Ifc.get()
element = ifc.createIfcWall()
type = ifc.createIfcWallType()
ifcopenshell.api.type.assign_type(ifc, related_objects=[element], relating_type=type)
assert subject.get_element_type(element) == type
class TestGetObjectName(NewFile):
def test_run(self):
obj = bpy.data.objects.new("Object", None)
assert subject.get_object_name(obj) == "Object"
def test_blender_number_suffixes_are_ignored(self):
obj = bpy.data.objects.new("Object.001", None)
assert subject.get_object_name(obj) == "Object"
obj = bpy.data.objects.new("Object.foo.123", None)
assert subject.get_object_name(obj) == "Object.foo"
class TestGetObjectRepresentation(NewFile):
def test_run(self):
ifc = ifcopenshell.file()
tool.Ifc.set(ifc)
representation = ifc.createIfcShapeRepresentation()
obj = bpy.data.objects.new("Object", (mesh := bpy.data.meshes.new("Mesh")))
tool.Geometry.get_mesh_props(mesh).ifc_definition_id = representation.id()
assert subject.get_object_representation(obj) == representation
class TestGetRepresentationContext(NewFile):
def test_run(self):
ifc = ifcopenshell.file()
tool.Ifc.set(ifc)
context = ifc.createIfcGeometricRepresentationContext()
representation = ifc.createIfcShapeRepresentation(ContextOfItems=context)
assert subject.get_representation_context(representation) == context
class TestIsElementA(NewFile):
def test_run(self):
ifc = ifcopenshell.file()
assert subject.is_element_a(ifc.createIfcWall(), "IfcSlab") is False
assert subject.is_element_a(ifc.createIfcOpeningElement(), "IfcOpeningElement") is True
class TestLinkObjectData(NewFile):
def test_run(self):
data = bpy.data.meshes.new("Mesh")
source = bpy.data.objects.new("Object", data)
destination = bpy.data.objects.new("Object", bpy.data.meshes.new("Mesh"))
subject.link_object_data(source, destination)
assert source.data == data
assert source.data == destination.data
class TestRunGeometryAddRepresntation(NewFile):
def test_nothing(self):
pass
class TestSetObjectName(NewFile):
def test_run(self):
ifc = ifcopenshell.file()
obj = bpy.data.objects.new("Object", bpy.data.meshes.new("Mesh"))
element = ifc.createIfcWall()
subject.set_object_name(obj, element)
assert obj.name == "IfcWall/Unnamed"
def test_existing_blender_names_are_ignored(self):
ifc = ifcopenshell.file()
obj = bpy.data.objects.new("IfcSlab/Object", bpy.data.meshes.new("Mesh"))
element = ifc.createIfcWall()
element.Name = "Foobar"
subject.set_object_name(obj, element)
assert obj.name == "IfcWall/Foobar"
class TestReassignClass(NewFile):
def test_reassign_type_to_reassign_occurrences(self):
tool.Project.get_project_props().template_file = "IFC4 Demo Template.ifc"
bpy.ops.bim.create_project()
ifc_file = tool.Ifc.get()
context = bpy.context
n_wall_types = len(ifc_file.by_type("IfcWallType"))
n_slab_types = len(ifc_file.by_type("IfcSlabType"))
relating_type = ifc_file.by_type("IfcSlabType")[0]
relating_type_obj = tool.Ifc.get_object(relating_type)
assert isinstance(relating_type_obj, bpy.types.Object)
relating_type_id = relating_type.id()
# Add occurrences.
bpy.ops.bim.add_occurrence(relating_type_id=relating_type_id)
bpy.ops.bim.add_occurrence(relating_type_id=relating_type_id)
bpy.ops.bim.add_occurrence(relating_type_id=relating_type_id)
# Run operator.
tool.Blender.set_objects_selection(context, relating_type_obj, selected_objects=(relating_type_obj,))
props = tool.Root.get_root_props()
props.ifc_product = "IfcElementType"
props.ifc_class = "IfcWallType"
bpy.ops.bim.reassign_class()
assert len(ifc_file.by_type("IfcWall")) == 3
assert len(ifc_file.by_type("IfcSlab")) == 0
assert len(ifc_file.by_type("IfcWallType")) == n_wall_types + 1
assert len(ifc_file.by_type("IfcSlabType")) == n_slab_types - 1
for wall in ifc_file.by_type("IfcWall"):
assert isinstance(obj := tool.Ifc.get_object(wall), bpy.types.Object)
assert obj.name.startswith("IfcWall/")
def test_reassigning_multiple_occurrences_of_the_same_type(self):
tool.Project.get_project_props().template_file = "IFC4 Demo Template.ifc"
bpy.ops.bim.create_project()
ifc_file = tool.Ifc.get()
context = bpy.context
relating_type_id = ifc_file.by_type("IfcSlabType")[0].id()
n_wall_types = len(ifc_file.by_type("IfcWallType"))
n_slab_types = len(ifc_file.by_type("IfcSlabType"))
# create 3 slabs
bpy.ops.bim.add_occurrence(relating_type_id=relating_type_id)
bpy.ops.bim.add_occurrence(relating_type_id=relating_type_id)
bpy.ops.bim.add_occurrence(relating_type_id=relating_type_id)
slabs = [
obj for e in ifc_file.by_type("IfcSlab") if isinstance(obj := tool.Ifc.get_object(e), bpy.types.Object)
]
assert len(slabs) == 3
tool.Blender.set_objects_selection(context, slabs[0], (slabs[1],))
props = tool.Root.get_root_props()
props.ifc_product = "IfcElement"
props.ifc_class = "IfcWall"
bpy.ops.bim.reassign_class()
assert len(ifc_file.by_type("IfcWall")) == 3
assert len(ifc_file.by_type("IfcSlab")) == 0
assert len(ifc_file.by_type("IfcWallType")) == n_wall_types + 1
assert len(ifc_file.by_type("IfcSlabType")) == n_slab_types - 1
class TestAssignClass(NewFile):
def create_objects(self, context):
# Create blender cylinder
bpy.ops.mesh.primitive_cylinder_add(vertices=10, location=(0, 4, 0))
datablock_obj = bpy.data.objects["Cylinder"]
# Create blender cube w/ props
bpy.ops.mesh.primitive_cube_add(location=(0, 0, 0))
obj = bpy.data.objects["Cube"]
# Set all the custom properties on the obj
obj["01_float"] = 3.14159
obj["02_float_array"] = [3.14159, 1.61803, 2.71828]
obj["03_integer"] = 2
obj["04_integer_array"] = [2, 3, 5, 7]
obj["05_boolean"] = True
obj["06_boolean_array"] = [True, False]
obj["07_string"] = "Bonsai!"
# Data Block is not proper Pointer in UI. Probably doesn't matter.
obj["08_data_block"] = datablock_obj
# Python expressions can also be stored, i.e. dictionary
obj["09_python"] = {"test": 12}
# Or a list of things, i.e. objects: [bpy.data.objects['IfcBuildingElementProxy/Cube']]
obj["10_python"] = bpy.context.selected_objects
return obj, datablock_obj
def test_normal_assign_ifc_class(self):
# Setup project
tool.Project.get_project_props().template_file = "IFC4 Demo Template.ifc"
bpy.ops.bim.create_project()
ifc_file = tool.Ifc.get()
context = bpy.context
obj, datablock_obj = self.create_objects(context)
# Assign IfcClass
bpy.ops.bim.assign_class(ifc_class="IfcBuildingElementProxy", predefined_type="ELEMENT", userdefined_type="")
element = tool.Ifc.get_entity(obj)
assert element
# Get Psets
psets = ifcopenshell.util.element.get_psets(element, psets_only=True)
assert psets == {}
def test_alternative_assign_ifc_class(self):
# Setup project
tool.Project.get_project_props().template_file = "IFC4 Demo Template.ifc"
bpy.ops.bim.create_project()
ifc_file = tool.Ifc.get()
context = bpy.context
obj, datablock_obj = self.create_objects(context)
# Assign IfcClass
bpy.ops.bim.assign_class(
ifc_class="IfcBuildingElementProxy", predefined_type="ELEMENT", userdefined_type="", props_to_pset=True
)
element = tool.Ifc.get_entity(obj)
assert element
# Get Psets
psets = ifcopenshell.util.element.get_psets(element, psets_only=True)
assert "BBIM_ImportedBlenderProps" in psets
pset = psets["BBIM_ImportedBlenderProps"]
assert "01_float" in pset and type(pset["01_float"]) is float
assert "02_float_array.1" in pset and type(pset["02_float_array.1"]) is float
assert "03_integer" in pset and type(pset["03_integer"]) is int
assert "04_integer_array.1" in pset and type(pset["04_integer_array.1"]) is int
assert "05_boolean" in pset and type(pset["05_boolean"]) is bool
assert "06_boolean_array.1" in pset and type(pset["06_boolean_array.1"]) is bool
assert "07_string" in pset and type(pset["07_string"]) is str
assert "08_data_block" not in pset
assert "09_python" not in pset
assert "10_python" not in pset