AttachOptions ​Contract 2.0.0 · package sha256
a857eca95b35921109faf997094bb4192f12527d9d0fcd4be7e97f06425bad6e· generated fromconfigurator-runtime.d.tsbyservices/onsite-scripter/scripts/build-contract-docs.mjs; edit the source, not this file.
Interface · import type { AttachOptions } from '@holostep-configurators/runtime-client/contract'; · stable · since 2.0.0 · section 12. Assembly
The member options of assembly.attach. They pass through a tx.
| Member | Kind | Summary |
|---|---|---|
from? |
property | The connector of node to use (a ConnectorRef.connector). |
to? |
property | A connector ({ node, connector }: used at any distance), or a node (its best free connector). |
near? |
property | Which of node's connectors to prefer when several have partners: the one nearest this world point. |
orient? |
property | 'auto': yaw node about world +Y so the two normals oppose, then translate. |
Inherited from SignalOption: signal.
export interface AttachOptions extends SignalOption {
from?: string;
to?: ConnectorRef | {
node: string;
};
near?: Point3;
orient?: 'auto' | 'keep';
}
| Rule | Result |
|---|---|
| 1. Neutral name | pass: AttachOptions names no product |
| 2. A precedent | pass: Onshape mate connectors (row K63) |
| 3. Two apps, or labs | pass: 5 apps (ledger: app-04c2774145, app-37356bf09f, app-4762caacdc, app-c1384707fc, app-f9a32142f1) |
| 4. The cheaper fix first | decided per need in Appendix B: rows K63 at tier app, stable (a member only where no rule, data, asset or app code serves the need) |