ifcopenshell.api.drawing.assign_product

Module Contents

ifcopenshell.api.drawing.assign_product.assign_product(file: ifcopenshell.file, relating_product: ifcopenshell.entity_instance, related_object: ifcopenshell.entity_instance) → ifcopenshell.entity_instance

Associates a product and an object, typically for annotation

Warning: this is an experimental API.

When you want to draw attention to a feature or characteristic (such as a dimension, material, or name) or of a product (e.g. wall, slab, furniture, etc), an annotation object is created. This annotation is then associated with the product so that it can reference attributes, properties, and relationships.

For example, an annotation of a line will be associated with a grid axis, such that when that grid axis moves, the annotation of that grid axis (which is typically truncated to the extents of a drawing) will also move.

Another example might be a label of a furniture product, which might have some text of the name of the furniture to be shown on drawings or in 3D.

Parameters:

• relating_product (ifcopenshell.entity_instance) – The IfcProduct the object is related to

• related_object (ifcopenshell.entity_instance) – The object (typically IfcAnnotation) that the product is related to

Returns:

The created IfcRelAssignsToProduct relationship

Return type:

ifcopenshell.entity_instance

Example:

furniture = ifcopenshell.api.root.create_entity(model, ifc_class="IfcFurniture")
annotation = ifcopenshell.api.root.create_entity(model, ifc_class="IfcAnnotation")
ifcopenshell.api.drawing.assign_product(model,
    relating_product=furniture, related_object=annotation)