mirror of
https://github.com/IfcOpenShell/IfcOpenShell.git
synced 2026-08-13 19:07:57 +00:00
Generate functions for all API usecases for better static code features. See #2693.
This commit is contained in:
Dion Moult
@@ -21,91 +21,96 @@ import ifcopenshell.api
|
||||
import ifcopenshell.util.element
|
||||
|
||||
|
||||
def assign_material_style(
|
||||
file, material=None, style=None, context=None, should_use_presentation_style_assignment=False
|
||||
) -> None:
|
||||
"""Assigns a style to a material
|
||||
|
||||
A style may either be assigned directly to an object's representation,
|
||||
or to a material which is then associated with the object. If both
|
||||
exist, then the style assigned directly to the object's representation
|
||||
takes precedence. It is recommended to use materials and assign styles
|
||||
to materials. This API function provides that capability.
|
||||
|
||||
:param material: The IfcMaterial which you want to assign the style to.
|
||||
:type material: ifcopenshell.entity_instance
|
||||
:param style: The IfcPresentationStyle (typically IfcSurfaceStyle) that
|
||||
you want to assign to the material. This will then be applied to all
|
||||
objects that have that material.
|
||||
:type style: ifcopenshell.entity_instance
|
||||
:param context: The IfcGeometricRepresentationSubContext at which this
|
||||
style should be used. Typically this is the Model BODY context.
|
||||
:type context: ifcopenshell.entity_instance
|
||||
:param should_use_presentation_style_assignment: This is a technical
|
||||
detail to accomodate a bug in Revit. This should always be left as
|
||||
the default of False, unless you are finding that colours aren't
|
||||
showing up in Revit. In that case, set it to True, but keep in mind
|
||||
that this is no longer a valid IFC. Blame Autodesk.
|
||||
:type should_use_presentation_style_assignment: bool
|
||||
:return: None
|
||||
:rtype: None
|
||||
|
||||
Example:
|
||||
|
||||
.. code:: python
|
||||
|
||||
# A model context is needed to store 3D geometry
|
||||
model3d = ifcopenshell.api.run("context.add_context", model, context_type="Model")
|
||||
|
||||
# Specifically, we want to store body geometry
|
||||
body = ifcopenshell.api.run("context.add_context", model,
|
||||
context_type="Model", context_identifier="Body", target_view="MODEL_VIEW", parent=model3d)
|
||||
|
||||
# Let's create a new wall. The wall does not have any geometry yet.
|
||||
wall = ifcopenshell.api.run("root.create_entity", model, ifc_class="IfcWall")
|
||||
|
||||
# Let's use the "3D Body" representation we created earlier to add a
|
||||
# new wall-like body geometry, 5 meters long, 3 meters high, and
|
||||
# 200mm thick
|
||||
representation = ifcopenshell.api.run("geometry.add_wall_representation", model,
|
||||
context=body, length=5, height=3, thickness=0.2)
|
||||
|
||||
# Assign our new body geometry back to our wall
|
||||
ifcopenshell.api.run("geometry.assign_representation", model,
|
||||
product=wall, representation=representation)
|
||||
|
||||
# Place our wall at the origin
|
||||
ifcopenshell.api.run("geometry.edit_object_placement", model, product=wall)
|
||||
|
||||
# Let's prepare a concrete material. Note that our concrete material
|
||||
# does not have any colours (styles) at this point.
|
||||
concrete = ifcopenshell.api.run("material.add_material", model, name="CON01", category="concrete")
|
||||
|
||||
# Assign our concrete material to our wall
|
||||
ifcopenshell.api.run("material.assign_material", model,
|
||||
products=[wall], type="IfcMaterial", material=concrete)
|
||||
|
||||
# Create a new surface style
|
||||
style = ifcopenshell.api.run("style.add_style", model)
|
||||
|
||||
# Create a simple grey shading colour and transparency.
|
||||
ifcopenshell.api.run("style.add_surface_style", model,
|
||||
style=style, ifc_class="IfcSurfaceStyleShading", attributes={
|
||||
"SurfaceColour": { "Name": None, "Red": 0.5, "Green": 0.5, "Blue": 0.5 },
|
||||
"Transparency": 0., # 0 is opaque, 1 is transparent
|
||||
})
|
||||
|
||||
# Now any element (like our wall) with a concrete material will have
|
||||
# a grey colour applied.
|
||||
ifcopenshell.api.run("style.assign_material_style", model, material=concrete, style=style, context=body)
|
||||
"""
|
||||
usecase = Usecase()
|
||||
usecase.file = file
|
||||
usecase.settings = {
|
||||
"material": material,
|
||||
"style": style,
|
||||
"context": context,
|
||||
"should_use_presentation_style_assignment": should_use_presentation_style_assignment,
|
||||
}
|
||||
return usecase.execute()
|
||||
|
||||
|
||||
class Usecase:
|
||||
def __init__(self, file, material=None, style=None, context=None, should_use_presentation_style_assignment=False):
|
||||
"""Assigns a style to a material
|
||||
|
||||
A style may either be assigned directly to an object's representation,
|
||||
or to a material which is then associated with the object. If both
|
||||
exist, then the style assigned directly to the object's representation
|
||||
takes precedence. It is recommended to use materials and assign styles
|
||||
to materials. This API function provides that capability.
|
||||
|
||||
:param material: The IfcMaterial which you want to assign the style to.
|
||||
:type material: ifcopenshell.entity_instance
|
||||
:param style: The IfcPresentationStyle (typically IfcSurfaceStyle) that
|
||||
you want to assign to the material. This will then be applied to all
|
||||
objects that have that material.
|
||||
:type style: ifcopenshell.entity_instance
|
||||
:param context: The IfcGeometricRepresentationSubContext at which this
|
||||
style should be used. Typically this is the Model BODY context.
|
||||
:type context: ifcopenshell.entity_instance
|
||||
:param should_use_presentation_style_assignment: This is a technical
|
||||
detail to accomodate a bug in Revit. This should always be left as
|
||||
the default of False, unless you are finding that colours aren't
|
||||
showing up in Revit. In that case, set it to True, but keep in mind
|
||||
that this is no longer a valid IFC. Blame Autodesk.
|
||||
:type should_use_presentation_style_assignment: bool
|
||||
:return: None
|
||||
:rtype: None
|
||||
|
||||
Example:
|
||||
|
||||
.. code:: python
|
||||
|
||||
# A model context is needed to store 3D geometry
|
||||
model3d = ifcopenshell.api.run("context.add_context", model, context_type="Model")
|
||||
|
||||
# Specifically, we want to store body geometry
|
||||
body = ifcopenshell.api.run("context.add_context", model,
|
||||
context_type="Model", context_identifier="Body", target_view="MODEL_VIEW", parent=model3d)
|
||||
|
||||
# Let's create a new wall. The wall does not have any geometry yet.
|
||||
wall = ifcopenshell.api.run("root.create_entity", model, ifc_class="IfcWall")
|
||||
|
||||
# Let's use the "3D Body" representation we created earlier to add a
|
||||
# new wall-like body geometry, 5 meters long, 3 meters high, and
|
||||
# 200mm thick
|
||||
representation = ifcopenshell.api.run("geometry.add_wall_representation", model,
|
||||
context=body, length=5, height=3, thickness=0.2)
|
||||
|
||||
# Assign our new body geometry back to our wall
|
||||
ifcopenshell.api.run("geometry.assign_representation", model,
|
||||
product=wall, representation=representation)
|
||||
|
||||
# Place our wall at the origin
|
||||
ifcopenshell.api.run("geometry.edit_object_placement", model, product=wall)
|
||||
|
||||
# Let's prepare a concrete material. Note that our concrete material
|
||||
# does not have any colours (styles) at this point.
|
||||
concrete = ifcopenshell.api.run("material.add_material", model, name="CON01", category="concrete")
|
||||
|
||||
# Assign our concrete material to our wall
|
||||
ifcopenshell.api.run("material.assign_material", model,
|
||||
products=[wall], type="IfcMaterial", material=concrete)
|
||||
|
||||
# Create a new surface style
|
||||
style = ifcopenshell.api.run("style.add_style", model)
|
||||
|
||||
# Create a simple grey shading colour and transparency.
|
||||
ifcopenshell.api.run("style.add_surface_style", model,
|
||||
style=style, ifc_class="IfcSurfaceStyleShading", attributes={
|
||||
"SurfaceColour": { "Name": None, "Red": 0.5, "Green": 0.5, "Blue": 0.5 },
|
||||
"Transparency": 0., # 0 is opaque, 1 is transparent
|
||||
})
|
||||
|
||||
# Now any element (like our wall) with a concrete material will have
|
||||
# a grey colour applied.
|
||||
ifcopenshell.api.run("style.assign_material_style", model, material=concrete, style=style, context=body)
|
||||
"""
|
||||
self.file = file
|
||||
self.settings = {
|
||||
"material": material,
|
||||
"style": style,
|
||||
"context": context,
|
||||
"should_use_presentation_style_assignment": should_use_presentation_style_assignment,
|
||||
}
|
||||
|
||||
def execute(self):
|
||||
self.style = self.settings["style"]
|
||||
if self.file.schema == "IFC2X3" or self.settings["should_use_presentation_style_assignment"]:
|
||||
|
||||
Reference in New Issue
Block a user