Building

import { Building } from '@opengeometry/floorkit';

constructor(config: Partial<Omit<BuildingOptions, "profile" | "height" | "segments">> & Pick<BuildingOptions, "segments">);

static editableSchema(): OPEditableSchema;

setSegment(index: number, patch: Partial<Omit<MassSegment, "storeys">>): void;

selectPart(object: THREE.Object3D): boolean;

storeyElevations(): Array<{
    storeyId: string;
    segmentId: string;
    elevation: number;
    height: number;
    use?: BuildingUse;
}>;

quantities(options?: {
    grade?: number;
}): MassQuantities;

move(delta: Vec3): void;

rotate(angleDeg: number, axis?: Vec3, anchor?: Vec3): void;

setOPGeometry(): void;

getExportRoots(view: PlanExportView): THREE.Object3D[];

toDrawing(view: PlanExportView): DrawingPrimitive[];

setOPMaterial(): void;

getOPConfig(): BuildingOptions;

setOPConfig(config: Partial<BuildingOptions>): void;

dispose(): void;

interface BuildingOptions extends HasPropertySets {
  ogid?: string;
  labelName: string;
  type: ElementType.BUILDING;
  profile: BuildingProfile;
  height: number;
  segments: MassSegment[];
  use: BuildingUse;
  showStoreys: boolean;
  color: number;
  elevation: number;
}

interface MassSegment {
  id: string;
  name?: string;
  footprint: PolygonProfile;
  height: number;
  use?: BuildingUse;
  color?: number;
  storeys: MassStorey[];
}

type BuildingUse =
  | 'residential'
  | 'office'
  | 'retail'
  | 'hotel'
  | 'civic'
  | 'industrial'
  | 'parking'
  | 'mixed'
  | 'other'
  | `custom:${string}`;

interface MassQuantities {
  footprintArea: number;
  grossFloorArea: number;
  grossFloorAreaByUse: Record<string, number>;
  grossFloorAreaByKind: Record<AreaKind, number>;
  grossVolume: number;
  height: number;
  numberOfStoreys: number;
  facadeAreaFlat: number;
  storeys: StoreyQuantity[];
}

type BuildingProfile = PolygonProfile;

interface StoreyQuantity {
  storeyId: string;
  segmentId: string;
  elevation: number;
  height: number;
  use?: BuildingUse;
  areaKind: AreaKind;
  grossFloorArea: number;
  perimeter: number;
}