IFClite TypeScript API
    Preparing search index...

    Interface AddColumnInStoreParams

    Rectangular column parameters retain their public interface and inherit the canonical geometry fields, including storey-local RefDirection.

    interface AddColumnInStoreParams {
        Depth: number;
        Description?: string;
        GlobalId?: string;
        Height: number;
        Name?: string;
        ObjectType?: string;
        Position: [number, number, number];
        RefDirection?: [number, number, number];
        Tag?: string;
        Width: number;
    }

    Hierarchy

    • AddElementCommonParams
    • Pick<
          ColumnInStoreParams,
          "Position"
          | "Width"
          | "Depth"
          | "Height"
          | "RefDirection",
      >
      • AddColumnInStoreParams
    Index
    Depth: number

    Profile depth along storey-local Y (metres).

    Description?: string
    GlobalId?: string
    Height: number

    Extrusion height along +Z (metres).

    Name?: string
    ObjectType?: string
    Position: [number, number, number]

    Base centre of the column, in storey-local coordinates (metres).

    RefDirection?: [number, number, number]

    The placement's RefDirection: where the section's local X (Width) points, in storey-local coordinates. Must be horizontal; it is normalised. Default [1, 0, 0]. Written explicitly either way, with Axis [0, 0, 1], so the column can be turned later (rotateEntity edits the RefDirection and refuses a placement without one).

    Tag?: string
    Width: number

    Profile width along storey-local X (metres).