mirror of
https://github.com/IfcOpenShell/IfcOpenShell.git
synced 2026-08-10 09:48:32 +00:00
Generate functions for all API usecases for better static code features. See #2693.
This commit is contained in:
Dion Moult
@@ -15,3 +15,9 @@
|
||||
#
|
||||
# You should have received a copy of the GNU Lesser General Public License
|
||||
# along with IfcOpenShell. If not, see <http://www.gnu.org/licenses/>.
|
||||
|
||||
from .add_layer import add_layer
|
||||
from .assign_layer import assign_layer
|
||||
from .edit_layer import edit_layer
|
||||
from .remove_layer import remove_layer
|
||||
from .unassign_layer import unassign_layer
|
||||
|
||||
@@ -17,33 +17,30 @@
|
||||
# along with IfcOpenShell. If not, see <http://www.gnu.org/licenses/>.
|
||||
|
||||
|
||||
class Usecase:
|
||||
def __init__(self, file, Name=None):
|
||||
"""Adds a new layer
|
||||
def add_layer(file, Name=None) -> None:
|
||||
"""Adds a new layer
|
||||
|
||||
An IFC layer is like a CAD layer. Portions of an object's geometry
|
||||
(typically portions of its 2D linework) can be assigned to layers, which
|
||||
can provide stylistic information such as line weights, colours, or
|
||||
simply be used for filtering.
|
||||
An IFC layer is like a CAD layer. Portions of an object's geometry
|
||||
(typically portions of its 2D linework) can be assigned to layers, which
|
||||
can provide stylistic information such as line weights, colours, or
|
||||
simply be used for filtering.
|
||||
|
||||
Layers have historically been used to organise CAD data and included in
|
||||
ISO standards such as ISO 13567 or by the AIA. This alllows IFC data to
|
||||
be compatible with older, 2D-oriented, layer-based workflows.
|
||||
Layers have historically been used to organise CAD data and included in
|
||||
ISO standards such as ISO 13567 or by the AIA. This alllows IFC data to
|
||||
be compatible with older, 2D-oriented, layer-based workflows.
|
||||
|
||||
Some software that are still based on layers, such as Tekla or ArchiCAD
|
||||
may also use this layer information for filtering.
|
||||
Some software that are still based on layers, such as Tekla or ArchiCAD
|
||||
may also use this layer information for filtering.
|
||||
|
||||
:param Name: The name of the layer. Defaults to "Unnamed".
|
||||
:type Name: str, optional
|
||||
:return: The newly created IfcPresentationLayerAssignment element
|
||||
:rtype: ifcopenshell.entity_instance
|
||||
:param Name: The name of the layer. Defaults to "Unnamed".
|
||||
:type Name: str, optional
|
||||
:return: The newly created IfcPresentationLayerAssignment element
|
||||
:rtype: ifcopenshell.entity_instance
|
||||
|
||||
Example:
|
||||
Example:
|
||||
|
||||
ifcopenshell.api.run("layer.add_layer", model, Name="AI-WALL-FULL-DIMS-N")
|
||||
"""
|
||||
self.file = file
|
||||
self.settings = {"Name": Name or "Unnamed"}
|
||||
ifcopenshell.api.run("layer.add_layer", model, Name="AI-WALL-FULL-DIMS-N")
|
||||
"""
|
||||
settings = {"Name": Name or "Unnamed"}
|
||||
|
||||
def execute(self):
|
||||
return self.file.create_entity("IfcPresentationLayerAssignment", Name=self.settings["Name"])
|
||||
return file.create_entity("IfcPresentationLayerAssignment", Name=settings["Name"])
|
||||
|
||||
@@ -19,64 +19,61 @@
|
||||
import ifcopenshell
|
||||
|
||||
|
||||
class Usecase:
|
||||
def __init__(
|
||||
self, file: ifcopenshell.file, items: list[ifcopenshell.entity_instance], layer: ifcopenshell.entity_instance
|
||||
):
|
||||
"""Assigns representation items to a layer
|
||||
def assign_layer(
|
||||
file: ifcopenshell.file, items: list[ifcopenshell.entity_instance], layer: ifcopenshell.entity_instance
|
||||
) -> None:
|
||||
"""Assigns representation items to a layer
|
||||
|
||||
In IFC, instead of objects being assigned to layers, representation
|
||||
items are assigned to layers. Representation items are portions of the
|
||||
object's representation. For example, this allows a single IFC Window
|
||||
element to have portions of its 2D linework (e.g. the cross section of
|
||||
its frame) assigned to one layer, and another portion (e.g. the glazing
|
||||
panels) assigned to another layer.
|
||||
In IFC, instead of objects being assigned to layers, representation
|
||||
items are assigned to layers. Representation items are portions of the
|
||||
object's representation. For example, this allows a single IFC Window
|
||||
element to have portions of its 2D linework (e.g. the cross section of
|
||||
its frame) assigned to one layer, and another portion (e.g. the glazing
|
||||
panels) assigned to another layer.
|
||||
|
||||
:param items: The list of IfcRepresentationItems to assign to the layer. This
|
||||
should be the items from the object's IfcShapeRepresentation.
|
||||
:type items: list[ifcopenshell.entity_instance]
|
||||
:param layer: The IfcPresentationLayerAssignment layer to assign the
|
||||
item to.
|
||||
:type layer: ifcopenshell.entity_instance
|
||||
:return: None
|
||||
:rtype: None
|
||||
:param items: The list of IfcRepresentationItems to assign to the layer. This
|
||||
should be the items from the object's IfcShapeRepresentation.
|
||||
:type items: list[ifcopenshell.entity_instance]
|
||||
:param layer: The IfcPresentationLayerAssignment layer to assign the
|
||||
item to.
|
||||
:type layer: ifcopenshell.entity_instance
|
||||
:return: None
|
||||
:rtype: None
|
||||
|
||||
Example:
|
||||
Example:
|
||||
|
||||
.. code:: python
|
||||
.. code:: python
|
||||
|
||||
# Remember, all geometry needs to specify the context it is part of first.
|
||||
# See ifcopenshell.api.context.add_context for details.
|
||||
model = ifcopenshell.api.run("context.add_context", model, context_type="Model")
|
||||
body = ifcopenshell.api.run("context.add_context", model,
|
||||
context_type="Model", context_identifier="Body", target_view="MODEL_VIEW", parent=model
|
||||
)
|
||||
# Remember, all geometry needs to specify the context it is part of first.
|
||||
# See ifcopenshell.api.context.add_context for details.
|
||||
model = ifcopenshell.api.run("context.add_context", model, context_type="Model")
|
||||
body = ifcopenshell.api.run("context.add_context", model,
|
||||
context_type="Model", context_identifier="Body", target_view="MODEL_VIEW", parent=model
|
||||
)
|
||||
|
||||
wall = ifcopenshell.api.run("root.create_entity", model, ifc_class="IfcWall")
|
||||
representation = ifcopenshell.api.run("geometry.add_wall_representation", model,
|
||||
context=body, length=5, height=3, thickness=0.2)
|
||||
ifcopenshell.api.run("geometry.assign_representation", model,
|
||||
product=wall, representation=representation)
|
||||
ifcopenshell.api.run("geometry.edit_object_placement", model, product=wall)
|
||||
wall = ifcopenshell.api.run("root.create_entity", model, ifc_class="IfcWall")
|
||||
representation = ifcopenshell.api.run("geometry.add_wall_representation", model,
|
||||
context=body, length=5, height=3, thickness=0.2)
|
||||
ifcopenshell.api.run("geometry.assign_representation", model,
|
||||
product=wall, representation=representation)
|
||||
ifcopenshell.api.run("geometry.edit_object_placement", model, product=wall)
|
||||
|
||||
# Now let's create a layer that contains walls
|
||||
layer = ifcopenshell.api.run("layer.add_layer", model, Name="AI-WALL")
|
||||
# Now let's create a layer that contains walls
|
||||
layer = ifcopenshell.api.run("layer.add_layer", model, Name="AI-WALL")
|
||||
|
||||
# And assign our wall representation item (in this example, there is
|
||||
# only one item) to the layer.
|
||||
ifcopenshell.api.run("layer.assign_layer", model, items=[representation.Items[0]], layer=layer)
|
||||
"""
|
||||
self.file = file
|
||||
self.settings = {
|
||||
"items": items,
|
||||
"layer": layer,
|
||||
}
|
||||
# And assign our wall representation item (in this example, there is
|
||||
# only one item) to the layer.
|
||||
ifcopenshell.api.run("layer.assign_layer", model, items=[representation.Items[0]], layer=layer)
|
||||
"""
|
||||
settings = {
|
||||
"items": items,
|
||||
"layer": layer,
|
||||
}
|
||||
|
||||
def execute(self) -> None:
|
||||
# support AssignedItems == None since layer might just got created
|
||||
layer = self.settings["layer"]
|
||||
assigned_items = set(layer.AssignedItems or [])
|
||||
items = set(self.settings["items"])
|
||||
if items.issubset(assigned_items):
|
||||
return
|
||||
layer.AssignedItems = list(assigned_items | items)
|
||||
# support AssignedItems == None since layer might just got created
|
||||
layer = settings["layer"]
|
||||
assigned_items = set(layer.AssignedItems or [])
|
||||
items = set(settings["items"])
|
||||
if items.issubset(assigned_items):
|
||||
return
|
||||
layer.AssignedItems = list(assigned_items | items)
|
||||
|
||||
@@ -17,31 +17,28 @@
|
||||
# along with IfcOpenShell. If not, see <http://www.gnu.org/licenses/>.
|
||||
|
||||
|
||||
class Usecase:
|
||||
def __init__(self, file, layer=None, attributes=None):
|
||||
"""Edits the attributes of an IfcPresentationLayerAssignment
|
||||
def edit_layer(file, layer=None, attributes=None) -> None:
|
||||
"""Edits the attributes of an IfcPresentationLayerAssignment
|
||||
|
||||
For more information about the attributes and data types of an
|
||||
IfcPresentationLayerAssignment, consult the IFC documentation.
|
||||
For more information about the attributes and data types of an
|
||||
IfcPresentationLayerAssignment, consult the IFC documentation.
|
||||
|
||||
:param layer: The IfcPresentationLayerAssignment entity you want to edit
|
||||
:type layer: ifcopenshell.entity_instance
|
||||
:param attributes: a dictionary of attribute names and values.
|
||||
:type attributes: dict, optional
|
||||
:return: None
|
||||
:rtype: None
|
||||
:param layer: The IfcPresentationLayerAssignment entity you want to edit
|
||||
:type layer: ifcopenshell.entity_instance
|
||||
:param attributes: a dictionary of attribute names and values.
|
||||
:type attributes: dict, optional
|
||||
:return: None
|
||||
:rtype: None
|
||||
|
||||
Example:
|
||||
Example:
|
||||
|
||||
.. code:: python
|
||||
.. code:: python
|
||||
|
||||
layer = ifcopenshell.api.run("layer.add_layer", model, Name="AI-WALL")
|
||||
ifcopenshell.api.run("layer.edit_layer", model,
|
||||
layer=layer, attributes={"Description": "All walls, based on the AIA standard."})
|
||||
"""
|
||||
self.file = file
|
||||
self.settings = {"layer": layer, "attributes": attributes or {}}
|
||||
layer = ifcopenshell.api.run("layer.add_layer", model, Name="AI-WALL")
|
||||
ifcopenshell.api.run("layer.edit_layer", model,
|
||||
layer=layer, attributes={"Description": "All walls, based on the AIA standard."})
|
||||
"""
|
||||
settings = {"layer": layer, "attributes": attributes or {}}
|
||||
|
||||
def execute(self):
|
||||
for name, value in self.settings["attributes"].items():
|
||||
setattr(self.settings["layer"], name, value)
|
||||
for name, value in settings["attributes"].items():
|
||||
setattr(settings["layer"], name, value)
|
||||
|
||||
@@ -17,27 +17,24 @@
|
||||
# along with IfcOpenShell. If not, see <http://www.gnu.org/licenses/>.
|
||||
|
||||
|
||||
class Usecase:
|
||||
def __init__(self, file, layer=None):
|
||||
"""Removes a layer
|
||||
def remove_layer(file, layer=None) -> None:
|
||||
"""Removes a layer
|
||||
|
||||
All representation items assigned to the layer will remain, but the
|
||||
relationship to the layer will be removed.
|
||||
All representation items assigned to the layer will remain, but the
|
||||
relationship to the layer will be removed.
|
||||
|
||||
:param layer: The IfcPresentationLayerAssignment entity to remove
|
||||
:type layer: ifcopenshell.entity_instance
|
||||
:return: None
|
||||
:rtype: None
|
||||
:param layer: The IfcPresentationLayerAssignment entity to remove
|
||||
:type layer: ifcopenshell.entity_instance
|
||||
:return: None
|
||||
:rtype: None
|
||||
|
||||
Example:
|
||||
Example:
|
||||
|
||||
.. code:: python
|
||||
.. code:: python
|
||||
|
||||
layer = ifcopenshell.api.run("layer.add_layer", model, Name="AI-WALL")
|
||||
ifcopenshell.api.run("layer.remove_layer", model, layer=layer)
|
||||
"""
|
||||
self.file = file
|
||||
self.settings = {"layer": layer}
|
||||
layer = ifcopenshell.api.run("layer.add_layer", model, Name="AI-WALL")
|
||||
ifcopenshell.api.run("layer.remove_layer", model, layer=layer)
|
||||
"""
|
||||
settings = {"layer": layer}
|
||||
|
||||
def execute(self):
|
||||
self.file.remove(self.settings["layer"])
|
||||
file.remove(settings["layer"])
|
||||
|
||||
@@ -20,68 +20,65 @@ import ifcopenshell
|
||||
import ifcopenshell.util.element
|
||||
|
||||
|
||||
class Usecase:
|
||||
def __init__(
|
||||
self, file: ifcopenshell.file, items: list[ifcopenshell.entity_instance], layer: ifcopenshell.entity_instance
|
||||
):
|
||||
"""Unassigns representation items from a layer
|
||||
def unassign_layer(
|
||||
file: ifcopenshell.file, items: list[ifcopenshell.entity_instance], layer: ifcopenshell.entity_instance
|
||||
) -> None:
|
||||
"""Unassigns representation items from a layer
|
||||
|
||||
If the representation item isn't assigned to the layer, nothing will
|
||||
happen.
|
||||
If after unassignment layer won't have any assigned items it will be
|
||||
removed to keep IFC valid.
|
||||
If the representation item isn't assigned to the layer, nothing will
|
||||
happen.
|
||||
If after unassignment layer won't have any assigned items it will be
|
||||
removed to keep IFC valid.
|
||||
|
||||
:param items: A list IfcRepresentationItem elements to unassign
|
||||
:type items: list[ifcopenshell.entity_instance]
|
||||
:param layer: The IfcPresentationLayerAssignment to unassign from
|
||||
:type layer: ifcopenshell.entity_instance
|
||||
:return: None
|
||||
:rtype: None
|
||||
:param items: A list IfcRepresentationItem elements to unassign
|
||||
:type items: list[ifcopenshell.entity_instance]
|
||||
:param layer: The IfcPresentationLayerAssignment to unassign from
|
||||
:type layer: ifcopenshell.entity_instance
|
||||
:return: None
|
||||
:rtype: None
|
||||
|
||||
Example:
|
||||
Example:
|
||||
|
||||
.. code:: python
|
||||
.. code:: python
|
||||
|
||||
# Remember, all geometry needs to specify the context it is part of first.
|
||||
# See ifcopenshell.api.context.add_context for details.
|
||||
model = ifcopenshell.api.run("context.add_context", model, context_type="Model")
|
||||
body = ifcopenshell.api.run("context.add_context", model,
|
||||
context_type="Model", context_identifier="Body", target_view="MODEL_VIEW", parent=model
|
||||
)
|
||||
# Remember, all geometry needs to specify the context it is part of first.
|
||||
# See ifcopenshell.api.context.add_context for details.
|
||||
model = ifcopenshell.api.run("context.add_context", model, context_type="Model")
|
||||
body = ifcopenshell.api.run("context.add_context", model,
|
||||
context_type="Model", context_identifier="Body", target_view="MODEL_VIEW", parent=model
|
||||
)
|
||||
|
||||
wall = ifcopenshell.api.run("root.create_entity", model, ifc_class="IfcWall")
|
||||
representation = ifcopenshell.api.run("geometry.add_wall_representation", model,
|
||||
context=body, length=5, height=3, thickness=0.2)
|
||||
ifcopenshell.api.run("geometry.assign_representation", model,
|
||||
product=wall, representation=representation)
|
||||
ifcopenshell.api.run("geometry.edit_object_placement", model, product=wall)
|
||||
wall = ifcopenshell.api.run("root.create_entity", model, ifc_class="IfcWall")
|
||||
representation = ifcopenshell.api.run("geometry.add_wall_representation", model,
|
||||
context=body, length=5, height=3, thickness=0.2)
|
||||
ifcopenshell.api.run("geometry.assign_representation", model,
|
||||
product=wall, representation=representation)
|
||||
ifcopenshell.api.run("geometry.edit_object_placement", model, product=wall)
|
||||
|
||||
# Now let's create a layer that contains walls
|
||||
layer = ifcopenshell.api.run("layer.add_layer", model, Name="AI-WALL")
|
||||
# Now let's create a layer that contains walls
|
||||
layer = ifcopenshell.api.run("layer.add_layer", model, Name="AI-WALL")
|
||||
|
||||
# And assign our wall representation item (in this example, there is
|
||||
# only one item) to the layer.
|
||||
ifcopenshell.api.run("layer.assign_layer", model, items=[representation.Items[0]], layer=layer)
|
||||
# And assign our wall representation item (in this example, there is
|
||||
# only one item) to the layer.
|
||||
ifcopenshell.api.run("layer.assign_layer", model, items=[representation.Items[0]], layer=layer)
|
||||
|
||||
# Let's undo it!
|
||||
ifcopenshell.api.run("layer.unassign_layer", model, items=[representation.Items[0]], layer=layer)
|
||||
"""
|
||||
self.file = file
|
||||
self.settings = {
|
||||
"items": items,
|
||||
"layer": layer,
|
||||
}
|
||||
# Let's undo it!
|
||||
ifcopenshell.api.run("layer.unassign_layer", model, items=[representation.Items[0]], layer=layer)
|
||||
"""
|
||||
settings = {
|
||||
"items": items,
|
||||
"layer": layer,
|
||||
}
|
||||
|
||||
def execute(self):
|
||||
layer = self.settings["layer"]
|
||||
assigned_items = set(layer.AssignedItems) or set()
|
||||
items = set(self.settings["items"])
|
||||
if not items.issubset(assigned_items):
|
||||
return
|
||||
assigned_items = list(assigned_items - items)
|
||||
layer = settings["layer"]
|
||||
assigned_items = set(layer.AssignedItems) or set()
|
||||
items = set(settings["items"])
|
||||
if not items.issubset(assigned_items):
|
||||
return
|
||||
assigned_items = list(assigned_items - items)
|
||||
|
||||
# keep IFC valid in case if there are no items left
|
||||
if assigned_items:
|
||||
layer.AssignedItems = assigned_items
|
||||
else:
|
||||
self.file.remove(layer)
|
||||
# keep IFC valid in case if there are no items left
|
||||
if assigned_items:
|
||||
layer.AssignedItems = assigned_items
|
||||
else:
|
||||
file.remove(layer)
|
||||
|
||||
Reference in New Issue
Block a user