Skip to content

Measure parallel-face distance with automatic annotation planes #14347

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Draft
nicboone8 wants to merge 1 commit into
base: main
Choose a base branch
from
Draft

Measure parallel-face distance with automatic annotation planes #14347

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 4 additions & 4 deletions docs/kcl-std/functions/std-gdt-distance.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -29,12 +29,12 @@ This is part of model-based definition (MBD).
| Name | Type | Description | Required |
|----------|------|-------------|----------|
| `tolerance` | [`number(Length)`](/docs/kcl-std/types/std-types-number) | The acceptable distance tolerance. If not given, or 0, tolerance will not be shown. | No |
| `from` | [`Face`](/docs/kcl-std/types/std-types-Face) or [`TaggedFace`](/docs/kcl-std/types/std-types-TaggedFace) or [`Edge`](/docs/kcl-std/types/std-types-Edge) or [`any`](/docs/kcl-std/types/std-types-any) | The face or edge to measure from. Must be used with `to`. The default position is the entity center. Edge specifier objects (`{ sideFaces = [...], endFaces? = [...], index? = 0 }`) are experimental; do not use them in generated or user-facing KCL yet. | No |
| `to` | [`Face`](/docs/kcl-std/types/std-types-Face) or [`TaggedFace`](/docs/kcl-std/types/std-types-TaggedFace) or [`Edge`](/docs/kcl-std/types/std-types-Edge) or [`any`](/docs/kcl-std/types/std-types-any) | The face or edge to measure to. Must be used with `from`. The default position is the entity center. Edge specifier objects (`{ sideFaces = [...], endFaces? = [...], index? = 0 }`) are experimental; do not use them in generated or user-facing KCL yet. | No |
| `from` | [`Face`](/docs/kcl-std/types/std-types-Face) or [`TaggedFace`](/docs/kcl-std/types/std-types-TaggedFace) or [`Edge`](/docs/kcl-std/types/std-types-Edge) or [`any`](/docs/kcl-std/types/std-types-any) | The face or edge to measure from. Must be used with `to`. Two parallel planar faces measure the perpendicular distance between their infinite supporting planes, even when their centers are offset sideways or their boundaries do not overlap. Coincident supporting planes cannot display a distance annotation. Other entity pairs measure between entity centers. Edge specifier objects (`{ sideFaces = [...], endFaces? = [...], index? = 0 }`) are experimental; do not use them in generated or user-facing KCL yet. | No |
| `to` | [`Face`](/docs/kcl-std/types/std-types-Face) or [`TaggedFace`](/docs/kcl-std/types/std-types-TaggedFace) or [`Edge`](/docs/kcl-std/types/std-types-Edge) or [`any`](/docs/kcl-std/types/std-types-any) | The face or edge to measure to. Must be used with `from`. Parallel planar faces use supporting-plane distance; other entity pairs use their centers. Edge specifier objects (`{ sideFaces = [...], endFaces? = [...], index? = 0 }`) are experimental; do not use them in generated or user-facing KCL yet. | No |
| `edges` | [[`Edge`](/docs/kcl-std/types/std-types-Edge) or [`any`](/docs/kcl-std/types/std-types-any); 1+] | The edges whose lengths are annotated. Cannot be combined with `from` or `to`. Edge specifier objects (`{ sideFaces = [...], endFaces? = [...], index? = 0 }`) are experimental; do not use them in generated or user-facing KCL yet. | No |
| `precision` | [`number(_)`](/docs/kcl-std/types/std-types-number) | The number of decimal places to display. The default is `3`. Must be greater than or equal to `0` and less than or equal to `9`. | No |
| `framePosition` | [`Point2d`](/docs/kcl-std/types/std-types-Point2d) | The position of the distance label relative to the measured geometry. The default is `[100mm, 100mm]`. | No |
| `framePlane` | [`Plane`](/docs/kcl-std/types/std-types-Plane) | The plane in which to display the distance. The default is `XY`. Other standard planes like `XZ` and `YZ` can also be used. The distance may be displayed in a plane parallel to the given plane. | No |
| `framePosition` | [`Point2d`](/docs/kcl-std/types/std-types-Point2d) | The distance label's local offset `[along, setback]`, in length units. `along` moves the label from the measurement midpoint, positive toward `from` and negative toward `to`; `0` centers it when the text fits. `setback` sets the perpendicular leader extent in `framePlane`; the dimension line lies at 80% of this extent. Its sign chooses the side. When omitted, the label is centered with a setback of 150% of the bounding-box diagonal, using the larger of the measured entities and the whole model. The dimension line lies at 80% of this setback, leaving 20% clearance beyond the diagonal for interior features. If no usable bounds are available, use `[0mm, 20mm]` as a fallback. Point-and-click writes the calculated position as literal lengths. Explicit positions are preserved, including `[0, 0]`. | No |
| `framePlane` | [`Plane`](/docs/kcl-std/types/std-types-Plane) | The plane in which to display the distance. For two parallel planar faces, omitting this chooses a display plane containing their common normal automatically. An explicit plane must contain that direction; its origin does not affect the measured distance. Other entity pairs and edge lengths default to `XY`. Standard planes like `XZ` and `YZ` or a custom plane can be used. The distance may be displayed in a plane parallel to the given plane. | No |
| `leaderScale` | [`number(_)`](/docs/kcl-std/types/std-types-number) | Scale of the distance arrows. The default is `1.0`. Must be greater than `0`. | No |
| `fontSize` | [`number(Length)`](/docs/kcl-std/types/std-types-number) | The model-space height to use for annotation text. The default is `10mm`. Explicit units are supported; bare numbers use the file's default length unit. This changes the scene size, not the internal raster texture quality. | No |
| `annotationName` | [`string`](/docs/kcl-std/types/std-types-string) | Human-friendly name for this annotation in exports and model metadata. This is not displayed visually. | No |
Expand Down
8 changes: 4 additions & 4 deletions rust/kcl-lib/expected-bindings/ts-rs/StdLibCommands.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3058,7 +3058,7 @@ export default {
{
"name": "from",
"ty": "Face | TaggedFace | Edge | any",
"docs": "The face or edge to measure from. Must be used with `to`. The default position is the entity center. Edge specifier objects (`{ sideFaces = [...], endFaces? = [...], index? = 0 }`) are experimental; do not use them in generated or user-facing KCL yet.",
"docs": "The face or edge to measure from. Must be used with `to`. Two parallel planar faces measure the perpendicular distance between their infinite supporting planes, even when their centers are offset sideways or their boundaries do not overlap. Coincident supporting planes cannot display a distance annotation. Other entity pairs measure between entity centers. Edge specifier objects (`{ sideFaces = [...], endFaces? = [...], index? = 0 }`) are experimental; do not use them in generated or user-facing KCL yet.",
"required": false,
"special": false,
"experimental": false,
Expand All @@ -3070,7 +3070,7 @@ export default {
{
"name": "to",
"ty": "Face | TaggedFace | Edge | any",
"docs": "The face or edge to measure to. Must be used with `from`. The default position is the entity center. Edge specifier objects (`{ sideFaces = [...], endFaces? = [...], index? = 0 }`) are experimental; do not use them in generated or user-facing KCL yet.",
"docs": "The face or edge to measure to. Must be used with `from`. Parallel planar faces use supporting-plane distance; other entity pairs use their centers. Edge specifier objects (`{ sideFaces = [...], endFaces? = [...], index? = 0 }`) are experimental; do not use them in generated or user-facing KCL yet.",
"required": false,
"special": false,
"experimental": false,
Expand Down Expand Up @@ -3106,7 +3106,7 @@ export default {
{
"name": "framePosition",
"ty": "Point2d",
"docs": "The position of the distance label relative to the measured geometry. The default is `[100mm, 100mm]`.",
"docs": "The distance label's local offset `[along, setback]`, in length units. `along` moves the label from the measurement midpoint, positive toward `from` and negative toward `to`; `0` centers it when the text fits. `setback` sets the perpendicular leader extent in `framePlane`; the dimension line lies at 80% of this extent. Its sign chooses the side. When omitted, the label is centered with a setback of 150% of the bounding-box diagonal, using the larger of the measured entities and the whole model. The dimension line lies at 80% of this setback, leaving 20% clearance beyond the diagonal for interior features. If no usable bounds are available, use `[0mm, 20mm]` as a fallback. Point-and-click writes the calculated position as literal lengths. Explicit positions are preserved, including `[0, 0]`.",
"required": false,
"special": false,
"experimental": false,
Expand All @@ -3118,7 +3118,7 @@ export default {
{
"name": "framePlane",
"ty": "Plane",
"docs": "The plane in which to display the distance. The default is `XY`. Other standard planes like `XZ` and `YZ` can also be used. The distance may be displayed in a plane parallel to the given plane.",
"docs": "The plane in which to display the distance. For two parallel planar faces, omitting this chooses a display plane containing their common normal automatically. An explicit plane must contain that direction; its origin does not affect the measured distance. Other entity pairs and edge lengths default to `XY`. Standard planes like `XZ` and `YZ` or a custom plane can be used. The distance may be displayed in a plane parallel to the given plane.",
"required": false,
"special": false,
"experimental": false,
Expand Down
Loading
Loading