ifcopenshell.api.material.edit_profile_usage

Module Contents

class ifcopenshell.api.material.edit_profile_usage.Usecase

calculate_position()

execute()

get_bottom_centre(shape)

get_bottom_left(shape)

get_bottom_right(shape)

get_mid_depth_centre(shape)

get_mid_depth_left(shape)

get_mid_depth_right(shape)

get_top_centre(shape)

get_top_left(shape)

get_top_right(shape)

update_cardinal_point()

update_representation(element)

update_swept_area_solid(element)

ifcopenshell.api.material.edit_profile_usage.edit_profile_usage(file: ifcopenshell.file, usage: ifcopenshell.entity_instance, attributes: dict[str, Any]) → None

Edits the attributes of an IfcMaterialProfileSetUsage

This is typically used to change the cardinal point of the profile. The cardinal point represents whether the profile is extruded along the center of the axis line, at a corner, at a shear center, at the bottom, top, etc.

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

Parameters:

• usage (ifcopenshell.entity_instance) – The IfcMaterialProfileSetUsage entity you want to edit

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

Returns:

None

Return type:

None

Example:

# Let's imagine we have a steel I-beam. Notice we are assigning to
# the type only, as all occurrences of that type will automatically
# inherit the material.
beam_type = ifcopenshell.api.root.create_entity(model, ifc_class="IfcBeamType", name="B1")

# First, let's create a material set. This will later be assigned
# to our beam type element.
material_set = ifcopenshell.api.material.add_profile_set(model,
    name="B1", set_type="IfcMaterialProfileSet")

# Create a steel material.
steel = ifcopenshell.api.material.add_material(model, name="ST01", category="steel")

# Create an I-beam profile curve. Notice how we name our profiles
# based on standardised steel profile names.
hea100 = usecase.file.create_entity(
    "IfcIShapeProfileDef", ProfileName="HEA100", ProfileType="AREA",
    OverallWidth=100, OverallDepth=96, WebThickness=5, FlangeThickness=8, FilletRadius=12,
)

# Define that steel material and cross section as a single profile
# item. If this were a composite beam, we might add multiple profile
# items instead, but this is rarely the case in most construction.
profile_item = ifcopenshell.api.material.add_profile(model,
    profile_set=material_set, material=steel, profile=hea100)

# Great! Let's assign our material set to our beam type.
ifcopenshell.api.material.assign_material(model, products=[beam_type], material=material_set)

# Let's create an occurrence of this beam.
beam = ifcopenshell.api.root.create_entity(model, ifc_class="IfcBeam", name="B1.01")
rel = ifcopenshell.api.material.assign_material(model,
    products=[beam], type="IfcMaterialProfileSetUsage")

# Let's give a 1000mm long beam body representation.
body = ifcopenshell.api.geometry.add_profile_representation(
    context=body_context, profile=hea100, depth=1000)
ifcopenshell.api.geometry.assign_representation(model, product=beam, representation=body)
ifcopenshell.api.geometry.edit_object_placement(model, product=beam)

# Let's change the cardinal point to be the top center of the axis
# line. This is represented by the number "8". Consult the IFC
# documentation for all the numbers you can use.
ifcopenshell.api.material.edit_profile_usage(model,
    usage=rel.RelatingMaterial, attributes={"CardinalPoint": 8})