Skip to content

Commit d4839d2

Browse files
authored
fix: build GeometryProcessSettings jsdoc into types (#226)
Use /** block comments so the GeometryProcessSettings field docs are emitted into index.d.ts.
1 parent fd11e67 commit d4839d2

1 file changed

Lines changed: 8 additions & 10 deletions

File tree

  • packages/fragments/src/Utils/shells

packages/fragments/src/Utils/shells/index.ts

Lines changed: 8 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -25,37 +25,35 @@ export type ShellData = {
2525
};
2626

2727
export type GeometryProcessSettings = {
28-
// Geometries larger than this threshold will be processed as raw data
29-
// a good value seem to be 3000
30-
/*
28+
/**
3129
* Maximum number of vertices to try to define a brep shell. If the number of vertices is greater than the threshold, the geometry will be saved as raw data, consuming more space.
3230
*/
3331
threshold: number;
34-
/*
32+
/**
3533
* Precision of the vertices when computing breps.
3634
*/
3735
precision: number;
38-
/*
36+
/**
3937
* Precision of the normals when computing breps.
4038
*/
4139
normalPrecision: number;
42-
/*
40+
/**
4341
* Precision of the plane constants for coplanarity when computing breps.
4442
*/
4543
planePrecision: number;
46-
/*
44+
/**
4745
* The threshold use to distinguish hard and smooth faces.
4846
*/
4947
faceThreshold: number;
50-
/*
48+
/**
5149
* The thresholds use to distinguish hard and smooth faces for each category. It overrides the global faceThreshold.
5250
*/
5351
categoryFaceThresholds?: Map<number, number>;
54-
/*
52+
/**
5553
* Whether to force ifc spaces to be transparent.
5654
*/
5755
forceTransparentSpaces: boolean;
58-
/*
56+
/**
5957
* Whether to process IfcRelSpaceBoundary2ndLevel entities and generate meshes from their IfcConnectionSurfaceGeometry.
6058
*/
6159
processIfcRelSpaceBoundarySecondLevel?: boolean;

0 commit comments

Comments
 (0)