Stair

import { Stair, computeStairLayout } from '@opengeometry/floorkit';

import { Stair, StairLayout, Floorkit } from '@opengeometry/floorkit';

async function example(wasmURL: string): Promise<void> {
  await new Floorkit().setupOpenGeometry(wasmURL);
  const stair = new Stair({
    layout: StairLayout.L_SHAPE,
    origin: [0, 0],
    elevation: 0,
    width: 1.1,
    totalRise: 3,
    treadDepth: 0.28,
    maxRiserHeight: 0.19,
    landingDepth: 1.2,
    turnDirection: 'left',
  });
  try {
    stair.setOPConfig({ totalRise: 3.1 });
    console.log(stair.riserCount, stair.actualRiserHeight, stair.layoutWarnings);
    console.log(stair.toDrawing('top', { cutElevation: 1.2 }));
  } finally {
    stair.dispose();
  }
}

constructor(config?: Partial<StairOptions>);

static editableSchema(): OPEditableSchema;

getPhysicalParts(): readonly PhysicalElementPart[];

move(delta: Vec3): void;

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

getRailingPath(side: "left" | "right", inset?: number): Vec3[];

attachRailing(railing: Railing, opts?: {
    side?: "left" | "right";
    inset?: number;
}): void;

detachRailing(railing: Railing): void;

getHostedRailings(): Railing[];

setOPGeometry(): void;

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

toDrawing(view: PlanExportView, options?: StairPlanDrawingOptions): DrawingPrimitive[];

setOPMaterial(): void;

getEditAnchors(): EditAnchor[];

applyEditAnchor(id: string, position: [
    number,
    number,
    number
]): void;

getOPConfig(): StairOptions;

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

beginEdit(): void;

endEdit(): {
    undo: () => void;
    redo: () => void;
} | undefined;

dispose(): void;

function computeStairLayout(input: StairLayoutInput): StairLayoutResult;

interface StairOptions extends HasPropertySets {
  ogid?: string;
  labelName: string;
  type: ElementType.STAIR;
  layout: StairLayout;
  origin: PointXZ;
  rotation: number;
  elevation: number;
  width: number;
  totalRise: number;
  treadDepth: number;
  riserHeight?: number;
  maxRiserHeight: number;
  landingDepth: number;
  turnDirection: StairTurnDirection;
  showBreakLine: boolean;
  color: number;
}

enum StairLayout {
  STRAIGHT = 'STRAIGHT',
  L_SHAPE = 'L_SHAPE',
  U_SHAPE = 'U_SHAPE',
}

type StairTurnDirection = 'left' | 'right';

interface StairLayoutResult {
  riserCount: number;
  actualRiserHeight: number;
  treadCount: number;
  runLength: number;
  landingSide: number;
  flights: StairFlight[];
  landings: StairLanding[];
  warnings: string[];
}

interface StairPlanDrawingOptions {
  cutElevation?: number;
}

interface StairLayoutInput {
  layout: StairLayout;
  width: number;
  totalRise: number;
  treadDepth: number;
  riserHeight?: number;
  maxRiserHeight?: number;
  landingDepth?: number;
  turnDirection?: StairTurnDirection;
}

interface StairFlight {
  riserCount: number;
  baseElevation: number;
  direction: PointXZ;
  steps: StairStep[];
  walkline: {
    start: PointXZ;
    end: PointXZ;
  };
}

interface StairLanding {
  rect: StairRect;
  topElevation: number;
  walkline: {
    start: PointXZ;
    end: PointXZ;
  };
}

interface StairStep {
  rect: StairRect;
  topElevation: number;
}

type StairRect = [PointXZ, PointXZ, PointXZ, PointXZ];