brepjs 2.0.3 → 2.0.4
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/dist/brepjs.cjs +374 -793
- package/dist/brepjs.d.ts +136 -312
- package/dist/brepjs.js +374 -793
- package/package.json +3 -3
package/dist/brepjs.d.ts
CHANGED
|
@@ -2,10 +2,10 @@ declare abstract class _1DShape<Type extends Deletable = OcShape> extends Shape<
|
|
|
2
2
|
protected abstract _geomAdaptor(): CurveLike;
|
|
3
3
|
get repr(): string;
|
|
4
4
|
get curve(): Curve;
|
|
5
|
-
get startPoint():
|
|
6
|
-
get endPoint():
|
|
7
|
-
tangentAt(position?: number):
|
|
8
|
-
pointAt(position?: number):
|
|
5
|
+
get startPoint(): Vec3;
|
|
6
|
+
get endPoint(): Vec3;
|
|
7
|
+
tangentAt(position?: number): Vec3;
|
|
8
|
+
pointAt(position?: number): Vec3;
|
|
9
9
|
get isClosed(): boolean;
|
|
10
10
|
get isPeriodic(): boolean;
|
|
11
11
|
get period(): number;
|
|
@@ -89,18 +89,6 @@ declare interface ApproximationOptions {
|
|
|
89
89
|
maxSegments?: number;
|
|
90
90
|
}
|
|
91
91
|
|
|
92
|
-
/**
|
|
93
|
-
* @deprecated Use toOcDir from occtBoundary.ts with Vec3 tuples instead.
|
|
94
|
-
* @see toOcDir
|
|
95
|
-
*/
|
|
96
|
-
export declare function asDir(coords: Point): OcType;
|
|
97
|
-
|
|
98
|
-
/**
|
|
99
|
-
* @deprecated Use toOcPnt from occtBoundary.ts with Vec3 tuples instead.
|
|
100
|
-
* @see toOcPnt
|
|
101
|
-
*/
|
|
102
|
-
export declare function asPnt(coords: Point): OcType;
|
|
103
|
-
|
|
104
92
|
export declare const assembleWire: (listOfEdges: (Edge | Wire)[]) => Result<Wire>;
|
|
105
93
|
|
|
106
94
|
export declare class AssemblyExporter extends WrappingObj<OcType> {
|
|
@@ -175,7 +163,7 @@ export declare class BaseSketcher2d {
|
|
|
175
163
|
protected _closeWithMirror(): void;
|
|
176
164
|
}
|
|
177
165
|
|
|
178
|
-
export declare const basicFaceExtrusion: (face: Face, extrusionVec:
|
|
166
|
+
export declare const basicFaceExtrusion: (face: Face, extrusionVec: PointInput) => Solid;
|
|
179
167
|
|
|
180
168
|
/**
|
|
181
169
|
* A Blueprint is an abstract Sketch, a 2D set of curves that can then be
|
|
@@ -200,12 +188,12 @@ export declare class Blueprint implements DrawingInterface {
|
|
|
200
188
|
translate(xDist: number, yDist: number): Blueprint;
|
|
201
189
|
translate(translationVector: Point2D): Blueprint;
|
|
202
190
|
mirror(centerOrDirection: Point2D, origin?: Point2D, mode?: 'center' | 'plane'): Blueprint;
|
|
203
|
-
sketchOnPlane(inputPlane?: PlaneName |
|
|
191
|
+
sketchOnPlane(inputPlane?: PlaneName | FnPlane, origin?: PointInput | number): SketchData;
|
|
204
192
|
sketchOnFace(face: Face, scaleMode?: ScaleMode): SketchData;
|
|
205
|
-
subFace(face: Face, origin?:
|
|
193
|
+
subFace(face: Face, origin?: PointInput | null): Face;
|
|
206
194
|
punchHole(shape: AnyShape, face: SingleFace, { height, origin, draftAngle, }?: {
|
|
207
195
|
height?: number | null;
|
|
208
|
-
origin?:
|
|
196
|
+
origin?: PointInput | null;
|
|
209
197
|
draftAngle?: number;
|
|
210
198
|
}): AnyShape;
|
|
211
199
|
toSVGPathD(): string;
|
|
@@ -251,11 +239,11 @@ export declare class Blueprints implements DrawingInterface {
|
|
|
251
239
|
translate(xDist: number, yDist: number): Blueprints;
|
|
252
240
|
translate(translationVector: Point2D): Blueprints;
|
|
253
241
|
mirror(centerOrDirection: Point2D, origin?: Point2D, mode?: 'center' | 'plane'): Blueprints;
|
|
254
|
-
sketchOnPlane(plane?: PlaneName |
|
|
242
|
+
sketchOnPlane(plane?: PlaneName | FnPlane, origin?: PointInput | number): (SketchData | SketchData[])[];
|
|
255
243
|
sketchOnFace(face: Face, scaleMode?: ScaleMode): (SketchData | SketchData[])[];
|
|
256
244
|
punchHole(shape: AnyShape, face: SingleFace, options?: {
|
|
257
245
|
height?: number;
|
|
258
|
-
origin?:
|
|
246
|
+
origin?: PointInput;
|
|
259
247
|
draftAngle?: number;
|
|
260
248
|
}): AnyShape;
|
|
261
249
|
toSVGViewBox(margin?: number): string;
|
|
@@ -291,36 +279,6 @@ export declare interface BooleanOptions {
|
|
|
291
279
|
strategy?: 'native' | 'pairwise';
|
|
292
280
|
}
|
|
293
281
|
|
|
294
|
-
/**
|
|
295
|
-
* @deprecated Use getBounds() from shapeFns.ts which returns a Bounds3D plain object.
|
|
296
|
-
* @example
|
|
297
|
-
* // Before (legacy):
|
|
298
|
-
* const bbox = shape.boundingBox;
|
|
299
|
-
* const center = bbox.center;
|
|
300
|
-
*
|
|
301
|
-
* // After (functional):
|
|
302
|
-
* import { getBounds, type Bounds3D } from 'brepjs';
|
|
303
|
-
* const bounds: Bounds3D = getBounds(shape);
|
|
304
|
-
* const center = [
|
|
305
|
-
* (bounds.xMin + bounds.xMax) / 2,
|
|
306
|
-
* (bounds.yMin + bounds.yMax) / 2,
|
|
307
|
-
* (bounds.zMin + bounds.zMax) / 2
|
|
308
|
-
* ];
|
|
309
|
-
*
|
|
310
|
-
* @see getBounds, Bounds3D
|
|
311
|
-
*/
|
|
312
|
-
export declare class BoundingBox extends WrappingObj<OcType> {
|
|
313
|
-
constructor(wrapped?: OcType);
|
|
314
|
-
get repr(): string;
|
|
315
|
-
get bounds(): [SimplePoint, SimplePoint];
|
|
316
|
-
get center(): SimplePoint;
|
|
317
|
-
get width(): number;
|
|
318
|
-
get height(): number;
|
|
319
|
-
get depth(): number;
|
|
320
|
-
add(other: BoundingBox): void;
|
|
321
|
-
isOut(other: BoundingBox): boolean;
|
|
322
|
-
}
|
|
323
|
-
|
|
324
282
|
export declare class BoundingBox2d extends WrappingObj<OcType> {
|
|
325
283
|
constructor(wrapped?: OcType);
|
|
326
284
|
get repr(): string;
|
|
@@ -453,9 +411,9 @@ export declare const combineFinderFilters: <Type, T, R = number>(filters: {
|
|
|
453
411
|
radius: R;
|
|
454
412
|
}[]) => [(v: Type) => R | null, () => void];
|
|
455
413
|
|
|
456
|
-
export declare function complexExtrude(wire: Wire, center:
|
|
414
|
+
export declare function complexExtrude(wire: Wire, center: PointInput, normal: PointInput, profileShape: ExtrusionProfile | undefined, shellMode: true): Result<[Shape3D, Wire, Wire]>;
|
|
457
415
|
|
|
458
|
-
export declare function complexExtrude(wire: Wire, center:
|
|
416
|
+
export declare function complexExtrude(wire: Wire, center: PointInput, normal: PointInput, profileShape?: ExtrusionProfile, shellMode?: false): Result<Shape3D>;
|
|
459
417
|
|
|
460
418
|
export declare class Compound extends _3DShape {
|
|
461
419
|
}
|
|
@@ -473,11 +431,11 @@ export declare class CompoundBlueprint implements DrawingInterface {
|
|
|
473
431
|
translate(xDist: number, yDist: number): CompoundBlueprint;
|
|
474
432
|
translate(translationVector: Point2D): CompoundBlueprint;
|
|
475
433
|
mirror(centerOrDirection: Point2D, origin?: Point2D, mode?: 'center' | 'plane'): CompoundBlueprint;
|
|
476
|
-
sketchOnPlane(plane?: PlaneName |
|
|
434
|
+
sketchOnPlane(plane?: PlaneName | FnPlane, origin?: PointInput | number): SketchData[];
|
|
477
435
|
sketchOnFace(face: Face, scaleMode?: ScaleMode): SketchData[];
|
|
478
436
|
punchHole(shape: AnyShape, face: SingleFace, options?: {
|
|
479
437
|
height?: number;
|
|
480
|
-
origin?:
|
|
438
|
+
origin?: PointInput;
|
|
481
439
|
draftAngle?: number;
|
|
482
440
|
}): AnyShape;
|
|
483
441
|
toSVGViewBox(margin?: number): string;
|
|
@@ -505,27 +463,27 @@ export declare class CompoundSketch implements SketchInterface {
|
|
|
505
463
|
get wires(): AnyShape;
|
|
506
464
|
face(): Face;
|
|
507
465
|
extrude(extrusionDistance: number, { extrusionDirection, extrusionProfile, twistAngle, origin, }?: {
|
|
508
|
-
extrusionDirection?:
|
|
466
|
+
extrusionDirection?: PointInput;
|
|
509
467
|
extrusionProfile?: ExtrusionProfile;
|
|
510
468
|
twistAngle?: number;
|
|
511
|
-
origin?:
|
|
469
|
+
origin?: PointInput;
|
|
512
470
|
}): Shape3D;
|
|
513
471
|
/**
|
|
514
472
|
* Revolves the drawing on an axis (defined by its direction and an origin
|
|
515
473
|
* (defaults to the sketch origin)
|
|
516
474
|
*/
|
|
517
|
-
revolve(revolutionAxis?:
|
|
518
|
-
origin?:
|
|
475
|
+
revolve(revolutionAxis?: PointInput, { origin }?: {
|
|
476
|
+
origin?: PointInput;
|
|
519
477
|
}): Shape3D;
|
|
520
478
|
loftWith(otherCompound: this, loftConfig: LoftConfig): Shape3D;
|
|
521
479
|
}
|
|
522
480
|
|
|
523
481
|
/** Extrude a compound sketch to a given distance. */
|
|
524
482
|
export declare function compoundSketchExtrude(sketch: CompoundSketch, height: number, config?: {
|
|
525
|
-
extrusionDirection?:
|
|
483
|
+
extrusionDirection?: PointInput;
|
|
526
484
|
extrusionProfile?: ExtrusionProfile;
|
|
527
485
|
twistAngle?: number;
|
|
528
|
-
origin?:
|
|
486
|
+
origin?: PointInput;
|
|
529
487
|
}): Shape3D;
|
|
530
488
|
|
|
531
489
|
/** Get the face from a compound sketch. */
|
|
@@ -535,8 +493,8 @@ export declare function compoundSketchFace(sketch: CompoundSketch): Face;
|
|
|
535
493
|
export declare function compoundSketchLoft(sketch: CompoundSketch, other: CompoundSketch, loftConfig: LoftConfig): Shape3D;
|
|
536
494
|
|
|
537
495
|
/** Revolve a compound sketch around an axis. */
|
|
538
|
-
export declare function compoundSketchRevolve(sketch: CompoundSketch, revolutionAxis?:
|
|
539
|
-
origin?:
|
|
496
|
+
export declare function compoundSketchRevolve(sketch: CompoundSketch, revolutionAxis?: PointInput, options?: {
|
|
497
|
+
origin?: PointInput;
|
|
540
498
|
}): Shape3D;
|
|
541
499
|
|
|
542
500
|
export declare class CompSolid extends _3DShape {
|
|
@@ -544,12 +502,6 @@ export declare class CompSolid extends _3DShape {
|
|
|
544
502
|
|
|
545
503
|
export declare function computationError(code: string, message: string, cause?: unknown): BrepError;
|
|
546
504
|
|
|
547
|
-
declare type CoordSystem = 'reference' | {
|
|
548
|
-
origin: Point;
|
|
549
|
-
zDir: Point;
|
|
550
|
-
xDir: Point;
|
|
551
|
-
};
|
|
552
|
-
|
|
553
505
|
export declare type Corner = {
|
|
554
506
|
firstCurve: Curve2D;
|
|
555
507
|
secondCurve: Curve2D;
|
|
@@ -609,12 +561,6 @@ export declare function createDistanceQuery(referenceShape: FnAnyShape): {
|
|
|
609
561
|
/** Create a disposable shape handle. */
|
|
610
562
|
export declare function createHandle(ocShape: OcShape): ShapeHandle;
|
|
611
563
|
|
|
612
|
-
/**
|
|
613
|
-
* @deprecated Use createNamedPlane from planeOps.ts which returns a functional Plane.
|
|
614
|
-
* @see createNamedPlane from planeOps.ts (exported as fnCreateNamedPlane from brepjs)
|
|
615
|
-
*/
|
|
616
|
-
export declare const createNamedPlane: (plane: PlaneName, sourceOrigin?: Point | number) => Result<Plane>;
|
|
617
|
-
|
|
618
564
|
/** Create a disposable handle for any OCCT object. */
|
|
619
565
|
export declare function createOcHandle<T extends Deletable>(ocObj: T): OcHandle<T>;
|
|
620
566
|
|
|
@@ -626,11 +572,11 @@ export declare type CubeFace = 'front' | 'back' | 'top' | 'bottom' | 'left' | 'r
|
|
|
626
572
|
export declare class Curve extends WrappingObj<CurveLike> {
|
|
627
573
|
get repr(): string;
|
|
628
574
|
get curveType(): CurveType;
|
|
629
|
-
get startPoint():
|
|
630
|
-
get endPoint():
|
|
575
|
+
get startPoint(): Vec3;
|
|
576
|
+
get endPoint(): Vec3;
|
|
631
577
|
protected _mapParameter(position: number): number;
|
|
632
|
-
pointAt(position?: number):
|
|
633
|
-
tangentAt(position?: number):
|
|
578
|
+
pointAt(position?: number): Vec3;
|
|
579
|
+
tangentAt(position?: number): Vec3;
|
|
634
580
|
get isClosed(): boolean;
|
|
635
581
|
get isPeriodic(): boolean;
|
|
636
582
|
get period(): number;
|
|
@@ -868,12 +814,12 @@ export declare class Drawing {
|
|
|
868
814
|
* @category Drawing Modifications
|
|
869
815
|
*/
|
|
870
816
|
chamfer(radius: number, filter?: (c: CornerFinder) => CornerFinder): Drawing;
|
|
871
|
-
sketchOnPlane(inputPlane:
|
|
872
|
-
sketchOnPlane(inputPlane?: PlaneName, origin?:
|
|
817
|
+
sketchOnPlane(inputPlane: FnPlane): SketchInterface | Sketches;
|
|
818
|
+
sketchOnPlane(inputPlane?: PlaneName, origin?: PointInput | number): SketchInterface | Sketches;
|
|
873
819
|
sketchOnFace(face: Face, scaleMode: ScaleMode): SketchInterface | Sketches;
|
|
874
820
|
punchHole(shape: AnyShape, faceFinder: SingleFace, options?: {
|
|
875
821
|
height?: number;
|
|
876
|
-
origin?:
|
|
822
|
+
origin?: PointInput;
|
|
877
823
|
draftAngle?: number;
|
|
878
824
|
}): AnyShape;
|
|
879
825
|
toSVG(margin?: number): string;
|
|
@@ -912,7 +858,7 @@ export declare interface DrawingInterface {
|
|
|
912
858
|
/**
|
|
913
859
|
* Returns sketch data for the drawing on a plane.
|
|
914
860
|
*/
|
|
915
|
-
sketchOnPlane(inputPlane?: PlaneName |
|
|
861
|
+
sketchOnPlane(inputPlane?: PlaneName | FnPlane, origin?: PointInput | number): SketchData | SketchData[] | (SketchData | SketchData[])[];
|
|
916
862
|
/**
|
|
917
863
|
* Returns sketch data for the drawing on a face.
|
|
918
864
|
*
|
|
@@ -964,7 +910,7 @@ export declare class DrawingPen extends BaseSketcher2d implements GenericSketche
|
|
|
964
910
|
}
|
|
965
911
|
|
|
966
912
|
/** Sketch a drawing on a plane, returning a Sketch or Sketches. */
|
|
967
|
-
export declare function drawingToSketchOnPlane(drawing: Drawing, inputPlane?: PlaneName |
|
|
913
|
+
export declare function drawingToSketchOnPlane(drawing: Drawing, inputPlane?: PlaneName | FnPlane, origin?: PointInput | number): any;
|
|
968
914
|
|
|
969
915
|
/**
|
|
970
916
|
* Creates the `Drawing` of parametric function
|
|
@@ -1076,7 +1022,7 @@ export declare class EdgeFinder extends Finder3d<Edge> {
|
|
|
1076
1022
|
*
|
|
1077
1023
|
* @category Filter
|
|
1078
1024
|
*/
|
|
1079
|
-
inDirection(direction: Direction_2 |
|
|
1025
|
+
inDirection(direction: Direction_2 | PointInput): this;
|
|
1080
1026
|
/**
|
|
1081
1027
|
* Filter to find edges of a certain length
|
|
1082
1028
|
*
|
|
@@ -1097,7 +1043,7 @@ export declare class EdgeFinder extends Finder3d<Edge> {
|
|
|
1097
1043
|
*
|
|
1098
1044
|
* @category Filter
|
|
1099
1045
|
*/
|
|
1100
|
-
parallelTo(plane:
|
|
1046
|
+
parallelTo(plane: FnPlane | StandardPlane | Face): this;
|
|
1101
1047
|
/**
|
|
1102
1048
|
* Filter to find edges that within a plane.
|
|
1103
1049
|
*
|
|
@@ -1106,7 +1052,7 @@ export declare class EdgeFinder extends Finder3d<Edge> {
|
|
|
1106
1052
|
*
|
|
1107
1053
|
* @category Filter
|
|
1108
1054
|
*/
|
|
1109
|
-
inPlane(inputPlane: PlaneName |
|
|
1055
|
+
inPlane(inputPlane: PlaneName | FnPlane, origin?: PointInput | number): this;
|
|
1110
1056
|
shouldKeep(element: Edge): boolean;
|
|
1111
1057
|
protected applyFilter(shape: AnyShape): Edge[];
|
|
1112
1058
|
}
|
|
@@ -1174,10 +1120,10 @@ export declare class Face extends Shape {
|
|
|
1174
1120
|
vMin: number;
|
|
1175
1121
|
vMax: number;
|
|
1176
1122
|
};
|
|
1177
|
-
pointOnSurface(u: number, v: number):
|
|
1178
|
-
uvCoordinates(point:
|
|
1179
|
-
normalAt(locationVector?:
|
|
1180
|
-
get center():
|
|
1123
|
+
pointOnSurface(u: number, v: number): Vec3;
|
|
1124
|
+
uvCoordinates(point: PointInput): [number, number];
|
|
1125
|
+
normalAt(locationVector?: PointInput): Vec3;
|
|
1126
|
+
get center(): Vec3;
|
|
1181
1127
|
outerWire(): Wire;
|
|
1182
1128
|
innerWires(): Wire[];
|
|
1183
1129
|
/* Excluded from this release type: triangulation */
|
|
@@ -1200,7 +1146,7 @@ export declare class FaceFinder extends Finder3d<Face> {
|
|
|
1200
1146
|
*
|
|
1201
1147
|
* @category Filter
|
|
1202
1148
|
*/
|
|
1203
|
-
parallelTo(plane:
|
|
1149
|
+
parallelTo(plane: FnPlane | StandardPlane | Face): this;
|
|
1204
1150
|
/**
|
|
1205
1151
|
* Filter to find faces that are of a certain surface type.
|
|
1206
1152
|
*
|
|
@@ -1214,7 +1160,7 @@ export declare class FaceFinder extends Finder3d<Face> {
|
|
|
1214
1160
|
*
|
|
1215
1161
|
* @category Filter
|
|
1216
1162
|
*/
|
|
1217
|
-
inPlane(inputPlane: PlaneName |
|
|
1163
|
+
inPlane(inputPlane: PlaneName | FnPlane, origin?: PointInput | number): this;
|
|
1218
1164
|
shouldKeep(element: Face): boolean;
|
|
1219
1165
|
protected applyFilter(shape: AnyShape): Face[];
|
|
1220
1166
|
}
|
|
@@ -1282,7 +1228,7 @@ export declare type FilletRadius = number | [number, number];
|
|
|
1282
1228
|
|
|
1283
1229
|
export declare type FilterFcn<Type> = {
|
|
1284
1230
|
element: Type;
|
|
1285
|
-
normal:
|
|
1231
|
+
normal: Vec3 | null;
|
|
1286
1232
|
};
|
|
1287
1233
|
|
|
1288
1234
|
export declare const findCurveType: (type: any) => Result<CurveType>;
|
|
@@ -1369,25 +1315,25 @@ declare abstract class Finder3d<Type extends FaceOrEdge> extends Finder<Type, An
|
|
|
1369
1315
|
*
|
|
1370
1316
|
* @category Filter
|
|
1371
1317
|
*/
|
|
1372
|
-
atAngleWith(direction?: Direction_2 |
|
|
1318
|
+
atAngleWith(direction?: Direction_2 | PointInput, angle?: number): this;
|
|
1373
1319
|
/**
|
|
1374
1320
|
* Filter to find elements that are at a specified distance from a point.
|
|
1375
1321
|
*
|
|
1376
1322
|
* @category Filter
|
|
1377
1323
|
*/
|
|
1378
|
-
atDistance(distance: number, point?:
|
|
1324
|
+
atDistance(distance: number, point?: PointInput): this;
|
|
1379
1325
|
/**
|
|
1380
1326
|
* Filter to find elements that contain a certain point
|
|
1381
1327
|
*
|
|
1382
1328
|
* @category Filter
|
|
1383
1329
|
*/
|
|
1384
|
-
containsPoint(point:
|
|
1330
|
+
containsPoint(point: PointInput): this;
|
|
1385
1331
|
/**
|
|
1386
1332
|
* Filter to find elements that are within a certain distance from a point.
|
|
1387
1333
|
*
|
|
1388
1334
|
* @category Filter
|
|
1389
1335
|
*/
|
|
1390
|
-
withinDistance(distance: number, point?:
|
|
1336
|
+
withinDistance(distance: number, point?: PointInput): this;
|
|
1391
1337
|
/**
|
|
1392
1338
|
* Filter to find elements that are within a box
|
|
1393
1339
|
*
|
|
@@ -1395,7 +1341,7 @@ declare abstract class Finder3d<Type extends FaceOrEdge> extends Finder<Type, An
|
|
|
1395
1341
|
*
|
|
1396
1342
|
* @category Filter
|
|
1397
1343
|
*/
|
|
1398
|
-
inBox(corner1:
|
|
1344
|
+
inBox(corner1: PointInput, corner2: PointInput): this;
|
|
1399
1345
|
/**
|
|
1400
1346
|
* Filter to find elements that are within a generic shape
|
|
1401
1347
|
*
|
|
@@ -1439,7 +1385,7 @@ export declare function fnCreateEdge(ocShape: OcShape): FnEdge;
|
|
|
1439
1385
|
export declare function fnCreateFace(ocShape: OcShape): FnFace;
|
|
1440
1386
|
|
|
1441
1387
|
/** Create a named plane with optional origin offset. */
|
|
1442
|
-
export declare function fnCreateNamedPlane(name:
|
|
1388
|
+
export declare function fnCreateNamedPlane(name: PlaneName, sourceOrigin?: PointInput | number): Result<FnPlane>;
|
|
1443
1389
|
|
|
1444
1390
|
export declare function fnCreateShell(ocShape: OcShape): FnShell;
|
|
1445
1391
|
|
|
@@ -1530,8 +1476,6 @@ export declare interface FnPlane {
|
|
|
1530
1476
|
readonly zDir: Vec3;
|
|
1531
1477
|
}
|
|
1532
1478
|
|
|
1533
|
-
export declare type FnPlaneName = 'XY' | 'YZ' | 'ZX' | 'XZ' | 'YX' | 'ZY' | 'front' | 'back' | 'left' | 'right' | 'top' | 'bottom';
|
|
1534
|
-
|
|
1535
1479
|
/** Get a point on a face surface at normalized UV coordinates (0–1 range). */
|
|
1536
1480
|
export declare function fnPointOnSurface(face: FnFace, u: number, v: number): Vec3;
|
|
1537
1481
|
|
|
@@ -2017,8 +1961,8 @@ export declare const loft: (wires: Wire[], { ruled, startPoint, endPoint }?: Lof
|
|
|
2017
1961
|
|
|
2018
1962
|
export declare interface LoftConfig {
|
|
2019
1963
|
ruled?: boolean | undefined;
|
|
2020
|
-
startPoint?:
|
|
2021
|
-
endPoint?:
|
|
1964
|
+
startPoint?: PointInput | undefined;
|
|
1965
|
+
endPoint?: PointInput | undefined;
|
|
2022
1966
|
}
|
|
2023
1967
|
|
|
2024
1968
|
/** Loft through a set of wire profiles to create a shape. */
|
|
@@ -2026,38 +1970,20 @@ export declare function loftWires(wires: FnWire[], { ruled, startPoint, endPoint
|
|
|
2026
1970
|
|
|
2027
1971
|
export declare function lookFromPlane(projectionPlane: ProjectionPlane): ProjectionCamera;
|
|
2028
1972
|
|
|
2029
|
-
/**
|
|
2030
|
-
* @deprecated Use makeOcAx1 from occtBoundary.ts with Vec3 tuples instead.
|
|
2031
|
-
* @see makeOcAx1
|
|
2032
|
-
*/
|
|
2033
|
-
export declare const makeAx1: (center: Point, dir: Point) => OcType;
|
|
2034
|
-
|
|
2035
|
-
/**
|
|
2036
|
-
* @deprecated Use makeOcAx2 from occtBoundary.ts with Vec3 tuples instead.
|
|
2037
|
-
* @see makeOcAx2
|
|
2038
|
-
*/
|
|
2039
|
-
export declare const makeAx2: (center: Point, dir: Point, xDir?: Point) => OcType;
|
|
2040
|
-
|
|
2041
|
-
/**
|
|
2042
|
-
* @deprecated Use makeOcAx3 from occtBoundary.ts with Vec3 tuples instead.
|
|
2043
|
-
* @see makeOcAx3
|
|
2044
|
-
*/
|
|
2045
|
-
export declare const makeAx3: (center: Point, dir: Point, xDir?: Point) => OcType;
|
|
2046
|
-
|
|
2047
1973
|
export declare const makeBaseBox: (xLength: number, yLength: number, zLength: number) => Shape3D;
|
|
2048
1974
|
|
|
2049
|
-
export declare const makeBezierCurve: (points:
|
|
1975
|
+
export declare const makeBezierCurve: (points: Vec3[]) => Edge;
|
|
2050
1976
|
|
|
2051
1977
|
/**
|
|
2052
1978
|
* Creates a box with the given corner points.
|
|
2053
1979
|
*
|
|
2054
1980
|
* @category Solids
|
|
2055
1981
|
*/
|
|
2056
|
-
export declare const makeBox: (corner1:
|
|
1982
|
+
export declare const makeBox: (corner1: Vec3, corner2: Vec3) => Solid;
|
|
2057
1983
|
|
|
2058
|
-
export declare const makeBSplineApproximation: (points:
|
|
1984
|
+
export declare const makeBSplineApproximation: (points: Vec3[], { tolerance, smoothing, degMax, degMin }?: BSplineApproximationConfig) => Result<Edge>;
|
|
2059
1985
|
|
|
2060
|
-
export declare const makeCircle: (radius: number, center?:
|
|
1986
|
+
export declare const makeCircle: (radius: number, center?: Vec3, normal?: Vec3) => Edge;
|
|
2061
1987
|
|
|
2062
1988
|
export declare const makeCompound: (shapeArray: AnyShape[]) => AnyShape;
|
|
2063
1989
|
|
|
@@ -2066,13 +1992,13 @@ export declare const makeCompound: (shapeArray: AnyShape[]) => AnyShape;
|
|
|
2066
1992
|
*
|
|
2067
1993
|
* @category Solids
|
|
2068
1994
|
*/
|
|
2069
|
-
export declare const makeCylinder: (radius: number, height: number, location?:
|
|
1995
|
+
export declare const makeCylinder: (radius: number, height: number, location?: Vec3, direction?: Vec3) => Solid;
|
|
2070
1996
|
|
|
2071
1997
|
export declare function makeDirection(p: Direction): Point;
|
|
2072
1998
|
|
|
2073
|
-
export declare const makeEllipse: (majorRadius: number, minorRadius: number, center?:
|
|
1999
|
+
export declare const makeEllipse: (majorRadius: number, minorRadius: number, center?: Vec3, normal?: Vec3, xDir?: Vec3) => Result<Edge>;
|
|
2074
2000
|
|
|
2075
|
-
export declare const makeEllipseArc: (majorRadius: number, minorRadius: number, startAngle: number, endAngle: number, center?:
|
|
2001
|
+
export declare const makeEllipseArc: (majorRadius: number, minorRadius: number, startAngle: number, endAngle: number, center?: Vec3, normal?: Vec3, xDir?: Vec3) => Result<Edge>;
|
|
2076
2002
|
|
|
2077
2003
|
/**
|
|
2078
2004
|
* Creates an ellipsoid with the given axis lengths.
|
|
@@ -2083,9 +2009,9 @@ export declare const makeEllipsoid: (aLength: number, bLength: number, cLength:
|
|
|
2083
2009
|
|
|
2084
2010
|
export declare const makeFace: (wire: Wire, holes?: Wire[]) => Result<Face>;
|
|
2085
2011
|
|
|
2086
|
-
export declare const makeHelix: (pitch: number, height: number, radius: number, center?:
|
|
2012
|
+
export declare const makeHelix: (pitch: number, height: number, radius: number, center?: Vec3, dir?: Vec3, lefthand?: boolean) => Wire;
|
|
2087
2013
|
|
|
2088
|
-
export declare const makeLine: (v1:
|
|
2014
|
+
export declare const makeLine: (v1: Vec3, v2: Vec3) => Edge;
|
|
2089
2015
|
|
|
2090
2016
|
export declare const makeNewFaceWithinFace: (originFace: Face, wire: Wire) => Face;
|
|
2091
2017
|
|
|
@@ -2093,16 +2019,16 @@ export declare const makeNonPlanarFace: (wire: Wire) => Result<Face>;
|
|
|
2093
2019
|
|
|
2094
2020
|
export declare const makeOffset: (face: Face, offset: number, tolerance?: number) => Result<Shape3D>;
|
|
2095
2021
|
|
|
2096
|
-
export declare function makePlane(plane:
|
|
2022
|
+
export declare function makePlane(plane: FnPlane): FnPlane;
|
|
2097
2023
|
|
|
2098
|
-
export declare function makePlane(plane?: PlaneName, origin?:
|
|
2024
|
+
export declare function makePlane(plane?: PlaneName, origin?: PointInput | number): FnPlane;
|
|
2099
2025
|
|
|
2100
2026
|
export declare const makePlaneFromFace: (face: {
|
|
2101
|
-
pointOnSurface: (u: number, v: number) =>
|
|
2102
|
-
normalAt: (p
|
|
2103
|
-
}, originOnSurface?: [number, number]) =>
|
|
2027
|
+
pointOnSurface: (u: number, v: number) => Vec3;
|
|
2028
|
+
normalAt: (p?: Vec3) => Vec3;
|
|
2029
|
+
}, originOnSurface?: [number, number]) => FnPlane;
|
|
2104
2030
|
|
|
2105
|
-
export declare const makePolygon: (points:
|
|
2031
|
+
export declare const makePolygon: (points: Vec3[]) => Result<Face>;
|
|
2106
2032
|
|
|
2107
2033
|
export declare function makeProjectedEdges(shape: AnyShape, camera: ProjectionCamera, withHiddenLines?: boolean): {
|
|
2108
2034
|
visible: Edge[];
|
|
@@ -2126,11 +2052,11 @@ export declare function makeSolid(facesOrShells: Array<Face | Shell>): Result<So
|
|
|
2126
2052
|
*/
|
|
2127
2053
|
export declare const makeSphere: (radius: number) => Solid;
|
|
2128
2054
|
|
|
2129
|
-
export declare const makeTangentArc: (startPoint:
|
|
2055
|
+
export declare const makeTangentArc: (startPoint: Vec3, startTgt: Vec3, endPoint: Vec3) => Edge;
|
|
2130
2056
|
|
|
2131
|
-
export declare const makeThreePointArc: (v1:
|
|
2057
|
+
export declare const makeThreePointArc: (v1: Vec3, v2: Vec3, v3: Vec3) => Edge;
|
|
2132
2058
|
|
|
2133
|
-
export declare const makeVertex: (point:
|
|
2059
|
+
export declare const makeVertex: (point: Vec3) => Vertex;
|
|
2134
2060
|
|
|
2135
2061
|
export declare function map<T, U, E>(result: Result<T, E>, fn: (value: T) => U): Result<U, E>;
|
|
2136
2062
|
|
|
@@ -2183,7 +2109,7 @@ export declare function meshShapeEdges(shape: FnAnyShape, { tolerance, angularTo
|
|
|
2183
2109
|
cache?: boolean;
|
|
2184
2110
|
}): EdgeMesh;
|
|
2185
2111
|
|
|
2186
|
-
export declare function mirror(shape: OcType, inputPlane?:
|
|
2112
|
+
export declare function mirror(shape: OcType, inputPlane?: PlaneInput | PointInput, origin?: PointInput): OcType;
|
|
2187
2113
|
|
|
2188
2114
|
/** Mirror a blueprint. Returns a new Blueprint. */
|
|
2189
2115
|
export declare function mirrorBlueprint(bp: Blueprint, centerOrDirection: Point2D, origin?: Point2D, mode?: 'center' | 'plane'): Blueprint;
|
|
@@ -2268,57 +2194,22 @@ export declare interface PhysicalProps {
|
|
|
2268
2194
|
/** Pivot plane by rotating around an axis. */
|
|
2269
2195
|
export declare function pivotPlane(plane: FnPlane, angleDeg: number, axis?: Vec3): FnPlane;
|
|
2270
2196
|
|
|
2271
|
-
/**
|
|
2272
|
-
* @deprecated Use the Plane interface from planeTypes.ts with planeOps functions instead.
|
|
2273
|
-
* @example
|
|
2274
|
-
* // Before (legacy):
|
|
2275
|
-
* const plane = new Plane([0, 0, 0], [1, 0, 0], [0, 0, 1]);
|
|
2276
|
-
* const moved = plane.translate([1, 0, 0]);
|
|
2277
|
-
*
|
|
2278
|
-
* // After (functional):
|
|
2279
|
-
* import { createPlane, translatePlane, type Plane as FnPlane } from 'brepjs';
|
|
2280
|
-
* const plane: FnPlane = createPlane([0, 0, 0], [1, 0, 0], [0, 0, 1]);
|
|
2281
|
-
* const moved = translatePlane(plane, [1, 0, 0]);
|
|
2282
|
-
*
|
|
2283
|
-
* @see createPlane, translatePlane, pivotPlane, rotatePlane2DAxes
|
|
2284
|
-
*/
|
|
2285
|
-
export declare class Plane {
|
|
2286
|
-
oc: OpenCascadeInstance;
|
|
2287
|
-
xDir: Vector;
|
|
2288
|
-
yDir: Vector;
|
|
2289
|
-
zDir: Vector;
|
|
2290
|
-
private _origin;
|
|
2291
|
-
private localToGlobal;
|
|
2292
|
-
private globalToLocal;
|
|
2293
|
-
constructor(origin: Point, xDirection?: Point | null, normal?: Point);
|
|
2294
|
-
delete(): void;
|
|
2295
|
-
clone(): Plane;
|
|
2296
|
-
get origin(): Vector;
|
|
2297
|
-
set origin(newOrigin: Vector);
|
|
2298
|
-
translateTo(point: Point): Plane;
|
|
2299
|
-
translate(xDist: number, yDist: number, zDist: number): Plane;
|
|
2300
|
-
translate(vector: Point): Plane;
|
|
2301
|
-
translateX(xDist: number): Plane;
|
|
2302
|
-
translateY(yDist: number): Plane;
|
|
2303
|
-
translateZ(zDist: number): Plane;
|
|
2304
|
-
pivot(angle: number, direction?: Direction): Plane;
|
|
2305
|
-
rotate2DAxes(angle: number): Plane;
|
|
2306
|
-
_calcTransforms(): void;
|
|
2307
|
-
setOrigin2d(x: number, y: number): void;
|
|
2308
|
-
toLocalCoords(vec: Vector): Vector;
|
|
2309
|
-
toWorldCoords(v: Point): Vector;
|
|
2310
|
-
}
|
|
2311
|
-
|
|
2312
2197
|
declare interface PlaneConfig {
|
|
2313
|
-
plane?: PlaneName |
|
|
2314
|
-
origin?:
|
|
2198
|
+
plane?: PlaneName | FnPlane;
|
|
2199
|
+
origin?: PointInput | number;
|
|
2315
2200
|
}
|
|
2316
2201
|
|
|
2317
|
-
export declare type PlaneInput = FnPlane |
|
|
2202
|
+
export declare type PlaneInput = FnPlane | PlaneName;
|
|
2318
2203
|
|
|
2319
|
-
|
|
2204
|
+
declare type PlaneName = 'XY' | 'YZ' | 'ZX' | 'XZ' | 'YX' | 'ZY' | 'front' | 'back' | 'left' | 'right' | 'top' | 'bottom';
|
|
2205
|
+
export { PlaneName as FnPlaneName }
|
|
2206
|
+
export { PlaneName }
|
|
2320
2207
|
|
|
2321
|
-
|
|
2208
|
+
/**
|
|
2209
|
+
* Legacy Point type for backward compatibility.
|
|
2210
|
+
* Prefer using PointInput or Vec3 from types.ts.
|
|
2211
|
+
*/
|
|
2212
|
+
export declare type Point = SimplePoint | [number, number] | {
|
|
2322
2213
|
XYZ: () => any;
|
|
2323
2214
|
delete: () => void;
|
|
2324
2215
|
};
|
|
@@ -2348,18 +2239,16 @@ export declare function projectEdges(shape: AnyShape, camera: Camera, withHidden
|
|
|
2348
2239
|
};
|
|
2349
2240
|
|
|
2350
2241
|
export declare class ProjectionCamera extends WrappingObj<OcType> {
|
|
2351
|
-
constructor(position?:
|
|
2352
|
-
get position():
|
|
2353
|
-
get direction():
|
|
2354
|
-
get xAxis():
|
|
2355
|
-
get yAxis():
|
|
2242
|
+
constructor(position?: PointInput, direction?: PointInput, xAxis?: PointInput);
|
|
2243
|
+
get position(): Vec3;
|
|
2244
|
+
get direction(): Vec3;
|
|
2245
|
+
get xAxis(): Vec3;
|
|
2246
|
+
get yAxis(): Vec3;
|
|
2356
2247
|
autoAxes(): void;
|
|
2357
|
-
setPosition(position:
|
|
2358
|
-
setXAxis(xAxis:
|
|
2359
|
-
setYAxis(yAxis:
|
|
2360
|
-
lookAt(shape:
|
|
2361
|
-
boundingBox: BoundingBox;
|
|
2362
|
-
} | Point): this;
|
|
2248
|
+
setPosition(position: PointInput): this;
|
|
2249
|
+
setXAxis(xAxis: PointInput): this;
|
|
2250
|
+
setYAxis(yAxis: PointInput): this;
|
|
2251
|
+
lookAt(shape: FnAnyShape | PointInput): this;
|
|
2363
2252
|
}
|
|
2364
2253
|
|
|
2365
2254
|
export declare type ProjectionPlane = 'XY' | 'XZ' | 'YZ' | 'YX' | 'ZX' | 'ZY' | 'front' | 'back' | 'top' | 'bottom' | 'left' | 'right';
|
|
@@ -2397,12 +2286,12 @@ export declare type Result<T, E = BrepError> = Ok<T> | Err<E>;
|
|
|
2397
2286
|
/** Return a reversed copy of the curve (non-mutating). */
|
|
2398
2287
|
export declare function reverseCurve(curve: Curve2D): Curve2D;
|
|
2399
2288
|
|
|
2400
|
-
export declare const revolution: (face: Face, center?:
|
|
2289
|
+
export declare const revolution: (face: Face, center?: PointInput, direction?: PointInput, angle?: number) => Result<Shape3D>;
|
|
2401
2290
|
|
|
2402
2291
|
/** Revolve a face around an axis. Angle is in degrees. */
|
|
2403
2292
|
export declare function revolveFace(face: FnFace, center?: Vec3, direction?: Vec3, angle?: number): Result<FnShape3D>;
|
|
2404
2293
|
|
|
2405
|
-
export declare function rotate(shape: OcType, angle: number, position?:
|
|
2294
|
+
export declare function rotate(shape: OcType, angle: number, position?: PointInput, direction?: PointInput): OcType;
|
|
2406
2295
|
|
|
2407
2296
|
/** Rotate a blueprint by angle degrees around an optional center. Returns a new Blueprint. */
|
|
2408
2297
|
export declare function rotateBlueprint(bp: Blueprint, angle: number, center?: Point2D): Blueprint;
|
|
@@ -2418,7 +2307,7 @@ export declare const roundedRectangleBlueprint: (width: number, height: number,
|
|
|
2418
2307
|
ry?: number;
|
|
2419
2308
|
}) => Blueprint;
|
|
2420
2309
|
|
|
2421
|
-
export declare function scale(shape: OcType, center:
|
|
2310
|
+
export declare function scale(shape: OcType, center: PointInput, scaleFactor: number): OcType;
|
|
2422
2311
|
|
|
2423
2312
|
/** Scale a blueprint by a factor around an optional center. Returns a new Blueprint. */
|
|
2424
2313
|
export declare function scaleBlueprint(bp: Blueprint, factor: number, center?: Point2D): Blueprint;
|
|
@@ -2460,7 +2349,7 @@ export declare class Shape<Type extends Deletable = OcShape> extends WrappingObj
|
|
|
2460
2349
|
* @category Shape Transformations
|
|
2461
2350
|
*/
|
|
2462
2351
|
translate(xDist: number, yDist: number, zDist: number): this;
|
|
2463
|
-
translate(vector:
|
|
2352
|
+
translate(vector: PointInput): this;
|
|
2464
2353
|
/**
|
|
2465
2354
|
* Translates the shape on the X axis.
|
|
2466
2355
|
*
|
|
@@ -2484,25 +2373,24 @@ export declare class Shape<Type extends Deletable = OcShape> extends WrappingObj
|
|
|
2484
2373
|
*
|
|
2485
2374
|
* @category Shape Transformations
|
|
2486
2375
|
*/
|
|
2487
|
-
rotate(angle: number, position?:
|
|
2376
|
+
rotate(angle: number, position?: PointInput, direction?: PointInput): this;
|
|
2488
2377
|
/**
|
|
2489
2378
|
* Mirrors the shape through a plane.
|
|
2490
2379
|
*
|
|
2491
2380
|
* @category Shape Transformations
|
|
2492
2381
|
*/
|
|
2493
|
-
mirror(inputPlane?:
|
|
2382
|
+
mirror(inputPlane?: FnPlane | PlaneName | PointInput, origin?: PointInput): this;
|
|
2494
2383
|
/**
|
|
2495
2384
|
* Returns a scaled version of the shape.
|
|
2496
2385
|
*
|
|
2497
2386
|
* @category Shape Transformations
|
|
2498
2387
|
*/
|
|
2499
|
-
scale(scaleFactor: number, center?:
|
|
2388
|
+
scale(scaleFactor: number, center?: PointInput): this;
|
|
2500
2389
|
protected _iterTopo(topo: TopoEntity): IterableIterator<OcShape>;
|
|
2501
2390
|
protected _listTopo(topo: TopoEntity): OcShape[];
|
|
2502
2391
|
get edges(): Edge[];
|
|
2503
2392
|
get faces(): Face[];
|
|
2504
2393
|
get wires(): Wire[];
|
|
2505
|
-
get boundingBox(): BoundingBox;
|
|
2506
2394
|
protected _mesh({ tolerance, angularTolerance }?: {
|
|
2507
2395
|
tolerance?: number | undefined;
|
|
2508
2396
|
angularTolerance?: number | undefined;
|
|
@@ -2671,24 +2559,24 @@ export declare class Sketch implements SketchInterface {
|
|
|
2671
2559
|
/**
|
|
2672
2560
|
* @ignore
|
|
2673
2561
|
*/
|
|
2674
|
-
_defaultOrigin:
|
|
2562
|
+
_defaultOrigin: Vec3;
|
|
2675
2563
|
/**
|
|
2676
2564
|
* @ignore
|
|
2677
2565
|
*/
|
|
2678
|
-
_defaultDirection:
|
|
2566
|
+
_defaultDirection: Vec3;
|
|
2679
2567
|
protected _baseFace: Face | null | undefined;
|
|
2680
2568
|
constructor(wire: Wire, { defaultOrigin, defaultDirection, }?: {
|
|
2681
|
-
defaultOrigin?:
|
|
2682
|
-
defaultDirection?:
|
|
2569
|
+
defaultOrigin?: PointInput;
|
|
2570
|
+
defaultDirection?: PointInput;
|
|
2683
2571
|
});
|
|
2684
2572
|
get baseFace(): Face | null | undefined;
|
|
2685
2573
|
set baseFace(newFace: Face | null | undefined);
|
|
2686
2574
|
delete(): void;
|
|
2687
2575
|
clone(): Sketch;
|
|
2688
|
-
get defaultOrigin():
|
|
2689
|
-
set defaultOrigin(newOrigin:
|
|
2690
|
-
get defaultDirection():
|
|
2691
|
-
set defaultDirection(newDirection:
|
|
2576
|
+
get defaultOrigin(): Vec3;
|
|
2577
|
+
set defaultOrigin(newOrigin: PointInput);
|
|
2578
|
+
get defaultDirection(): Vec3;
|
|
2579
|
+
set defaultDirection(newDirection: PointInput);
|
|
2692
2580
|
/**
|
|
2693
2581
|
* Transforms the lines into a face. The lines should be closed.
|
|
2694
2582
|
*/
|
|
@@ -2699,8 +2587,8 @@ export declare class Sketch implements SketchInterface {
|
|
|
2699
2587
|
* Revolves the drawing on an axis (defined by its direction and an origin
|
|
2700
2588
|
* (defaults to the sketch origin)
|
|
2701
2589
|
*/
|
|
2702
|
-
revolve(revolutionAxis?:
|
|
2703
|
-
origin?:
|
|
2590
|
+
revolve(revolutionAxis?: PointInput, { origin }?: {
|
|
2591
|
+
origin?: PointInput;
|
|
2704
2592
|
}): Shape3D;
|
|
2705
2593
|
/** Extrudes the sketch to a certain distance (along the default direction
|
|
2706
2594
|
* and origin of the sketch).
|
|
@@ -2713,16 +2601,16 @@ export declare class Sketch implements SketchInterface {
|
|
|
2713
2601
|
* a s-shape).
|
|
2714
2602
|
*/
|
|
2715
2603
|
extrude(extrusionDistance: number, { extrusionDirection, extrusionProfile, twistAngle, origin, }?: {
|
|
2716
|
-
extrusionDirection?:
|
|
2604
|
+
extrusionDirection?: PointInput;
|
|
2717
2605
|
extrusionProfile?: ExtrusionProfile;
|
|
2718
2606
|
twistAngle?: number;
|
|
2719
|
-
origin?:
|
|
2607
|
+
origin?: PointInput;
|
|
2720
2608
|
}): Shape3D;
|
|
2721
2609
|
/**
|
|
2722
2610
|
* Sweep along this sketch another sketch defined in the function
|
|
2723
2611
|
* `sketchOnPlane`.
|
|
2724
2612
|
*/
|
|
2725
|
-
sweepSketch(sketchOnPlane: (plane:
|
|
2613
|
+
sweepSketch(sketchOnPlane: (plane: FnPlane, origin: Vec3) => this, sweepConfig?: GenericSweepConfig): Shape3D;
|
|
2726
2614
|
/** Loft between this sketch and another sketch (or an array of them)
|
|
2727
2615
|
*
|
|
2728
2616
|
* You can also define a `startPoint` for the loft (that will be placed
|
|
@@ -2739,7 +2627,7 @@ export declare class Sketch implements SketchInterface {
|
|
|
2739
2627
|
export declare function sketchBlueprintOnFace(bp: Blueprint, face: Face, scaleMode?: ScaleMode): any;
|
|
2740
2628
|
|
|
2741
2629
|
/** Sketch a blueprint on a plane. */
|
|
2742
|
-
export declare function sketchBlueprintOnPlane(bp: Blueprint, inputPlane?: PlaneName |
|
|
2630
|
+
export declare function sketchBlueprintOnPlane(bp: Blueprint, inputPlane?: PlaneName | FnPlane, origin?: PointInput | number): any;
|
|
2743
2631
|
|
|
2744
2632
|
/**
|
|
2745
2633
|
* Creates the `Sketch` of a circle in a defined plane
|
|
@@ -2752,8 +2640,8 @@ export declare const sketchCircle: (radius: number, planeConfig?: PlaneConfig) =
|
|
|
2752
2640
|
* Layer 3 wraps this in a Sketch class. */
|
|
2753
2641
|
export declare interface SketchData {
|
|
2754
2642
|
wire: Wire;
|
|
2755
|
-
defaultOrigin?:
|
|
2756
|
-
defaultDirection?:
|
|
2643
|
+
defaultOrigin?: Vec3;
|
|
2644
|
+
defaultDirection?: Vec3;
|
|
2757
2645
|
baseFace?: Face | null;
|
|
2758
2646
|
}
|
|
2759
2647
|
|
|
@@ -2770,9 +2658,9 @@ export declare const sketchEllipse: (xRadius?: number, yRadius?: number, planeCo
|
|
|
2770
2658
|
* @category Sketching
|
|
2771
2659
|
*/
|
|
2772
2660
|
export declare class Sketcher implements GenericSketcher<Sketch> {
|
|
2773
|
-
protected plane:
|
|
2774
|
-
protected pointer:
|
|
2775
|
-
protected firstPoint:
|
|
2661
|
+
protected plane: FnPlane;
|
|
2662
|
+
protected pointer: Vec3;
|
|
2663
|
+
protected firstPoint: Vec3;
|
|
2776
2664
|
protected pendingEdges: Edge[];
|
|
2777
2665
|
protected _mirrorWire: boolean;
|
|
2778
2666
|
/**
|
|
@@ -2780,10 +2668,10 @@ export declare class Sketcher implements GenericSketcher<Sketch> {
|
|
|
2780
2668
|
* with either a point of origin, or the position on the normal axis from
|
|
2781
2669
|
* the coordinates origin
|
|
2782
2670
|
*/
|
|
2783
|
-
constructor(plane:
|
|
2784
|
-
constructor(plane?: PlaneName, origin?:
|
|
2671
|
+
constructor(plane: FnPlane);
|
|
2672
|
+
constructor(plane?: PlaneName, origin?: PointInput | number);
|
|
2785
2673
|
delete(): void;
|
|
2786
|
-
protected _updatePointer(newPointer:
|
|
2674
|
+
protected _updatePointer(newPointer: Vec3): void;
|
|
2787
2675
|
movePointerTo([x, y]: Point2D): this;
|
|
2788
2676
|
lineTo([x, y]: Point2D): this;
|
|
2789
2677
|
line(xDist: number, yDist: number): this;
|
|
@@ -2841,26 +2729,26 @@ export declare class Sketches {
|
|
|
2841
2729
|
* a s-shape).
|
|
2842
2730
|
*/
|
|
2843
2731
|
extrude(extrusionDistance: number, extrusionConfig?: {
|
|
2844
|
-
extrusionDirection?:
|
|
2732
|
+
extrusionDirection?: PointInput;
|
|
2845
2733
|
extrusionProfile?: ExtrusionProfile;
|
|
2846
2734
|
twistAngle?: number;
|
|
2847
|
-
origin?:
|
|
2735
|
+
origin?: PointInput;
|
|
2848
2736
|
}): AnyShape;
|
|
2849
2737
|
/**
|
|
2850
2738
|
* Revolves the drawing on an axis (defined by its direction and an origin
|
|
2851
2739
|
* (defaults to the sketch origin)
|
|
2852
2740
|
*/
|
|
2853
|
-
revolve(revolutionAxis?:
|
|
2854
|
-
origin?:
|
|
2741
|
+
revolve(revolutionAxis?: PointInput, config?: {
|
|
2742
|
+
origin?: PointInput;
|
|
2855
2743
|
}): AnyShape;
|
|
2856
2744
|
}
|
|
2857
2745
|
|
|
2858
2746
|
/** Extrude a sketch to a given distance. Consumes the sketch. */
|
|
2859
2747
|
export declare function sketchExtrude(sketch: Sketch, height: number, config?: {
|
|
2860
|
-
extrusionDirection?:
|
|
2748
|
+
extrusionDirection?: PointInput;
|
|
2861
2749
|
extrusionProfile?: ExtrusionProfile;
|
|
2862
2750
|
twistAngle?: number;
|
|
2863
|
-
origin?:
|
|
2751
|
+
origin?: PointInput;
|
|
2864
2752
|
}): Shape3D;
|
|
2865
2753
|
|
|
2866
2754
|
/**
|
|
@@ -2876,7 +2764,7 @@ export declare const sketchFaceOffset: (face: Face, offset: number) => Sketch;
|
|
|
2876
2764
|
*
|
|
2877
2765
|
* @category Sketching
|
|
2878
2766
|
*/
|
|
2879
|
-
export declare const sketchHelix: (pitch: number, height: number, radius: number, center?:
|
|
2767
|
+
export declare const sketchHelix: (pitch: number, height: number, radius: number, center?: PointInput, dir?: PointInput, lefthand?: boolean) => Sketch;
|
|
2880
2768
|
|
|
2881
2769
|
export declare interface SketchInterface {
|
|
2882
2770
|
/**
|
|
@@ -2887,8 +2775,8 @@ export declare interface SketchInterface {
|
|
|
2887
2775
|
* Revolves the drawing on an axis (defined by its direction and an origin
|
|
2888
2776
|
* (defaults to the sketch origin)
|
|
2889
2777
|
*/
|
|
2890
|
-
revolve(revolutionAxis?:
|
|
2891
|
-
origin?:
|
|
2778
|
+
revolve(revolutionAxis?: PointInput, config?: {
|
|
2779
|
+
origin?: PointInput;
|
|
2892
2780
|
}): Shape3D;
|
|
2893
2781
|
/**
|
|
2894
2782
|
* Extrudes the sketch to a certain distance (along the default direction
|
|
@@ -2902,10 +2790,10 @@ export declare interface SketchInterface {
|
|
|
2902
2790
|
* a s-shape).
|
|
2903
2791
|
*/
|
|
2904
2792
|
extrude(extrusionDistance: number, extrusionConfig?: {
|
|
2905
|
-
extrusionDirection?:
|
|
2793
|
+
extrusionDirection?: PointInput;
|
|
2906
2794
|
extrusionProfile?: ExtrusionProfile;
|
|
2907
2795
|
twistAngle?: number;
|
|
2908
|
-
origin?:
|
|
2796
|
+
origin?: PointInput;
|
|
2909
2797
|
}): Shape3D;
|
|
2910
2798
|
/**
|
|
2911
2799
|
* Loft between this sketch and another sketch (or an array of them)
|
|
@@ -2954,8 +2842,8 @@ export declare const sketchPolysides: (radius: number, sidesCount: number, sagit
|
|
|
2954
2842
|
export declare const sketchRectangle: (xLength: number, yLength: number, planeConfig?: PlaneConfig) => Sketch;
|
|
2955
2843
|
|
|
2956
2844
|
/** Revolve a sketch around an axis. Consumes the sketch. */
|
|
2957
|
-
export declare function sketchRevolve(sketch: Sketch, revolutionAxis?:
|
|
2958
|
-
origin?:
|
|
2845
|
+
export declare function sketchRevolve(sketch: Sketch, revolutionAxis?: PointInput, options?: {
|
|
2846
|
+
origin?: PointInput;
|
|
2959
2847
|
}): Shape3D;
|
|
2960
2848
|
|
|
2961
2849
|
/**
|
|
@@ -2977,8 +2865,8 @@ export declare function sketchText(text: string, textConfig?: {
|
|
|
2977
2865
|
fontSize?: number;
|
|
2978
2866
|
fontFamily?: string;
|
|
2979
2867
|
}, planeConfig?: {
|
|
2980
|
-
plane?: PlaneName |
|
|
2981
|
-
origin?:
|
|
2868
|
+
plane?: PlaneName | FnPlane;
|
|
2869
|
+
origin?: PointInput | number;
|
|
2982
2870
|
}): Sketches;
|
|
2983
2871
|
|
|
2984
2872
|
export declare class Solid extends _3DShape {
|
|
@@ -3005,7 +2893,7 @@ declare type SupportedUnit = 'M' | 'CM' | 'MM' | 'INCH' | 'FT' | 'm' | 'mm' | 'c
|
|
|
3005
2893
|
export { SupportedUnit as FnSupportedUnit }
|
|
3006
2894
|
export { SupportedUnit }
|
|
3007
2895
|
|
|
3008
|
-
export declare const supportExtrude: (wire: Wire, center:
|
|
2896
|
+
export declare const supportExtrude: (wire: Wire, center: PointInput, normal: PointInput, support: OcType) => Result<Shape3D>;
|
|
3009
2897
|
|
|
3010
2898
|
export declare class Surface extends WrappingObj<OcType> {
|
|
3011
2899
|
get surfaceType(): Result<SurfaceType>;
|
|
@@ -3058,33 +2946,7 @@ export declare function toVec2(p: PointInput): Vec2;
|
|
|
3058
2946
|
/** Normalize any point input to Vec3 */
|
|
3059
2947
|
export declare function toVec3(p: PointInput): Vec3;
|
|
3060
2948
|
|
|
3061
|
-
|
|
3062
|
-
* @deprecated Use standalone transform functions instead.
|
|
3063
|
-
* @example
|
|
3064
|
-
* // Before (legacy):
|
|
3065
|
-
* const trsf = new Transformation();
|
|
3066
|
-
* trsf.translate([1, 0, 0]);
|
|
3067
|
-
* const newShape = trsf.transform(shape.wrapped);
|
|
3068
|
-
*
|
|
3069
|
-
* // After (functional):
|
|
3070
|
-
* import { translateShape } from 'brepjs';
|
|
3071
|
-
* const newShape = translateShape(shape, [1, 0, 0]);
|
|
3072
|
-
*
|
|
3073
|
-
* @see translateShape, rotateShape, mirrorShape, scaleShape
|
|
3074
|
-
*/
|
|
3075
|
-
export declare class Transformation extends WrappingObj<OcType> {
|
|
3076
|
-
constructor(transform?: OcType);
|
|
3077
|
-
translate(xDist: number, yDist: number, zDist: number): Transformation;
|
|
3078
|
-
translate(vector: Point): Transformation;
|
|
3079
|
-
rotate(angle: number, position?: Point, direction?: Point): this;
|
|
3080
|
-
mirror(inputPlane?: Plane | PlaneName | Point, inputOrigin?: Point): this;
|
|
3081
|
-
scale(center: Point, scale: number): this;
|
|
3082
|
-
coordSystemChange(fromSystem: CoordSystem, toSystem: CoordSystem): this;
|
|
3083
|
-
transformPoint(point: Point): OcType;
|
|
3084
|
-
transform(shape: OcType): OcType;
|
|
3085
|
-
}
|
|
3086
|
-
|
|
3087
|
-
export declare function translate(shape: OcType, vector: Point): OcType;
|
|
2949
|
+
export declare function translate(shape: OcType, vector: PointInput): OcType;
|
|
3088
2950
|
|
|
3089
2951
|
/** Translate a blueprint by (dx, dy). Returns a new Blueprint. */
|
|
3090
2952
|
export declare function translateBlueprint(bp: Blueprint, dx: number, dy: number): Blueprint;
|
|
@@ -3118,9 +2980,9 @@ export declare function tryCatch<T, E>(fn: () => T, mapError: (error: unknown) =
|
|
|
3118
2980
|
*/
|
|
3119
2981
|
export declare function tryCatchAsync<T, E>(fn: () => Promise<T>, mapError: (error: unknown) => E): Promise<Result<T, E>>;
|
|
3120
2982
|
|
|
3121
|
-
export declare function twistExtrude(wire: Wire, angleDegrees: number, center:
|
|
2983
|
+
export declare function twistExtrude(wire: Wire, angleDegrees: number, center: PointInput, normal: PointInput, profileShape?: ExtrusionProfile, shellMode?: false): Result<Shape3D>;
|
|
3122
2984
|
|
|
3123
|
-
export declare function twistExtrude(wire: Wire, angleDegrees: number, center:
|
|
2985
|
+
export declare function twistExtrude(wire: Wire, angleDegrees: number, center: PointInput, normal: PointInput, profileShape: ExtrusionProfile | undefined, shellMode: true): Result<[Shape3D, Wire, Wire]>;
|
|
3124
2986
|
|
|
3125
2987
|
export declare function typeCastError(code: string, message: string, cause?: unknown): BrepError;
|
|
3126
2988
|
|
|
@@ -3199,44 +3061,6 @@ export declare function vecScale(v: Vec3, s: number): Vec3;
|
|
|
3199
3061
|
|
|
3200
3062
|
export declare function vecSub(a: Vec3, b: Vec3): Vec3;
|
|
3201
3063
|
|
|
3202
|
-
/**
|
|
3203
|
-
* @deprecated Use Vec3 tuples with vecOps functions instead.
|
|
3204
|
-
* @example
|
|
3205
|
-
* // Before (legacy):
|
|
3206
|
-
* const v = new Vector([1, 2, 3]);
|
|
3207
|
-
* const result = v.add(new Vector([4, 5, 6]));
|
|
3208
|
-
*
|
|
3209
|
-
* // After (functional):
|
|
3210
|
-
* import { vecAdd, type Vec3 } from 'brepjs';
|
|
3211
|
-
* const v: Vec3 = [1, 2, 3];
|
|
3212
|
-
* const result = vecAdd(v, [4, 5, 6]);
|
|
3213
|
-
*/
|
|
3214
|
-
export declare class Vector extends WrappingObj<OcType> {
|
|
3215
|
-
constructor(vector?: Point);
|
|
3216
|
-
get repr(): string;
|
|
3217
|
-
get x(): number;
|
|
3218
|
-
get y(): number;
|
|
3219
|
-
get z(): number;
|
|
3220
|
-
get Length(): number;
|
|
3221
|
-
toTuple(): [number, number, number];
|
|
3222
|
-
/** Convert to Vec3 tuple */
|
|
3223
|
-
toVec3(): Vec3;
|
|
3224
|
-
cross(v: Vector): Vector;
|
|
3225
|
-
dot(v: Vector): number;
|
|
3226
|
-
sub(v: Vector): Vector;
|
|
3227
|
-
add(v: Vector): Vector;
|
|
3228
|
-
multiply(scale: number): Vector;
|
|
3229
|
-
normalized(): Vector;
|
|
3230
|
-
normalize(): this;
|
|
3231
|
-
getCenter(): this;
|
|
3232
|
-
getAngle(v: Vector): number;
|
|
3233
|
-
projectToPlane(plane: Plane): Vector;
|
|
3234
|
-
equals(other: Vector): boolean;
|
|
3235
|
-
toPnt(): OcType;
|
|
3236
|
-
toDir(): OcType;
|
|
3237
|
-
rotate(angle: number, center?: Point, direction?: Point): this;
|
|
3238
|
-
}
|
|
3239
|
-
|
|
3240
3064
|
export declare class Vertex extends Shape {
|
|
3241
3065
|
asTuple(): [number, number, number];
|
|
3242
3066
|
}
|