`ifcopenshell.api.geometry.add_profile_representation`¶

Module Contents¶

class ifcopenshell.api.geometry.add_profile_representation.Usecase¶

apply_clippings(first_operand: ifcopenshell.entity_instance) → ifcopenshell.entity_instance¶

execute(context: ifcopenshell.entity_instance, profile: ifcopenshell.entity_instance, depth: float, cardinal_point: CardinalPoint | None, clippings: list[ifcopenshell.util.data.Clipping | dict[str, Any]], placement_zx_axes: tuple[VECTOR_3D | None, VECTOR_3D | None]) → ifcopenshell.entity_instance¶

ifcopenshell.api.geometry.add_profile_representation.add_profile_representation(file: ifcopenshell.file, context: ifcopenshell.entity_instance, profile: ifcopenshell.entity_instance, depth: float = 1.0, cardinal_point: CardinalPoint | None = 5, clippings: list[ifcopenshell.util.data.Clipping | dict[str, Any]] | None = None, placement_zx_axes: tuple[VECTOR_3D | None, VECTOR_3D | None] = (None, None)) → ifcopenshell.entity_instance¶

Add profile representation.

Parameters:

context – The IfcGeometricRepresentationContext for the representation, only Model/Body/MODEL_VIEW type of representations are currently supported.
profile – The IfcProfileDef to extrude.
depth – The depth of the extrusion in meters.
cardinal_point – The cardinal point of the profile.
clippings – A list of planes that define clipping half space solids. Planes are defined either by Clipping objects or by dictionaries of arguments for Clipping.parse.
placement_zx_axes – A tuple of two vectors that define the placement of the profile. The first vector is the Z axis, the second vector is the X axis.

Returns:

IfcShapeRepresentation.

ifcopenshell.api.geometry.add_profile_representation.CARDINAL_POINT_VALUES: tuple[CardinalPointString, Ellipsis]¶