IFClite TypeScript API
    Preparing search index...

    Interface GenericElementParams

    Parameters for the generic addElement() method. Allows creating ANY IFC entity type with ANY geometry creation method.

    creator.addElement(storeyId, {
      IfcType: 'IFCFLOWSEGMENT',
      Placement: { Location: [0, 0, 0] },
      Profile: { ProfileType: 'AREA', Radius: 0.1 },
      Depth: 5,
    });
    interface GenericElementParams {
        Depth: number;
        Description?: string;
        ExtrusionDirection?: Point3D;
        IfcType: string;
        Name?: string;
        ObjectType?: string;
        Placement: Placement3D;
        PredefinedType?: string;
        Profile: ProfileDef;
        Tag?: string;
    }

    Hierarchy (View Summary)

    Index
    Depth Description? ExtrusionDirection? IfcType Name? ObjectType? Placement PredefinedType? Profile Tag?
    Depth: number

    Extrusion depth (length along the extrusion direction)

    Description?: string
    ExtrusionDirection?: Point3D

    Extrusion direction in the PROFILE's coordinate system, where the profile lies in the XY plane. Default: [0, 0, 1] (perpendicular to the profile). It must have a non-zero Z component (IFC4 IfcExtrudedAreaSolid.WR31): a direction like [1, 0, 0] lies IN the profile plane and sweeps the profile into a zero-volume sheet. To orient the element in the model (e.g. a horizontal pipe), keep the default and set Placement.Axis to the world direction the element should run along instead.

    IfcType: string

    IFC entity type name in UPPERCASE (e.g. 'IFCFLOWSEGMENT', 'IFCFLOWFITTING', 'IFCELECTRICALAPPLIANCE', 'IFCWALLSTANDARDCASE', etc.).

    Any IFC product type can be used. The only requirement is that it extends IfcProduct in the IFC schema (i.e. it can have a placement and representation).

    Name?: string
    ObjectType?: string
    Placement: Placement3D

    3D placement for the element

    PredefinedType?: string

    Optional predefined type token (without surrounding dots). The serializer wraps it as .TOKEN. in the STEP output. E.g. 'RIGIDSEGMENT', 'NOTDEFINED'

    Profile: ProfileDef

    Cross-section profile to extrude. Supports all profile types: Rectangle, Circle, CircleHollow, IShape, LShape, TShape, UShape, CShape, RectangleHollow, or Arbitrary (polyline).

    Tag?: string

    Settings
    Member Visibility

    On This Page
    Properties