geometrix 0.5.10 → 0.5.11

package/dist/index.d.ts

@@ -0,0 +1,505 @@
+declare const colors: {
+    point: string;
+    line: string;
+    vector: string;
+    contour: string;
+    main: string;
+    mainB: string;
+    second: string;
+    secondB: string;
+    dynamics: string;
+    ruler: string;
+    origin: string;
+    reference: string;
+    mouse: string;
+};
+interface tCanvasAdjust {
+    init: number;
+    xMin: number;
+    yMin: number;
+    xyDiff: number;
+    shiftX: number;
+    shiftY: number;
+    scaleX: number;
+    scaleY: number;
+}
+declare function point2canvas(px: number, py: number, iAdjust: tCanvasAdjust): [number, number];
+declare function canvas2point(cx: number, cy: number, iAdjust: tCanvasAdjust): [number, number];
+declare function canvasTranslatePolar(cx: number, cy: number, ia: number, il: number): [number, number];
+declare function radius2canvas(iRadius: number, iAdjust: tCanvasAdjust): number;
+declare function adjustZero(): tCanvasAdjust;
+declare function adjustInit(xMin: number, xMax: number, yMin: number, yMax: number, cWidth: number, cHeight: number): tCanvasAdjust;
+declare function adjustCenter(px: number, py: number, iAdjust: tCanvasAdjust): tCanvasAdjust;
+declare function adjustRect(p1x: number, p1y: number, p2x: number, p2y: number, cWidth: number, cHeight: number): tCanvasAdjust;
+declare function adjustScale(iFactor: number, iAdjust: tCanvasAdjust): tCanvasAdjust;
+declare function adjustTranslate(p1x: number, p1y: number, p2x: number, p2y: number, iAdjust: tCanvasAdjust): tCanvasAdjust;
+
+declare function degToRad(degrees: number): number;
+declare function radToDeg(rad: number): number;
+declare function roundZero(ix: number): number;
+declare function withinZero2Pi(ia: number): number;
+declare function withinPiPi(ia: number): number;
+declare function ffix(ifloat: number): string;
+
+declare function lcFromLaLbAc(la: number, lb: number, ac: number): number;
+declare function aCFromLaLbLc(la: number, lb: number, lc: number): number;
+declare function lbFromLaAaAb(ila: number, iaA: number, iaB: number): number;
+declare function aBFromLaLbAa(ila: number, ilb: number, iaA: number): number;
+
+type tPolar = [number, number];
+declare enum ShapePoint {
+    eDefault = 0,
+    eCircle = 1,
+    eCross = 2,
+    eSquare = 3,
+    eBigSquare = 4,
+    eTwoTri = 5,
+    eTri1 = 6,
+    eTri2 = 7,
+    eTri3 = 8,
+    eTri4 = 9
+}
+declare class Point {
+    cx: number;
+    cy: number;
+    shape: ShapePoint;
+    constructor(ix: number, iy: number, ishape?: ShapePoint);
+    draw(ctx: CanvasRenderingContext2D, cAdjust: tCanvasAdjust, color?: string, ishape?: ShapePoint): void;
+    distanceOrig(): number;
+    angleOrig(): number;
+    getPolar(): tPolar;
+    setPolar(ia: number, il: number): Point;
+    translate(ix: number, iy: number): Point;
+    translatePolar(ia: number, il: number): Point;
+    clone(ishape?: ShapePoint): Point;
+    rotateOrig(ia: number): Point;
+    scaleOrig(ir: number): Point;
+    rotate(ic: Point, ia: number): Point;
+    scale(ic: Point, ir: number): Point;
+    isEqual(ic: Point): boolean;
+    distanceToPoint(p2: Point): number;
+    angleToPoint(p2: Point): number;
+    angleFromToPoints(p2: Point, p3: Point): number;
+    middlePoint(p2: Point): Point;
+    equidistantPoint(p2: Point, dist: number, p3: Point): Point;
+}
+declare function point(ix: number, iy: number, ishape?: ShapePoint): Point;
+
+interface tAffine {
+    quasiVertical: boolean;
+    ha: number;
+    hb: number;
+    va: number;
+    vb: number;
+}
+declare class Line {
+    cx: number;
+    cy: number;
+    ca: number;
+    constructor(ix: number, iy: number, ia: number);
+    draw(ctx: CanvasRenderingContext2D, cAdjust: tCanvasAdjust, color?: string): void;
+    setFromPoints(p1: Point, p2: Point): this;
+    getAffine(): tAffine;
+    setAffine(iAffine: tAffine): Line;
+    intersection(il: Line): Point;
+    getAxisXIntersection(): number;
+    getAxisYIntersection(): number;
+    getAxisXIntersecTri(): number;
+    getAxisYIntersecTri(): number;
+    angleOrig(): number;
+    distanceOrig(): number;
+    projectOrig(): Point;
+    translate(ix: number, iy: number): Line;
+    rotateOrig(ia: number): Line;
+    scaleOrig(ir: number): Line;
+    rotate(ic: Point, ia: number): Line;
+    scale(ic: Point, ir: number): Line;
+    clone(): Line;
+    lineOrthogonal(ic: Point): Line;
+    lineParallel(ic: Point): Line;
+    distanceToPoint(ic: Point): number;
+    projectPoint(ic: Point): Point;
+    isParallel(il: Line): boolean;
+    isOrthogonal(il: Line): boolean;
+    isEqual(il: Line): boolean;
+    bisector(il: Line, ip: Point): Line;
+    lineParallelDistance(iDist: number, ipMagnet: Point, ipMagnet2: Point): Line;
+}
+declare function line(ix: number, iy: number, ia: number): Line;
+declare function linePP(ip1: Point, ip2: Point): Line;
+declare function bisector(ip1: Point, ip2: Point): Line;
+declare function circleCenter(ip1: Point, ip2: Point, ip3: Point): Point;
+
+type tCartesian = [number, number];
+declare class Vector {
+    ca: number;
+    cl: number;
+    drawPoint: Point;
+    constructor(ia: number, il: number, iDrawPoint: Point);
+    draw(ctx: CanvasRenderingContext2D, cAdjust: tCanvasAdjust, color?: string): void;
+    getCartesian(): tCartesian;
+    setCartesian(ix: number, iy: number): Vector;
+    translatePoint(ip: Point): Point;
+    add(iVect: Vector): Vector;
+    addCart(ix: number, iy: number): Vector;
+    translate(ix: number, iy: number): Vector;
+    rotate(ic: Point, ia: number): Vector;
+    clone(): Vector;
+    isEqual(iVect: Vector): boolean;
+    dotProduct(iVect: Vector): number;
+    crossProduct(iVect: Vector): number;
+}
+declare function vector(ia: number, il: number, iDrawPoint: Point): Vector;
+
+declare enum SegEnum {
+    eStroke = 0,
+    eArc = 1,
+    ePointed = 2,
+    eRounded = 3,
+    eWidened = 4,
+    eWideAcc = 5,// Widened Access
+    eStart = 6
+}
+declare class Segment1 {
+    sType: SegEnum;
+    px: number;
+    py: number;
+    radius: number;
+    arcLarge: boolean;
+    arcCcw: boolean;
+    constructor(iType: SegEnum, ix: number, iy: number, iRadius: number, iArcLarge?: boolean, iArcCcw?: boolean);
+    clone(): Segment1;
+}
+
+declare class DxfSeg {
+    arc: boolean;
+    p1x: number;
+    p1y: number;
+    radius: number;
+    a1: number;
+    a2: number;
+    p2x: number;
+    p2y: number;
+    constructor(arc: boolean, p1x: number, p1y: number, radius: number, a1: number, a2: number, p2x: number, p2y: number);
+}
+
+interface tPaxContourCircle {
+    circle: boolean;
+    cx: number;
+    cy: number;
+    radius: number;
+}
+declare enum PSeg {
+    eStart = 0,
+    eStroke = 1,
+    eArc = 2
+}
+interface tPaxSegSt {
+    typ: PSeg;
+    px: number;
+    py: number;
+}
+interface tPaxSegArc {
+    typ: PSeg;
+    px: number;
+    py: number;
+    radius: number;
+    large: boolean;
+    ccw: boolean;
+}
+type tPaxSeg = tPaxSegSt | tPaxSegArc;
+interface tPaxContourPath {
+    circle: boolean;
+    seg: tPaxSeg[];
+}
+type tPaxContour = tPaxContourPath | tPaxContourCircle;
+
+declare abstract class AContour {
+    abstract circle: boolean;
+    abstract imposedColor: string;
+    abstract draw(ctx: CanvasRenderingContext2D, cAdjust: tCanvasAdjust, color: string): void;
+    abstract extractSkeleton(): AContour;
+    abstract generateContour(): AContour;
+    abstract generatePoints(): Point[];
+    abstract generateLines(): Line[];
+    abstract check(): string;
+    abstract toSvg(yCeiling: number, color?: string): string;
+    abstract toDxfSeg(): DxfSeg[];
+    abstract toPax(): tPaxContour;
+}
+declare class Contour extends AContour {
+    circle: boolean;
+    segments: Segment1[];
+    points: Point[];
+    debugPoints: Point[];
+    debugLines: Line[];
+    lastPoint: Point;
+    imposedColor: string;
+    constructor(ix: number, iy: number, icolor?: string);
+    setLastPoint(ix: number, iy: number): void;
+    getLastPoint(): Point;
+    addPointA(ax: number, ay: number): Contour;
+    addPointAP(aa: number, al: number): Contour;
+    addPointR(rx: number, ry: number): Contour;
+    addPointRP(ra: number, rl: number): Contour;
+    addSeg(iSeg: Segment1): Contour;
+    addSegStroke(): Contour;
+    addSegStrokeA(ax: number, ay: number): Contour;
+    addSegStrokeAP(aa: number, al: number): Contour;
+    addSegStrokeR(rx: number, ry: number): Contour;
+    addSegStrokeRP(ra: number, rl: number): Contour;
+    addSegArc(iRadius: number, iLarge: boolean, iCcw: boolean): Contour;
+    addSegArc2(): Contour;
+    addSegArc3(iTangentAngle1: number, firstNlast: boolean): Contour;
+    addSeg2Arcs(ita1: number, ita2: number): Contour;
+    addCornerPointed(): Contour;
+    addCornerRounded(iRadius: number): Contour;
+    addCornerWidened(iRadius: number): Contour;
+    addCornerWideAcc(iRadius: number): Contour;
+    closeSegStroke(): Contour;
+    closeSegArc(iRadius: number, iLarge: boolean, iCcw: boolean): Contour;
+    clone(): Contour;
+    translate(ix: number, iy: number): Contour;
+    translatePolar(ia: number, il: number): Contour;
+    rotate(ix: number, iy: number, ia: number): Contour;
+    scale(ix: number, iy: number, ir: number, scaleCorner?: boolean): Contour;
+    addPartial(iContour: Contour): Contour;
+    draw(ctx: CanvasRenderingContext2D, cAdjust: tCanvasAdjust, color?: string): void;
+    extractSkeleton(): Contour;
+    generateContour(): Contour;
+    generatePoints(): Point[];
+    generateLines(): Line[];
+    checkContour(ctr: Contour): void;
+    check(): string;
+    toSvg(yCeiling: number, color?: string): string;
+    toDxfSeg(): DxfSeg[];
+    toPax(): tPaxContourPath;
+}
+declare class ContourCircle extends AContour {
+    circle: boolean;
+    px: number;
+    py: number;
+    radius: number;
+    imposedColor: string;
+    constructor(ix: number, iy: number, iRadius: number, icolor?: string);
+    clone(): ContourCircle;
+    translate(ix: number, iy: number): ContourCircle;
+    translatePolar(ia: number, il: number): ContourCircle;
+    rotate(ix: number, iy: number, ia: number): ContourCircle;
+    draw(ctx: CanvasRenderingContext2D, cAdjust: tCanvasAdjust, color?: string): void;
+    extractSkeleton(): ContourCircle;
+    generateContour(): ContourCircle;
+    generatePoints(): Point[];
+    generateLines(): Line[];
+    check(): string;
+    toSvg(yCeiling: number, color?: string): string;
+    toDxfSeg(): DxfSeg[];
+    toPax(): tPaxContourCircle;
+}
+declare function contour(ix: number, iy: number, icolor?: string): Contour;
+declare function contourCircle(ix: number, iy: number, iRadius: number, icolor?: string): ContourCircle;
+type tContour = Contour | ContourCircle;
+
+interface tLayers {
+    points: boolean;
+    lines: boolean;
+    vectors: boolean;
+    main: boolean;
+    mainB: boolean;
+    second: boolean;
+    secondB: boolean;
+    dynamics: boolean;
+    ruler: boolean;
+    refframe: boolean;
+}
+declare class Figure {
+    pointList: Point[];
+    lineList: Line[];
+    vectorList: Vector[];
+    mainList: tContour[];
+    mainBList: tContour[];
+    secondList: tContour[];
+    secondBList: tContour[];
+    dynamicsList: tContour[];
+    xMin: number;
+    xMax: number;
+    yMin: number;
+    yMax: number;
+    constructor();
+    addPoint(ipoint: Point): void;
+    addPoints(ipoints: Point[]): void;
+    addLine(iline: Line): void;
+    addLines(ilines: Line[]): void;
+    addVector(ivector: Vector): void;
+    addMain(icontour: tContour): void;
+    addSecond(icontour: tContour): void;
+    addDynamics(icontour: tContour): void;
+    translate(ix: number, iy: number): Figure;
+    translatePolar(ia: number, il: number): Figure;
+    rotate(ix: number, iy: number, ia: number): Figure;
+    mergeFigure(ifig: Figure, mainToSecond?: boolean): void;
+    clear(): void;
+    getMinMax(): void;
+    getAdjustFull(iCanvasWidth: number, iCanvasHeight: number): tCanvasAdjust;
+    getAdjustZoom(iCanvasWidth: number, iCanvasHeight: number): tCanvasAdjust;
+    quantifyRuler(canvasWidth: number, adjust: tCanvasAdjust): number[];
+    drawRuler(ctx: CanvasRenderingContext2D, adjust: tCanvasAdjust, color: string): void;
+    draw(ctx: CanvasRenderingContext2D, adjust: tCanvasAdjust, layers: tLayers): void;
+}
+declare function figure(): Figure;
+type tFaces = Record<string, Figure>;
+declare function mergeFaces(iFaces: tFaces): Figure;
+declare function initLayers(): tLayers;
+declare function copyLayers(iLayers: tLayers): tLayers;
+
+declare enum PType {
+    eNumber = 0,
+    eCheckbox = 1,
+    eDropdown = 2
+}
+interface tParam {
+    name: string;
+    unit: string;
+    init: number;
+    min: number;
+    max: number;
+    step: number;
+    dropdown: string[];
+    pType: PType;
+}
+interface tSimTime {
+    tMax: number;
+    tStep: number;
+    tUpdate: number;
+}
+interface tParamDef {
+    partName: string;
+    params: tParam[];
+    paramSvg: Record<string, string>;
+    sim: tSimTime;
+}
+type tParamVal = Record<string, number>;
+type tParamChanged = Record<string, boolean>;
+interface tDesignParamOne {
+    val: number;
+    init: number;
+    chg: boolean;
+}
+declare function oneDesignParam(iVal: number, iInit: number, iChg: boolean): tDesignParamOne;
+type tDesignParamList = Record<string, tDesignParamOne>;
+declare function paramListToVal(dpList: tDesignParamList): tParamVal;
+declare class DesignParam {
+    paramVal: tParamVal;
+    paramInit: tParamVal;
+    paramChanged: tParamChanged;
+    partName: string;
+    paramNames: string[];
+    getParamName(): string[];
+    constructor(iparamDef: tParamDef);
+    getPartName(): string;
+    getParamVal(): tParamVal;
+    getVal(iname: string): number;
+    getInit(iname: string): number;
+    getChanged(iname: string): boolean;
+    setVal(iname: string, ival: number): void;
+    applyParamVal(iValues: tParamVal): string;
+    applyParamList(iValues: tDesignParamList): string;
+    getDesignParamList(): tDesignParamList;
+}
+declare function designParam(iparamDef: tParamDef): DesignParam;
+declare function pNumber(name: string, unit: string, init: number, min?: number, max?: number, step?: number): tParam;
+declare function pCheckbox(name: string, init: boolean): tParam;
+declare function pDropdown(name: string, values: string[]): tParam;
+
+type tPosiOrien = [number, number, number];
+interface tSubInst {
+    partName: string;
+    dparam: tDesignParamList;
+    orientation: tPosiOrien;
+    position: tPosiOrien;
+}
+type tSubDesign = Record<string, tSubInst>;
+
+interface tGeom {
+    partName: string;
+    calcErr: boolean;
+    logstr: string;
+    fig: tFaces;
+    vol: tVolume;
+    sub: tSubDesign;
+}
+type tGeomFunc = (t: number, ipVal: tParamVal) => tGeom;
+interface tPageDef {
+    pTitle: string;
+    pDescription: string;
+    pDef: tParamDef;
+    pGeom: tGeomFunc;
+}
+type tAllPageDef = Record<string, tPageDef>;
+type tAllLink = Record<string, string>;
+declare function fround(ireal: number, iprecision?: number): number;
+declare function initGeom(partName: string): tGeom;
+declare function checkGeom(iGeom: tGeom): void;
+declare function prefixLog(iLog: string, iPartName: string): string;
+
+interface tInherit {
+    outName: string;
+    subdesign: string;
+    subgeom: tGeom;
+    rotate: [number, number, number];
+    translate: [number, number, number];
+}
+declare enum EExtrude {
+    eLinearOrtho = 0,
+    eRotate = 1
+}
+interface tExtrude {
+    outName: string;
+    face: string;
+    extrudeMethod: EExtrude;
+    length?: number;
+    rotate: [number, number, number];
+    translate: [number, number, number];
+}
+declare enum EBVolume {
+    eIdentity = 0,
+    eIntersection = 1,
+    eUnion = 2,
+    eSubstraction = 3
+}
+interface tBVolume {
+    outName: string;
+    boolMethod: EBVolume;
+    inList: string[];
+}
+interface tVolume {
+    inherits?: tInherit[];
+    extrudes: tExtrude[];
+    volumes: tBVolume[];
+}
+
+declare enum EFormat {
+    eSVG = 0,
+    eSVGALL = 1,
+    eDXF = 2,
+    eDXFALL = 3,
+    ePAX = 4,
+    eOPENSCAD = 5,
+    eJSCAD = 6,
+    eZIP = 7
+}
+declare function fileTextContent(fgeom: tGeomFunc, paramVal: tParamVal, eFace: string, exportFormat: EFormat): string;
+declare function fileBinContent(fgeom: tGeomFunc, tSim: number, paramVal: tParamVal, exportFormat: EFormat): Promise<Blob>;
+declare function fileMime(exportFormat: EFormat): string;
+declare function fileSuffix(exportFormat: EFormat): string;
+declare function fileBin(exportFormat: EFormat): boolean;
+
+interface tParamValInFile {
+    lastModif: string;
+    pVal: tParamVal;
+    comment: string;
+}
+declare function createParamFile(lastModif: string, idparams: tParamVal, comment: string): string;
+declare function parseParamFile(fContentStr: string): [tParamValInFile, string];
+
+export { DesignParam, EBVolume, EExtrude, EFormat, Figure, PType, Point, ShapePoint, aBFromLaLbAa, aCFromLaLbLc, adjustCenter, adjustInit, adjustRect, adjustScale, adjustTranslate, adjustZero, bisector, canvas2point, canvasTranslatePolar, checkGeom, circleCenter, colors, contour, contourCircle, copyLayers, createParamFile, degToRad, designParam, ffix, figure, fileBin, fileBinContent, fileMime, fileSuffix, fileTextContent, fround, initGeom, initLayers, lbFromLaAaAb, lcFromLaLbAc, line, linePP, mergeFaces, oneDesignParam, pCheckbox, pDropdown, pNumber, paramListToVal, parseParamFile, point, point2canvas, prefixLog, radToDeg, radius2canvas, roundZero, type tAllLink, type tAllPageDef, type tBVolume, type tCanvasAdjust, type tContour, type tDesignParamList, type tExtrude, type tFaces, type tGeom, type tGeomFunc, type tInherit, type tLayers, type tPageDef, type tParamDef, type tParamVal, type tParamValInFile, type tPosiOrien, type tSubDesign, type tSubInst, type tVolume, vector, withinPiPi, withinZero2Pi };