ifcopenshell.api.material.edit_constituent

Module Contents

ifcopenshell.api.material.edit_constituent.edit_constituent(file: ifcopenshell.file, constituent: ifcopenshell.entity_instance, attributes: dict[str, Any] | None = None, material: ifcopenshell.entity_instance | None = None) → None

Edits the attributes of an IfcMaterialConstituent

For more information about the attributes and data types of an IfcMaterialConstituent, consult the IFC documentation.

Parameters:

• constituent (ifcopenshell.entity_instance) – The IfcMaterialConstituent entity you want to edit

• attributes (dict, optional) – a dictionary of attribute names and values.

• material (ifcopenshell.entity_instance, optional) – The IfcMaterial entity you want to change the constituent to

Returns:

None

Return type:

None

Example:

# Let's add two materials
aluminium1 = ifcopenshell.api.material.add_material(model, name="AL01", category="aluminium")
aluminium2 = ifcopenshell.api.material.add_material(model, name="AL02", category="aluminium")
glass = ifcopenshell.api.material.add_material(model, name="GLZ01", category="glass")

material_set = ifcopenshell.api.material.add_material_set(model,
    name="Window", set_type="IfcMaterialConstituentSet")

# Set up two constituents, one for the frame and the other for the glazing.
framing = ifcopenshell.api.material.add_constituent(model,
    constituent_set=material_set, material=aluminium1)
glazing = ifcopenshell.api.material.add_constituent(model,
    constituent_set=material_set, material=glass)

# Let's make sure this constituent refers to the framing of the
# window and uses the second aluminium material instead.
ifcopenshell.api.material.edit_constituent(model,
    constituent=framing, attributes={"Name": "Framing"}, material=aluminium2)

ifcopenshell.api.material.edit_constituent(model,
    constituent=constituent, attributes={"Name": "Glazing"})